feat!: allow amount-specific control of collateral

CHANGELOG.md

@@ -48,6 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### API Breaking
 
+- [1029](https://github.com/umee-network/umee/pull/1029) Removed MsgSetCollateral(addr,denom,bool), and replaced with MsgAddCollateral(addr,coin) and MsgRemoveCollateral(addr,coin)
 - [1023](https://github.com/umee-network/umee/pull/1023) Restrict MsgWithdraw to only uToken input (no base token auto-convert)
 
 ### Features

proto/umee/leverage/v1/genesis.proto

@@ -9,20 +9,18 @@ import "gogoproto/gogo.proto";
 
 // GenesisState defines the x/leverage module's genesis state.
 message GenesisState {
-  Params                     params              = 1 [(gogoproto.nullable) = false];
-  repeated Token             registry            = 2 [(gogoproto.nullable) = false];
-  repeated AdjustedBorrow    adjusted_borrows    = 3 [(gogoproto.nullable) = false];
-  repeated CollateralSetting collateral_settings = 4
-      [(gogoproto.nullable) = false];
-  repeated Collateral collateral             = 5 [(gogoproto.nullable) = false];
-  repeated cosmos.base.v1beta1.Coin reserves = 6 [
+  Params                  params             = 1 [(gogoproto.nullable) = false];
+  repeated Token          registry           = 2 [(gogoproto.nullable) = false];
+  repeated AdjustedBorrow adjusted_borrows   = 3 [(gogoproto.nullable) = false];
+  repeated Collateral     collateral         = 4 [(gogoproto.nullable) = false];
+  repeated cosmos.base.v1beta1.Coin reserves = 5 [
     (gogoproto.nullable)     = false,
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   ];
-  int64                   last_interest_time      = 7;
-  repeated BadDebt        bad_debts               = 8 [(gogoproto.nullable) = false];
-  repeated InterestScalar interest_scalars        = 9 [(gogoproto.nullable) = false];
-  repeated cosmos.base.v1beta1.Coin utoken_supply = 10 [
+  int64                   last_interest_time      = 6;
+  repeated BadDebt        bad_debts               = 7 [(gogoproto.nullable) = false];
+  repeated InterestScalar interest_scalars        = 8 [(gogoproto.nullable) = false];
+  repeated cosmos.base.v1beta1.Coin utoken_supply = 9 [
     (gogoproto.nullable)     = false,
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   ];
@@ -35,13 +33,6 @@ message AdjustedBorrow {
   cosmos.base.v1beta1.DecCoin amount  = 2 [(gogoproto.nullable) = false];
 }
 
-// CollateralSetting is a collateral setting struct used in the leverage
-// module's genesis state.
-message CollateralSetting {
-  string address = 1;
-  string denom   = 2;
-}
-
 // Collateral is a collateral struct used in the leverage module's genesis
 // state.
 message Collateral {

proto/umee/leverage/v1/query.proto

@@ -89,13 +89,6 @@ service Query {
     option (google.api.http).get = "/umee/leverage/v1/reserve_amount";
   }
 
-  // CollateralSetting queries a borrower's collateral setting (enabled or
-  // disabled) for a specified uToken denomination.
-  rpc CollateralSetting(QueryCollateralSettingRequest)
-      returns (QueryCollateralSettingResponse) {
-    option (google.api.http).get = "/umee/leverage/v1/collateral_setting";
-  }
-
   // Collateral queries the collateral amount of a user by token denomination.
   // If the denomination is not supplied, all of the user's collateral tokens
   // are returned.
@@ -334,19 +327,6 @@ message QueryReserveAmountResponse {
   ];
 }
 
-// QueryCollateralSettingsRequest defines the request structure for the
-// CollateralSetting gRPC service handler.
-message QueryCollateralSettingRequest {
-  string address = 1;
-  string denom   = 2;
-}
-
-// QueryCollateralSettingsResponse defines the response structure for the
-// CollateralSetting gRPC service handler.
-message QueryCollateralSettingResponse {
-  bool enabled = 1;
-}
-
 // QueryCollateralRequest defines the request structure for the Collateral gRPC
 // service handler.
 message QueryCollateralRequest {

proto/umee/leverage/v1/tx.proto

@@ -15,9 +15,13 @@ service Msg {
   // the capital facility.
   rpc WithdrawAsset(MsgWithdrawAsset) returns (MsgWithdrawAssetResponse);
 
-  // SetCollateral defines a method for users to enable or disable a uToken
-  // denomination in their wallet for use as collateral.
-  rpc SetCollateral(MsgSetCollateral) returns (MsgSetCollateralResponse);
+  // AddCollateral defines a method for users to enable selected uTokens
+  // as collateral.
+  rpc AddCollateral(MsgAddCollateral) returns (MsgAddCollateralResponse);
+
+  // RemoveCollateral defines a method for users to disable selected uTokens
+  // as collateral.
+  rpc RemoveCollateral(MsgRemoveCollateral) returns (MsgRemoveCollateralResponse);
 
   // BorrowAsset defines a method for borrowing coins from the capital facility.
   rpc BorrowAsset(MsgBorrowAsset) returns (MsgBorrowAssetResponse);
@@ -45,12 +49,18 @@ message MsgWithdrawAsset {
   cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.nullable) = false];
 }
 
-// MsgSetCollateral represents a lender's request to enable or disable
-// a uToken type in their possession as collateral.
-message MsgSetCollateral {
-  string borrower = 1;
-  string denom    = 2;
-  bool   enable   = 3;
+// MsgAddCollateral represents a lender's request to enable selected
+// uTokens as collateral.
+message MsgAddCollateral {
+  string                   borrower = 1;
+  cosmos.base.v1beta1.Coin coin     = 2 [(gogoproto.nullable) = false];
+}
+
+// MsgRemoveCollateral represents a lender's request to disable selected
+// uTokens as collateral.
+message MsgRemoveCollateral {
+  string                   borrower = 1;
+  cosmos.base.v1beta1.Coin coin     = 2 [(gogoproto.nullable) = false];
 }
 
 // MsgBorrowAsset represents a lender's request to borrow a base asset type
@@ -82,8 +92,11 @@ message MsgLendAssetResponse {}
 // MsgWithdrawAssetResponse defines the Msg/WithdrawAsset response type.
 message MsgWithdrawAssetResponse {}
 
-// MsgSetCollateralResponse defines the Msg/SetCollateral response type.
-message MsgSetCollateralResponse {}
+// MsgAddCollateralResponse defines the Msg/AddCollateral response type.
+message MsgAddCollateralResponse {}
+
+// MsgRemoveCollateralResponse defines the Msg/RemoveCollateral response type.
+message MsgRemoveCollateralResponse {}
 
 // MsgBorrowAssetResponse defines the Msg/BorrowAsset response type.
 message MsgBorrowAssetResponse {}

x/leverage/client/cli/query.go

@@ -35,7 +35,6 @@ func GetQueryCmd(queryRoute string) *cobra.Command {
 		GetCmdQueryReserveAmount(),
 		GetCmdQueryCollateral(),
 		GetCmdQueryCollateralValue(),
-		GetCmdQueryCollateralSetting(),
 		GetCmdQueryExchangeRate(),
 		GetCmdQueryLendAPY(),
 		GetCmdQueryBorrowAPY(),
@@ -289,40 +288,6 @@ func GetCmdQueryReserveAmount() *cobra.Command {
 	return cmd
 }
 
-// GetCmdQueryCollateralSetting creates a Cobra command to query for the collateral
-// setting of a specific token denom for an address.
-func GetCmdQueryCollateralSetting() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "collateral-setting [addr] [denom]",
-		Args:  cobra.ExactArgs(2),
-		Short: "Query for the collateral setting of a specific denom for an address",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			clientCtx, err := client.GetClientQueryContext(cmd)
-			if err != nil {
-				return err
-			}
-
-			queryClient := types.NewQueryClient(clientCtx)
-
-			req := &types.QueryCollateralSettingRequest{
-				Address: args[0],
-				Denom:   args[1],
-			}
-
-			resp, err := queryClient.CollateralSetting(cmd.Context(), req)
-			if err != nil {
-				return err
-			}
-
-			return clientCtx.PrintProto(resp)
-		},
-	}
-
-	flags.AddQueryFlagsToCmd(cmd)
-
-	return cmd
-}
-
 // GetCmdQueryCollateral creates a Cobra command to query for the amount of
 // total collateral tokens for a given address.
 func GetCmdQueryCollateral() *cobra.Command {

x/leverage/client/cli/tx.go

@@ -2,7 +2,6 @@ package cli
 
 import (
 	"fmt"
-	"strconv"
 	"strings"
 
 	"github.com/cosmos/cosmos-sdk/client"
@@ -28,7 +27,8 @@ func GetTxCmd() *cobra.Command {
 	cmd.AddCommand(
 		GetCmdLendAsset(),
 		GetCmdWithdrawAsset(),
-		GetCmdSetCollateral(),
+		GetCmdAddCollateral(),
+		GetCmdRemoveCollateral(),
 		GetCmdBorrowAsset(),
 		GetCmdRepayAsset(),
 		GetCmdLiquidate(),
@@ -103,13 +103,13 @@ func GetCmdWithdrawAsset() *cobra.Command {
 	return cmd
 }
 
-// GetCmdSetCollateral creates a Cobra command to generate or broadcast a
-// transaction with a MsgSetCollateral message.
-func GetCmdSetCollateral() *cobra.Command {
+// GetCmdAddCollateral creates a Cobra command to generate or broadcast a
+// transaction with a MsgAddCollateral message.
+func GetCmdAddCollateral() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "set-collateral [borrower] [denom] [toggle]",
-		Args:  cobra.ExactArgs(3),
-		Short: "Enable or disable an asset type to be used as collateral",
+		Use:   "add-collateral [borrower] [coin]",
+		Args:  cobra.ExactArgs(2),
+		Short: "Add uTokens as collateral",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := cmd.Flags().Set(flags.FlagFrom, args[0]); err != nil {
 				return err
@@ -120,12 +120,49 @@ func GetCmdSetCollateral() *cobra.Command {
 				return err
 			}
 
-			toggle, err := strconv.ParseBool(args[2])
+			coin, err := sdk.ParseCoinNormalized(args[1])
+			if err != nil {
+				return err
+			}
+			msg := types.NewMsgAddCollateral(clientCtx.GetFromAddress(), coin)
+			if err = msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+
+	flags.AddTxFlagsToCmd(cmd)
+
+	return cmd
+}
+
+// GetCmdRemoveCollateral returns a CLI command handler to generate or broadcast a
+// transaction with a MsgRemoveCollateral message.
+func GetCmdRemoveCollateral() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "remove-collateral [borrower] [coin]",
+		Args:  cobra.ExactArgs(2),
+		Short: "Remove uTokens from collateral",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if err := cmd.Flags().Set(flags.FlagFrom, args[0]); err != nil {
+				return err
+			}
+
+			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
-				return fmt.Errorf("failed to parse toggle: %w", err)
+				return err
 			}
 
-			msg := types.NewMsgSetCollateral(clientCtx.GetFromAddress(), args[1], toggle)
+			coin, err := sdk.ParseCoinNormalized(args[1])
+			if err != nil {
+				return err
+			}
+			msg := types.NewMsgRemoveCollateral(clientCtx.GetFromAddress(), coin)
+			if err = msg.ValidateBasic(); err != nil {
+				return err
+			}
 
 			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
 		},