refactor bitcoin error

zetaclient/chains/bitcoin/errors.go

@@ -0,0 +1,6 @@
+package bitcoin
+
+import "errors"
+
+// ErrBitcoinNotEnabled is the error returned when bitcoin is not enabled
+var ErrBitcoinNotEnabled = errors.New("bitcoin is not enabled")

zetaclient/chains/bitcoin/observer/inbound.go

@@ -5,7 +5,6 @@ import (
 	"encoding/hex"
 	"fmt"
 	"math/big"
-	"strings"
 
 	cosmosmath "cosmossdk.io/math"
 	"github.com/btcsuite/btcd/btcjson"
@@ -57,9 +56,13 @@ func (ob *Observer) WatchInbound(ctx context.Context) error {
 			}
 			err := ob.ObserveInbound(ctx)
 			if err != nil {
-				// skip showing log for block number 0 as it means Bitcoin is not being observed
-				if !strings.Contains(err.Error(), "current block number 0 is too low") {
+				// skip showing log for block number 0 as it means Bitcoin node is not enabled
+				// TODO: prevent this routine from running if Bitcoin node is not enabled
+				// https://github.com/zeta-chain/node/issues/2790
+				if !errors.Is(err, bitcoin.ErrBitcoinNotEnabled) {
 					ob.logger.Inbound.Error().Err(err).Msg("WatchInbound error observing in tx")
+				} else {
+					ob.logger.Inbound.Debug().Err(err).Msg("WatchInbound: Bitcoin node is not enabled")
 				}
 			}
 			ticker.UpdateInterval(ob.GetChainParams().InboundTicker, ob.logger.Inbound)
@@ -76,28 +79,34 @@ func (ob *Observer) ObserveInbound(ctx context.Context) error {
 	zetaCoreClient := ob.ZetacoreClient()
 
 	// get and update latest block height
-	cnt, err := ob.btcClient.GetBlockCount()
+	currentBlock, err := ob.btcClient.GetBlockCount()
 	if err != nil {
 		return fmt.Errorf("observeInboundBTC: error getting block number: %s", err)
 	}
-	if cnt < 0 {
-		return fmt.Errorf("observeInboundBTC: block number is negative: %d", cnt)
+	if currentBlock < 0 {
+		return fmt.Errorf("observeInboundBTC: block number is negative: %d", currentBlock)
 	}
+
+	// 0 will be returned if the node is not synced
+	if currentBlock == 0 {
+		return errors.Wrap(bitcoin.ErrBitcoinNotEnabled, "observeInboundBTC: current block number 0 is too low")
+	}
+
 	// #nosec G115 checked positive
-	lastBlock := uint64(cnt)
+	lastBlock := uint64(currentBlock)
 
 	if lastBlock < ob.LastBlock() {
 		return fmt.Errorf(
 			"observeInboundBTC: block number should not decrease: current %d last %d",
-			cnt,
+			currentBlock,
 			ob.LastBlock(),
 		)
 	}
 	ob.WithLastBlock(lastBlock)
 
 	// skip if current height is too low
 	if lastBlock < ob.GetChainParams().ConfirmationCount {
-		return fmt.Errorf("observeInboundBTC: skipping observer, current block number %d is too low", cnt)
+		return fmt.Errorf("observeInboundBTC: skipping observer, current block number %d is too low", currentBlock)
 	}
 
 	// skip if no new block is confirmed
@@ -115,7 +124,7 @@ func (ob *Observer) ObserveInbound(ctx context.Context) error {
 		return err
 	}
 	ob.logger.Inbound.Info().Msgf("observeInboundBTC: block %d has %d txs, current block %d, last block %d",
-		blockNumber, len(res.Block.Tx), cnt, lastScanned)
+		blockNumber, len(res.Block.Tx), currentBlock, lastScanned)
 
 	// add block header to zetacore
 	if len(res.Block.Tx) > 1 {

zetaclient/chains/bitcoin/observer/observer.go

@@ -458,10 +458,12 @@ func (ob *Observer) WatchUTXOs(ctx context.Context) error {
 			if err != nil {
 				// log debug log if the error if no wallet is loaded
 				// this is to prevent extensive logging in localnet when the wallet is not loaded for non-Bitcoin test
+				// TODO: prevent this routine from running if Bitcoin node is not enabled
+				// https://github.com/zeta-chain/node/issues/2790
 				if !strings.Contains(err.Error(), "No wallet is loaded") {
 					ob.logger.UTXOs.Error().Err(err).Msg("error fetching btc utxos")
 				} else {
-					ob.logger.UTXOs.Debug().Msg("No wallet is loaded; retrying...")
+					ob.logger.UTXOs.Debug().Err(err).Msg("No wallet is loaded")
 				}
 			}
 			ticker.UpdateInterval(ob.GetChainParams().WatchUtxoTicker, ob.logger.UTXOs)