register aborted CCTX for Bitcoin inbound that carries insufficient d…

…eposit fee
zeta-chain · Jan 16, 2025 · deb1fc1 · deb1fc1
1 parent 7eea20e
commit deb1fc1
Show file tree

Hide file tree

Showing 34 changed files with 377 additions and 261 deletions.
diff --git a/cmd/zetae2e/local/bitcoin.go b/cmd/zetae2e/local/bitcoin.go
@@ -58,7 +58,8 @@ func bitcoinTestRoutines(
 		_, err := runnerDeposit.GenerateToAddressIfLocalBitcoin(101, runnerDeposit.BTCDeployerAddress)
 		require.NoError(runnerDeposit, err)
 
-		// send BTC to ZEVM addresses
+		// donate BTC to TSS and send BTC to ZEVM addresses
+		runnerDeposit.DonateBTC()
 		runnerDeposit.DepositBTC(runnerDeposit.EVMAddress())
 		runnerDeposit.DepositBTC(runnerWithdraw.EVMAddress())
 	}

diff --git a/cmd/zetae2e/local/local.go b/cmd/zetae2e/local/local.go
@@ -298,6 +298,7 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 			e2etests.TestBitcoinStdMemoDepositAndCallName,
 			e2etests.TestBitcoinStdMemoDepositAndCallRevertName,
 			e2etests.TestBitcoinStdMemoInscribedDepositAndCallName,
+			e2etests.TestBitcoinDepositAndAbortWithLowDepositFeeName,
 			e2etests.TestCrosschainSwapName,
 		}
 		bitcoinDepositTestsAdvanced := []string{

diff --git a/docs/spec/crosschain/messages.md b/docs/spec/crosschain/messages.md
@@ -192,6 +192,7 @@ message MsgVoteInbound {
 	RevertOptions revert_options = 17;
 	CallOptions call_options = 18;
 	bool is_cross_chain_call = 19;
+	string error_message = 20;
 }
 ```
 

diff --git a/e2e/e2etests/e2etests.go b/e2e/e2etests/e2etests.go
@@ -82,6 +82,7 @@ const (
 	TestBitcoinStdMemoDepositAndCallRevertName             = "bitcoin_std_memo_deposit_and_call_revert"
 	TestBitcoinStdMemoDepositAndCallRevertOtherAddressName = "bitcoin_std_memo_deposit_and_call_revert_other_address"
 	TestBitcoinStdMemoInscribedDepositAndCallName          = "bitcoin_std_memo_inscribed_deposit_and_call"
+	TestBitcoinDepositAndAbortWithLowDepositFeeName        = "bitcoin_deposit_and_abort_with_low_deposit_fee"
 	TestBitcoinWithdrawSegWitName                          = "bitcoin_withdraw_segwit"
 	TestBitcoinWithdrawTaprootName                         = "bitcoin_withdraw_taproot"
 	TestBitcoinWithdrawMultipleName                        = "bitcoin_withdraw_multiple"
@@ -647,6 +648,12 @@ var AllE2ETests = []runner.E2ETest{
 		},
 		TestBitcoinStdMemoInscribedDepositAndCall,
 	),
+	runner.NewE2ETest(
+		TestBitcoinDepositAndAbortWithLowDepositFeeName,
+		"deposit Bitcoin into ZEVM that aborts due to insufficient deposit fee",
+		[]runner.ArgDefinition{},
+		TestBitcoinDepositAndAbortWithLowDepositFee,
+	),
 	runner.NewE2ETest(
 		TestBitcoinWithdrawSegWitName,
 		"withdraw BTC from ZEVM to a SegWit address",

diff --git a/e2e/e2etests/test_bitcoin_deposit.go b/e2e/e2etests/test_bitcoin_deposit.go
@@ -13,7 +13,7 @@ func TestBitcoinDeposit(r *runner.E2ERunner, args []string) {
 
 	depositAmount := utils.ParseFloat(r, args[0])
 
-	txHash := r.DepositBTCWithAmount(depositAmount, nil)
+	txHash := r.DepositBTCWithAmount(depositAmount, nil, true)
 
 	// wait for the cctx to be mined
 	cctx := utils.WaitCctxMinedByInboundHash(r.Ctx, txHash.String(), r.CctxClient, r.Logger, r.CctxTimeout)

diff --git a/e2e/e2etests/test_bitcoin_deposit_abort_with_low_deposit_fee.go b/e2e/e2etests/test_bitcoin_deposit_abort_with_low_deposit_fee.go
@@ -0,0 +1,35 @@
+package e2etests
+
+import (
+	"fmt"
+
+	"github.com/btcsuite/btcd/btcutil"
+	"github.com/stretchr/testify/require"
+
+	"github.com/zeta-chain/node/e2e/runner"
+	"github.com/zeta-chain/node/e2e/utils"
+	zetabitcoin "github.com/zeta-chain/node/zetaclient/chains/bitcoin/common"
+)
+
+func TestBitcoinDepositAndAbortWithLowDepositFee(r *runner.E2ERunner, args []string) {
+	require.Len(r, args, 0)
+
+	// Given small amount
+	depositAmount := zetabitcoin.DefaultDepositorFee - float64(1)/btcutil.SatoshiPerBitcoin
+
+	// ACT
+	txHash := r.DepositBTCWithAmount(depositAmount, nil, false)
+
+	// ASSERT
+	// cctx status should be aborted
+	cctx := utils.WaitCctxAbortedByInboundHash(r.Ctx, r, txHash.String(), r.CctxClient)
+	r.Logger.CCTX(cctx, "deposit aborted")
+
+	// check cctx details
+	require.Equal(r, cctx.InboundParams.Amount.Uint64(), uint64(0))
+	require.Equal(r, cctx.GetCurrentOutboundParam().Amount.Uint64(), uint64(0))
+
+	// check cctx error message
+	expectedError := fmt.Sprintf("deposited amount %v is less than depositor fee", depositAmount)
+	require.Contains(r, cctx.CctxStatus.ErrorMessage, expectedError)
+}
diff --git a/e2e/e2etests/test_bitcoin_deposit_and_call_revert.go b/e2e/e2etests/test_bitcoin_deposit_and_call_revert.go
@@ -20,16 +20,14 @@ func TestBitcoinDepositAndCallRevert(r *runner.E2ERunner, args []string) {
 	amount += zetabitcoin.DefaultDepositorFee
 
 	// Given a list of UTXOs
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
-	require.NotEmpty(r, utxos)
+	utxos := r.ListDeployerUTXOs()
 
 	// ACT
 	// Send BTC to TSS address with a dummy memo
 	// zetacore should revert cctx if call is made on a non-existing address
 	nonExistReceiver := sample.EthAddress()
 	badMemo := append(nonExistReceiver.Bytes(), []byte("gibberish-memo")...)
-	txHash, err := r.SendToTSSFromDeployerWithMemo(amount, utxos, badMemo)
+	txHash, err := r.SendToTSSFromDeployerWithMemo(amount, utxos[:1], badMemo)
 	require.NoError(r, err)
 	require.NotEmpty(r, txHash)
 

diff --git a/e2e/e2etests/test_bitcoin_deposit_and_call_revert_with_dust.go b/e2e/e2etests/test_bitcoin_deposit_and_call_revert_with_dust.go
@@ -32,16 +32,14 @@ func TestBitcoinDepositAndCallRevertWithDust(r *runner.E2ERunner, args []string)
 	amount := depositAmount + zetabitcoin.DefaultDepositorFee
 
 	// Given a list of UTXOs
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
-	require.NotEmpty(r, utxos)
+	utxos := r.ListDeployerUTXOs()
 
 	// ACT
 	// Send BTC to TSS address with a dummy memo
 	// zetacore should revert cctx if call is made on a non-existing address
 	nonExistReceiver := sample.EthAddress()
 	anyMemo := append(nonExistReceiver.Bytes(), []byte("gibberish-memo")...)
-	txHash, err := r.SendToTSSFromDeployerWithMemo(amount, utxos, anyMemo)
+	txHash, err := r.SendToTSSFromDeployerWithMemo(amount, utxos[:1], anyMemo)
 	require.NoError(r, err)
 	require.NotEmpty(r, txHash)
 

diff --git a/e2e/e2etests/test_bitcoin_deposit_and_withdraw_with_dust.go b/e2e/e2etests/test_bitcoin_deposit_and_withdraw_with_dust.go
@@ -32,13 +32,11 @@ func TestBitcoinDepositAndWithdrawWithDust(r *runner.E2ERunner, args []string) {
 	require.Equal(r, receipt.Status, uint64(1))
 
 	// Given a list of UTXOs
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
-	require.NotEmpty(r, utxos)
+	utxos := r.ListDeployerUTXOs()
 
 	// ACT
 	// Deposit 0.01 BTC to withdrawer, this is an arbitrary amount, must be greater than dust amount
-	txHash, err := r.SendToTSSFromDeployerWithMemo(0.01, utxos, withdrawerAddr.Bytes())
+	txHash, err := r.SendToTSSFromDeployerWithMemo(0.01, utxos[:1], withdrawerAddr.Bytes())
 	require.NoError(r, err)
 	require.NotEmpty(r, txHash)
 

diff --git a/e2e/e2etests/test_bitcoin_deposit_call.go b/e2e/e2etests/test_bitcoin_deposit_call.go
@@ -23,9 +23,7 @@ func TestBitcoinDepositAndCall(r *runner.E2ERunner, args []string) {
 	amountTotal := amount + common.DefaultDepositorFee
 
 	// Given a list of UTXOs
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
-	require.NotEmpty(r, utxos)
+	utxos := r.ListDeployerUTXOs()
 
 	// deploy an example contract in ZEVM
 	contractAddr, _, contract, err := testcontract.DeployExample(r.ZEVMAuth, r.ZEVMClient)
@@ -36,7 +34,7 @@ func TestBitcoinDepositAndCall(r *runner.E2ERunner, args []string) {
 	// Send BTC to TSS address with a dummy memo
 	data := []byte("hello satoshi")
 	memo := append(contractAddr.Bytes(), data...)
-	txHash, err := r.SendToTSSFromDeployerWithMemo(amountTotal, utxos, memo)
+	txHash, err := r.SendToTSSFromDeployerWithMemo(amountTotal, utxos[:1], memo)
 	require.NoError(r, err)
 
 	// wait for the cctx to be mined

diff --git a/e2e/e2etests/test_bitcoin_donation.go b/e2e/e2etests/test_bitcoin_donation.go
@@ -23,14 +23,12 @@ func TestBitcoinDonation(r *runner.E2ERunner, args []string) {
 	amountTotal := amount + zetabitcoin.DefaultDepositorFee
 
 	// Given a list of UTXOs
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
-	require.NotEmpty(r, utxos)
+	utxos := r.ListDeployerUTXOs()
 
 	// ACT
 	// Send BTC to TSS address with donation message
 	memo := []byte(constant.DonationMessage)
-	txHash, err := r.SendToTSSFromDeployerWithMemo(amountTotal, utxos, memo)
+	txHash, err := r.SendToTSSFromDeployerWithMemo(amountTotal, utxos[:1], memo)
 	require.NoError(r, err)
 
 	// ASSERT after 4 Zeta blocks

diff --git a/e2e/e2etests/test_bitcoin_std_deposit.go b/e2e/e2etests/test_bitcoin_std_deposit.go
@@ -40,7 +40,7 @@ func TestBitcoinStdMemoDeposit(r *runner.E2ERunner, args []string) {
 	}
 
 	// deposit BTC with standard memo
-	txHash := r.DepositBTCWithAmount(amount, memo)
+	txHash := r.DepositBTCWithAmount(amount, memo, true)
 
 	// wait for the cctx to be mined
 	cctx := utils.WaitCctxMinedByInboundHash(r.Ctx, txHash.String(), r.CctxClient, r.Logger, r.CctxTimeout)

diff --git a/e2e/e2etests/test_bitcoin_std_deposit_and_call.go b/e2e/e2etests/test_bitcoin_std_deposit_and_call.go
@@ -40,7 +40,7 @@ func TestBitcoinStdMemoDepositAndCall(r *runner.E2ERunner, args []string) {
 	}
 
 	// deposit BTC with standard memo
-	txHash := r.DepositBTCWithAmount(amount, memo)
+	txHash := r.DepositBTCWithAmount(amount, memo, true)
 
 	// wait for the cctx to be mined
 	cctx := utils.WaitCctxMinedByInboundHash(r.Ctx, txHash.String(), r.CctxClient, r.Logger, r.CctxTimeout)

diff --git a/e2e/e2etests/test_bitcoin_std_deposit_and_call_revert.go b/e2e/e2etests/test_bitcoin_std_deposit_and_call_revert.go
@@ -33,7 +33,7 @@ func TestBitcoinStdMemoDepositAndCallRevert(r *runner.E2ERunner, args []string)
 
 	// ACT
 	// Deposit
-	txHash := r.DepositBTCWithAmount(amount, memo)
+	txHash := r.DepositBTCWithAmount(amount, memo, true)
 
 	// ASSERT
 	// Now we want to make sure revert TX is completed.

diff --git a/e2e/e2etests/test_bitcoin_std_deposit_and_call_revert_other_address.go b/e2e/e2etests/test_bitcoin_std_deposit_and_call_revert_other_address.go
@@ -38,7 +38,7 @@ func TestBitcoinStdMemoDepositAndCallRevertOtherAddress(r *runner.E2ERunner, arg
 
 	// ACT
 	// Deposit
-	txHash := r.DepositBTCWithAmount(amount, memo)
+	txHash := r.DepositBTCWithAmount(amount, memo, true)
 
 	// ASSERT
 	// Now we want to make sure revert TX is completed.

diff --git a/e2e/e2etests/test_crosschain_swap.go b/e2e/e2etests/test_crosschain_swap.go
@@ -102,8 +102,7 @@ func TestCrosschainSwap(r *runner.E2ERunner, _ []string) {
 
 	r.Logger.Info("******* Second test: BTC -> ERC20ZRC20")
 	// list deployer utxos
-	utxos, err := r.ListDeployerUTXOs()
-	require.NoError(r, err)
+	utxos := r.ListDeployerUTXOs()
 
 	r.Logger.Info("#utxos %d", len(utxos))
 	r.Logger.Info("memo address %s", r.ERC20ZRC20Addr)
@@ -143,8 +142,7 @@ func TestCrosschainSwap(r *runner.E2ERunner, _ []string) {
 		r.Logger.Info("memo length %d", len(memo))
 
 		amount := 0.1
-		utxos, err = r.ListDeployerUTXOs()
-		require.NoError(r, err)
+		utxos = r.ListDeployerUTXOs()
 		txid, err := r.SendToTSSFromDeployerWithMemo(amount, utxos[0:1], memo)
 		require.NoError(r, err)
 

diff --git a/e2e/e2etests/test_stress_btc_deposit.go b/e2e/e2etests/test_stress_btc_deposit.go
@@ -28,7 +28,7 @@ func TestStressBTCDeposit(r *runner.E2ERunner, args []string) {
 	// send the deposits
 	for i := 0; i < numDeposits; i++ {
 		i := i
-		txHash := r.DepositBTCWithAmount(depositAmount, nil)
+		txHash := r.DepositBTCWithAmount(depositAmount, nil, true)
 		r.Logger.Print("index %d: starting deposit, tx hash: %s", i, txHash.String())
 
 		eg.Go(func() error { return monitorBTCDeposit(r, txHash, i, time.Now()) })