Merge branch 'dynamic-unbonding-rr-refactor' of github.com:Stride-Lab…

…s/stride into dynamic-unbonding-rr-refactor
Stride-Labs · Jan 11, 2024 · fcd7e15 · fcd7e15
2 parents b08635f + e23c4b3
commit fcd7e15
Show file tree

Hide file tree

Showing 25 changed files with 140 additions and 144 deletions.
diff --git a/app/upgrades/v17/upgrades.go b/app/upgrades/v17/upgrades.go
@@ -164,7 +164,7 @@ func MigrateUnbondingRecords(ctx sdk.Context, k stakeibckeeper.Keeper) error {
 			}
 			// similarly, if there aren't any tokens to unbond, we don't want to modify the record
 			// as we won't be able to estimate a redemption rate
-			if hostZoneUnbonding.NativeTokenAmount == sdkmath.ZeroInt() {
+			if hostZoneUnbonding.NativeTokenAmount.IsZero() {
 				continue
 			}
 
@@ -173,6 +173,7 @@ func MigrateUnbondingRecords(ctx sdk.Context, k stakeibckeeper.Keeper) error {
 			stTokenAmountDec := sdk.NewDecFromInt(hostZoneUnbonding.StTokenAmount)
 			// this estimated rate is the amount of stTokens that would be received for 1 native token
 			// e.g. if the rate is 0.5, then 1 native token would be worth 0.5 stTokens
+			// e.g. if the rate is 0.5, then 1 native token would be worth 0.5 stTokens
 			estimatedStTokenConversionRate := stTokenAmountDec.Quo(nativeTokenAmountDec)
 
 			// Loop through User Redemption Records and insert an estimated stTokenAmount
@@ -184,7 +185,7 @@ func MigrateUnbondingRecords(ctx sdk.Context, k stakeibckeeper.Keeper) error {
 					continue
 				}
 
-				userRedemptionRecord.StTokenAmount = estimatedStTokenConversionRate.Mul(sdkmath.LegacyDec(userRedemptionRecord.Amount)).RoundInt()
+				userRedemptionRecord.StTokenAmount = estimatedStTokenConversionRate.Mul(sdk.NewDecFromInt(userRedemptionRecord.NativeTokenAmount)).RoundInt()
 				k.RecordsKeeper.SetUserRedemptionRecord(ctx, userRedemptionRecord)
 			}
 		}

diff --git a/app/upgrades/v17/upgrades_test.go b/app/upgrades/v17/upgrades_test.go
@@ -572,11 +572,7 @@ func (s *UpgradeTestSuite) TestUpdateRateLimitThresholds() {
 			ChannelId:      "channel-1",
 			HostDenom:      "uosmo",
 			RateLimitDenom: "stuosmo",
-<<<<<<< HEAD
-			Duration:       15,
-=======
 			Duration:       20,
->>>>>>> v17-upgrade-handler
 			Threshold:      sdkmath.NewInt(15),
 		},
 		"juno": {

diff --git a/app/upgrades/v5/upgrades_test.go b/app/upgrades/v5/upgrades_test.go
@@ -329,7 +329,7 @@ func (s *UpgradeTestSuite) SetupOldRecordStore(codec codec.Codec) func() {
 		userRedemptionRecord, found := s.App.RecordsKeeper.GetUserRedemptionRecord(s.Ctx, userRedemptionRecordId)
 		s.Require().True(found, "redemption record found")
 		s.Require().Equal(userRedemptionRecord.Id, userRedemptionRecordId, "redemption record id")
-		s.Require().Equal(userRedemptionRecord.Amount, sdkmath.NewInt(1000000), "redemption record amount")
+		s.Require().Equal(userRedemptionRecord.NativeTokenAmount, sdkmath.NewInt(1000000), "redemption record amount")
 
 		epochUnbondingRecord, found := s.App.RecordsKeeper.GetEpochUnbondingRecord(s.Ctx, epochNumber)
 		s.Require().True(found, "epoch unbonding record found")

diff --git a/proto/stride/records/records.proto b/proto/stride/records/records.proto
@@ -9,7 +9,7 @@ option go_package = "github.com/Stride-Labs/stride/v16/x/records/types";
 message UserRedemptionRecord {
   string id = 1; // {chain_id}.{epoch}.{receiver}
   string receiver = 3;
-  string amount = 4 [
+  string native_token_amount = 4 [
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int",
     (gogoproto.nullable) = false
   ];

diff --git a/readme-docs/md/records_README.md b/readme-docs/md/records_README.md
@@ -34,7 +34,7 @@ Epoch Unbonding Records
 - `GetAllPreviousEpochUnbondingRecords()`
 - `GetHostZoneUnbondingByChainId()`
 - `AddHostZoneToEpochUnbondingRecord()`
-- `SetHostZoneUnbondings()`
+- `SetHostZoneUnbondingStatus()`
 
 User Redemption Records
 - `SetUserRedemptionRecord()`

diff --git a/x/records/README.md b/x/records/README.md
@@ -37,7 +37,7 @@ Epoch Unbonding Records
 - `GetAllPreviousEpochUnbondingRecords()`
 - `GetHostZoneUnbondingByChainId()`
 - `AddHostZoneToEpochUnbondingRecord()`
-- `SetHostZoneUnbondings()`
+- `SetHostZoneUnbondingStatus()`
 
 User Redemption Records
 

diff --git a/x/records/client/cli/query_user_redemption_record_test.go b/x/records/client/cli/query_user_redemption_record_test.go
@@ -29,9 +29,9 @@ func networkWithUserRedemptionRecordObjects(t *testing.T, n int) (*network.Netwo
 
 	for i := 0; i < n; i++ {
 		userRedemptionRecord := types.UserRedemptionRecord{
-			Id:            strconv.Itoa(i),
-			Amount:        sdkmath.NewInt(int64(i)),
-			StTokenAmount: sdkmath.NewInt(int64(i)),
+			Id:                strconv.Itoa(i),
+			NativeTokenAmount: sdkmath.NewInt(int64(i)),
+			StTokenAmount:     sdkmath.NewInt(int64(i)),
 		}
 		nullify.Fill(&userRedemptionRecord)
 		state.UserRedemptionRecordList = append(state.UserRedemptionRecordList, userRedemptionRecord)

diff --git a/x/records/keeper/epoch_unbonding_record.go b/x/records/keeper/epoch_unbonding_record.go
@@ -133,8 +133,7 @@ func (k Keeper) SetHostZoneUnbondingRecord(ctx sdk.Context, epochNumber uint64,
 }
 
 // Updates the status for a given host zone across relevant epoch unbonding record IDs
-// TODO [cleanup]: Rename to SetHostZoneUnbondingStatus
-func (k Keeper) SetHostZoneUnbondings(ctx sdk.Context, chainId string, epochUnbondingRecordIds []uint64, status types.HostZoneUnbonding_Status) error {
+func (k Keeper) SetHostZoneUnbondingStatus(ctx sdk.Context, chainId string, epochUnbondingRecordIds []uint64, status types.HostZoneUnbonding_Status) error {
 	for _, epochUnbondingRecordId := range epochUnbondingRecordIds {
 		k.Logger(ctx).Info(fmt.Sprintf("Updating host zone unbondings on EpochUnbondingRecord %d to status %s", epochUnbondingRecordId, status.String()))
 		// fetch the host zone unbonding

diff --git a/x/records/keeper/epoch_unbonding_record_test.go b/x/records/keeper/epoch_unbonding_record_test.go
@@ -161,7 +161,7 @@ func TestSetHostZoneUnbondings(t *testing.T) {
 		}
 	}
 
-	err := keeper.SetHostZoneUnbondings(ctx, hostIdToUpdate, epochsToUpdate, newStatus)
+	err := keeper.SetHostZoneUnbondingStatus(ctx, hostIdToUpdate, epochsToUpdate, newStatus)
 	require.Nil(t, err)
 
 	actualEpochUnbondingRecord := keeper.GetAllEpochUnbondingRecord(ctx)

diff --git a/x/records/keeper/user_redemption_record_test.go b/x/records/keeper/user_redemption_record_test.go
@@ -20,7 +20,7 @@ func createNUserRedemptionRecord(keeper *keeper.Keeper, ctx sdk.Context, n int)
 	items := make([]types.UserRedemptionRecord, n)
 	for i := range items {
 		items[i].Id = strconv.Itoa(i)
-		items[i].Amount = sdkmath.NewInt(int64(i))
+		items[i].NativeTokenAmount = sdkmath.NewInt(int64(i))
 		items[i].StTokenAmount = sdkmath.NewInt(int64(i))
 		keeper.SetUserRedemptionRecord(ctx, items[i])
 	}

diff --git a/x/records/migrations/v2/convert.go b/x/records/migrations/v2/convert.go
@@ -44,11 +44,11 @@ func convertToNewUserRedemptionRecord(oldRedemptionRecord oldrecordstypes.UserRe
 	return recordstypes.UserRedemptionRecord{
 		Id: oldRedemptionRecord.Id,
 		// Sender:         oldRedemptionRecord.Sender,
-		Receiver:       oldRedemptionRecord.Receiver,
-		Amount:         sdkmath.NewIntFromUint64(oldRedemptionRecord.Amount),
-		Denom:          oldRedemptionRecord.Denom,
-		HostZoneId:     oldRedemptionRecord.HostZoneId,
-		EpochNumber:    oldRedemptionRecord.EpochNumber,
-		ClaimIsPending: oldRedemptionRecord.ClaimIsPending,
+		Receiver:          oldRedemptionRecord.Receiver,
+		NativeTokenAmount: sdkmath.NewIntFromUint64(oldRedemptionRecord.Amount),
+		Denom:             oldRedemptionRecord.Denom,
+		HostZoneId:        oldRedemptionRecord.HostZoneId,
+		EpochNumber:       oldRedemptionRecord.EpochNumber,
+		ClaimIsPending:    oldRedemptionRecord.ClaimIsPending,
 	}
 }
diff --git a/x/records/migrations/v2/convert_test.go b/x/records/migrations/v2/convert_test.go
@@ -123,11 +123,11 @@ func TestConvertUserRedemptionRecord(t *testing.T) {
 		Id:       id,
 		Receiver: receiver,
 		// Sender:         sender,
-		Amount:         sdkmath.NewInt(1),
-		Denom:          denom,
-		HostZoneId:     hostZoneId,
-		EpochNumber:    epochNumber,
-		ClaimIsPending: claimIsPending,
+		NativeTokenAmount: sdkmath.NewInt(1),
+		Denom:             denom,
+		HostZoneId:        hostZoneId,
+		EpochNumber:       epochNumber,
+		ClaimIsPending:    claimIsPending,
 	}
 
 	actualNewUserRedemptionRecord := convertToNewUserRedemptionRecord(oldUserRedemptionRecord)