Add TBTC monitoring confirmations

pkg/chain/chain.go

@@ -7,11 +7,14 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ipfs/go-log"
 	"github.com/keep-network/keep-common/pkg/subscription"
 	"github.com/keep-network/keep-core/pkg/chain"
 	"github.com/keep-network/keep-ecdsa/pkg/ecdsa"
 )
 
+var logger = log.Logger("keep-chain")
+
 // Handle represents a handle to an ethereum blockchain.
 type Handle interface {
 	// Address returns client's ethereum address.

pkg/chain/confirmation.go

@@ -0,0 +1,32 @@
+package eth
+
+import (
+	"fmt"
+)
+
+// WaitForChainConfirmation ensures that after receiving specific number of block
+// confirmations the state of the chain is actually as expected. It waits for
+// predefined number of blocks since the start block number provided. After the
+// required block number is reached it performs a check of the chain state with
+// a provided function returning a boolean value.
+func WaitForChainConfirmation(
+	ethereumChain Handle,
+	startBlockNumber uint64,
+	blockConfirmations uint64,
+	stateCheck func() (bool, error),
+) (bool, error) {
+	blockHeight := startBlockNumber + blockConfirmations
+	logger.Infof("waiting for block [%d] to confirm chain state", blockHeight)
+
+	err := ethereumChain.BlockCounter().WaitForBlockHeight(blockHeight)
+	if err != nil {
+		return false, fmt.Errorf("failed to wait for block height: [%v]", err)
+	}
+
+	result, err := stateCheck()
+	if err != nil {
+		return false, fmt.Errorf("failed to get chain state confirmation: [%v]", err)
+	}
+
+	return result, nil
+}

pkg/chain/ethereum/tbtc.go

@@ -364,6 +364,23 @@ func (tec *TBTCEthereumChain) ProvideRedemptionProof(
 	return nil
 }
 
+// CurrentState returns the current state for the provided deposit.
+func (tec *TBTCEthereumChain) CurrentState(
+	depositAddress string,
+) (chain.DepositState, error) {
+	deposit, err := tec.getDepositContract(depositAddress)
+	if err != nil {
+		return 0, err
+	}
+
+	state, err := deposit.CurrentState()
+	if err != nil {
+		return 0, err
+	}
+
+	return chain.DepositState(state.Uint64()), err
+}
+
 func (tec *TBTCEthereumChain) getDepositContract(
 	address string,
 ) (*contract.Deposit, error) {

pkg/chain/local/tbtc.go

@@ -23,6 +23,7 @@ const (
 type localDeposit struct {
 	keepAddress string
 	pubkey      []byte
+	state       chain.DepositState
 
 	utxoValue           *big.Int
 	redemptionDigest    [32]byte
@@ -114,6 +115,7 @@ func (tlc *TBTCLocalChain) CreateDeposit(
 
 	tlc.deposits[depositAddress] = &localDeposit{
 		keepAddress:               keepAddress.Hex(),
+		state:                     chain.AwaitingSignerSetup,
 		utxoValue:                 big.NewInt(defaultUTXOValue),
 		redemptionRequestedEvents: make([]*chain.DepositRedemptionRequestedEvent, 0),
 	}
@@ -188,6 +190,7 @@ func (tlc *TBTCLocalChain) RedeemDeposit(depositAddress string) error {
 		return err
 	}
 
+	deposit.state = chain.AwaitingWithdrawalSignature
 	deposit.redemptionDigest = randomDigest
 	deposit.redemptionFee = big.NewInt(defaultInitialRedemptionFee)
 
@@ -346,6 +349,7 @@ func (tlc *TBTCLocalChain) RetrieveSignerPubkey(depositAddress string) error {
 	}
 
 	deposit.pubkey = keep.publicKey[:]
+	deposit.state = chain.AwaitingBtcFundingProof
 
 	for _, handler := range tlc.depositRegisteredPubkeyHandlers {
 		go func(handler func(depositAddress string), depositAddress string) {
@@ -387,6 +391,7 @@ func (tlc *TBTCLocalChain) ProvideRedemptionSignature(
 		)
 	}
 
+	deposit.state = chain.AwaitingWithdrawalProof
 	deposit.redemptionSignature = &Signature{
 		V: v,
 		R: r,
@@ -454,6 +459,7 @@ func (tlc *TBTCLocalChain) IncreaseRedemptionFee(
 		return err
 	}
 
+	deposit.state = chain.AwaitingWithdrawalSignature
 	deposit.redemptionDigest = randomDigest
 	deposit.redemptionFee = new(big.Int).Sub(deposit.utxoValue, newOutputValue)
 	deposit.redemptionSignature = nil
@@ -518,6 +524,7 @@ func (tlc *TBTCLocalChain) ProvideRedemptionProof(
 		)
 	}
 
+	deposit.state = chain.Redeemed
 	deposit.redemptionProof = &TxProof{}
 
 	for _, handler := range tlc.depositRedeemedHandlers {
@@ -529,6 +536,20 @@ func (tlc *TBTCLocalChain) ProvideRedemptionProof(
 	return nil
 }
 
+func (tlc *TBTCLocalChain) CurrentState(
+	depositAddress string,
+) (chain.DepositState, error) {
+	tlc.tbtcLocalChainMutex.Lock()
+	defer tlc.tbtcLocalChainMutex.Unlock()
+
+	deposit, ok := tlc.deposits[depositAddress]
+	if !ok {
+		return 0, fmt.Errorf("no deposit with address [%v]", depositAddress)
+	}
+
+	return deposit.state, nil
+}
+
 func (tlc *TBTCLocalChain) DepositPubkey(
 	depositAddress string,
 ) ([]byte, error) {

pkg/chain/tbtc.go

@@ -54,6 +54,9 @@ type Deposit interface {
 		txIndexInBlock *big.Int,
 		bitcoinHeaders []uint8,
 	) error
+
+	// CurrentState returns the current state for the provided deposit.
+	CurrentState(depositAddress string) (DepositState, error)
 }
 
 // TBTCSystem is an interface that provides ability to interact
@@ -112,3 +115,21 @@ type DepositRedemptionRequestedEvent struct {
 	Outpoint             []byte
 	BlockNumber          uint64
 }
+
+// DepositState represents the deposit state.
+type DepositState int
+
+const (
+	Start DepositState = iota
+	AwaitingSignerSetup
+	AwaitingBtcFundingProof
+	FailedSetup
+	Active
+	AwaitingWithdrawalSignature
+	AwaitingWithdrawalProof
+	Redeemed
+	CourtesyCall
+	FraudLiquidationInProgress
+	LiquidationInProgress
+	Liquidated
+)

pkg/client/client.go

@@ -3,7 +3,6 @@ package client
 
 import (
 	"context"
-	"fmt"
 	"math/big"
 	"sync"
 	"time"
@@ -66,9 +65,10 @@ func Initialize(
 			return false
 		}
 
-		isKeepActive, err := waitForChainConfirmation(
+		isKeepActive, err := eth.WaitForChainConfirmation(
 			ethereumChain,
 			currentBlock,
+			blockConfirmations,
 			func() (bool, error) {
 				return ethereumChain.IsActive(keepAddress)
 			},
@@ -537,9 +537,10 @@ func monitorSigningRequests(
 				}
 				defer requestedSignatures.remove(keepAddress, event.Digest)
 
-				isAwaitingSignature, err := waitForChainConfirmation(
+				isAwaitingSignature, err := eth.WaitForChainConfirmation(
 					ethereumChain,
 					event.BlockNumber,
+					blockConfirmations,
 					func() (bool, error) {
 						return ethereumChain.IsAwaitingSignature(keepAddress, event.Digest)
 					},
@@ -624,9 +625,10 @@ func checkAwaitingSignature(
 			return
 		}
 
-		isStillAwaitingSignature, err := waitForChainConfirmation(
+		isStillAwaitingSignature, err := eth.WaitForChainConfirmation(
 			ethereumChain,
 			startBlock,
+			blockConfirmations,
 			func() (bool, error) {
 				isAwaitingSignature, err := ethereumChain.IsAwaitingSignature(keepAddress, latestDigest)
 				if err != nil {
@@ -710,9 +712,10 @@ func monitorKeepClosedEvents(
 				event.BlockNumber,
 			)
 
-			isKeepActive, err := waitForChainConfirmation(
+			isKeepActive, err := eth.WaitForChainConfirmation(
 				ethereumChain,
 				event.BlockNumber,
+				blockConfirmations,
 				func() (bool, error) {
 					return ethereumChain.IsActive(keepAddress)
 				},
@@ -773,9 +776,10 @@ func monitorKeepTerminatedEvent(
 				event.BlockNumber,
 			)
 
-			isKeepActive, err := waitForChainConfirmation(
+			isKeepActive, err := eth.WaitForChainConfirmation(
 				ethereumChain,
 				event.BlockNumber,
+				blockConfirmations,
 				func() (bool, error) {
 					return ethereumChain.IsActive(keepAddress)
 				},
@@ -815,29 +819,3 @@ func monitorKeepTerminatedEvent(
 
 	logger.Info("unsubscribing from events on keep terminated")
 }
-
-// waitForChainConfirmation ensures that after receiving specific number of block
-// confirmations the state of the chain is actually as expected. It waits for
-// predefined number of blocks since the start block number provided. After the
-// required block number is reached it performs a check of the chain state with
-// a provided function returning a boolean value.
-func waitForChainConfirmation(
-	ethereumChain eth.Handle,
-	startBlockNumber uint64,
-	stateCheck func() (bool, error),
-) (bool, error) {
-	blockHeight := startBlockNumber + blockConfirmations
-	logger.Infof("waiting for block [%d] to confirm chain state", blockHeight)
-
-	err := ethereumChain.BlockCounter().WaitForBlockHeight(blockHeight)
-	if err != nil {
-		return false, fmt.Errorf("failed to wait for block height: [%v]", err)
-	}
-
-	result, err := stateCheck()
-	if err != nil {
-		return false, fmt.Errorf("failed to get chain state confirmation: [%v]", err)
-	}
-
-	return result, nil
-}

pkg/client/registration.go

@@ -286,9 +286,10 @@ func monitorSignerPoolStatus(
 					)
 				}
 
-				isRegistered, err := waitForChainConfirmation(
+				isRegistered, err := eth.WaitForChainConfirmation(
 					ethereumChain,
 					statusCheckBlock,
+					blockConfirmations,
 					func() (bool, error) {
 						return ethereumChain.IsRegisteredForApplication(
 							application,