test(e2e): TestBitcoinDepositRefund, WithdrawBitcoinMultipleTimes (…

…#2349)

* Add debugging capabilities to e2e tests (Delve)

* Add `make start-localnet-skip-build`

* Bump github.com/rjeczalik/notify to fix Apple ARM issue (rjeczalik/notify#212)

* Add run.sh for a single e2e test run

* Add testify support for e2e runner

* Minor refactoring

* WIP TestDepositBTCRefund

* WIP

* Fix naming

* WIP [2]

* Add test to CI

* Complete "btc deposit refund" test case

* Add WithdrawBitcoinMultipleTimes test

* Lint

* Revert MD formatting

* Address PR comments

* Lint

* Address PR comments [2]

Makefile

@@ -248,11 +248,13 @@ start-upgrade-test-light: zetanode-upgrade
 	@echo "--> Starting light upgrade test (no ZetaChain state populating before upgrade)"
 	cd contrib/localnet/ && $(DOCKER) compose -f docker-compose.yml -f docker-compose-upgrade.yml -f docker-compose-upgrade-light.yml up -d
 
-start-localnet: zetanode
+start-localnet: zetanode start-localnet-skip-build
+
+start-localnet-skip-build:
 	@echo "--> Starting localnet"
 	cd contrib/localnet/ && $(DOCKER) compose -f docker-compose.yml -f docker-compose-setup-only.yml up -d
 
-stop-test:
+stop-localnet:
 	cd contrib/localnet/ && $(DOCKER) compose down --remove-orphans
 
 ###############################################################################

changelog.md

@@ -61,6 +61,7 @@
 * [2329](https://github.com/zeta-chain/node/pull/2329) - fix TODOs in rpc unit tests
 * [2342](https://github.com/zeta-chain/node/pull/2342) - extend rpc unit tests with testing extension to include synthetic ethereum txs
 * [2299](https://github.com/zeta-chain/node/pull/2299) - add `zetae2e` command to deploy test contracts
+* [2349](https://github.com/zeta-chain/node/pull/2349) - add TestBitcoinDepositRefund and WithdrawBitcoinMultipleTimes E2E tests
 
 ### Fixes
 

cmd/zetae2e/local/local.go

@@ -289,6 +289,8 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 			e2etests.TestMessagePassingEVMtoZEVMRevertFailName,
 		}
 		bitcoinTests := []string{
+			e2etests.TestBitcoinDepositName,
+			e2etests.TestBitcoinDepositRefundName,
 			e2etests.TestBitcoinWithdrawSegWitName,
 			e2etests.TestBitcoinWithdrawInvalidAddressName,
 			e2etests.TestZetaWithdrawBTCRevertName,
@@ -297,6 +299,7 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 		bitcoinAdvancedTests := []string{
 			e2etests.TestBitcoinWithdrawTaprootName,
 			e2etests.TestBitcoinWithdrawLegacyName,
+			e2etests.TestBitcoinWithdrawMultipleName,
 			e2etests.TestBitcoinWithdrawP2SHName,
 			e2etests.TestBitcoinWithdrawP2WSHName,
 			e2etests.TestBitcoinWithdrawRestrictedName,

cmd/zetae2e/stress.go

@@ -7,6 +7,7 @@ import (
 	"math/big"
 	"os"
 	"sort"
+	"sync"
 	"time"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -223,11 +224,25 @@ func StressTest(cmd *cobra.Command, _ []string) {
 	fmt.Println("	1. Periodically Withdraw ETH from ZEVM to EVM")
 	fmt.Println("	2. Display Network metrics to monitor performance [Num Pending outbound tx], [Num Trackers]")
 
-	e2eTest.WG.Add(2)
-	go WithdrawCCtx(e2eTest)       // Withdraw from ZEVM to EVM
-	go EchoNetworkMetrics(e2eTest) // Display Network metrics periodically to monitor performance
+	var wg sync.WaitGroup
 
-	e2eTest.WG.Wait()
+	wg.Add(2)
+
+	go func() {
+		defer wg.Done()
+
+		// Withdraw from ZEVM to EVM
+		WithdrawCCtx(e2eTest)
+	}()
+
+	go func() {
+		defer wg.Done()
+
+		// Display Network metrics periodically to monitor performance
+		EchoNetworkMetrics(e2eTest)
+	}()
+
+	wg.Wait()
 }
 
 // WithdrawCCtx withdraw ETHZRC20 from ZEVM to EVM

docs/development/LOCAL_TESTING.md

@@ -88,7 +88,7 @@ $ docker logs -f orchestrator
 
 To stop the tests,
 ```bash
-make stop-test
+make stop-localnet
 ```
 
 ### Run monitoring setup

e2e/README.md

@@ -56,3 +56,23 @@ zeta_chain_id: "zetachain-1"
 ```
 
 NOTE: config is in progress, contracts on the zEVM must be added
+
+## Debugging
+
+It's possible to debug a single test using Delve debugger.
+
+1. Make sure delve is installed. `go install github.com/go-delve/delve/cmd/dlv@latest`
+2. Configure your IDE to use Delve as the debugger. For Goland, you can do the following:
+    - Go to "Run" > "Edit Run Configurations"
+    - Hit "+" > "Go Remote". Keep port as default (`2345`). Toggle "On Disconnect" > "Stop Delve process"
+3. Make sure that localnet is running. For a quick start, you can use `make start-localnet-skip-build`.
+   Networks need some time to generate blocks.
+4. Run test as following: `./e2e/scripts/debug.sh my_test_name arg1 arg2 arg_n`.
+   Example: `./e2e/scripts/debug.sh bitcoin_withdraw_restricted 0.001`
+5. Place a breakpoint in the code.
+6. Go to the editor's debug panel and hit "Debug" button.
+
+You can also run an alias of `zetae2e run` like so:
+```shell
+  `./e2e/scripts/run.sh bitcoin_withdraw_restricted 0.001`
+```

e2e/e2etests/e2etests.go

@@ -56,8 +56,10 @@ const (
 	 Test transfer of Bitcoin asset across chains
 	*/
 	TestBitcoinDepositName                = "bitcoin_deposit"
+	TestBitcoinDepositRefundName          = "bitcoin_deposit_refund"
 	TestBitcoinWithdrawSegWitName         = "bitcoin_withdraw_segwit"
 	TestBitcoinWithdrawTaprootName        = "bitcoin_withdraw_taproot"
+	TestBitcoinWithdrawMultipleName       = "bitcoin_withdraw_multiple"
 	TestBitcoinWithdrawLegacyName         = "bitcoin_withdraw_legacy"
 	TestBitcoinWithdrawP2WSHName          = "bitcoin_withdraw_p2wsh"
 	TestBitcoinWithdrawP2SHName           = "bitcoin_withdraw_p2sh"
@@ -332,6 +334,13 @@ var AllE2ETests = []runner.E2ETest{
 		},
 		TestBitcoinDeposit,
 	),
+	runner.NewE2ETest(
+		TestBitcoinDepositRefundName,
+		"deposit Bitcoin into ZEVM; expect refund", []runner.ArgDefinition{
+			{Description: "amount in btc", DefaultValue: "0.1"},
+		},
+		TestBitcoinDepositRefund,
+	),
 	runner.NewE2ETest(
 		TestBitcoinWithdrawSegWitName,
 		"withdraw BTC from ZEVM to a SegWit address",
@@ -359,6 +368,15 @@ var AllE2ETests = []runner.E2ETest{
 		},
 		TestBitcoinWithdrawLegacy,
 	),
+	runner.NewE2ETest(
+		TestBitcoinWithdrawMultipleName,
+		"withdraw BTC from ZEVM multiple times",
+		[]runner.ArgDefinition{
+			{Description: "amount", DefaultValue: "0.01"},
+			{Description: "times", DefaultValue: "2"},
+		},
+		WithdrawBitcoinMultipleTimes,
+	),
 	runner.NewE2ETest(
 		TestBitcoinWithdrawP2WSHName,
 		"withdraw BTC from ZEVM to a P2WSH address",