Add collateral type to cdp (#629)

* add collateral type field to cdp and collateral param * fix upstream tests * fix simulations * fix validation logic * update incentive to use collateral type instead of denom * use collateral type instead of denom in cdp * remove unused code * address review comments
Kava-Labs · Aug 21, 2020 · daa1b2b · daa1b2b
1 parent 60d7f52
commit daa1b2b
Show file tree

Hide file tree

Showing 70 changed files with 1,101 additions and 809 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,6 +46,16 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 [\#578](https://github.com/Kava-Labs/kava/pulls/578) Add v0.3 compatible REST client that supports
 
+[\#629](https://github.com/Kava-Labs/kava/pulls/629) Add CDP collateral type as a field for CDPs and collateral parameters.
+
+### Breaking changes
+
+* CDPs have an additional field, Type, which is a string that represents the unique collateral type that this CDP holds. This enables, for example, a single denom such as 'bnb' to have two CDP types, 'bnb-a' and 'bnb-b'.
+* CollateralParam has an additional field, Type, which is a string that represents the collateral type of CDPs that this collateral parameter governs. It must be non-empty at genesis or when altering CDP fields. It is UNSAFE to alter the type of an existing collateral param using unchain governance.
+* CDP messages must specify the collateral type 'bnb-a', rather than the denom of the cdp.
+* In the incentive module, fields previously named `Denom` have been changed to `CollateralType`. Previously, 'Denom' was validated to check that it satisfied `sdk.ValidateDenom`, now, the validation checks that the `CollateralType` is not blank.
+* Incentive module messages now require the user to specify the collateral type ('bnb-a'), rather than the denom of the cdp ('bnb')
+
 ```plaintext
 /v0_3/node_info
 /v0_3/auth/accounts/<address>

diff --git a/rest_test/setup/setuptest.go b/rest_test/setup/setuptest.go
@@ -121,6 +121,7 @@ func sendBtcCdp() {
 		addr,
 		sdk.NewInt64Coin("btc", 200000000),
 		sdk.NewInt64Coin("usdx", 10000000),
+		"btc-a",
 	)
 
 	// helper methods for transactions
@@ -154,6 +155,7 @@ func sendXrpCdp() {
 		addr,
 		sdk.NewInt64Coin("xrp", 200000000),
 		sdk.NewInt64Coin("usdx", 10000000),
+		"xrp-a",
 	)
 
 	// helper methods for transactions

diff --git a/x/cdp/abci.go b/x/cdp/abci.go
@@ -31,12 +31,12 @@ func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, k Keeper) {
 			continue
 		}
 
-		err := k.UpdateFeesForAllCdps(ctx, cp.Denom)
+		err := k.UpdateFeesForAllCdps(ctx, cp.Type)
 		if err != nil {
 			panic(err)
 		}
 
-		err = k.LiquidateCdps(ctx, cp.LiquidationMarketID, cp.Denom, cp.LiquidationRatio)
+		err = k.LiquidateCdps(ctx, cp.LiquidationMarketID, cp.Type, cp.LiquidationRatio)
 		if err != nil && !errors.Is(err, pricefeedtypes.ErrNoValidPrice) {
 			panic(err)
 		}

diff --git a/x/cdp/abci_test.go b/x/cdp/abci_test.go
@@ -103,8 +103,8 @@ func (suite *ModuleTestSuite) createCdps() {
 				tracker.debt += int64(debt)
 			}
 		}
-		suite.Nil(suite.keeper.AddCdp(suite.ctx, addrs[j], c(collateral, int64(amount)), c("usdx", int64(debt))))
-		c, f := suite.keeper.GetCDP(suite.ctx, collateral, uint64(j+1))
+		suite.Nil(suite.keeper.AddCdp(suite.ctx, addrs[j], c(collateral, int64(amount)), c("usdx", int64(debt)), collateral+"-a"))
+		c, f := suite.keeper.GetCDP(suite.ctx, collateral+"-a", uint64(j+1))
 		suite.True(f)
 		cdps[j] = c
 	}
@@ -153,9 +153,9 @@ func (suite *ModuleTestSuite) TestBeginBlock() {
 }
 
 func (suite *ModuleTestSuite) TestSeizeSingleCdpWithFees() {
-	err := suite.keeper.AddCdp(suite.ctx, suite.addrs[0], c("xrp", 10000000000), c("usdx", 1000000000))
+	err := suite.keeper.AddCdp(suite.ctx, suite.addrs[0], c("xrp", 10000000000), c("usdx", 1000000000), "xrp-a")
 	suite.NoError(err)
-	suite.Equal(i(1000000000), suite.keeper.GetTotalPrincipal(suite.ctx, "xrp", "usdx"))
+	suite.Equal(i(1000000000), suite.keeper.GetTotalPrincipal(suite.ctx, "xrp-a", "usdx"))
 	sk := suite.app.GetSupplyKeeper()
 	cdpMacc := sk.GetModuleAccount(suite.ctx, cdp.ModuleName)
 	suite.Equal(i(1000000000), cdpMacc.GetCoins().AmountOf("debt"))
@@ -166,11 +166,11 @@ func (suite *ModuleTestSuite) TestSeizeSingleCdpWithFees() {
 
 	cdpMacc = sk.GetModuleAccount(suite.ctx, cdp.ModuleName)
 	suite.Equal(i(1000000900), (cdpMacc.GetCoins().AmountOf("debt")))
-	cdp, _ := suite.keeper.GetCDP(suite.ctx, "xrp", 1)
+	cdp, _ := suite.keeper.GetCDP(suite.ctx, "xrp-a", 1)
 
 	err = suite.keeper.SeizeCollateral(suite.ctx, cdp)
 	suite.NoError(err)
-	_, found := suite.keeper.GetCDP(suite.ctx, "xrp", 1)
+	_, found := suite.keeper.GetCDP(suite.ctx, "xrp-a", 1)
 	suite.False(found)
 }
 

diff --git a/x/cdp/alias.go b/x/cdp/alias.go
@@ -38,7 +38,7 @@ const (
 	QueryGetCdpsByCollateralization = types.QueryGetCdpsByCollateralization
 	QueryGetParams                  = types.QueryGetParams
 	RestOwner                       = types.RestOwner
-	RestCollateralDenom             = types.RestCollateralDenom
+	RestCollateralType              = types.RestCollateralType
 	RestRatio                       = types.RestRatio
 )
 

diff --git a/x/cdp/client/cli/query.go b/x/cdp/client/cli/query.go
@@ -26,8 +26,8 @@ func GetQueryCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 
 	cdpQueryCmd.AddCommand(flags.GetCommands(
 		QueryCdpCmd(queryRoute, cdc),
-		QueryCdpsByDenomCmd(queryRoute, cdc),
-		QueryCdpsByDenomAndRatioCmd(queryRoute, cdc),
+		QueryCdpsByCollateralTypeCmd(queryRoute, cdc),
+		QueryCdpsByCollateralTypeAndRatioCmd(queryRoute, cdc),
 		QueryCdpDepositsCmd(queryRoute, cdc),
 		QueryParamsCmd(queryRoute, cdc),
 		QueryGetAccounts(queryRoute, cdc),
@@ -39,13 +39,13 @@ func GetQueryCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 // QueryCdpCmd returns the command handler for querying a particular cdp
 func QueryCdpCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "cdp [owner-addr] [collateral-name]",
+		Use:   "cdp [owner-addr] [collateral-type]",
 		Short: "get info about a cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Get a CDP by the owner address and the collateral name.
 
 Example:
-$ %s query %s cdp kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw uatom
+$ %s query %s cdp kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw atom-a
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -57,8 +57,8 @@ $ %s query %s cdp kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw uatom
 				return err
 			}
 			bz, err := cdc.MarshalJSON(types.QueryCdpParams{
-				CollateralDenom: args[1],
-				Owner:           ownerAddress,
+				CollateralType: args[1],
+				Owner:          ownerAddress,
 			})
 			if err != nil {
 				return err
@@ -79,23 +79,23 @@ $ %s query %s cdp kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw uatom
 	}
 }
 
-// QueryCdpsByDenomCmd returns the command handler for querying cdps for a collateral type
-func QueryCdpsByDenomCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
+// QueryCdpsByCollateralTypeCmd returns the command handler for querying cdps for a collateral type
+func QueryCdpsByCollateralTypeCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "cdps [collateral-name]",
+		Use:   "cdps [collateral-type]",
 		Short: "query CDPs by collateral",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`List all CDPs collateralized with the specified asset.
 
 Example:
-$ %s query %s cdps uatom
+$ %s query %s cdps atom-a
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
 
 			// Prepare params for querier
-			bz, err := cdc.MarshalJSON(types.QueryCdpsParams{CollateralDenom: args[0]})
+			bz, err := cdc.MarshalJSON(types.QueryCdpsParams{CollateralType: args[0]})
 			if err != nil {
 				return err
 			}
@@ -115,18 +115,18 @@ $ %s query %s cdps uatom
 	}
 }
 
-// QueryCdpsByDenomAndRatioCmd returns the command handler for querying cdps
+// QueryCdpsByCollateralTypeAndRatioCmd returns the command handler for querying cdps
 // that are under the specified collateral ratio
-func QueryCdpsByDenomAndRatioCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
+func QueryCdpsByCollateralTypeAndRatioCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "cdps-by-ratio [collateral-name] [collateralization-ratio]",
+		Use:   "cdps-by-ratio [collateral-type] [collateralization-ratio]",
 		Short: "get cdps under a collateralization ratio",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`List all CDPs under a specified collateralization ratio.
 Collateralization ratio is: collateral * price / debt.
 
 Example:
-$ %s query %s cdps-by-ratio uatom 1.5
+$ %s query %s cdps-by-ratio atom-a 1.6
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -138,8 +138,8 @@ $ %s query %s cdps-by-ratio uatom 1.5
 				return err
 			}
 			bz, err := cdc.MarshalJSON(types.QueryCdpsByRatioParams{
-				CollateralDenom: args[0],
-				Ratio:           ratio,
+				CollateralType: args[0],
+				Ratio:          ratio,
 			})
 			if err != nil {
 				return err
@@ -163,13 +163,13 @@ $ %s query %s cdps-by-ratio uatom 1.5
 // QueryCdpDepositsCmd returns the command handler for querying the deposits of a particular cdp
 func QueryCdpDepositsCmd(queryRoute string, cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "deposits [owner-addr] [collateral-name]",
+		Use:   "deposits [owner-addr] [collateral-type]",
 		Short: "get deposits for a cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Get the deposits of a CDP.
 
 Example:
-$ %s query %s deposits kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw uatom
+$ %s query %s deposits kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw atom-a
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -181,8 +181,8 @@ $ %s query %s deposits kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw uatom
 				return err
 			}
 			bz, err := cdc.MarshalJSON(types.QueryCdpParams{
-				CollateralDenom: args[1],
-				Owner:           ownerAddress,
+				CollateralType: args[1],
+				Owner:          ownerAddress,
 			})
 			if err != nil {
 				return err

diff --git a/x/cdp/client/cli/tx.go b/x/cdp/client/cli/tx.go
@@ -39,15 +39,15 @@ func GetTxCmd(cdc *codec.Codec) *cobra.Command {
 // GetCmdCreateCdp returns the command handler for creating a cdp
 func GetCmdCreateCdp(cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "create [collateral] [debt]",
+		Use:   "create [collateral] [debt] [collateral-type]",
 		Short: "create a new cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Create a new cdp, depositing some collateral and drawing some debt.
 
 Example:
-$ %s tx %s create 10000000uatom 1000usdx --from myKeyName
+$ %s tx %s create 10000000uatom 1000usdx atom-a --from myKeyName
 `, version.ClientName, types.ModuleName)),
-		Args: cobra.ExactArgs(2),
+		Args: cobra.ExactArgs(3),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			inBuf := bufio.NewReader(cmd.InOrStdin())
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
@@ -61,7 +61,7 @@ $ %s tx %s create 10000000uatom 1000usdx --from myKeyName
 			if err != nil {
 				return err
 			}
-			msg := types.NewMsgCreateCDP(cliCtx.GetFromAddress(), collateral, debt)
+			msg := types.NewMsgCreateCDP(cliCtx.GetFromAddress(), collateral, debt, args[2])
 			err = msg.ValidateBasic()
 			if err != nil {
 				return err
@@ -74,15 +74,15 @@ $ %s tx %s create 10000000uatom 1000usdx --from myKeyName
 // GetCmdDeposit cli command for depositing to a cdp.
 func GetCmdDeposit(cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "deposit [owner-addr] [collateral]",
+		Use:   "deposit [owner-addr] [collateral] [collateral-type]",
 		Short: "deposit collateral to an existing cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Add collateral to an existing cdp.
 
 Example:
-$ %s tx %s deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --from myKeyName
+$ %s tx %s deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName
 `, version.ClientName, types.ModuleName)),
-		Args: cobra.ExactArgs(2),
+		Args: cobra.ExactArgs(3),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			inBuf := bufio.NewReader(cmd.InOrStdin())
 			cliCtx := context.NewCLIContext().WithCodec(cdc)
@@ -96,7 +96,7 @@ $ %s tx %s deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --f
 			if err != nil {
 				return err
 			}
-			msg := types.NewMsgDeposit(owner, cliCtx.GetFromAddress(), collateral)
+			msg := types.NewMsgDeposit(owner, cliCtx.GetFromAddress(), collateral, args[2])
 			err = msg.ValidateBasic()
 			if err != nil {
 				return err
@@ -109,13 +109,13 @@ $ %s tx %s deposit kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --f
 // GetCmdWithdraw cli command for withdrawing from a cdp.
 func GetCmdWithdraw(cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "withdraw [owner-addr] [collateral]",
+		Use:   "withdraw [owner-addr] [collateral] [collateral-type]",
 		Short: "withdraw collateral from an existing cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Remove collateral from an existing cdp.
 
 Example:
-$ %s tx %s withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --from myKeyName
+$ %s tx %s withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom atom-a --from myKeyName
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -131,7 +131,7 @@ $ %s tx %s withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --
 			if err != nil {
 				return err
 			}
-			msg := types.NewMsgWithdraw(owner, cliCtx.GetFromAddress(), collateral)
+			msg := types.NewMsgWithdraw(owner, cliCtx.GetFromAddress(), collateral, args[2])
 			err = msg.ValidateBasic()
 			if err != nil {
 				return err
@@ -144,13 +144,13 @@ $ %s tx %s withdraw kava15qdefkmwswysgg4qxgqpqr35k3m49pkx2jdfnw 10000000uatom --
 // GetCmdDraw cli command for depositing to a cdp.
 func GetCmdDraw(cdc *codec.Codec) *cobra.Command {
 	return &cobra.Command{
-		Use:   "draw [collateral-name] [debt]",
+		Use:   "draw [collateral-type] [debt]",
 		Short: "draw debt off an existing cdp",
 		Long: strings.TrimSpace(
 			fmt.Sprintf(`Create debt in an existing cdp and send the newly minted asset to your account.
 
 Example:
-$ %s tx %s draw uatom 1000usdx --from myKeyName
+$ %s tx %s draw atom-a 1000usdx --from myKeyName
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -181,7 +181,7 @@ func GetCmdRepay(cdc *codec.Codec) *cobra.Command {
 			fmt.Sprintf(`Cancel out debt in an existing cdp.
 
 Example:
-$ %s tx %s repay uatom 1000usdx --from myKeyName
+$ %s tx %s repay atom-a 1000usdx --from myKeyName
 `, version.ClientName, types.ModuleName)),
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {