feat: DON'T review before merging previous PRs, (BitcoinRBF-Step3) zetaclient watches BTC mempool stuck txs and bump fee

changelog.md

@@ -10,6 +10,10 @@
 * [3368](https://github.com/zeta-chain/node/pull/3368) - cli command to fetch inbound ballot from inbound hash added to zetatools.
 * [3425](https://github.com/zeta-chain/node/pull/3425) - enable inscription parsing on Bitcoin mainnet
 
+### Features
+
+* [3396](https://github.com/zeta-chain/node/pull/3396) - add support for Bitcoin RBF (Replace-By-Fee) in zetaclient
+
 ### Refactor
 
 * [3332](https://github.com/zeta-chain/node/pull/3332) - implement orchestrator V2. Move BTC observer-signer to V2

contrib/localnet/docker-compose.yml

@@ -199,7 +199,7 @@ services:
         ipv4_address: 172.20.0.102
 
   bitcoin:
-    image: ghcr.io/zeta-chain/bitcoin-core-docker:a94b52f
+    image: ghcr.io/zeta-chain/bitcoin-core-docker:28.0-zeta6
     container_name: bitcoin
     hostname: bitcoin
     networks:

pkg/math/integer.go

@@ -0,0 +1,40 @@
+// Package implements helper functions for integer math operations.
+package math
+
+import (
+	"math"
+	"math/big"
+)
+
+// IncreaseIntByPercent is a function that increases integer by a percentage.
+// Example1: IncreaseIntByPercent(10, 15) = 10 * 1.15 = 11
+// Example2: IncreaseIntByPercent(-10, 15) = -10 * 1.15 = -11
+//
+// Note: use with caution if passing negative values.
+func IncreaseIntByPercent(value int64, percent uint32) int64 {
+	if percent == 0 {
+		return value
+	}
+
+	if value < 0 {
+		return -IncreaseIntByPercent(-value, percent)
+	}
+
+	bigValue := big.NewInt(value)
+	bigPercent := big.NewInt(int64(percent))
+
+	// product = value * percent
+	product := new(big.Int).Mul(bigValue, bigPercent)
+
+	// dividing product by 100
+	product.Div(product, big.NewInt(100))
+
+	// result = original value + product
+	result := new(big.Int).Add(bigValue, product)
+
+	// be mindful if result > MaxInt64
+	if result.Cmp(big.NewInt(math.MaxInt64)) > 0 {
+		return math.MaxInt64
+	}
+	return result.Int64()
+}

pkg/math/integer_test.go

@@ -0,0 +1,31 @@
+package math
+
+import (
+	"fmt"
+	"math"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_IncreaseIntByPercent(t *testing.T) {
+	for i, tt := range []struct {
+		value    int64
+		percent  uint32
+		expected int64
+	}{
+		{value: 10, percent: 0, expected: 10},
+		{value: 10, percent: 15, expected: 11},
+		{value: 10, percent: 225, expected: 32},
+		{value: math.MaxInt64 / 2, percent: 101, expected: math.MaxInt64},
+		{value: -10, percent: 0, expected: -10},
+		{value: -10, percent: 15, expected: -11},
+		{value: -10, percent: 225, expected: -32},
+		{value: -math.MaxInt64 / 2, percent: 101, expected: -math.MaxInt64},
+	} {
+		t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
+			result := IncreaseIntByPercent(tt.value, tt.percent)
+			assert.Equal(t, tt.expected, result)
+		})
+	}
+}

testutil/sample/crypto.go

@@ -8,14 +8,15 @@ import (
 	"strconv"
 	"testing"
 
-	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/chaincfg"
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
+	"github.com/btcsuite/btcd/txscript"
 	"github.com/cometbft/cometbft/crypto/secp256k1"
 	"github.com/cosmos/cosmos-sdk/crypto/keys/ed25519"
 	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	secp "github.com/decred/dcrd/dcrec/secp256k1/v4"
 	ethcommon "github.com/ethereum/go-ethereum/common"
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 	ethcrypto "github.com/ethereum/go-ethereum/crypto"
@@ -90,16 +91,24 @@ func EthAddressFromRand(r *rand.Rand) ethcommon.Address {
 	return ethcommon.BytesToAddress(sdk.AccAddress(PubKey(r).Address()).Bytes())
 }
 
-// BtcAddressP2WPKH returns a sample btc P2WPKH address
-func BtcAddressP2WPKH(t *testing.T, net *chaincfg.Params) string {
-	privateKey, err := btcec.NewPrivateKey()
+// BTCAddressP2WPKH returns a sample Bitcoin Pay-to-Witness-Public-Key-Hash (P2WPKH) address
+func BTCAddressP2WPKH(t *testing.T, r *rand.Rand, net *chaincfg.Params) *btcutil.AddressWitnessPubKeyHash {
+	privateKey, err := secp.GeneratePrivateKeyFromRand(r)
 	require.NoError(t, err)
 
 	pubKeyHash := btcutil.Hash160(privateKey.PubKey().SerializeCompressed())
 	addr, err := btcutil.NewAddressWitnessPubKeyHash(pubKeyHash, net)
 	require.NoError(t, err)
 
-	return addr.String()
+	return addr
+}
+
+// BtcAddressP2WPKH returns a pkscript for a sample btc P2WPKH address
+func BTCAddressP2WPKHScript(t *testing.T, r *rand.Rand, net *chaincfg.Params) []byte {
+	addr := BTCAddressP2WPKH(t, r, net)
+	script, err := txscript.PayToAddrScript(addr)
+	require.NoError(t, err)
+	return script
 }
 
 // SolanaPrivateKey returns a sample solana private key

x/crosschain/types/cctx_test.go

@@ -138,10 +138,11 @@ func Test_SetRevertOutboundValues(t *testing.T) {
 	})
 
 	t.Run("successfully set BTC revert address V1", func(t *testing.T) {
+		r := sample.Rand()
 		cctx := sample.CrossChainTx(t, "test")
 		cctx.InboundParams.SenderChainId = chains.BitcoinTestnet.ChainId
 		cctx.OutboundParams = cctx.OutboundParams[:1]
-		cctx.RevertOptions.RevertAddress = sample.BtcAddressP2WPKH(t, &chaincfg.TestNet3Params)
+		cctx.RevertOptions.RevertAddress = sample.BTCAddressP2WPKH(t, r, &chaincfg.TestNet3Params).String()
 
 		err := cctx.AddRevertOutbound(100)
 		require.NoError(t, err)

x/crosschain/types/revert_options_test.go

@@ -49,7 +49,8 @@ func TestRevertOptions_GetEVMRevertAddress(t *testing.T) {
 
 func TestRevertOptions_GetBTCRevertAddress(t *testing.T) {
 	t.Run("valid Bitcoin revert address", func(t *testing.T) {
-		addr := sample.BtcAddressP2WPKH(t, &chaincfg.TestNet3Params)
+		r := sample.Rand()
+		addr := sample.BTCAddressP2WPKH(t, r, &chaincfg.TestNet3Params).String()
 		actualAddr, valid := types.RevertOptions{
 			RevertAddress: addr,
 		}.GetBTCRevertAddress(chains.BitcoinTestnet.ChainId)

zetaclient/chains/bitcoin/bitcoin.go

@@ -14,6 +14,7 @@ import (
 	"github.com/zeta-chain/node/zetaclient/chains/base"
 	"github.com/zeta-chain/node/zetaclient/chains/bitcoin/observer"
 	"github.com/zeta-chain/node/zetaclient/chains/bitcoin/signer"
+	"github.com/zeta-chain/node/zetaclient/common"
 	zctx "github.com/zeta-chain/node/zetaclient/context"
 )
 
@@ -62,6 +63,8 @@ func (b *Bitcoin) Start(ctx context.Context) error {
 		return ticker.DurationFromUint64Seconds(b.observer.ChainParams().WatchUtxoTicker)
 	})
 
+	optMempoolInterval := scheduler.Interval(common.BTCMempoolStuckTxCheckInterval)
+
 	optOutboundInterval := scheduler.IntervalUpdater(func() time.Duration {
 		return ticker.DurationFromUint64Seconds(b.observer.ChainParams().OutboundTicker)
 	})
@@ -91,6 +94,7 @@ func (b *Bitcoin) Start(ctx context.Context) error {
 	register(b.observer.ObserveInbound, "observe_inbound", optInboundInterval, optInboundSkipper)
 	register(b.observer.ProcessInboundTrackers, "process_inbound_trackers", optInboundInterval, optInboundSkipper)
 	register(b.observer.FetchUTXOs, "fetch_utxos", optUTXOInterval, optGenericSkipper)
+	register(b.observer.WatchMempoolTxs, "watch_mempool_txs", optMempoolInterval, optGenericSkipper)
 	register(b.observer.PostGasPrice, "post_gas_price", optGasInterval, optGenericSkipper)
 	register(b.observer.CheckRPCStatus, "check_rpc_status")
 	register(b.observer.ProcessOutboundTrackers, "process_outbound_trackers", optOutboundInterval, optOutboundSkipper)

zetaclient/chains/bitcoin/client/client.go

@@ -38,6 +38,7 @@
 	"github.com/rs/zerolog"
 	"github.com/tendermint/btcd/chaincfg"
 
+	pkgchains "github.com/zeta-chain/node/pkg/chains"
 	"github.com/zeta-chain/node/zetaclient/config"
 	"github.com/zeta-chain/node/zetaclient/logs"
 	"github.com/zeta-chain/node/zetaclient/metrics"
@@ -48,6 +49,7 @@
 	hostURL    string
 	client     *http.Client
 	clientName string
+	isRegnet   bool
 	config     config.BTCConfig
 	params     chains.Params
 	logger     zerolog.Logger
@@ -81,14 +83,18 @@
 		return nil, errors.Wrap(err, "unable to resolve chain params")
 	}
 
-	clientName := fmt.Sprintf("btc:%d", chainID)
+	var (
+		clientName = fmt.Sprintf("btc:%d", chainID)
+		isRegnet   = pkgchains.IsBitcoinRegnet(chainID)
+	)
 
 	c := &Client{
 		hostURL:    normalizeHostURL(cfg.RPCHost, true),
 		client:     defaultHTTPClient(),
 		config:     cfg,
 		params:     params,
 		clientName: clientName,
+		isRegnet:   isRegnet,
 		logger: logger.With().
 			Str(logs.FieldModule, "btc_client").
 			Int64(logs.FieldChain, chainID).