Merge pull request #277 from terra-money/feat/update-weight-ranges

Feat/update weight ranges
terra-money · Nov 13, 2023 · 8439e9f · 8439e9f
2 parents 5c1938d + 5b8534e
commit 8439e9f
Show file tree

Hide file tree

Showing 15 changed files with 262 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -6,8 +6,7 @@
   ·
   <a href="https://docs.alliance.terra.money/guides/get-started">Integration Guide</a>
   ·
-    <a href="https://docs.alliance.terra.money/alliance-audit.pdf">Code Audit</a>
-
+  <a href="https://github.com/terra-money/alliance/blob/main/audit/alliance-audit-v1.0.pdf">Code Audit</a>
 </p>
 
 <br/>

diff --git a/audit/alliance-audit-v1.0.pdf b/audit/alliance-audit-v1.0.pdf
diff --git a/docs/proto/proto-docs.md b/docs/proto/proto-docs.md
@@ -644,6 +644,7 @@ GenesisState defines the module's genesis state.
 | `take_rate` | [string](#string) |  |  |
 | `reward_change_rate` | [string](#string) |  |  |
 | `reward_change_interval` | [google.protobuf.Duration](#google.protobuf.Duration) |  |  |
+| `reward_weight_range` | [RewardWeightRange](#alliance.alliance.RewardWeightRange) |  | set a bound of weight range to limit how much reward weights can scale. |
 
 
 
@@ -1368,6 +1369,7 @@ Params
 | `take_rate` | [string](#string) |  |  |
 | `reward_change_rate` | [string](#string) |  |  |
 | `reward_change_interval` | [google.protobuf.Duration](#google.protobuf.Duration) |  |  |
+| `reward_weight_range` | [RewardWeightRange](#alliance.alliance.RewardWeightRange) |  | set a bound of weight range to limit how much reward weights can scale. |
 
 
 

diff --git a/proto/alliance/alliance/gov.proto b/proto/alliance/alliance/gov.proto
@@ -80,6 +80,10 @@ message MsgUpdateAllianceProposal {
       (gogoproto.stdduration) = true
     ];
 
+    // set a bound of weight range to limit how much reward weights can scale.
+    RewardWeightRange reward_weight_range = 8 [
+      (gogoproto.nullable)   = false
+    ];
 }
 
 message MsgDeleteAllianceProposal {

diff --git a/proto/alliance/alliance/tx.proto b/proto/alliance/alliance/tx.proto
@@ -157,6 +157,11 @@ message MsgUpdateAlliance {
     (gogoproto.nullable)   = false,
     (gogoproto.stdduration) = true
   ];
+
+  // set a bound of weight range to limit how much reward weights can scale.
+  RewardWeightRange reward_weight_range = 7 [
+    (gogoproto.nullable)   = false
+  ];
 }
 
 message MsgUpdateAllianceResponse {}

diff --git a/x/alliance/client/cli/gov.go b/x/alliance/client/cli/gov.go
@@ -118,7 +118,7 @@ func CreateAlliance() *cobra.Command {
 
 func UpdateAlliance() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "update-alliance denom reward-weight take-rate reward-change-rate reward-change-interval",
+		Use:   "update-alliance denom reward-weight reward-weight-min reward-weight-max take-rate reward-change-rate reward-change-interval",
 		Args:  cobra.ExactArgs(5),
 		Short: "Update an alliance with the specified parameters",
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -143,6 +143,16 @@ func UpdateAlliance() *cobra.Command {
 				return err
 			}
 
+			rewardWeightMin, err := sdk.NewDecFromStr(args[2])
+			if err != nil {
+				return err
+			}
+
+			rewardWeightMax, err := sdk.NewDecFromStr(args[3])
+			if err != nil {
+				return err
+			}
+
 			takeRate, err := sdk.NewDecFromStr(args[2])
 			if err != nil {
 				return err
@@ -175,6 +185,10 @@ func UpdateAlliance() *cobra.Command {
 				description,
 				denom,
 				rewardWeight,
+				types.RewardWeightRange{
+					Min: rewardWeightMin,
+					Max: rewardWeightMax,
+				},
 				takeRate,
 				rewardChangeRate,
 				rewardChangeInterval,

diff --git a/x/alliance/keeper/asset.go b/x/alliance/keeper/asset.go
@@ -82,6 +82,7 @@ func (k Keeper) UpdateAllianceAsset(ctx sdk.Context, newAsset types.AllianceAsse
 	asset.RewardChangeRate = newAsset.RewardChangeRate
 	asset.RewardChangeInterval = newAsset.RewardChangeInterval
 	asset.LastRewardChangeTime = newAsset.LastRewardChangeTime
+	asset.RewardWeightRange = newAsset.RewardWeightRange
 	k.SetAsset(ctx, asset)
 
 	return nil

diff --git a/x/alliance/keeper/msg_server.go b/x/alliance/keeper/msg_server.go
@@ -189,6 +189,7 @@ func (m MsgServer) UpdateAlliance(ctx context.Context, msg *types.MsgUpdateAllia
 	if !found {
 		return nil, types.ErrUnknownAsset
 	}
+	asset.RewardWeightRange = msg.RewardWeightRange
 	if asset.RewardWeightRange.Min.GT(msg.RewardWeight) || asset.RewardWeightRange.Max.LT(msg.RewardWeight) {
 		return nil, types.ErrRewardWeightOutOfBound
 	}

diff --git a/x/alliance/keeper/proposal.go b/x/alliance/keeper/proposal.go
@@ -28,6 +28,7 @@ func (k Keeper) UpdateAlliance(ctx context.Context, req *types.MsgUpdateAlliance
 		RewardWeight:         req.RewardWeight,
 		TakeRate:             req.TakeRate,
 		RewardChangeRate:     req.RewardChangeRate,
+		RewardWeightRange:    req.RewardWeightRange,
 		RewardChangeInterval: req.RewardChangeInterval,
 	})
 	return err

diff --git a/x/alliance/keeper/tests/asset_test.go b/x/alliance/keeper/tests/asset_test.go
@@ -741,6 +741,7 @@ func TestRewardWeightDecay(t *testing.T) {
 		Description:          "",
 		Denom:                AllianceDenom,
 		RewardWeight:         sdk.MustNewDecFromStr("0.5"),
+		RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)},
 		TakeRate:             sdk.ZeroDec(),
 		RewardChangeRate:     sdk.ZeroDec(),
 		RewardChangeInterval: 0,
@@ -753,6 +754,7 @@ func TestRewardWeightDecay(t *testing.T) {
 		Description:          "",
 		Denom:                AllianceDenom,
 		RewardWeight:         sdk.MustNewDecFromStr("0.5"),
+		RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)},
 		TakeRate:             sdk.ZeroDec(),
 		RewardChangeRate:     sdk.MustNewDecFromStr("0.1"),
 		RewardChangeInterval: decayInterval,
@@ -779,6 +781,7 @@ func TestRewardWeightDecay(t *testing.T) {
 		Description:          "",
 		Denom:                AllianceDenomTwo,
 		RewardWeight:         sdk.MustNewDecFromStr("0.5"),
+		RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)},
 		TakeRate:             sdk.ZeroDec(),
 		RewardChangeRate:     sdk.MustNewDecFromStr("0.1"),
 		RewardChangeInterval: decayInterval,
@@ -1113,6 +1116,7 @@ func TestRewardWeightRateChange(t *testing.T) {
 		Description:          "",
 		Denom:                alliance.Denom,
 		RewardWeight:         alliance.RewardWeight,
+		RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)},
 		TakeRate:             alliance.TakeRate,
 		RewardChangeRate:     sdk.MustNewDecFromStr("1.001"),
 		RewardChangeInterval: time.Minute * 5,

diff --git a/x/alliance/keeper/tests/proposal_test.go b/x/alliance/keeper/tests/proposal_test.go
@@ -106,10 +106,14 @@ func TestUpdateAlliance(t *testing.T) {
 
 	// WHEN
 	updateErr := app.AllianceKeeper.UpdateAlliance(ctx, &types.MsgUpdateAllianceProposal{
-		Title:                "",
-		Description:          "",
-		Denom:                "uluna",
-		RewardWeight:         sdk.NewDec(6),
+		Title:        "",
+		Description:  "",
+		Denom:        "uluna",
+		RewardWeight: sdk.NewDec(11),
+		RewardWeightRange: types.RewardWeightRange{
+			Min: sdk.NewDec(0),
+			Max: sdk.NewDec(11),
+		},
 		TakeRate:             sdk.NewDec(7),
 		RewardChangeInterval: 0,
 		RewardChangeRate:     sdk.ZeroDec(),
@@ -123,8 +127,8 @@ func TestUpdateAlliance(t *testing.T) {
 		Alliances: []types.AllianceAsset{
 			{
 				Denom:                "uluna",
-				RewardWeight:         sdk.NewDec(6),
-				RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(10)},
+				RewardWeight:         sdk.NewDec(11),
+				RewardWeightRange:    types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(11)},
 				TakeRate:             sdk.NewDec(7),
 				TotalTokens:          sdk.ZeroInt(),
 				TotalValidatorShares: sdk.NewDec(0),

diff --git a/x/alliance/types/gov.go b/x/alliance/types/gov.go
@@ -85,7 +85,7 @@ func (m *MsgCreateAllianceProposal) ValidateBasic() error {
 	return nil
 }
 
-func NewMsgUpdateAllianceProposal(title, description, denom string, rewardWeight, takeRate sdk.Dec, rewardChangeRate sdk.Dec, rewardChangeInterval time.Duration) govtypes.Content {
+func NewMsgUpdateAllianceProposal(title, description, denom string, rewardWeight sdk.Dec, rewardWeightRange RewardWeightRange, takeRate sdk.Dec, rewardChangeRate sdk.Dec, rewardChangeInterval time.Duration) govtypes.Content {
 	return &MsgUpdateAllianceProposal{
 		Title:                title,
 		Description:          description,
@@ -94,6 +94,7 @@ func NewMsgUpdateAllianceProposal(title, description, denom string, rewardWeight
 		TakeRate:             takeRate,
 		RewardChangeRate:     rewardChangeRate,
 		RewardChangeInterval: rewardChangeInterval,
+		RewardWeightRange:    rewardWeightRange,
 	}
 }
 func (m *MsgUpdateAllianceProposal) GetTitle() string       { return m.Title }
@@ -122,6 +123,19 @@ func (m *MsgUpdateAllianceProposal) ValidateBasic() error {
 		return status.Errorf(codes.InvalidArgument, "Alliance rewardChangeInterval must be strictly a positive number")
 	}
 
+	if m.RewardWeightRange.Min.IsNil() || m.RewardWeightRange.Min.LT(sdk.ZeroDec()) ||
+		m.RewardWeightRange.Max.IsNil() || m.RewardWeightRange.Max.LT(sdk.ZeroDec()) {
+		return status.Errorf(codes.InvalidArgument, "Alliance rewardWeight min and max must be zero or a positive number")
+	}
+
+	if m.RewardWeightRange.Min.GT(m.RewardWeightRange.Max) {
+		return status.Errorf(codes.InvalidArgument, "Alliance rewardWeight min must be less or equal to rewardWeight max")
+	}
+
+	if m.RewardWeight.LT(m.RewardWeightRange.Min) || m.RewardWeight.GT(m.RewardWeightRange.Max) {
+		return status.Errorf(codes.InvalidArgument, "Alliance rewardWeight must be bounded in RewardWeightRange")
+	}
+
 	return nil
 }
 

diff --git a/x/alliance/types/gov.pb.go b/x/alliance/types/gov.pb.go
diff --git a/x/alliance/types/tests/types_test.go b/x/alliance/types/tests/types_test.go
@@ -62,11 +62,11 @@ func TestProposalsContent(t *testing.T) {
 			str:   "title:\"Alliance1\" description:\"Alliance with 1\" denom:\"ibc/denom1\" reward_weight:\"1000000000000000000\" take_rate:\"1000000000000000000\" reward_change_rate:\"1000000000000000000\" reward_change_interval:<seconds:1 > reward_weight_range:<min:\"0\" max:\"5000000000000000000\" > ",
 		},
 		"msg_update_alliance_proposal": {
-			p:     types.NewMsgUpdateAllianceProposal("Alliance2", "Alliance with 2", "ibc/denom2", sdk.NewDec(2), sdk.NewDec(2), sdk.NewDec(2), time.Hour),
+			p:     types.NewMsgUpdateAllianceProposal("Alliance2", "Alliance with 2", "ibc/denom2", sdk.NewDec(2), types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)}, sdk.NewDec(2), sdk.NewDec(2), time.Hour),
 			title: "Alliance2",
 			desc:  "Alliance with 2",
 			typ:   "msg_update_alliance_proposal",
-			str:   "title:\"Alliance2\" description:\"Alliance with 2\" denom:\"ibc/denom2\" reward_weight:\"2000000000000000000\" take_rate:\"2000000000000000000\" reward_change_rate:\"2000000000000000000\" reward_change_interval:<seconds:3600 > ",
+			str:   "title:\"Alliance2\" description:\"Alliance with 2\" denom:\"ibc/denom2\" reward_weight:\"2000000000000000000\" take_rate:\"2000000000000000000\" reward_change_rate:\"2000000000000000000\" reward_change_interval:<seconds:3600 > reward_weight_range:<min:\"0\" max:\"5000000000000000000\" > ",
 		},
 		"msg_delete_alliance_proposal": {
 			p:     types.NewMsgDeleteAllianceProposal("test", "abcd", "ibc/denom"),
@@ -130,7 +130,7 @@ func TestInvalidProposalsContent(t *testing.T) {
 			typ:   "msg_create_alliance_proposal",
 		},
 		"msg_update_alliance_proposal": {
-			p:     types.NewMsgUpdateAllianceProposal("Alliance2", "Alliance with 2", "ibc/denom2", sdk.NewDec(2), sdk.NewDec(2), sdk.NewDec(2), -time.Hour),
+			p:     types.NewMsgUpdateAllianceProposal("Alliance2", "Alliance with 2", "ibc/denom2", sdk.NewDec(2), types.RewardWeightRange{Min: sdk.NewDec(0), Max: sdk.NewDec(5)}, sdk.NewDec(2), sdk.NewDec(2), -time.Hour),
 			title: "Alliance2",
 			desc:  "Alliance with 2",
 			typ:   "msg_update_alliance_proposal",