Redemption flow actions

pkg/chain/chain.go

@@ -143,4 +143,11 @@ type BondedECDSAKeep interface {
 
 	// GetOpenedTimestamp returns timestamp when the keep was created.
 	GetOpenedTimestamp(keepAddress common.Address) (time.Time, error)
+
+	// PastSignatureSubmittedEvents returns all signature submitted events
+	// for the given keep which occurred after the provided start block.
+	PastSignatureSubmittedEvents(
+		keepAddress string,
+		startBlock uint64,
+	) ([]*SignatureSubmittedEvent, error)
 }

pkg/chain/ethereum/ethereum.go

@@ -6,6 +6,9 @@ import (
 	"math/big"
 	"time"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/keep-network/keep-ecdsa/pkg/chain/gen/abi"
+
 	"github.com/ethereum/go-ethereum/common"
 
 	"github.com/ipfs/go-log"
@@ -507,3 +510,48 @@ func (ec *EthereumChain) GetOpenedTimestamp(keepAddress common.Address) (time.Ti
 
 	return keepOpenTime, nil
 }
+
+// PastSignatureSubmittedEvents returns all signature submitted events
+// for the given keep which occurred after the provided start block.
+func (ec *EthereumChain) PastSignatureSubmittedEvents(
+	keepAddress string,
+	startBlock uint64,
+) ([]*eth.SignatureSubmittedEvent, error) {
+	if !common.IsHexAddress(keepAddress) {
+		return nil, fmt.Errorf("invalid keep address: [%v]", keepAddress)
+	}
+
+	keepContractAbi, err := abi.NewBondedECDSAKeep(
+		common.HexToAddress(keepAddress),
+		ec.client,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	iterator, err := keepContractAbi.FilterSignatureSubmitted(
+		&bind.FilterOpts{Start: startBlock},
+		nil,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	result := make([]*eth.SignatureSubmittedEvent, 0)
+
+	hasNext := true
+	for hasNext {
+		hasNext = iterator.Next()
+		if hasNext {
+			event := iterator.Event
+			result = append(result, &eth.SignatureSubmittedEvent{
+				Digest:     event.Digest,
+				R:          event.R,
+				S:          event.S,
+				RecoveryID: event.RecoveryID,
+			})
+		}
+	}
+
+	return result, nil
+}

pkg/chain/ethereum/tbtc.go

@@ -83,8 +83,111 @@ func (tec *TBTCEthereumChain) OnDepositRegisteredPubkey(
 			handler(DepositContractAddress.Hex())
 		},
 		func(err error) error {
-			return fmt.Errorf("watch deposit created failed: [%v]", err)
+			return fmt.Errorf(
+				"watch deposit registered pubkey failed: [%v]",
+				err,
+			)
+		},
+		nil,
+	)
+}
+
+// OnDepositRedemptionRequested installs a callback that is invoked when an
+// on-chain notification of a deposit redemption request is seen.
+func (tec *TBTCEthereumChain) OnDepositRedemptionRequested(
+	handler func(
+		depositAddress string,
+		requesterAddress string,
+		digest [32]uint8,
+		utxoValue *big.Int,
+		redeemerOutputScript []uint8,
+		requestedFee *big.Int,
+		outpoint []uint8,
+		blockNumber uint64,
+	),
+) (subscription.EventSubscription, error) {
+	return tec.tbtcSystemContract.WatchRedemptionRequested(
+		func(
+			DepositContractAddress common.Address,
+			Requester common.Address,
+			Digest [32]uint8,
+			UtxoValue *big.Int,
+			RedeemerOutputScript []uint8,
+			RequestedFee *big.Int,
+			Outpoint []uint8,
+			blockNumber uint64,
+		) {
+			handler(
+				DepositContractAddress.Hex(),
+				Requester.Hex(),
+				Digest,
+				UtxoValue,
+				RedeemerOutputScript,
+				RequestedFee,
+				Outpoint,
+				blockNumber,
+			)
 		},
+		func(err error) error {
+			return fmt.Errorf(
+				"watch deposit redemption requested failed: [%v]",
+				err,
+			)
+		},
+		nil,
+		nil,
+		nil,
+	)
+}
+
+// OnDepositGotRedemptionSignature installs a callback that is invoked when an
+// on-chain notification of a deposit receiving a redemption signature is seen.
+func (tec *TBTCEthereumChain) OnDepositGotRedemptionSignature(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	return tec.tbtcSystemContract.WatchGotRedemptionSignature(
+		func(
+			DepositContractAddress common.Address,
+			Digest [32]uint8,
+			R [32]uint8,
+			S [32]uint8,
+			Timestamp *big.Int,
+			blockNumber uint64,
+		) {
+			handler(DepositContractAddress.Hex())
+		},
+		func(err error) error {
+			return fmt.Errorf(
+				"watch deposit got redemption signature failed: [%v]",
+				err,
+			)
+		},
+		nil,
+		nil,
+	)
+}
+
+// OnDepositRedeemed installs a callback that is invoked when an
+// on-chain notification of a deposit redemption is seen.
+func (tec *TBTCEthereumChain) OnDepositRedeemed(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	return tec.tbtcSystemContract.WatchRedeemed(
+		func(
+			DepositContractAddress common.Address,
+			Txid [32]uint8,
+			Timestamp *big.Int,
+			blockNumber uint64,
+		) {
+			handler(DepositContractAddress.Hex())
+		},
+		func(err error) error {
+			return fmt.Errorf(
+				"watch deposit redeemed failed: [%v]",
+				err,
+			)
+		},
+		nil,
 		nil,
 	)
 }
@@ -130,6 +233,59 @@ func (tec *TBTCEthereumChain) RetrieveSignerPubkey(
 	return nil
 }
 
+// ProvideRedemptionSignature provides the redemption signature for the
+// provided deposit.
+func (tec *TBTCEthereumChain) ProvideRedemptionSignature(
+	depositAddress string,
+	v uint8,
+	r [32]uint8,
+	s [32]uint8,
+) error {
+	deposit, err := tec.getDepositContract(depositAddress)
+	if err != nil {
+		return err
+	}
+
+	transaction, err := deposit.ProvideRedemptionSignature(v, r, s)
+	if err != nil {
+		return err
+	}
+
+	logger.Debugf(
+		"submitted ProvideRedemptionSignature transaction with hash: [%x]",
+		transaction.Hash(),
+	)
+
+	return nil
+}
+
+// IncreaseRedemptionFee increases the redemption fee for the provided deposit.
+func (tec *TBTCEthereumChain) IncreaseRedemptionFee(
+	depositAddress string,
+	previousOutputValueBytes [8]uint8,
+	newOutputValueBytes [8]uint8,
+) error {
+	deposit, err := tec.getDepositContract(depositAddress)
+	if err != nil {
+		return err
+	}
+
+	transaction, err := deposit.IncreaseRedemptionFee(
+		previousOutputValueBytes,
+		newOutputValueBytes,
+	)
+	if err != nil {
+		return err
+	}
+
+	logger.Debugf(
+		"submitted IncreaseRedemptionFee transaction with hash: [%x]",
+		transaction.Hash(),
+	)
+
+	return nil
+}
+
 func (tec *TBTCEthereumChain) getDepositContract(
 	address string,
 ) (*contract.Deposit, error) {

pkg/chain/event.go

@@ -42,6 +42,14 @@ type KeepTerminatedEvent struct {
 	BlockNumber uint64
 }
 
+// SignatureSubmittedEvent is an event emitted when a keep submits a signature.
+type SignatureSubmittedEvent struct {
+	Digest     [32]byte
+	R          [32]byte
+	S          [32]byte
+	RecoveryID uint8
+}
+
 // IsMember checks if list of members contains the given address.
 func (e *BondedECDSAKeepCreatedEvent) IsMember(address common.Address) bool {
 	for _, member := range e.Members {

pkg/chain/local/local.go

@@ -351,6 +351,13 @@ func (lc *localChain) GetOpenedTimestamp(keepAddress common.Address) (time.Time,
 	panic("implement")
 }
 
+func (lc *localChain) PastSignatureSubmittedEvents(
+	keepAddress string,
+	startBlock uint64,
+) ([]*eth.SignatureSubmittedEvent, error) {
+	panic("implement")
+}
+
 func generateHandlerID() int {
 	// #nosec G404 (insecure random number source (rand))
 	// Local chain implementation doesn't require secure randomness.

pkg/chain/local/tbtc.go

@@ -3,6 +3,7 @@ package local
 import (
 	"bytes"
 	"fmt"
+	"math/big"
 	"sync"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -106,6 +107,33 @@ func (tlc *TBTCLocalChain) OnDepositRegisteredPubkey(
 	}), nil
 }
 
+func (tlc *TBTCLocalChain) OnDepositRedemptionRequested(
+	handler func(
+		depositAddress string,
+		requesterAddress string,
+		digest [32]uint8,
+		utxoValue *big.Int,
+		redeemerOutputScript []uint8,
+		requestedFee *big.Int,
+		outpoint []uint8,
+		blockNumber uint64,
+	),
+) (subscription.EventSubscription, error) {
+	panic("not implemented") // TODO: Implementation for unit testing purposes.
+}
+
+func (tlc *TBTCLocalChain) OnDepositGotRedemptionSignature(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	panic("not implemented") // TODO: Implementation for unit testing purposes.
+}
+
+func (tlc *TBTCLocalChain) OnDepositRedeemed(
+	handler func(depositAddress string),
+) (subscription.EventSubscription, error) {
+	panic("not implemented") // TODO: Implementation for unit testing purposes.
+}
+
 func (tlc *TBTCLocalChain) KeepAddress(depositAddress string) (string, error) {
 	tlc.mutex.Lock()
 	defer tlc.mutex.Unlock()
@@ -167,6 +195,23 @@ func (tlc *TBTCLocalChain) RetrieveSignerPubkey(depositAddress string) error {
 	return nil
 }
 
+func (tlc *TBTCLocalChain) ProvideRedemptionSignature(
+	depositAddress string,
+	v uint8,
+	r [32]uint8,
+	s [32]uint8,
+) error {
+	panic("not implemented") // TODO: Implementation for unit testing purposes.
+}
+
+func (tlc *TBTCLocalChain) IncreaseRedemptionFee(
+	depositAddress string,
+	previousOutputValueBytes [8]uint8,
+	newOutputValueBytes [8]uint8,
+) error {
+	panic("not implemented") // TODO: Implementation for unit testing purposes.
+}
+
 func (tlc *TBTCLocalChain) DepositPubkey(
 	depositAddress string,
 ) ([]byte, error) {