feat: add liquidity cap parameter to ZRC20 creation (#3353)

* add liquidity cap to message * update messages and tests * fix e2e tests * changelog * fix tests * feat: allow nil liquidity cap (#3387) * feat: allow nil liquidity cap * restore inner nil check * remove cli docs * format --------- Co-authored-by: Alex Gartner <[email protected]>
zeta-chain · Jan 23, 2025 · ac3b447 · ac3b447
1 parent 9fc89e0
commit ac3b447
Show file tree

Hide file tree

Showing 33 changed files with 548 additions and 220 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,10 @@
 # CHANGELOG
 
-## unreleased
+## Unreleased
+
+### Features
+
+* [3353](https://github.com/zeta-chain/node/pull/3353) - add liquidity cap parameter to ZRC20 creation
 
 ### Refactor
 

diff --git a/docs/spec/crosschain/messages.md b/docs/spec/crosschain/messages.md
@@ -211,6 +211,7 @@ message MsgWhitelistERC20 {
 	string symbol = 5;
 	uint32 decimals = 6;
 	int64 gas_limit = 7;
+	string liquidity_cap = 8;
 }
 ```
 

diff --git a/docs/spec/fungible/messages.md b/docs/spec/fungible/messages.md
@@ -43,6 +43,7 @@ message MsgDeployFungibleCoinZRC20 {
 	string symbol = 6;
 	pkg.coin.CoinType coin_type = 7;
 	int64 gas_limit = 8;
+	string liquidity_cap = 9;
 }
 ```
 

diff --git a/e2e/e2etests/test_migrate_chain_support.go b/e2e/e2etests/test_migrate_chain_support.go
@@ -7,6 +7,7 @@ import (
 	"os/exec"
 	"time"
 
+	sdkmath "cosmossdk.io/math"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	ethcommon "github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/ethclient"
@@ -79,6 +80,7 @@ func TestMigrateChainSupport(r *runner.E2ERunner, _ []string) {
 			"sETH",
 			coin.CoinType_Gas,
 			100000,
+			nil,
 		),
 	)
 	require.NoError(r, err)
@@ -165,6 +167,7 @@ func TestMigrateChainSupport(r *runner.E2ERunner, _ []string) {
 		"USDT",
 		18,
 		100000,
+		sdkmath.NewUintFromString("100000000000000000000000000"),
 	))
 	require.NoError(r, err)
 

diff --git a/e2e/e2etests/test_solana_whitelist_spl.go b/e2e/e2etests/test_solana_whitelist_spl.go
@@ -1,6 +1,7 @@
 package e2etests
 
 import (
+	sdkmath "cosmossdk.io/math"
 	"github.com/gagliardetto/solana-go"
 	"github.com/gagliardetto/solana-go/rpc"
 	"github.com/stretchr/testify/require"
@@ -45,6 +46,7 @@ func TestSolanaWhitelistSPL(r *runner.E2ERunner, _ []string) {
 		"TESTSPL",
 		6,
 		100000,
+		sdkmath.NewUintFromString("100000000000000000000000000"),
 	))
 	require.NoError(r, err)
 

diff --git a/e2e/e2etests/test_whitelist_erc20.go b/e2e/e2etests/test_whitelist_erc20.go
@@ -3,6 +3,7 @@ package e2etests
 import (
 	"math/big"
 
+	sdkmath "cosmossdk.io/math"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	ethcommon "github.com/ethereum/go-ethereum/common"
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
@@ -40,6 +41,7 @@ func TestWhitelistERC20(r *runner.E2ERunner, _ []string) {
 		"NEWERC20",
 		6,
 		100000,
+		sdkmath.NewUintFromString("100000000000000000000000000"),
 	))
 	require.NoError(r, err)
 

diff --git a/e2e/txserver/zeta_tx_server.go b/e2e/txserver/zeta_tx_server.go
@@ -443,6 +443,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"gETH",
 			coin.CoinType_Gas,
 			100000,
+			nil,
 		),
 		fungibletypes.NewMsgDeployFungibleCoinZRC20(
 			deployerAddr,
@@ -453,6 +454,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"tBTC",
 			coin.CoinType_Gas,
 			100000,
+			nil,
 		),
 		fungibletypes.NewMsgDeployFungibleCoinZRC20(
 			deployerAddr,
@@ -463,6 +465,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"SOL",
 			coin.CoinType_Gas,
 			100000,
+			nil,
 		),
 		fungibletypes.NewMsgDeployFungibleCoinZRC20(
 			deployerAddr,
@@ -473,6 +476,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"TON",
 			coin.CoinType_Gas,
 			100_000,
+			nil,
 		),
 		fungibletypes.NewMsgDeployFungibleCoinZRC20(
 			deployerAddr,
@@ -483,6 +487,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"USDT",
 			coin.CoinType_ERC20,
 			100000,
+			nil,
 		),
 	}
 
@@ -496,6 +501,7 @@ func (zts ZetaTxServer) DeployZRC20s(
 			"USDT",
 			coin.CoinType_ERC20,
 			100000,
+			nil,
 		))
 	}
 

diff --git a/precompiles/bank/method_test.go b/precompiles/bank/method_test.go
@@ -4,6 +4,8 @@ import (
 	"math/big"
 	"testing"
 
+	sdkmath "cosmossdk.io/math"
+
 	storetypes "github.com/cosmos/cosmos-sdk/store/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/ethereum/go-ethereum/accounts/abi"
@@ -17,6 +19,7 @@ import (
 	"github.com/zeta-chain/ethermint/x/evm/statedb"
 	"github.com/zeta-chain/node/pkg/chains"
 	"github.com/zeta-chain/node/pkg/contracts/erc1967proxy"
+	"github.com/zeta-chain/node/pkg/ptr"
 	precompiletypes "github.com/zeta-chain/node/precompiles/types"
 	"github.com/zeta-chain/node/testutil/keeper"
 	"github.com/zeta-chain/node/testutil/sample"
@@ -634,6 +637,7 @@ func setupGasCoin(
 		symbol,
 		8,
 		nil,
+		ptr.Ptr(sdkmath.NewUintFromString("100000000000000000000000000")),
 	)
 	require.NoError(t, err)
 	assertContractDeployment(t, *evmk, ctx, addr)

diff --git a/precompiles/staking/staking_test.go b/precompiles/staking/staking_test.go
@@ -28,6 +28,7 @@ import (
 	"github.com/zeta-chain/node/cmd/zetacored/config"
 	"github.com/zeta-chain/node/pkg/chains"
 	"github.com/zeta-chain/node/pkg/contracts/erc1967proxy"
+	"github.com/zeta-chain/node/pkg/ptr"
 	"github.com/zeta-chain/node/precompiles/prototype"
 	"github.com/zeta-chain/node/testutil/keeper"
 	"github.com/zeta-chain/node/testutil/sample"
@@ -508,6 +509,7 @@ func setupGasCoin(
 		symbol,
 		8,
 		nil,
+		ptr.Ptr(math.NewUintFromString("100000000000000000000000000")),
 	)
 	require.NoError(t, err)
 	assertContractDeployment(t, *evmk, ctx, addr)

diff --git a/proto/zetachain/zetacore/crosschain/tx.proto b/proto/zetachain/zetacore/crosschain/tx.proto
@@ -81,6 +81,10 @@ message MsgWhitelistERC20 {
   string symbol = 5;
   uint32 decimals = 6;
   int64 gas_limit = 7;
+  string liquidity_cap = 8 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Uint",
+    (gogoproto.nullable) = false
+  ];
 }
 
 message MsgWhitelistERC20Response {

diff --git a/proto/zetachain/zetacore/fungible/tx.proto b/proto/zetachain/zetacore/fungible/tx.proto
@@ -69,6 +69,8 @@ message MsgDeployFungibleCoinZRC20 {
   string symbol = 6;
   pkg.coin.CoinType coin_type = 7;
   int64 gas_limit = 8;
+  string liquidity_cap = 9
+      [ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Uint" ];
 }
 
 message MsgDeployFungibleCoinZRC20Response { string address = 1; }

diff --git a/testutil/keeper/mocks/crosschain/fungible.go b/testutil/keeper/mocks/crosschain/fungible.go
diff --git a/typescript/zetachain/zetacore/crosschain/tx_pb.d.ts b/typescript/zetachain/zetacore/crosschain/tx_pb.d.ts
@@ -229,6 +229,11 @@ export declare class MsgWhitelistERC20 extends Message<MsgWhitelistERC20> {
    */
   gasLimit: bigint;
 
+  /**
+   * @generated from field: string liquidity_cap = 8;
+   */
+  liquidityCap: string;
+
   constructor(data?: PartialMessage<MsgWhitelistERC20>);
 
   static readonly runtime: typeof proto3;

diff --git a/typescript/zetachain/zetacore/fungible/tx_pb.d.ts b/typescript/zetachain/zetacore/fungible/tx_pb.d.ts
@@ -227,6 +227,11 @@ export declare class MsgDeployFungibleCoinZRC20 extends Message<MsgDeployFungibl
    */
   gasLimit: bigint;
 
+  /**
+   * @generated from field: string liquidity_cap = 9;
+   */
+  liquidityCap: string;
+
   constructor(data?: PartialMessage<MsgDeployFungibleCoinZRC20>);
 
   static readonly runtime: typeof proto3;

diff --git a/x/crosschain/client/cli/cli_whitelist_erc20.go b/x/crosschain/client/cli/cli_whitelist_erc20.go
@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"strconv"
 
+	sdkmath "cosmossdk.io/math"
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	"github.com/cosmos/cosmos-sdk/client/tx"
@@ -14,9 +15,9 @@ import (
 
 func CmdWhitelistERC20() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "whitelist-erc20 [erc20Address] [chainID] [name] [symbol] [decimals] [gasLimit]",
+		Use:   "whitelist-erc20 [erc20Address] [chainID] [name] [symbol] [decimals] [gasLimit] [liquidityCap]",
 		Short: "Add a new erc20 token to whitelist",
-		Args:  cobra.ExactArgs(6),
+		Args:  cobra.ExactArgs(7),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
@@ -44,6 +45,8 @@ func CmdWhitelistERC20() *cobra.Command {
 				return err
 			}
 
+			liquidityCap := sdkmath.NewUintFromString(args[6])
+
 			msg := types.NewMsgWhitelistERC20(
 				clientCtx.GetFromAddress().String(),
 				erc20Address,
@@ -53,6 +56,7 @@ func CmdWhitelistERC20() *cobra.Command {
 				// #nosec G115 always in range
 				uint32(decimals),
 				gasLimit,
+				liquidityCap,
 			)
 
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)

diff --git a/x/crosschain/keeper/msg_server_whitelist_erc20.go b/x/crosschain/keeper/msg_server_whitelist_erc20.go
@@ -11,6 +11,7 @@ import (
 	"github.com/gagliardetto/solana-go"
 
 	"github.com/zeta-chain/node/pkg/coin"
+	"github.com/zeta-chain/node/pkg/ptr"
 	authoritytypes "github.com/zeta-chain/node/x/authority/types"
 	"github.com/zeta-chain/node/x/crosschain/types"
 	fungibletypes "github.com/zeta-chain/node/x/fungible/types"
@@ -98,6 +99,7 @@ func (k msgServer) WhitelistERC20(
 		coin.CoinType_ERC20,
 		msg.Erc20Address,
 		big.NewInt(msg.GasLimit),
+		ptr.Ptr(msg.LiquidityCap),
 	)
 	if err != nil {
 		return nil, errorsmod.Wrapf(
@@ -172,7 +174,8 @@ func (k msgServer) WhitelistERC20(
 		Symbol:               msg.Symbol,
 		CoinType:             coin.CoinType_ERC20,
 		// #nosec G115 always positive
-		GasLimit: uint64(msg.GasLimit),
+		GasLimit:     uint64(msg.GasLimit),
+		LiquidityCap: msg.LiquidityCap,
 	}
 	k.fungibleKeeper.SetForeignCoins(ctx, foreignCoin)
 	k.SaveCCTXUpdate(ctx, cctx, tss.TssPubkey)