feat: add inspector queries

.golangci.yml

@@ -20,7 +20,7 @@ linters:
     # - wsl
     - asciicheck
     - bodyclose
-    - depguard
+    # - depguard
     - dogsled
     - errcheck
     - exportloopref

proto/umee/leverage/v1/inspector.proto

@@ -0,0 +1,152 @@
+syntax = "proto3";
+package umee.leverage.v1;
+
+import "gogoproto/gogo.proto";
+import "cosmos/base/v1beta1/coin.proto";
+
+option go_package = "github.com/umee-network/umee/v5/x/leverage/types";
+
+option (gogoproto.goproto_getters_all) = false;
+
+// QueryInspect defines the request structure for the Inspect gRPC service handler.
+message QueryInspect {
+  // Mode is a string which selects the logic behind the inspector query.
+  string mode = 1;
+  // Symbol optionally selects a symbol denom for query modes that allow one to be specified.
+  string symbol = 2;
+  // Sort is an optional string which controls how accounts are sorted.
+  string sort = 3;
+  // Mode minimum is the mode value below which accounts will be filtered. For example,
+  // in collateral mode this is the minimum collateral value an account must have to
+  // be displayed.
+  string mode_min = 4 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Sort minimum is the sorted value below which accounts will be filtered. For example,
+  // in risk mode this is the minimum LTV an account must have to be displayed.
+  string sort_min = 5 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// QueryInspectNeat defines the request structure for the InspectNeat gRPC service handler.
+message QueryInspectNeat {
+  // Mode is a string which selects the logic behind the inspector query.
+  string mode = 1;
+  // Symbol optionally selects a symbol denom for query modes that allow one to be specified.
+  string symbol = 2;
+  // Sort is an optional string which controls how accounts are sorted.
+  string sort = 3;
+  // Mode minimum is the mode value below which accounts will be filtered. For example,
+  // in collateral mode this is the minimum collateral value an account must have to
+  // be displayed.
+  string mode_min = 4 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Sort minimum is the sorted value below which accounts will be filtered. For example,
+  // in risk mode this is the minimum LTV an account must have to be displayed.
+  string sort_min = 5 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// QueryRiskData defines the request structure for the RiskData gRPC service handler.
+message QueryRiskData {}
+
+// QueryInspectResponse defines the response structure for the Inspect gRPC service handler.
+message QueryInspectResponse {
+  repeated BorrowerSummary borrowers = 1 [
+    (gogoproto.nullable) = false
+  ];
+}
+
+// QueryInspectNeatResponse defines the response structure for the InspectNeat gRPC service handler.
+message QueryInspectNeatResponse {
+  repeated BorrowerSummaryNeat borrowers = 1 [
+    (gogoproto.nullable) = false
+  ];
+}
+
+// QueryRiskDataResponse defines the response structure for the RiskData gRPC service handler.
+message QueryRiskDataResponse {
+  repeated AccountSymbolBalances borrowers = 1 [
+    (gogoproto.nullable) = false
+  ];
+}
+
+// BorrowerSummary defines a borrower's address and account health.
+message BorrowerSummary {
+  string address = 1;
+  // Supplied Value is the total USD value of all tokens the account has supplied, includng interest earned.
+  string supplied_value = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Collateral Value is the total USD value of the account's collateral.
+  string collateral_value = 3 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Borrowed Value is the total USD value of all tokens the account has borrowed, including interest owed.
+  string borrowed_value = 4 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Borrow Limit is the maximum Borrowed Value the account is allowed to reach through direct borrowing.
+  string borrow_limit = 5 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // Liquidation Threshold is the Borrowed Value at which the account becomes eligible for liquidation.
+  string liquidation_threshold = 6 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // SpecificCollateralValue is the amount of Collateral Value which is the result of a specified collateral denom.
+  string specific_collateral_value = 7 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+  // SpecificBorrowValue is the amount of Borrowed Value which is the result of a specified borrowed denom.
+  string specific_borrow_value = 8 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// BorrowerSummaryNeat defines a borrower's address and account health without requiring sdk.Dec formatting
+message BorrowerSummaryNeat {
+  string Account = 1;
+  // Borrowed is account's borrowed value, either in total or just a specified denom.
+  double Borrowed = 2;
+  // X is borrowed value as a portion of borrow limit.
+  double X = 3;
+  // Y is borrowed value as a portion of liquidation threshold.
+  double Y = 4;
+  // Z is the borrowed value as a portion of collateral value.
+  double Z = 5;
+}
+
+// AccountSymbolBalances contains an account's position denoted in symbol denom tokens.
+message AccountSymbolBalances {
+  string Account = 1;
+  // Supplied contains all tokens the account has supplied, including interest earned.
+  repeated cosmos.base.v1beta1.DecCoin supplied = 2 [
+    (gogoproto.nullable)     = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"
+  ];
+  // Collateral contains all uTokens the account has collateralized. It has been converted from uTokens to tokens.
+  repeated cosmos.base.v1beta1.DecCoin collateral = 3 [
+    (gogoproto.nullable)     = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"
+  ];
+  // Borrowed contains all tokens the account has borrowed, including interest owed.
+  repeated cosmos.base.v1beta1.DecCoin borrowed = 4 [
+    (gogoproto.nullable)     = false,
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.DecCoins"
+  ];
+}

proto/umee/leverage/v1/query.proto

@@ -7,6 +7,8 @@ import "umee/leverage/v1/leverage.proto";
 import "gogoproto/gogo.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
+import "umee/leverage/v1/inspector.proto";
+
 option go_package = "github.com/umee-network/umee/v5/x/leverage/types";
 
 option (gogoproto.goproto_getters_all) = false;
@@ -65,6 +67,26 @@ service Query {
       returns (QueryMaxBorrowResponse) {
     option (google.api.http).get = "/umee/leverage/v1/max_borrow";
   }
+
+  // Inspect is the customizable inspector query.
+  rpc Inspect(QueryInspect)
+      returns (QueryInspectResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/inspect";
+  }
+
+  // InspectNeat is the inspector query, with a different response structure
+  // optimized for human readability on the CLI.
+  rpc InspectNeat(QueryInspectNeat)
+      returns (QueryInspectNeatResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/inspect_neat";
+  }
+
+  // RiskData returns filtered and sorted account balances by symbol
+  // denom for all qualifying accounts.
+  rpc RiskData(QueryRiskData)
+      returns (QueryRiskDataResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/risk_data";
+  }
 }
 
 // QueryParams defines the request structure for the Params gRPC service