feat: add symbol name to the x/uibc QueryInflowsResponse (#2377)

* feat: add symbol name to the x/uibc QueryInflowsResponse

* add missing file

* changelog

CHANGELOG.md

@@ -53,6 +53,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - [2363](https://github.com/umee-network/umee/pull/2363) Upgrade Cosmos SDK to v0.47.7.
 - [2370](https://github.com/umee-network/umee/pull/2370) Add missing params to `uibc/MsgGovUpdateQuota`.
 - [2374](https://github.com/umee-network/umee/pull/2374) Add symbol name to the x/uibc QueryAllOutflowsResponse `outflows` entry.
+- [2377](https://github.com/umee-network/umee/pull/2377) Add symbol name to the x/uibc QueryInflowsResponse `inflows` entry.
 
 ### Features
 

proto/umee/uibc/v1/query.proto

@@ -1,7 +1,6 @@
 syntax = "proto3";
 package umee.uibc.v1;
 
-import "cosmos/base/v1beta1/coin.proto";
 import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
@@ -68,10 +67,7 @@ message QueryInflowsResponse {
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable)   = false
   ];
-  repeated cosmos.base.v1beta1.DecCoin inflows = 2 [
-    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.DecCoin",
-    (gogoproto.nullable)   = false
-  ];
+  repeated DecCoinSymbol inflows = 2 [(gogoproto.nullable) = false];
 }
 
 // QueryParams defines the request structure for the Params gRPC service

swagger/swagger.yaml

@@ -3180,15 +3180,12 @@ paths:
                       type: string
                     amount:
                       type: string
+                    symbol:
+                      type: string
+                      title: token symbol name
                   description: >-
-                    DecCoin defines a token with a denomination and a decimal
-                    amount.
-
-
-                    NOTE: The amount field is an Dec which implements the custom
-                    method
-
-                    signatures required by gogoproto.
+                    DecCoinSymbol extends the Cosmos SDK DecCoin type and adds
+                    symbol name.
             title: QueryInflowsResponse defines response type of Query/Inflows
         default:
           description: An unexpected error response.
@@ -9249,11 +9246,12 @@ definitions:
               type: string
             amount:
               type: string
-          description: |-
-            DecCoin defines a token with a denomination and a decimal amount.
-
-            NOTE: The amount field is an Dec which implements the custom method
-            signatures required by gogoproto.
+            symbol:
+              type: string
+              title: token symbol name
+          description: >-
+            DecCoinSymbol extends the Cosmos SDK DecCoin type and adds symbol
+            name.
     title: QueryInflowsResponse defines response type of Query/Inflows
   umee.uibc.v1.QueryOutflowsResponse:
     type: object

x/uibc/quota/grpc_query.go

@@ -56,35 +56,28 @@ func (q Querier) AllOutflows(goCtx context.Context, _ *uibc.QueryAllOutflows) (
 	if err != nil {
 		return nil, err
 	}
-	tokenSymbols := map[string]string{}
-	for _, t := range k.leverage.GetAllRegisteredTokens(ctx) {
-		tokenSymbols[t.BaseDenom] = t.SymbolDenom
-	}
-	outflows := make([]uibc.DecCoinSymbol, len(o))
-	for i := range o {
-		outflows[i].Denom = o[i].Denom
-		outflows[i].Amount = o[i].Amount
-		outflows[i].Symbol = tokenSymbols[o[i].Denom]
-	}
+	outflows := k.coinsWithTokenSymbols(ctx, o)
 	return &uibc.QueryAllOutflowsResponse{Outflows: outflows}, nil
 }
 
 // Inflows returns sum of inflows and registered IBC denoms inflows in the current quota period.
 func (q Querier) Inflows(goCtx context.Context, req *uibc.QueryInflows) (*uibc.QueryInflowsResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 	var (
-		inflows sdk.DecCoins
-		err     error
+		inflowCoins sdk.DecCoins
+		err         error
+		k           = q.Keeper(&ctx)
 	)
 
 	if len(req.Denom) != 0 {
-		inflows = append(inflows, q.Keeper(&ctx).GetTokenInflow(req.Denom))
+		inflowCoins = sdk.NewDecCoins(k.GetTokenInflow(req.Denom))
 	} else {
-		inflows, err = q.Keeper(&ctx).GetAllInflows()
+		inflowCoins, err = k.GetAllInflows()
 		if err != nil {
 			return nil, err
 		}
 	}
+	inflows := k.coinsWithTokenSymbols(ctx, inflowCoins)
 	return &uibc.QueryInflowsResponse{Sum: q.Keeper(&ctx).GetInflowSum(), Inflows: inflows}, nil
 }
 

x/uibc/quota/token.go

@@ -0,0 +1,21 @@
+package quota
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/umee-network/umee/v6/x/uibc"
+)
+
+// returns mapping of token denom (according to x/bank) to token symbol name.
+func (k Keeper) coinsWithTokenSymbols(ctx sdk.Context, coins sdk.DecCoins) []uibc.DecCoinSymbol {
+	tokenSymbols := map[string]string{}
+	for _, t := range k.leverage.GetAllRegisteredTokens(ctx) {
+		tokenSymbols[t.BaseDenom] = t.SymbolDenom
+	}
+	cs := make([]uibc.DecCoinSymbol, len(coins))
+	for i := range coins {
+		cs[i].Denom = coins[i].Denom
+		cs[i].Amount = coins[i].Amount
+		cs[i].Symbol = tokenSymbols[coins[i].Denom]
+	}
+	return cs
+}