feat: add special asset pairs

CHANGELOG.md

@@ -51,6 +51,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - [2129](https://github.com/umee-network/umee/pull/2129) Emergency Group x/ugov proto.
 - [2146](https://github.com/umee-network/umee/pull/2146) Add store `GetTimeMs` and `SetTimeMs`.
 - [2157](https://github.com/umee-network/umee/pull/2157) Add `x/metoken` module.
+- [2150](https://github.com/umee-network/umee/pull/2150) Add gov message to create Special Asset Pairs
 - [2145](https://github.com/umee-network/umee/pull/2145) Add New `Inflation Parms` to x/ugov proto and added `inflation rate` change logic to umint
 - [2159](https://github.com/umee-network/umee/pull/2159) Add hard market cap for token emission.
 - [2155](https://github.com/umee-network/umee/pull/2155) `bpmath`: basis points math package.

proto/umee/leverage/v1/genesis.proto

@@ -26,6 +26,7 @@ message GenesisState {
     (gogoproto.nullable)     = false,
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   ];
+  repeated SpecialAssetPair special_pairs = 10 [(gogoproto.nullable) = false];
 }
 
 // AdjustedBorrow is a borrow struct used in the leverage module's genesis

proto/umee/leverage/v1/leverage.proto

@@ -249,3 +249,42 @@ message Token {
     (gogoproto.moretags) = "yaml:\"historic_medians\""
   ];
 }
+
+// SpecialAssetPair defines a special (increased) CollateralWeight used when a specified Collateral is used
+// to collateralize a specified Borrow. This association is one-way (so it does not work in reverse).
+message SpecialAssetPair {
+  option (gogoproto.equal) = true;
+
+  // Collateral base token denom.
+  string collateral = 1;
+
+  // Borrow base token denom.
+  string borrow = 2;
+
+  // Collateral Weight defines what portion of the total value of the asset
+  // can contribute to a users borrowing power. For special asset pairs, this
+  // also overrides the borrowed asset's collateral weight when evaluating borrow
+  // factor. Valid values: 0-1.
+  string collateral_weight = 3 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}
+
+// SpecialAssetSet defines a special (increased) CollateralWeight used when any of a set
+// of assets are used to borrow each other (except for looping). It is used in gov proposals
+// to create all the pairs that make up a set at once.
+message SpecialAssetSet {
+  option (gogoproto.equal) = true;
+
+  // Collateral or borrowed base token denoms.
+  repeated string assets = 1;
+
+  // Collateral Weight defines what portion of the total value of the assets
+  // can contribute to a users borrowing power, when borrowing within the set.
+  // Valid values: 0-1.
+  string collateral_weight = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.nullable)   = false
+  ];
+}

proto/umee/leverage/v1/query.proto

@@ -24,6 +24,12 @@ service Query {
     option (google.api.http).get = "/umee/leverage/v1/registered_tokens";
   }
 
+  // SpecialAssetPairs queries for all special asset pairs.
+  rpc SpecialAssetPairs(QuerySpecialAssetPairs)
+      returns (QuerySpecialAssetPairsResponse) {
+    option (google.api.http).get = "/umee/leverage/v1/special_asset_pairs";
+  }
+
   // MarketSummary queries a base asset's current borrowing and supplying conditions.
   rpc MarketSummary(QueryMarketSummary)
       returns (QueryMarketSummaryResponse) {
@@ -100,6 +106,19 @@ message QueryRegisteredTokensResponse {
   repeated Token registry = 1 [(gogoproto.nullable) = false];
 }
 
+// QuerySpecialAssetPairs defines the request structure for the SpecialAssetPairs
+// gRPC service handler.
+message QuerySpecialAssetPairs {
+  // denom can be used to query only pairs affecting a specific asset
+  string denom = 1;
+}
+
+// QuerySpecialAssetPairsResponse defines the response structure for the
+// SpecialAssetPairs gRPC service handler.
+message QuerySpecialAssetPairsResponse {
+  repeated SpecialAssetPair pairs = 1 [(gogoproto.nullable) = false];
+}
+
 // QueryMarketSummary defines the request structure for the MarketSummary gRPC service handler.
 message QueryMarketSummary {
   string denom = 1;

proto/umee/leverage/v1/tx.proto

@@ -66,6 +66,11 @@ service Msg {
   // GovUpdateRegistry adds new tokens to the token registry or
   // updates existing tokens with new settings.
   rpc GovUpdateRegistry(MsgGovUpdateRegistry) returns (MsgGovUpdateRegistryResponse);
+
+  // GovUpdateSpecialAssetPairs adds, updates, or removes special asset pairs. Note that a special asset
+  // pair can be removed by setting its special collateral weight to negative one. Also allows for the creation
+  // of sets of assets, where each asset in the set forms a special asset pair with all of the others.
+  rpc GovUpdateSpecialAssetPairs(MsgGovUpdateSpecialAssetPairs) returns (MsgGovUpdateSpecialAssetPairsResponse);
 }
 
 // MsgSupply represents a user's request to supply assets to the module.
@@ -266,3 +271,30 @@ message MsgGovUpdateRegistry {
 
 // MsgGovUpdateRegistryResponse defines the Msg/GovUpdateRegistry response type.
 message MsgGovUpdateRegistryResponse {}
+
+// MsgGovUpdateSpecialAssetPairs defines the Msg/GovUpdateSpecialAssetPairs request type.
+message MsgGovUpdateSpecialAssetPairs {
+  option (gogoproto.equal)            = true;
+  option (gogoproto.goproto_getters)  = false;
+  option (gogoproto.goproto_stringer) = false;
+  option (cosmos.msg.v1.signer)       = "authority";
+
+  // authority is the address of the governance account.
+  string authority = 1 [(cosmos_proto.scalar) = "cosmos.AddressString"];
+
+  // sets are bidirectional groups of special asset pairs. Creating a special asset
+  // set causes all assets in the set to have a certain collateral weight when borrowing
+  // against each other (but not looping with themselves). Overrides any existing
+  // special asset pairs between assets in the set. Using a collateral weight
+  // of zero will clear all existing special pairs in the set instead.
+  repeated SpecialAssetSet sets = 2 [(gogoproto.nullable) = false];
+
+  // pairs are new or updated special asset pairs. Updating a special asset pair's
+  // collateral weight to zero deletes the pair instead.
+  // These pairs will be applied after any sets above when passing a proposal,
+  // so they can be used for more granular control.
+  repeated SpecialAssetPair pairs = 3 [(gogoproto.nullable) = false];
+}
+
+// MsgGovUpdateSpecialAssetPairsResponse defines the Msg/GovUpdateSpecialAssetPairs response type.
+message MsgGovUpdateSpecialAssetPairsResponse {}

swagger/swagger.yaml

@@ -1281,6 +1281,81 @@ paths:
           type: string
       tags:
         - Query
+  /umee/leverage/v1/special_asset_pairs:
+    get:
+      summary: SpecialAssetPairs queries for all special asset pairs.
+      operationId: SpecialAssetPairs
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              pairs:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    collateral:
+                      type: string
+                      description: Collateral base token denom.
+                    borrow:
+                      type: string
+                      description: Borrow base token denom.
+                    collateral_weight:
+                      type: string
+                      description: >-
+                        Collateral Weight defines what portion of the total
+                        value of the asset
+
+                        can contribute to a users borrowing power. For special
+                        asset pairs, this
+
+                        also overrides the borrowed asset's collateral weight
+                        when evaluating borrow
+
+                        factor. Valid values: 0-1.
+                  description: >-
+                    SpecialAssetPair defines a special (increased)
+                    CollateralWeight used when a specified Collateral is used
+
+                    to collateralize a specified Borrow. This association is
+                    one-way (so it does not work in reverse).
+            description: >-
+              QuerySpecialAssetPairsResponse defines the response structure for
+              the
+
+              SpecialAssetPairs gRPC service handler.
+        default:
+          description: An unexpected error response.
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    type_url:
+                      type: string
+                    value:
+                      type: string
+                      format: byte
+      parameters:
+        - name: denom
+          description: denom can be used to query only pairs affecting a specific asset.
+          in: query
+          required: false
+          type: string
+      tags:
+        - Query
   /umee/historacle/v1/avg_price/{denom}:
     get:
       summary: QueryAvgPrice returns avg price of a given denom (required).
@@ -5098,6 +5173,42 @@ definitions:
     description: |-
       QueryRegisteredTokensResponse defines the response structure for the
       RegisteredTokens gRPC service handler.
+  umee.leverage.v1.QuerySpecialAssetPairsResponse:
+    type: object
+    properties:
+      pairs:
+        type: array
+        items:
+          type: object
+          properties:
+            collateral:
+              type: string
+              description: Collateral base token denom.
+            borrow:
+              type: string
+              description: Borrow base token denom.
+            collateral_weight:
+              type: string
+              description: >-
+                Collateral Weight defines what portion of the total value of the
+                asset
+
+                can contribute to a users borrowing power. For special asset
+                pairs, this
+
+                also overrides the borrowed asset's collateral weight when
+                evaluating borrow
+
+                factor. Valid values: 0-1.
+          description: >-
+            SpecialAssetPair defines a special (increased) CollateralWeight used
+            when a specified Collateral is used
+
+            to collateralize a specified Borrow. This association is one-way (so
+            it does not work in reverse).
+    description: |-
+      QuerySpecialAssetPairsResponse defines the response structure for the
+      SpecialAssetPairs gRPC service handler.
   umee.leverage.v1.RiskInfo:
     type: object
     properties:
@@ -5116,6 +5227,33 @@ definitions:
     description: >-
       RiskInfo defines a borrower's account health without requiring sdk.Dec
       formatting.
+  umee.leverage.v1.SpecialAssetPair:
+    type: object
+    properties:
+      collateral:
+        type: string
+        description: Collateral base token denom.
+      borrow:
+        type: string
+        description: Borrow base token denom.
+      collateral_weight:
+        type: string
+        description: >-
+          Collateral Weight defines what portion of the total value of the asset
+
+          can contribute to a users borrowing power. For special asset pairs,
+          this
+
+          also overrides the borrowed asset's collateral weight when evaluating
+          borrow
+
+          factor. Valid values: 0-1.
+    description: >-
+      SpecialAssetPair defines a special (increased) CollateralWeight used when
+      a specified Collateral is used
+
+      to collateralize a specified Borrow. This association is one-way (so it
+      does not work in reverse).
   umee.leverage.v1.Token:
     type: object
     properties:

x/leverage/client/cli/query.go

@@ -30,6 +30,7 @@ func GetQueryCmd() *cobra.Command {
 	cmd.AddCommand(
 		GetCmdQueryParams(),
 		GetCmdQueryRegisteredTokens(),
+		GetCmdQuerySpecialAssetPairs(),
 		GetCmdQueryMarketSummary(),
 		GetCmdQueryAccountBalances(),
 		GetCmdQueryAccountSummary(),
@@ -95,6 +96,34 @@ func GetCmdQueryRegisteredTokens() *cobra.Command {
 	return cmd
 }
 
+// GetCmdQuerySpecialAssetPairs creates a Cobra command to query for all
+// the special asset pairs in the x/leverage module.
+func GetCmdQuerySpecialAssetPairs() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "special-pairs",
+		Args:  cobra.RangeArgs(0, 1),
+		Short: "Query for all currently registered special asset pairs",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			queryClient := types.NewQueryClient(clientCtx)
+			req := &types.QuerySpecialAssetPairs{}
+			if len(args) > 0 {
+				req.Denom = args[0]
+			}
+			resp, err := queryClient.SpecialAssetPairs(cmd.Context(), req)
+			return cli.PrintOrErr(resp, err, clientCtx)
+		},
+	}
+
+	flags.AddQueryFlagsToCmd(cmd)
+
+	return cmd
+}
+
 // GetCmdQueryMarketSummary creates a Cobra command to query for the
 // Market Summary of a specific token.
 func GetCmdQueryMarketSummary() *cobra.Command {

x/leverage/client/tests/tests.go

@@ -94,6 +94,16 @@ func (s *IntegrationTests) TestLeverageScenario() {
 			},
 			ErrMsg: "",
 		},
+		{
+			Name:     "query special asset pairs",
+			Command:  cli.GetCmdQuerySpecialAssetPairs(),
+			Args:     []string{"uumee"},
+			Response: &types.QuerySpecialAssetPairsResponse{},
+			ExpectedResponse: &types.QuerySpecialAssetPairsResponse{
+				Pairs: []types.SpecialAssetPair{},
+			},
+			ErrMsg: "",
+		},
 		{
 			Name:     "query registered token info by base_denom",
 			Command:  cli.GetCmdQueryRegisteredTokens(),

x/leverage/keeper/genesis.go

@@ -43,6 +43,10 @@ func (k Keeper) InitGenesis(ctx sdk.Context, genState types.GenesisState) {
 	for _, rate := range genState.InterestScalars {
 		util.Panic(k.setInterestScalar(ctx, rate.Denom, rate.Scalar))
 	}
+
+	for _, pair := range genState.SpecialPairs {
+		util.Panic(k.SetSpecialAssetPair(ctx, pair))
+	}
 }
 
 // ExportGenesis returns the x/leverage module's exported genesis state.
@@ -57,6 +61,7 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState {
 		k.getAllBadDebts(ctx),
 		k.getAllInterestScalars(ctx),
 		k.GetAllUTokenSupply(ctx),
+		k.GetAllSpecialAssetPairs(ctx),
 	)
 }