Problem: external token mapping not manageable directly (#128)

* Problem: external token mapping not manageable directly

Closes: #119

Solution:
- add native message to update token mapping

unit tests

Update x/cronos/keeper/msg_server.go

fix lint

fix msgs

* changelog

* fix tests

Author: yihuang

CHANGELOG.md

@@ -24,6 +24,7 @@ We also enable swagger doc ui and add the token mapping state in genesis.
 
 - [cronos#110](https://github.com/crypto-org-chain/cronos/pull/110) embed swagger doc ui
 - [cronos#113](https://github.com/crypto-org-chain/cronos/pull/113) export token mapping state to genesis
+- [cronos#128](https://github.com/crypto-org-chain/cronos/pull/128) add native message to update token mapping
 
 *September 22, 2021*
 ## v0.5.4

app/test_helpers.go

@@ -30,6 +30,7 @@ import (
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	minttypes "github.com/cosmos/cosmos-sdk/x/mint/types"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
+	cronostypes "github.com/crypto-org-chain/cronos/x/cronos/types"
 )
 
 const (
@@ -67,8 +68,14 @@ func setup(withGenesis bool, invCheckPeriod uint) (*App, GenesisState) {
 }
 
 // Setup initializes a new App. A Nop logger is set in App.
-func Setup(isCheckTx bool) *App {
+func Setup(isCheckTx bool, cronosAdmin string) *App {
 	app, genesisState := setup(!isCheckTx, 5)
+
+	// set cronos_admin for test
+	cronosGen := cronostypes.DefaultGenesis()
+	cronosGen.Params.CronosAdmin = cronosAdmin
+	genesisState["cronos"] = app.cdc.MustMarshalJSON(cronosGen)
+
 	if !isCheckTx {
 		// init chain must be called to stop deliverState from being nil
 		stateBytes, err := json.MarshalIndent(genesisState, "", " ")

docs/api/proto-docs.md

@@ -25,6 +25,8 @@
     - [MsgConvertVouchersResponse](#cronos.MsgConvertVouchersResponse)
     - [MsgTransferTokens](#cronos.MsgTransferTokens)
     - [MsgTransferTokensResponse](#cronos.MsgTransferTokensResponse)
+    - [MsgUpdateTokenMapping](#cronos.MsgUpdateTokenMapping)
+    - [MsgUpdateTokenMappingResponse](#cronos.MsgUpdateTokenMappingResponse)
 
     - [Msg](#cronos.Msg)
 
@@ -49,6 +51,7 @@ Params defines the parameters for the cronos module.
 | ----- | ---- | ----- | ----------- |
 | `ibc_cro_denom` | [string](#string) |  |  |
 | `ibc_timeout` | [uint64](#uint64) |  |  |
+| `cronos_admin` | [string](#string) |  | the admin address who can update token mapping |
 
 
 
@@ -274,7 +277,32 @@ MsgTransferTokens represents a message to transfer cronos evm coins through ibc.
 ### MsgTransferTokensResponse
 MsgTransferTokensResponse defines the TransferTokens response type.
 
-this line is used by starport scaffolding # proto/tx/message
+
+
+
+
+
+<a name="cronos.MsgUpdateTokenMapping"></a>
+
+### MsgUpdateTokenMapping
+MsgUpdateTokenMapping defines the request type
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `sender` | [string](#string) |  |  |
+| `denom` | [string](#string) |  |  |
+| `contract` | [string](#string) |  |  |
+
+
+
+
+
+
+<a name="cronos.MsgUpdateTokenMappingResponse"></a>
+
+### MsgUpdateTokenMappingResponse
+MsgUpdateTokenMappingResponse defines the response type
 
 
 
@@ -296,6 +324,7 @@ Msg defines the Cronos Msg service
 | ----------- | ------------ | ------------- | ------------| ------- | -------- |
 | `ConvertVouchers` | [MsgConvertVouchers](#cronos.MsgConvertVouchers) | [MsgConvertVouchersResponse](#cronos.MsgConvertVouchersResponse) | ConvertVouchers defines a method for converting ibc voucher to cronos evm coins. | |
 | `TransferTokens` | [MsgTransferTokens](#cronos.MsgTransferTokens) | [MsgTransferTokensResponse](#cronos.MsgTransferTokensResponse) | TransferTokens defines a method to transfer cronos evm coins to another chain through IBC | |
+| `UpdateTokenMapping` | [MsgUpdateTokenMapping](#cronos.MsgUpdateTokenMapping) | [MsgUpdateTokenMappingResponse](#cronos.MsgUpdateTokenMappingResponse) | UpdateTokenMapping defines a method to update token mapping | |
 
  <!-- end services -->
 

integration_tests/cosmoscli.py

@@ -983,3 +983,17 @@ def gov_propose_token_mapping_change(self, denom, contract, **kwargs):
                 **kwargs,
             )
         )
+
+    def update_token_mapping(self, denom, contract, **kwargs):
+        return json.loads(
+            self.raw(
+                "tx",
+                "cronos",
+                "update-token-mapping",
+                denom,
+                contract,
+                "-y",
+                home=self.data_dir,
+                **kwargs,
+            )
+        )

integration_tests/test_gravity.py

@@ -271,3 +271,60 @@ def check():
         return balance == 10
 
     wait_for_fn("check balance on cronos", check)
+
+
+def test_direct_token_mapping(gravity):
+    """
+    Test adding a token mapping directly
+    - deploy test erc20 contract on geth
+    - deploy corresponding contract on cronos
+    - add the token mapping on cronos using gov module
+    - do a gravity transfer, check the balances
+    """
+    geth = gravity.geth
+    cli = gravity.cronos.cosmos_cli()
+    cronos_w3 = gravity.cronos.w3
+
+    # deploy test erc20 contract
+    erc20 = deploy_contract(
+        geth,
+        Path(__file__).parent
+        / "contracts/artifacts/contracts/TestERC20A.sol/TestERC20A.json",
+    )
+    print("erc20 contract", erc20.address)
+    crc20 = deploy_contract(
+        cronos_w3,
+        Path(__file__).parent
+        / "contracts/artifacts/contracts/TestERC20Utility.sol/TestERC20Utility.json",
+    )
+    print("crc20 contract", crc20.address)
+    denom = f"gravity{erc20.address}"
+
+    print("check the contract mapping not exists yet")
+    with pytest.raises(AssertionError):
+        cli.query_contract_by_denom(denom)
+
+    rsp = cli.update_token_mapping(denom, crc20.address, from_="community")
+    assert rsp["code"] != 0, "should not have the permission"
+
+    rsp = cli.update_token_mapping(denom, crc20.address, from_="validator")
+    assert rsp["code"] == 0, rsp["raw_log"]
+    wait_for_new_blocks(cli, 1)
+
+    print("check the contract mapping exists now")
+    rsp = cli.query_contract_by_denom(denom)
+    print("contract", rsp)
+    assert rsp["contract"] == crc20.address
+
+    print("try to send token from ethereum to cronos")
+    txreceipt = send_to_cosmos(
+        gravity.contract, erc20, ADDRS["community"], 10, KEYS["validator"]
+    )
+    assert txreceipt.status == 1
+
+    def check():
+        balance = crc20.caller.balanceOf(ADDRS["community"])
+        print("crc20 balance", balance)
+        return balance == 10
+
+    wait_for_fn("check balance on cronos", check)

proto/cronos/cronos.proto

@@ -11,6 +11,8 @@ message Params {
   string ibc_cro_denom = 1
       [ (gogoproto.moretags) = "yaml:\"ibc_cro_denom,omitempty\"" ];
   uint64 ibc_timeout = 2;
+  // the admin address who can update token mapping
+  string cronos_admin = 3;
 }
 
 // TokenMappingChangeProposal defines a proposal to change one token mapping.

proto/cronos/tx.proto

@@ -17,6 +17,9 @@ service Msg {
 
     // TransferTokens defines a method to transfer cronos evm coins to another chain through IBC
     rpc TransferTokens(MsgTransferTokens) returns (MsgTransferTokensResponse);
+
+    // UpdateTokenMapping defines a method to update token mapping
+    rpc UpdateTokenMapping(MsgUpdateTokenMapping) returns (MsgUpdateTokenMappingResponse);
 }
 
 // MsgConvertVouchers represents a message to convert ibc voucher coins to cronos evm coins.
@@ -39,4 +42,16 @@ message MsgConvertVouchersResponse {}
 
 // MsgTransferTokensResponse defines the TransferTokens response type.
 message MsgTransferTokensResponse {}
+
+// MsgUpdateTokenMapping defines the request type
+message MsgUpdateTokenMapping {
+    string sender = 1;
+    string denom = 2;
+    string contract = 3;
+}
+
+// MsgUpdateTokenMappingResponse defines the response type
+message MsgUpdateTokenMappingResponse {
+}
+
 // this line is used by starport scaffolding # proto/tx/message

scripts/cronos-devnet.yaml

@@ -21,6 +21,9 @@ cronos_777-1:
       evm:
         params:
           evm_denom: basetcro
+      cronos:
+        params:
+          cronos_admin: crc12luku6uxehhak02py4rcz65zu0swh7wjsrw0pp
       gov:
         voting_params:
           voting_period: "10s"

x/cronos/client/cli/tx.go

@@ -33,6 +33,7 @@ func GetTxCmd() *cobra.Command {
 
 	cmd.AddCommand(CmdConvertTokens())
 	cmd.AddCommand(CmdSendToCryptoOrg())
+	cmd.AddCommand(CmdUpdateTokenMapping())
 
 	return cmd
 }
@@ -174,3 +175,28 @@ $ %s tx gov submit-proposal token-mapping-change gravity0x0000...0000 0x0000...0
 
 	return cmd
 }
+
+// CmdUpdateTokenMapping returns a CLI command handler for update token mapping
+func CmdUpdateTokenMapping() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "update-token-mapping [denom] [contract]",
+		Short: "Update token mapping",
+		Args:  cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientTxContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			msg := types.NewMsgUpdateTokenMapping(clientCtx.GetFromAddress().String(), args[0], args[1])
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+
+	flags.AddTxFlagsToCmd(cmd)
+
+	return cmd
+}

x/cronos/handler.go

@@ -27,6 +27,9 @@ func NewHandler(k keeper.Keeper) sdk.Handler {
 		case *types.MsgTransferTokens:
 			res, err := msgServer.TransferTokens(sdk.WrapSDKContext(ctx), msg)
 			return sdk.WrapServiceResult(ctx, res, err)
+		case *types.MsgUpdateTokenMapping:
+			res, err := msgServer.UpdateTokenMapping(sdk.WrapSDKContext(ctx), msg)
+			return sdk.WrapServiceResult(ctx, res, err)
 		default:
 			errMsg := fmt.Sprintf("unrecognized %s message type: %T", types.ModuleName, msg)
 			return nil, sdkerrors.Wrap(sdkerrors.ErrUnknownRequest, errMsg)