test: fix and unit tests for query pending cctx within rate limit (#2060

)

* initial commit of grpc pending cctx query with rate limiter

* replace big.Float with sdk.Dec and update mock rate limiter flags

* split big loop into backwards loop and forwards loop to be more accurate

* adjust zetaclient code to query pending cctx with rate limit

* update change log and add one more rate limiter flag test

* use outboun amount for calculation

* some minimum code refactor

* created separate file for cctx query with rate limit

* improved a few error handlling

* use old cctx query as fallback when rate limiter is disabled; some renaming

* fixed unit test compile

* added unit test for fallback query

* added unit tests for cctx value conversion

* add changelog entry

* added unit tests for query pending cctxs within rate limit

* added total value in rate limiter window for monitoring purpose

* Update x/crosschain/keeper/grpc_query_cctx_rate_limit.go

Co-authored-by: Lucas Bertrand <[email protected]>

* change variable name fCoin to foreignCoin

* Update x/fungible/keeper/foreign_coins.go

Co-authored-by: Lucas Bertrand <[email protected]>

* Update x/crosschain/keeper/grpc_query_cctx_rate_limit_test.go

Co-authored-by: Lucas Bertrand <[email protected]>

* converted rate limiter query unit tests to table test

* handle edge case when pending cctxs span wider block range than sliding window

* added zero rate check; added comment to make unit test clearer

* added unit test and note for method GetAllForeignCoinMap

* treat Rate as average block rate; stop outbound when current rate limit exceeds Rate; updated metrics

* add commented unit tests back

* replace sdk.Dec with sdkmath.Int to represent cctx value in azeta

* test: disable header proof test in local upgrade test E2E test (#2051)

* add skip header option

* use option for migration test

* move bitcoin addresses tests to advanced

* show cctx in logs

* update version

* fix verification flags error

* test(e2e): add rate limiter admin E2E test (#2063)

* refactor and create Withdraw ZETA general function

* new rate limiter test

* use rate limiter for admin test

* fix the test: single approval and add liquidity

* make generate

* fix liquidity

* fix uniswap pool

* change localnet chain params

* fix lint

* add cli query

* add nil check

* fix nil point

* modify tests

* eliminate nil pending nonce issue

* fix query

* set flags

* Update e2e/runner/evm.go

Co-authored-by: Charlie Chen <[email protected]>

* add back other advanced tests

* make generate

* add comment

* fix eth liquidity cap test

* fix withdraw count

---------

Co-authored-by: Charlie Chen <[email protected]>
Co-authored-by: Charlie Chen <[email protected]>

* removed incorrect Note

* improved variable name

* add E2E test for rate limiter gas and erc20

* remove outdated comment

---------

Co-authored-by: Lucas Bertrand <[email protected]>

changelog.md

@@ -84,6 +84,7 @@
 * [1985](https://github.com/zeta-chain/node/pull/1985) - improve fungible module coverage
 * [1992](https://github.com/zeta-chain/node/pull/1992) - remove setupKeeper from crosschain module
 * [2008](https://github.com/zeta-chain/node/pull/2008) - add test for connector bytecode update
+* [2060](https://github.com/zeta-chain/node/pull/2060) - add unit test for rate limiter query
 
 ### Fixes
 

cmd/zetae2e/local/local.go

@@ -308,6 +308,7 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 	}
 	if testAdmin {
 		eg.Go(adminTestRoutine(conf, deployerRunner, verbose,
+			e2etests.TestRateLimiterName,
 			e2etests.TestPauseZRC20Name,
 			e2etests.TestUpdateBytecodeZRC20Name,
 			e2etests.TestUpdateBytecodeConnectorName,

contrib/localnet/orchestrator/start-zetae2e.sh

@@ -14,36 +14,36 @@ sleep 2
 ### Create the accounts and fund them with Ether on local Ethereum network
 
 # unlock the deployer account
-echo "funding deployer address 0xE5C5367B8224807Ac2207d350E60e1b6F27a7ecC with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xE5C5367B8224807Ac2207d350E60e1b6F27a7ecC", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0xE5C5367B8224807Ac2207d350E60e1b6F27a7ecC with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xE5C5367B8224807Ac2207d350E60e1b6F27a7ecC", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock erc20 tester accounts
-echo "funding deployer address 0x6F57D5E7c6DBb75e59F1524a3dE38Fc389ec5Fd6 with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x6F57D5E7c6DBb75e59F1524a3dE38Fc389ec5Fd6", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0x6F57D5E7c6DBb75e59F1524a3dE38Fc389ec5Fd6 with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x6F57D5E7c6DBb75e59F1524a3dE38Fc389ec5Fd6", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock zeta tester accounts
-echo "funding deployer address 0x5cC2fBb200A929B372e3016F1925DcF988E081fd with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x5cC2fBb200A929B372e3016F1925DcF988E081fd", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0x5cC2fBb200A929B372e3016F1925DcF988E081fd with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x5cC2fBb200A929B372e3016F1925DcF988E081fd", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock bitcoin tester accounts
-echo "funding deployer address 0x283d810090EdF4043E75247eAeBcE848806237fD with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x283d810090EdF4043E75247eAeBcE848806237fD", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0x283d810090EdF4043E75247eAeBcE848806237fD with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x283d810090EdF4043E75247eAeBcE848806237fD", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock ethers tester accounts
-echo "funding deployer address 0x8D47Db7390AC4D3D449Cc20D799ce4748F97619A with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x8D47Db7390AC4D3D449Cc20D799ce4748F97619A", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0x8D47Db7390AC4D3D449Cc20D799ce4748F97619A with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x8D47Db7390AC4D3D449Cc20D799ce4748F97619A", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock miscellaneous tests accounts
-echo "funding deployer address 0x90126d02E41c9eB2a10cfc43aAb3BD3460523Cdf with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x90126d02E41c9eB2a10cfc43aAb3BD3460523Cdf", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0x90126d02E41c9eB2a10cfc43aAb3BD3460523Cdf with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0x90126d02E41c9eB2a10cfc43aAb3BD3460523Cdf", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock admin erc20 tests accounts
-echo "funding deployer address 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding deployer address 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266 with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 # unlock the TSS account
-echo "funding TSS address 0xF421292cb0d3c97b90EEEADfcD660B893592c6A2 with 100 Ether"
-geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xF421292cb0d3c97b90EEEADfcD660B893592c6A2", value: web3.toWei(100,"ether")})' attach http://eth:8545
+echo "funding TSS address 0xF421292cb0d3c97b90EEEADfcD660B893592c6A2 with 10000 Ether"
+geth --exec 'eth.sendTransaction({from: eth.coinbase, to: "0xF421292cb0d3c97b90EEEADfcD660B893592c6A2", value: web3.toWei(10000,"ether")})' attach http://eth:8545
 
 ### Run zetae2e command depending on the option passed
 

docs/cli/zetacored/zetacored_query_crosschain.md

@@ -35,6 +35,7 @@ zetacored query crosschain [flags]
 * [zetacored query crosschain list-in-tx-tracker](zetacored_query_crosschain_list-in-tx-tracker.md)	 - shows a list of in tx tracker by chainId
 * [zetacored query crosschain list-out-tx-tracker](zetacored_query_crosschain_list-out-tx-tracker.md)	 - list all OutTxTracker
 * [zetacored query crosschain list-pending-cctx](zetacored_query_crosschain_list-pending-cctx.md)	 - shows pending CCTX
+* [zetacored query crosschain list_pending_cctx_within_rate_limit](zetacored_query_crosschain_list_pending_cctx_within_rate_limit.md)	 - list all pending CCTX within rate limit
 * [zetacored query crosschain show-cctx](zetacored_query_crosschain_show-cctx.md)	 - shows a CCTX
 * [zetacored query crosschain show-gas-price](zetacored_query_crosschain_show-gas-price.md)	 - shows a gasPrice
 * [zetacored query crosschain show-in-tx-hash-to-cctx](zetacored_query_crosschain_show-in-tx-hash-to-cctx.md)	 - shows a inTxHashToCctx

docs/cli/zetacored/zetacored_query_crosschain_list_pending_cctx_within_rate_limit.md

@@ -0,0 +1,33 @@
+# query crosschain list_pending_cctx_within_rate_limit
+
+list all pending CCTX within rate limit
+
+```
+zetacored query crosschain list_pending_cctx_within_rate_limit [flags]
+```
+
+### Options
+
+```
+      --grpc-addr string   the gRPC endpoint to use for this chain
+      --grpc-insecure      allow gRPC over insecure channels, if not TLS the server must use TLS
+      --height int         Use a specific height to query state at (this can error if the node is pruning state)
+  -h, --help               help for list_pending_cctx_within_rate_limit
+      --node string        [host]:[port] to Tendermint RPC interface for this chain 
+  -o, --output string      Output format (text|json) 
+```
+
+### Options inherited from parent commands
+
+```
+      --chain-id string     The network chain ID
+      --home string         directory for config and data 
+      --log_format string   The logging format (json|plain) 
+      --log_level string    The logging level (trace|debug|info|warn|error|fatal|panic) 
+      --trace               print out full stack trace on errors
+```
+
+### SEE ALSO
+
+* [zetacored query crosschain](zetacored_query_crosschain.md)	 - Querying commands for the crosschain module
+

docs/openapi/openapi.swagger.yaml

@@ -54013,6 +54013,11 @@ definitions:
       total_pending:
         type: string
         format: uint64
+      current_withdraw_window:
+        type: string
+        format: int64
+      current_withdraw_rate:
+        type: string
       rate_limit_exceeded:
         type: boolean
   crosschainQueryMessagePassingProtocolFeeResponse:

e2e/e2etests/e2etests.go

@@ -59,6 +59,7 @@ const (
 	TestPauseZRC20Name              = "pause_zrc20"
 	TestUpdateBytecodeZRC20Name     = "update_bytecode_zrc20"
 	TestUpdateBytecodeConnectorName = "update_bytecode_connector"
+	TestRateLimiterName             = "rate_limiter"
 )
 
 // AllE2ETests is an ordered list of all e2e tests
@@ -386,6 +387,12 @@ var AllE2ETests = []runner.E2ETest{
 		[]runner.ArgDefinition{},
 		TestUpdateBytecodeConnector,
 	),
+	runner.NewE2ETest(
+		TestRateLimiterName,
+		"test sending cctxs with rate limiter enabled and show logs when processing cctxs",
+		[]runner.ArgDefinition{},
+		TestRateLimiter,
+	),
 	runner.NewE2ETest(
 		TestMessagePassingZEVMToEVMName,
 		"zevm -> evm message passing contract call",

e2e/e2etests/test_erc20_withdraw.go

@@ -36,28 +36,10 @@ func TestERC20Withdraw(r *runner.E2ERunner, args []string) {
 	r.Logger.Info("eth zrc20 approve receipt: status %d", receipt.Status)
 
 	// withdraw
-	tx, err = r.ERC20ZRC20.Withdraw(r.ZEVMAuth, r.DeployerAddress.Bytes(), withdrawalAmount)
-	if err != nil {
-		panic(err)
-	}
-	receipt = utils.MustWaitForTxReceipt(r.Ctx, r.ZEVMClient, tx, r.Logger, r.ReceiptTimeout)
-	r.Logger.Info("Receipt txhash %s status %d", receipt.TxHash, receipt.Status)
-	for _, log := range receipt.Logs {
-		event, err := r.ERC20ZRC20.ParseWithdrawal(*log)
-		if err != nil {
-			continue
-		}
-		r.Logger.Info(
-			"  logs: from %s, to %x, value %d, gasfee %d",
-			event.From.Hex(),
-			event.To,
-			event.Value,
-			event.Gasfee,
-		)
-	}
+	tx = r.WithdrawERC20(withdrawalAmount)
 
 	// verify the withdraw value
-	cctx := utils.WaitCctxMinedByInTxHash(r.Ctx, receipt.TxHash.Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
+	cctx := utils.WaitCctxMinedByInTxHash(r.Ctx, tx.Hash().Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
 	verifyTransferAmountFromCCTX(r, cctx, withdrawalAmount.Int64())
 }
 

e2e/e2etests/test_eth_deposit.go

@@ -268,8 +268,8 @@ func TestDepositEtherLiquidityCap(r *runner.E2ERunner, args []string) {
 	}
 
 	liquidityCap := math.NewUintFromBigInt(supply).Add(liquidityCapArg)
-	amountLessThanCap := liquidityCap.BigInt().Div(liquidityCap.BigInt(), big.NewInt(10)) // 1/10 of the cap
-	amountMoreThanCap := liquidityCap.BigInt().Mul(liquidityCap.BigInt(), big.NewInt(10)) // 10 times the cap
+	amountLessThanCap := liquidityCapArg.BigInt().Div(liquidityCapArg.BigInt(), big.NewInt(10)) // 1/10 of the cap
+	amountMoreThanCap := liquidityCapArg.BigInt().Mul(liquidityCapArg.BigInt(), big.NewInt(10)) // 10 times the cap
 	msg := fungibletypes.NewMsgUpdateZRC20LiquidityCap(
 		r.ZetaTxServer.GetAccountAddress(0),
 		r.ETHZRC20Addr.Hex(),

e2e/e2etests/test_eth_withdraw.go

@@ -42,21 +42,10 @@ func TestEtherWithdraw(r *runner.E2ERunner, args []string) {
 	r.Logger.EVMReceipt(*receipt, "approve")
 
 	// withdraw
-	tx, err = r.ETHZRC20.Withdraw(r.ZEVMAuth, r.DeployerAddress.Bytes(), withdrawalAmount)
-	if err != nil {
-		panic(err)
-	}
-	r.Logger.EVMTransaction(*tx, "withdraw")
-
-	receipt = utils.MustWaitForTxReceipt(r.Ctx, r.ZEVMClient, tx, r.Logger, r.ReceiptTimeout)
-	if receipt.Status == 0 {
-		panic("withdraw failed")
-	}
-	r.Logger.EVMReceipt(*receipt, "withdraw")
-	r.Logger.ZRC20Withdrawal(r.ETHZRC20, *receipt, "withdraw")
+	tx = r.WithdrawEther(withdrawalAmount)
 
 	// verify the withdraw value
-	cctx := utils.WaitCctxMinedByInTxHash(r.Ctx, receipt.TxHash.Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
+	cctx := utils.WaitCctxMinedByInTxHash(r.Ctx, tx.Hash().Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
 	r.Logger.CCTX(*cctx, "withdraw")
 	if cctx.CctxStatus.Status != crosschaintypes.CctxStatus_OutboundMined {
 		panic("cctx status is not outbound mined")

e2e/e2etests/test_migrate_chain_support.go

@@ -157,7 +157,20 @@ func TestMigrateChainSupport(r *runner.E2ERunner, _ []string) {
 	newRunner.WaitForMinedCCTX(txEtherDeposit)
 
 	// perform withdrawals on the new chain
-	TestZetaWithdraw(newRunner, []string{"10000000000000000000"})
+	amount := big.NewInt(0).Mul(big.NewInt(1e18), big.NewInt(10))
+	newRunner.DepositAndApproveWZeta(amount)
+	tx := newRunner.WithdrawZeta(amount, true)
+	cctx := utils.WaitCctxMinedByInTxHash(r.Ctx, tx.Hash().Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
+	r.Logger.CCTX(*cctx, "zeta withdraw")
+	if cctx.CctxStatus.Status != crosschaintypes.CctxStatus_OutboundMined {
+		panic(fmt.Errorf(
+			"expected cctx status to be %s; got %s, message %s",
+			crosschaintypes.CctxStatus_OutboundMined,
+			cctx.CctxStatus.Status.String(),
+			cctx.CctxStatus.StatusMessage,
+		))
+	}
+
 	TestEtherWithdraw(newRunner, []string{"50000000000000000"})
 
 	// finally try to deposit Zeta back