feat: query RegisteredTokenMarkets (#2369)

* proto changes, except uibc * implement query * -- * test * changelog * lint * api suggestion Co-authored-by: Robert Zaremba <[email protected]> * proto gen after suggestion --------- Co-authored-by: Robert Zaremba <[email protected]>
umee-network · Jan 2, 2024 · c7a3e5b · c7a3e5b
1 parent cb45498
commit c7a3e5b
Show file tree

Hide file tree

Showing 7 changed files with 858 additions and 156 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,11 +46,15 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## Unreleased
 
+### Features
+
+- [2369](https://github.com/umee-network/umee/pull/2369) Add query RegisteredTokenMarkets to fetch Registered Tokens and their Market Summaries for frontend in fewer queries.
+
 ## v6.2.0 - 2023-12-01
 
 ### Bug Fixes
 
-- [2315](https://github.com/umee-network/umee/pull/2215) Improve reliability of MaxBorrow, MaxWithdraw when special asset pairs present.
+- [2315](https://github.com/umee-network/umee/pull/2315) Improve reliability of MaxBorrow, MaxWithdraw when special asset pairs present.
 - [2346](https://github.com/umee-network/umee/pull/2346) Fix an issue where metokens were not included in historic data.
 
 ### Improvements

diff --git a/proto/umee/leverage/v1/query.proto b/proto/umee/leverage/v1/query.proto
@@ -24,6 +24,12 @@ service Query {
     option (google.api.http).get = "/umee/leverage/v1/registered_tokens";
   }
 
+  // RegisteredTokensWithMarkets queries for all the registered tokens and their market summaries.
+  rpc RegisteredTokensWithMarkets(QueryRegisteredTokensWithMarkets)
+      returns (QueryRegisteredTokensWithMarketsResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/registered_tokens_with_markets";
+  }
+
   // SpecialAssets queries for all special asset pairs.
   rpc SpecialAssets(QuerySpecialAssets)
       returns (QuerySpecialAssetsResponse) {
@@ -112,6 +118,24 @@ message QueryRegisteredTokensResponse {
   repeated Token registry = 1 [(gogoproto.nullable) = false];
 }
 
+// QueryRegisteredTokensWithMarkets defines the request structure for the RegisteredTokenMarkets
+// gRPC service handler.
+message QueryRegisteredTokensWithMarkets {}
+
+// QueryRegisteredTokensWithMarketsResponse defines the response structure for the
+// RegisteredTokensWithMarkets gRPC service handler.
+message QueryRegisteredTokensWithMarketsResponse {
+  repeated TokenMarket markets = 1 [(gogoproto.nullable) = false];
+}
+
+// TokenMarket is a token and its market summary.
+message TokenMarket {
+  // Token is a registered token and its parameters.
+  Token token = 1 [(gogoproto.nullable) = false];
+  // Market is the market summary for the token.
+  QueryMarketSummaryResponse market = 2 [(gogoproto.nullable) = false];
+}
+
 // QuerySpecialAssets defines the request structure for the SpecialAssets
 // gRPC service handler.
 message QuerySpecialAssets {

diff --git a/x/leverage/keeper/grpc_query.go b/x/leverage/keeper/grpc_query.go
@@ -62,6 +62,35 @@ func (q Querier) RegisteredTokens(
 	}, nil
 }
 
+func (q Querier) RegisteredTokensWithMarkets(
+	goCtx context.Context,
+	req *types.QueryRegisteredTokensWithMarkets,
+) (*types.QueryRegisteredTokensWithMarketsResponse, error) {
+	if req == nil {
+		return nil, status.Error(codes.InvalidArgument, "empty request")
+	}
+
+	ctx := sdk.UnwrapSDKContext(goCtx)
+	tokens := q.Keeper.GetAllRegisteredTokens(ctx)
+	markets := []types.TokenMarket{}
+
+	for _, token := range tokens {
+		marketSumnmary, err := q.MarketSummary(goCtx, &types.QueryMarketSummary{Denom: token.BaseDenom})
+		if err != nil {
+			// absorb overall query error into struct, which may be empty, but proceed with this query
+			marketSumnmary.Errors += err.Error()
+		}
+		markets = append(markets, types.TokenMarket{
+			Token:  token,
+			Market: *marketSumnmary,
+		})
+	}
+
+	return &types.QueryRegisteredTokensWithMarketsResponse{
+		Markets: markets,
+	}, nil
+}
+
 func (q Querier) SpecialAssets(
 	goCtx context.Context,
 	req *types.QuerySpecialAssets,

diff --git a/x/leverage/keeper/grpc_query_test.go b/x/leverage/keeper/grpc_query_test.go
@@ -99,6 +99,29 @@ func (s *IntegrationTestSuite) TestQuerier_MarketSummary() {
 	require.Equal(expected, *resp)
 }
 
+func (s *IntegrationTestSuite) TestQuerier_TokenMarkets() {
+	require := s.Require()
+
+	req := &types.QueryRegisteredTokensWithMarkets{}
+	resp, err := s.queryClient.RegisteredTokensWithMarkets(context.Background(), req)
+	require.NoError(err)
+
+	expected := types.QueryRegisteredTokensWithMarketsResponse{
+		Markets: []types.TokenMarket{},
+	}
+	tokens := s.tk.GetAllRegisteredTokens(s.ctx)
+	for _, token := range tokens {
+		ms, err := s.queryClient.MarketSummary(context.Background(), &types.QueryMarketSummary{Denom: token.BaseDenom})
+		require.NoError(err)
+		expected.Markets = append(expected.Markets, types.TokenMarket{
+			Token:  token,
+			Market: *ms,
+		})
+	}
+
+	require.Equal(expected, *resp)
+}
+
 func (s *IntegrationTestSuite) TestQuerier_AccountBalances() {
 	ctx, require := s.ctx, s.Require()