feat: add MarketSummary query (backport #894) (#900)

* feat: add MarketSummary query (#894)

* feat: add MarketSummary query

(cherry picked from commit 0ecf33c)

# Conflicts:
#	x/leverage/types/query.pb.go
#	x/leverage/types/query.pb.gw.go

* proto gen

Co-authored-by: toteki <63419657+toteki@users.noreply.github.com>

CHANGELOG.md

@@ -49,6 +49,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Features
 
 - [860](https://github.com/umee-network/umee/pull/860) Add IBC upgrade and upgrade-client gov proposals.
+- [894](https://github.com/umee-network/umee/pull/894) Add MarketSummary query
 
 ### Improvements
 

proto/umee/leverage/v1beta1/query.proto

@@ -120,6 +120,11 @@ service Query {
   rpc LiquidationTargets(QueryLiquidationTargetsRequest) returns (QueryLiquidationTargetsResponse) {
     option (google.api.http).get = "/umee/leverage/v1beta1/liquidation_targets";
   }
+
+  // MarketSummary queries a base asset's current borrowing and lending conditions.
+  rpc MarketSummary(QueryMarketSummaryRequest) returns (QueryMarketSummaryResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/market_summary";
+  }
 }
 
 // QueryRegisteredTokens defines the request structure for the RegisteredTokens
@@ -356,3 +361,30 @@ message QueryLiquidationTargetsRequest {}
 message QueryLiquidationTargetsResponse {
   repeated string targets = 1;
 }
+
+// QueryMarketSummaryRequest defines the request structure for the
+// MarketSummary gRPC service handler.
+message QueryMarketSummaryRequest {
+  string denom = 1;
+}
+
+// QueryMarketSummaryResponse defines the response structure for the
+// MarketSummary gRPC service handler.
+message QueryMarketSummaryResponse {
+  string symbol_denom = 1;
+  uint32 exponent = 2;
+  string oracle_price = 3
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = true];
+  string uToken_exchange_rate = 4
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string lend_APY = 5
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string borrow_APY = 6
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string market_size = 7
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
+  string available_borrow = 8
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
+  string reserved = 9
+  [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
+}

x/leverage/keeper/grpc_query.go

@@ -558,3 +558,45 @@ func (q Querier) LiquidationTargets(
 
 	return &types.QueryLiquidationTargetsResponse{Targets: stringTargets}, nil
 }
+
+func (q Querier) MarketSummary(
+	goCtx context.Context,
+	req *types.QueryMarketSummaryRequest,
+) (*types.QueryMarketSummaryResponse, error) {
+	if req == nil {
+		return nil, status.Error(codes.InvalidArgument, "empty request")
+	}
+	if req.Denom == "" {
+		return nil, status.Error(codes.InvalidArgument, "invalid denom")
+	}
+
+	ctx := sdk.UnwrapSDKContext(goCtx)
+
+	token, err := q.Keeper.GetRegisteredToken(ctx, req.Denom)
+	if err != nil {
+		return nil, status.Error(codes.InvalidArgument, "not accepted Token denom")
+	}
+	rate := q.Keeper.DeriveExchangeRate(ctx, req.Denom)
+	lendAPY := q.Keeper.DeriveLendAPY(ctx, req.Denom)
+	borrowAPY := q.Keeper.DeriveBorrowAPY(ctx, req.Denom)
+	marketSizeCoin, _ := q.Keeper.GetTotalLoaned(ctx, req.Denom)
+	availableBorrow := q.Keeper.GetAvailableToBorrow(ctx, req.Denom)
+	reserved := q.Keeper.GetReserveAmount(ctx, req.Denom)
+
+	resp := types.QueryMarketSummaryResponse{
+		SymbolDenom:        token.SymbolDenom,
+		Exponent:           token.Exponent,
+		UTokenExchangeRate: rate,
+		Lend_APY:           lendAPY,
+		Borrow_APY:         borrowAPY,
+		MarketSize:         marketSizeCoin.Amount,
+		AvailableBorrow:    availableBorrow,
+		Reserved:           reserved,
+	}
+
+	if oraclePrice, oracleErr := q.Keeper.TokenPrice(ctx, req.Denom); oracleErr == nil {
+		resp.OraclePrice = &oraclePrice
+	}
+
+	return &resp, nil
+}

x/leverage/spec/03_queries.md

@@ -14,6 +14,7 @@ Queries on accepted asset types:
 - **Exchange Rate** queries the [uToken Exchange Rate](01_concepts.md#uToken-Exchange-Rate) of a given uToken denomination.
 - **Market Size** queries the [Market Size](01_concepts.md#Market-Size) of a specified denomination.
 - **Token Market Size** queries the [Market Size](01_concepts.md#Market-Size) of a specified denomination, but denominated in base tokens instead of USD. This amounts to _total loaned by all lenders + interest accrued._
+- **Market Summary** combines several asset-specifying queries for more efficient frontend access.
 
 Queries on account addresses:
 - **Borrowed** queries for the amount of a given token denomination borrowed by a user. If a denomination is not supplied, the total for each borrowed token is returned.