refactor: reimplement BridgeTokens gRPC query (#748)

PundiAI · Oct 17, 2024 · bff5bda · bff5bda
1 parent 5a008d6
commit bff5bda
Show file tree

Hide file tree

Showing 27 changed files with 7,293 additions and 7,499 deletions.
diff --git a/api/fx/gravity/crosschain/v1/genesis.pulsar.go b/api/fx/gravity/crosschain/v1/genesis.pulsar.go
diff --git a/api/fx/gravity/crosschain/v1/legacy.pulsar.go b/api/fx/gravity/crosschain/v1/legacy.pulsar.go
diff --git a/api/fx/gravity/crosschain/v1/query.pulsar.go b/api/fx/gravity/crosschain/v1/query.pulsar.go
diff --git a/api/fx/gravity/crosschain/v1/types.pulsar.go b/api/fx/gravity/crosschain/v1/types.pulsar.go
diff --git a/app/genesis.json b/app/genesis.json
@@ -28,7 +28,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -86,7 +85,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -173,7 +171,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -254,7 +251,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -431,7 +427,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -491,7 +486,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -537,7 +531,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],
@@ -619,7 +612,6 @@
     },
     "oracles": [],
     "oracle_sets": [],
-    "bridge_tokens": [],
     "unbatched_transfers": [],
     "batches": [],
     "oracle_set_confirms": [],

diff --git a/docs/statik/statik.go b/docs/statik/statik.go
diff --git a/docs/swagger-ui/swagger.yaml b/docs/swagger-ui/swagger.yaml
@@ -7314,7 +7314,6 @@ paths:
                     channel_ibc:
                       type: string
                       title: 'Deprecated: after upgrade v3'
-                  title: BridgeToken
         default:
           description: An unexpected error response.
           schema:
@@ -41567,7 +41566,6 @@ definitions:
       channel_ibc:
         type: string
         title: 'Deprecated: after upgrade v3'
-    title: BridgeToken
   fx.gravity.crosschain.v1.BridgeValidator:
     type: object
     properties:
@@ -42093,7 +42091,6 @@ definitions:
             channel_ibc:
               type: string
               title: 'Deprecated: after upgrade v3'
-          title: BridgeToken
   fx.gravity.crosschain.v1.QueryCurrentOracleSetResponse:
     type: object
     properties:

diff --git a/proto/fx/gravity/crosschain/v1/genesis.proto b/proto/fx/gravity/crosschain/v1/genesis.proto
@@ -15,16 +15,15 @@ message GenesisState {
       [ (gogoproto.nullable) = false ];
   repeated Oracle oracles = 4 [ (gogoproto.nullable) = false ];
   repeated OracleSet oracle_sets = 5 [ (gogoproto.nullable) = false ];
-  repeated BridgeToken bridge_tokens = 6 [ (gogoproto.nullable) = false ];
-  repeated OutgoingTransferTx unbatched_transfers = 7
+  repeated OutgoingTransferTx unbatched_transfers = 6
       [ (gogoproto.nullable) = false ];
-  repeated OutgoingTxBatch batches = 8 [ (gogoproto.nullable) = false ];
-  repeated MsgOracleSetConfirm oracle_set_confirms = 9
+  repeated OutgoingTxBatch batches = 7 [ (gogoproto.nullable) = false ];
+  repeated MsgOracleSetConfirm oracle_set_confirms = 8
       [ (gogoproto.nullable) = false ];
-  repeated MsgConfirmBatch batch_confirms = 10 [ (gogoproto.nullable) = false ];
-  repeated Attestation attestations = 11 [ (gogoproto.nullable) = false ];
-  ProposalOracle proposal_oracle = 12 [ (gogoproto.nullable) = false ];
-  OracleSet last_observed_oracle_set = 13 [ (gogoproto.nullable) = false ];
-  uint64 last_slashed_batch_block = 14;
-  uint64 last_slashed_oracle_set_nonce = 15;
+  repeated MsgConfirmBatch batch_confirms = 9 [ (gogoproto.nullable) = false ];
+  repeated Attestation attestations = 10 [ (gogoproto.nullable) = false ];
+  ProposalOracle proposal_oracle = 11 [ (gogoproto.nullable) = false ];
+  OracleSet last_observed_oracle_set = 12 [ (gogoproto.nullable) = false ];
+  uint64 last_slashed_batch_block = 13;
+  uint64 last_slashed_oracle_set_nonce = 14;
 }
diff --git a/proto/fx/gravity/crosschain/v1/legacy.proto b/proto/fx/gravity/crosschain/v1/legacy.proto
@@ -123,4 +123,49 @@ message MsgOracleSetConfirmResponse { option deprecated = true; }
 
 message MsgConfirmBatchResponse { option deprecated = true; }
 
-message MsgBridgeCallConfirmResponse { option deprecated = true; }
+message MsgBridgeCallConfirmResponse { option deprecated = true; }
+
+message BridgeToken {
+  option deprecated = true;
+  string token = 1;
+  string denom = 2;
+  // Deprecated: after upgrade v3
+  string channel_ibc = 3;
+}
+
+message BatchFees {
+  option deprecated = true;
+  string token_contract = 1;
+  string total_fees = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "cosmossdk.io/math.Int",
+    (gogoproto.nullable) = false
+  ];
+  uint64 total_txs = 3;
+  string total_amount = 4 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "cosmossdk.io/math.Int",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message MinBatchFee {
+  option deprecated = true;
+  string token_contract = 1;
+  string base_fee = 2 [
+    (cosmos_proto.scalar) = "cosmos.Int",
+    (gogoproto.customtype) = "cosmossdk.io/math.Int",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message QueryBatchFeeRequest {
+  option deprecated = true;
+  string chain_name = 1;
+  repeated MinBatchFee min_batch_fees = 2 [ (gogoproto.nullable) = false ];
+}
+
+message QueryBatchFeeResponse {
+  option deprecated = true;
+  repeated BatchFees batch_fees = 1;
+}
diff --git a/proto/fx/gravity/crosschain/v1/query.proto b/proto/fx/gravity/crosschain/v1/query.proto
@@ -6,6 +6,7 @@ import "cosmos/base/v1beta1/coin.proto";
 import "cosmos_proto/cosmos.proto";
 import "fx/gravity/crosschain/v1/tx.proto";
 import "fx/gravity/crosschain/v1/types.proto";
+import "fx/gravity/crosschain/v1/legacy.proto";
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
 import "google/protobuf/any.proto";
@@ -187,12 +188,6 @@ message QueryLastPendingOracleSetRequestByAddrResponse {
   repeated OracleSet oracle_sets = 1;
 }
 
-message QueryBatchFeeRequest {
-  string chain_name = 1;
-  repeated MinBatchFee min_batch_fees = 2 [ (gogoproto.nullable) = false ];
-}
-message QueryBatchFeeResponse { repeated BatchFees batch_fees = 1; }
-
 message QueryLastPendingBatchRequestByAddrRequest {
   string chain_name = 1;
   string bridger_address = 2;

diff --git a/proto/fx/gravity/crosschain/v1/types.proto b/proto/fx/gravity/crosschain/v1/types.proto
@@ -51,14 +51,6 @@ message LastObservedBlockHeight {
   uint64 block_height = 2;
 }
 
-// BridgeToken
-message BridgeToken {
-  string token = 1;
-  string denom = 2;
-  // Deprecated: after upgrade v3
-  string channel_ibc = 3;
-}
-
 // ClaimType is the cosmos type of an event from the counterpart chain that can
 // be handled
 enum ClaimType {
@@ -124,30 +116,6 @@ message ERC20Token {
   ];
 }
 
-message BatchFees {
-  string token_contract = 1;
-  string total_fees = 2 [
-    (cosmos_proto.scalar) = "cosmos.Int",
-    (gogoproto.customtype) = "cosmossdk.io/math.Int",
-    (gogoproto.nullable) = false
-  ];
-  uint64 total_txs = 3;
-  string total_amount = 4 [
-    (cosmos_proto.scalar) = "cosmos.Int",
-    (gogoproto.customtype) = "cosmossdk.io/math.Int",
-    (gogoproto.nullable) = false
-  ];
-}
-
-message MinBatchFee {
-  string token_contract = 1;
-  string base_fee = 2 [
-    (cosmos_proto.scalar) = "cosmos.Int",
-    (gogoproto.customtype) = "cosmossdk.io/math.Int",
-    (gogoproto.nullable) = false
-  ];
-}
-
 // Params represent the Gravity genesis and store parameters
 // gravity_id:
 // a random 32 byte value to prevent signature reuse, for example if the

diff --git a/x/crosschain/keeper/bridge_token.go b/x/crosschain/keeper/bridge_token.go
@@ -28,7 +28,7 @@ func (k Keeper) AddBridgeTokenExecuted(ctx sdk.Context, claim *types.MsgBridgeTo
 		return types.ErrInvalid.Wrapf("%s denom decimals not match %d, expect %d",
 			fxtypes.DefaultDenom, claim.Decimals, fxtypes.DenomUnit)
 	}
-	bridgeToken, err := k.erc20Keeper.GetBridgeToken(ctx, claim.Symbol, k.moduleName)
+	bridgeToken, err := k.erc20Keeper.GetBridgeToken(ctx, k.moduleName, claim.Symbol)
 	if err != nil {
 		return err
 	}
@@ -49,13 +49,13 @@ func (k Keeper) BridgeCoinSupply(ctx context.Context, token, target string) (sdk
 	}
 	var targetDenom string
 	if fxTarget.IsIBC() {
-		ibcToken, err := k.erc20Keeper.GetIBCToken(ctx, baseDenom, fxTarget.IBCChannel)
+		ibcToken, err := k.erc20Keeper.GetIBCToken(ctx, fxTarget.IBCChannel, baseDenom)
 		if err != nil {
 			return sdk.Coin{}, err
 		}
 		targetDenom = ibcToken.IbcDenom
 	} else {
-		bridgeToken, err := k.erc20Keeper.GetBridgeToken(ctx, baseDenom, fxTarget.GetModuleName())
+		bridgeToken, err := k.erc20Keeper.GetBridgeToken(ctx, fxTarget.GetModuleName(), baseDenom)
 		if err != nil {
 			return sdk.Coin{}, err
 		}

diff --git a/x/crosschain/keeper/grpc_query.go b/x/crosschain/keeper/grpc_query.go
@@ -192,7 +192,7 @@ func (k QueryServer) DenomToToken(c context.Context, req *types.QueryDenomToToke
 		return nil, status.Error(codes.InvalidArgument, "denom")
 	}
 
-	bridgeToken, err := k.erc20Keeper.GetBridgeToken(c, req.Denom, req.ChainName)
+	bridgeToken, err := k.erc20Keeper.GetBridgeToken(c, req.ChainName, req.Denom)
 	if err != nil {
 		return nil, status.Error(codes.NotFound, err.Error())
 	}
@@ -207,7 +207,7 @@ func (k QueryServer) TokenToDenom(c context.Context, req *types.QueryTokenToDeno
 	if err != nil {
 		return nil, status.Error(codes.NotFound, err.Error())
 	}
-	_, err = k.erc20Keeper.GetBridgeToken(c, baseDenom, req.ChainName)
+	_, err = k.erc20Keeper.GetBridgeToken(c, req.ChainName, baseDenom)
 	if err != nil {
 		return nil, status.Error(codes.NotFound, err.Error())
 	}
@@ -282,9 +282,18 @@ func (k QueryServer) ProjectedBatchTimeoutHeight(c context.Context, _ *types.Que
 	return &types.QueryProjectedBatchTimeoutHeightResponse{TimeoutHeight: timeout}, nil
 }
 
-func (k QueryServer) BridgeTokens(c context.Context, _ *types.QueryBridgeTokensRequest) (*types.QueryBridgeTokensResponse, error) {
-	bridgeTokens := make([]*types.BridgeToken, 0)
-	// todo: need implement
+func (k QueryServer) BridgeTokens(c context.Context, req *types.QueryBridgeTokensRequest) (*types.QueryBridgeTokensResponse, error) {
+	tokens, err := k.erc20Keeper.GetBridgeTokens(c, req.ChainName)
+	if err != nil {
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+	bridgeTokens := make([]*types.BridgeToken, 0, len(tokens))
+	for _, token := range tokens {
+		bridgeTokens = append(bridgeTokens, &types.BridgeToken{
+			Token: token.Contract,
+			Denom: token.BridgeDenom(),
+		})
+	}
 	return &types.QueryBridgeTokensResponse{BridgeTokens: bridgeTokens}, nil
 }
 

diff --git a/x/crosschain/keeper/many_to_one.go b/x/crosschain/keeper/many_to_one.go
@@ -33,7 +33,7 @@ func (k Keeper) BridgeTokenToBaseCoin(ctx context.Context, holder sdk.AccAddress
 }
 
 func (k Keeper) BaseCoinToBridgeToken(ctx context.Context, holder sdk.AccAddress, baseCoin sdk.Coin) (bridgeToken erc20types.BridgeToken, err error) {
-	bridgeToken, err = k.erc20Keeper.GetBridgeToken(ctx, baseCoin.Denom, k.moduleName)
+	bridgeToken, err = k.erc20Keeper.GetBridgeToken(ctx, k.moduleName, baseCoin.Denom)
 	if err != nil {
 		return bridgeToken, err
 	}
@@ -106,7 +106,7 @@ func (k Keeper) IBCCoinToBaseCoin(ctx context.Context, holder sdk.AccAddress, ib
 }
 
 func (k Keeper) BaseCoinToIBCCoin(ctx context.Context, holder sdk.AccAddress, baseCoin sdk.Coin, channel string) (sdk.Coin, error) {
-	ibcToken, err := k.erc20Keeper.GetIBCToken(ctx, baseCoin.Denom, channel)
+	ibcToken, err := k.erc20Keeper.GetIBCToken(ctx, channel, baseCoin.Denom)
 	if err != nil {
 		// NOTE: if not found in IBCToken
 		return baseCoin, nil
@@ -168,5 +168,5 @@ func (k Keeper) GetBridgeToken(ctx context.Context, tokenAddr string) (erc20type
 	if err != nil {
 		return erc20types.BridgeToken{}, err
 	}
-	return k.erc20Keeper.GetBridgeToken(ctx, baseDenom, k.moduleName)
+	return k.erc20Keeper.GetBridgeToken(ctx, k.moduleName, baseDenom)
 }
diff --git a/x/crosschain/mock/expected_keepers_mocks.go b/x/crosschain/mock/expected_keepers_mocks.go
diff --git a/x/crosschain/types/expected_keepers.go b/x/crosschain/types/expected_keepers.go
@@ -54,9 +54,10 @@ type Erc20Keeper interface {
 
 	GetERC20Token(ctx context.Context, baseDenom string) (erc20types.ERC20Token, error)
 
-	GetBridgeToken(ctx context.Context, baseDenom, chainName string) (erc20types.BridgeToken, error)
+	GetBridgeToken(ctx context.Context, chainName, baseDenom string) (erc20types.BridgeToken, error)
+	GetBridgeTokens(ctx context.Context, chainName string) ([]erc20types.BridgeToken, error)
 
-	GetIBCToken(ctx context.Context, baseDenom, channel string) (erc20types.IBCToken, error)
+	GetIBCToken(ctx context.Context, channel, baseDenom string) (erc20types.IBCToken, error)
 }
 
 // EVMKeeper defines the expected EVM keeper interface used on crosschain