From dce631d3de6aaa006c148d3aecb48e29f3e570df Mon Sep 17 00:00:00 2001 From: Derrick Lee Date: Tue, 29 Nov 2022 13:59:11 -0800 Subject: [PATCH] Add generic incentive `AccumulateRewards` method (#1392) * Add generic accumulator * Add MultiRewardPeriodOfClaimType type to params * Add adapters wrapper * Add MultiRewardPeriodsOfClaimType to params * Add multireward period to genesis test * Rename MultiRewardPeriodOfClaimType to TypedMultiRewardPeriod * Use source adapters wrapper --- docs/core/proto-docs.md | 21 +- proto/kava/incentive/v1beta1/params.proto | 18 +- x/incentive/abci.go | 7 + x/incentive/genesis_test.go | 9 + x/incentive/keeper/adapters/adapter.go | 78 ++++ x/incentive/keeper/keeper.go | 18 +- x/incentive/keeper/rewards.go | 37 +- x/incentive/keeper/rewards_accumulate_test.go | 334 +++++++++++++++ x/incentive/types/genesis_test.go | 1 + x/incentive/types/params.go | 68 ++- x/incentive/types/params.pb.go | 389 +++++++++++++++--- 11 files changed, 891 insertions(+), 89 deletions(-) create mode 100644 x/incentive/keeper/adapters/adapter.go create mode 100644 x/incentive/keeper/rewards_accumulate_test.go diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md index 1354c470..21cc8bae 100644 --- a/docs/core/proto-docs.md +++ b/docs/core/proto-docs.md @@ -330,6 +330,7 @@ - [MultipliersPerDenom](#kava.incentive.v1beta1.MultipliersPerDenom) - [Params](#kava.incentive.v1beta1.Params) - [RewardPeriod](#kava.incentive.v1beta1.RewardPeriod) + - [TypedMultiRewardPeriod](#kava.incentive.v1beta1.TypedMultiRewardPeriod) - [kava/incentive/v1beta1/genesis.proto](#kava/incentive/v1beta1/genesis.proto) - [AccrualTime](#kava.incentive.v1beta1.AccrualTime) @@ -4743,7 +4744,8 @@ MultiRewardPeriod supports multiple reward types ### Multiplier -Multiplier amount the claim rewards get increased by, along with how long the claim rewards are locked +Multiplier amount the claim rewards get increased by, along with how long the +claim rewards are locked | Field | Type | Label | Description | @@ -4790,6 +4792,7 @@ Params | `claim_end` | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | | `savings_reward_periods` | [MultiRewardPeriod](#kava.incentive.v1beta1.MultiRewardPeriod) | repeated | | | `earn_reward_periods` | [MultiRewardPeriod](#kava.incentive.v1beta1.MultiRewardPeriod) | repeated | | +| `reward_periods` | [TypedMultiRewardPeriod](#kava.incentive.v1beta1.TypedMultiRewardPeriod) | repeated | | @@ -4814,6 +4817,22 @@ RewardPeriod stores the state of an ongoing reward + + + +### TypedMultiRewardPeriod +TypedMultiRewardPeriod stores mutiple reward types of a claim type + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| `claim_type` | [ClaimType](#kava.incentive.v1beta1.ClaimType) | | | +| `reward_periods` | [MultiRewardPeriod](#kava.incentive.v1beta1.MultiRewardPeriod) | repeated | | + + + + + diff --git a/proto/kava/incentive/v1beta1/params.proto b/proto/kava/incentive/v1beta1/params.proto index 7571f9a3..258514de 100644 --- a/proto/kava/incentive/v1beta1/params.proto +++ b/proto/kava/incentive/v1beta1/params.proto @@ -4,6 +4,7 @@ package kava.incentive.v1beta1; import "cosmos/base/v1beta1/coin.proto"; import "gogoproto/gogo.proto"; import "google/protobuf/timestamp.proto"; +import "kava/incentive/v1beta1/claims.proto"; option go_package = "github.com/kava-labs/kava/x/incentive/types"; option (gogoproto.goproto_getters_all) = false; @@ -49,7 +50,17 @@ message MultiRewardPeriod { ]; } -// Multiplier amount the claim rewards get increased by, along with how long the claim rewards are locked +// TypedMultiRewardPeriod stores mutiple reward types of a claim type +message TypedMultiRewardPeriod { + ClaimType claim_type = 1; + repeated MultiRewardPeriod reward_periods = 2 [ + (gogoproto.castrepeated) = "MultiRewardPeriods", + (gogoproto.nullable) = false + ]; +} + +// Multiplier amount the claim rewards get increased by, along with how long the +// claim rewards are locked message Multiplier { string name = 1; @@ -118,4 +129,9 @@ message Params { (gogoproto.castrepeated) = "MultiRewardPeriods", (gogoproto.nullable) = false ]; + + repeated TypedMultiRewardPeriod reward_periods = 10 [ + (gogoproto.castrepeated) = "TypedMultiRewardPeriods", + (gogoproto.nullable) = false + ]; } diff --git a/x/incentive/abci.go b/x/incentive/abci.go index feac0e6c..1cfc0480 100644 --- a/x/incentive/abci.go +++ b/x/incentive/abci.go @@ -35,4 +35,11 @@ func BeginBlocker(ctx sdk.Context, k keeper.Keeper) { panic(fmt.Sprintf("failed to accumulate earn rewards: %s", err)) } } + + // New generic RewardPeriods + for _, mrp := range params.RewardPeriods { + for _, rp := range mrp.RewardPeriods { + k.AccumulateRewards(ctx, mrp.ClaimType, rp) + } + } } diff --git a/x/incentive/genesis_test.go b/x/incentive/genesis_test.go index b567b74e..a227cd84 100644 --- a/x/incentive/genesis_test.go +++ b/x/incentive/genesis_test.go @@ -94,6 +94,7 @@ func (suite *GenesisTestSuite) SetupTest() { }, }, suite.genesisTime.Add(5*oneYear), + types.DefaultTypedMultiRewardPeriods, ), types.DefaultGenesisRewardState, types.DefaultGenesisRewardState, @@ -165,6 +166,14 @@ func (suite *GenesisTestSuite) TestExportedGenesisMatchesImported() { }, }, genesisTime.Add(5*oneYear), + types.TypedMultiRewardPeriods{ + types.NewTypedMultiRewardPeriod( + types.CLAIM_TYPE_SWAP, + types.MultiRewardPeriods{ + types.NewMultiRewardPeriod(true, "ukava", genesisTime.Add(-1*oneYear), genesisTime.Add(oneYear), cs(c("hard", 122354))), + }, + ), + }, ), types.NewGenesisRewardState( types.AccumulationTimes{ diff --git a/x/incentive/keeper/adapters/adapter.go b/x/incentive/keeper/adapters/adapter.go new file mode 100644 index 00000000..af948682 --- /dev/null +++ b/x/incentive/keeper/adapters/adapter.go @@ -0,0 +1,78 @@ +package adapters + +import ( + "fmt" + + sdk "github.com/cosmos/cosmos-sdk/types" + + "github.com/kava-labs/kava/x/incentive/keeper/adapters/swap" + "github.com/kava-labs/kava/x/incentive/types" +) + +// SourceAdapters is a collection of source adapters. +type SourceAdapters struct { + adapters map[types.ClaimType]types.SourceAdapter +} + +// SourceShare is a single share from a source with it's corresponding ID. +type SourceShare struct { + ID string + Shares sdk.Dec +} + +// NewSourceAdapters returns a new SourceAdapters instance with all available +// source adapters. +func NewSourceAdapters( + swapKeeper types.SwapKeeper, +) SourceAdapters { + return SourceAdapters{ + adapters: map[types.ClaimType]types.SourceAdapter{ + types.CLAIM_TYPE_SWAP: swap.NewSourceAdapter(swapKeeper), + }, + } +} + +// OwnerSharesBySource returns a slice of SourceShares for each sourceID from a +// specified owner. The slice is sorted by sourceID. +func (a SourceAdapters) OwnerSharesBySource( + ctx sdk.Context, + claimType types.ClaimType, + owner sdk.AccAddress, + sourceIDs []string, +) []SourceShare { + adapter, found := a.adapters[claimType] + if !found { + panic(fmt.Sprintf("no source share fetcher for claim type %s", claimType)) + } + + ownerShares := adapter.OwnerSharesBySource(ctx, owner, sourceIDs) + + var shares []SourceShare + for _, sourceID := range sourceIDs { + singleShares, found := ownerShares[sourceID] + if !found { + panic(fmt.Sprintf("no source shares for claimType %s and source %s", claimType, sourceID)) + } + + shares = append(shares, SourceShare{ + ID: sourceID, + Shares: singleShares, + }) + } + + return shares +} + +// TotalSharesBySource returns the total shares of a given claimType and sourceID. +func (a SourceAdapters) TotalSharesBySource( + ctx sdk.Context, + claimType types.ClaimType, + sourceID string, +) sdk.Dec { + adapter, found := a.adapters[claimType] + if !found { + panic(fmt.Sprintf("no source share fetcher for claim type %s", claimType)) + } + + return adapter.TotalSharesBySource(ctx, sourceID) +} diff --git a/x/incentive/keeper/keeper.go b/x/incentive/keeper/keeper.go index a9a08ba9..01168ffd 100644 --- a/x/incentive/keeper/keeper.go +++ b/x/incentive/keeper/keeper.go @@ -1,14 +1,13 @@ package keeper import ( - "fmt" "time" "github.com/cosmos/cosmos-sdk/codec" "github.com/cosmos/cosmos-sdk/store/prefix" sdk "github.com/cosmos/cosmos-sdk/types" - "github.com/kava-labs/kava/x/incentive/keeper/adapters/swap" + "github.com/kava-labs/kava/x/incentive/keeper/adapters" "github.com/kava-labs/kava/x/incentive/types" ) @@ -27,7 +26,7 @@ type Keeper struct { liquidKeeper types.LiquidKeeper earnKeeper types.EarnKeeper - adapters map[types.ClaimType]types.SourceAdapter + adapters adapters.SourceAdapters // Keepers used for APY queries mintKeeper types.MintKeeper @@ -60,9 +59,7 @@ func NewKeeper( liquidKeeper: lqk, earnKeeper: ek, - adapters: map[types.ClaimType]types.SourceAdapter{ - types.CLAIM_TYPE_SWAP: swap.NewSourceAdapter(swpk), - }, + adapters: adapters.NewSourceAdapters(swpk), mintKeeper: mk, distrKeeper: dk, @@ -894,15 +891,6 @@ func (k Keeper) IterateEarnRewardAccrualTimes(ctx sdk.Context, cb func(string, t // ----------------------------------------------------------------------------- // New deduplicated methods -func (k Keeper) GetSourceAdapter(claimType types.ClaimType) types.SourceAdapter { - fetcher, found := k.adapters[claimType] - if !found { - panic(fmt.Sprintf("no source share fetcher for claim type %s", claimType)) - } - - return fetcher -} - // GetClaim returns the claim in the store corresponding the the owner and // claimType, and a boolean for if the claim was found func (k Keeper) GetClaim( diff --git a/x/incentive/keeper/rewards.go b/x/incentive/keeper/rewards.go index 342df77a..9f80f892 100644 --- a/x/incentive/keeper/rewards.go +++ b/x/incentive/keeper/rewards.go @@ -7,6 +7,36 @@ import ( "github.com/kava-labs/kava/x/incentive/types" ) +// AccumulateRewards calculates new rewards to distribute this block and updates the global indexes to reflect this. +// The provided rewardPeriod must be valid to avoid panics in calculating time durations. +func (k Keeper) AccumulateRewards( + ctx sdk.Context, + claimType types.ClaimType, + rewardPeriod types.MultiRewardPeriod, +) { + previousAccrualTime, found := k.GetRewardAccrualTime(ctx, claimType, rewardPeriod.CollateralType) + if !found { + previousAccrualTime = ctx.BlockTime() + } + + indexes, found := k.GetRewardIndexesOfClaimType(ctx, claimType, rewardPeriod.CollateralType) + if !found { + indexes = types.RewardIndexes{} + } + + acc := types.NewAccumulator(previousAccrualTime, indexes) + + totalSource := k.adapters.TotalSharesBySource(ctx, claimType, rewardPeriod.CollateralType) + + acc.Accumulate(rewardPeriod, totalSource, ctx.BlockTime()) + + k.SetRewardAccrualTime(ctx, claimType, rewardPeriod.CollateralType, acc.PreviousAccumulationTime) + if len(acc.Indexes) > 0 { + // the store panics when setting empty or nil indexes + k.SetRewardIndexes(ctx, claimType, rewardPeriod.CollateralType, acc.Indexes) + } +} + // InitializeClaim creates a new claim with zero rewards and indexes matching // the global indexes. If the claim already exists it just updates the indexes. func (k Keeper) InitializeClaim( @@ -106,12 +136,11 @@ func (k Keeper) GetSynchronizedClaim( return false }) - adapter := k.GetSourceAdapter(claimType) - accShares := adapter.OwnerSharesBySource(ctx, owner, sourceIDs) + accShares := k.adapters.OwnerSharesBySource(ctx, claimType, owner, sourceIDs) // Synchronize claim for each source ID - for _, sourceID := range sourceIDs { - claim = k.synchronizeClaim(ctx, claim, sourceID, owner, accShares[sourceID]) + for _, share := range accShares { + claim = k.synchronizeClaim(ctx, claim, share.ID, owner, share.Shares) } return claim, true diff --git a/x/incentive/keeper/rewards_accumulate_test.go b/x/incentive/keeper/rewards_accumulate_test.go new file mode 100644 index 00000000..ae3f1ca8 --- /dev/null +++ b/x/incentive/keeper/rewards_accumulate_test.go @@ -0,0 +1,334 @@ +package keeper_test + +import ( + "testing" + "time" + + "github.com/kava-labs/kava/x/incentive/types" + "github.com/stretchr/testify/suite" +) + +type AccumulateTestSuite struct { + unitTester +} + +func TestAccumulateTestSuite(t *testing.T) { + suite.Run(t, new(AccumulateTestSuite)) +} + +func (suite *AccumulateTestSuite) storedTimeEquals( + claimType types.ClaimType, + poolID string, + expected time.Time, +) { + storedTime, found := suite.keeper.GetRewardAccrualTime(suite.ctx, claimType, poolID) + suite.True(found) + suite.Equal(expected, storedTime) +} + +func (suite *AccumulateTestSuite) storedIndexesEquals( + claimType types.ClaimType, + poolID string, + expected types.RewardIndexes, +) { + storedIndexes, found := suite.keeper.GetRewardIndexesOfClaimType(suite.ctx, claimType, poolID) + suite.Equal(found, expected != nil) + if found { + suite.Equal(expected, storedIndexes) + } else { + suite.Empty(storedIndexes) + } +} + +func (suite *AccumulateTestSuite) TestStateUpdatedWhenBlockTimeHasIncreased() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper().addPool(pool, i(1e6)) + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + suite.storeGlobalIndexes(claimType, types.MultiRewardIndexes{ + { + CollateralType: pool, + RewardIndexes: types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("0.02"), + }, + { + CollateralType: "ukava", + RewardFactor: d("0.04"), + }, + }, + }, + }) + previousAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.keeper.SetRewardAccrualTime(suite.ctx, claimType, pool, previousAccrualTime) + + newAccrualTime := previousAccrualTime.Add(1 * time.Hour) + suite.ctx = suite.ctx.WithBlockTime(newAccrualTime) + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Unix(0, 0), // ensure the test is within start and end times + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), // same denoms as in global indexes + ) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // check time and factors + + suite.storedTimeEquals(claimType, pool, newAccrualTime) + suite.storedIndexesEquals(claimType, pool, types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("7.22"), + }, + { + CollateralType: "ukava", + RewardFactor: d("3.64"), + }, + }) +} + +func (suite *AccumulateTestSuite) TestStateUnchangedWhenBlockTimeHasNotIncreased() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper().addPool(pool, i(1e6)) + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + previousIndexes := types.MultiRewardIndexes{ + { + CollateralType: pool, + RewardIndexes: types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("0.02"), + }, + { + CollateralType: "ukava", + RewardFactor: d("0.04"), + }, + }, + }, + } + suite.storeGlobalIndexes(claimType, previousIndexes) + previousAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.keeper.SetRewardAccrualTime(suite.ctx, claimType, pool, previousAccrualTime) + + suite.ctx = suite.ctx.WithBlockTime(previousAccrualTime) + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Unix(0, 0), // ensure the test is within start and end times + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), // same denoms as in global indexes + ) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // check time and factors + + suite.storedTimeEquals(claimType, pool, previousAccrualTime) + expected, f := previousIndexes.Get(pool) + suite.True(f) + suite.storedIndexesEquals(claimType, pool, expected) +} + +func (suite *AccumulateTestSuite) TestNoAccumulationWhenSourceSharesAreZero() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper() // no pools, so no source shares + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + previousIndexes := types.MultiRewardIndexes{ + { + CollateralType: pool, + RewardIndexes: types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("0.02"), + }, + { + CollateralType: "ukava", + RewardFactor: d("0.04"), + }, + }, + }, + } + suite.storeGlobalIndexes(claimType, previousIndexes) + previousAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.keeper.SetRewardAccrualTime(suite.ctx, claimType, pool, previousAccrualTime) + + firstAccrualTime := previousAccrualTime.Add(7 * time.Second) + suite.ctx = suite.ctx.WithBlockTime(firstAccrualTime) + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Unix(0, 0), // ensure the test is within start and end times + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), // same denoms as in global indexes + ) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // check time and factors + + suite.storedTimeEquals(claimType, pool, firstAccrualTime) + expected, f := previousIndexes.Get(pool) + suite.True(f) + suite.storedIndexesEquals(claimType, pool, expected) +} + +func (suite *AccumulateTestSuite) TestStateAddedWhenStateDoesNotExist() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper().addPool(pool, i(1e6)) + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Unix(0, 0), // ensure the test is within start and end times + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), + ) + + firstAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.ctx = suite.ctx.WithBlockTime(firstAccrualTime) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // After the first accumulation only the current block time should be stored. + // The indexes will be empty as no time has passed since the previous block because it didn't exist. + suite.storedTimeEquals(claimType, pool, firstAccrualTime) + suite.storedIndexesEquals(claimType, pool, nil) + + secondAccrualTime := firstAccrualTime.Add(10 * time.Second) + suite.ctx = suite.ctx.WithBlockTime(secondAccrualTime) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // After the second accumulation both current block time and indexes should be stored. + suite.storedTimeEquals(claimType, pool, secondAccrualTime) + suite.storedIndexesEquals(claimType, pool, types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("0.02"), + }, + { + CollateralType: "ukava", + RewardFactor: d("0.01"), + }, + }) +} + +func (suite *AccumulateTestSuite) TestNoPanicWhenStateDoesNotExist() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper() + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Unix(0, 0), // ensure the test is within start and end times + distantFuture, + cs(), + ) + + accrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.ctx = suite.ctx.WithBlockTime(accrualTime) + + // Accumulate with no swap shares and no rewards per second will result in no increment to the indexes. + // No increment and no previous indexes stored, results in an updated of nil. Setting this in the state panics. + // Check there is no panic. + suite.NotPanics(func() { + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + }) + + suite.storedTimeEquals(claimType, pool, accrualTime) + suite.storedIndexesEquals(claimType, pool, nil) +} + +func (suite *AccumulateTestSuite) TestNoAccumulationWhenBeforeStartTime() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper().addPool(pool, i(1e6)) + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + previousIndexes := types.MultiRewardIndexes{ + { + CollateralType: pool, + RewardIndexes: types.RewardIndexes{ + { + CollateralType: "swap", + RewardFactor: d("0.02"), + }, + { + CollateralType: "ukava", + RewardFactor: d("0.04"), + }, + }, + }, + } + suite.storeGlobalIndexes(claimType, previousIndexes) + previousAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.keeper.SetRewardAccrualTime(suite.ctx, claimType, pool, previousAccrualTime) + + firstAccrualTime := previousAccrualTime.Add(10 * time.Second) + + period := types.NewMultiRewardPeriod( + true, + pool, + firstAccrualTime.Add(time.Nanosecond), // start time after accrual time + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), + ) + + suite.ctx = suite.ctx.WithBlockTime(firstAccrualTime) + + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + + // The accrual time should be updated, but the indexes unchanged + suite.storedTimeEquals(claimType, pool, firstAccrualTime) + expectedIndexes, f := previousIndexes.Get(pool) + suite.True(f) + suite.storedIndexesEquals(claimType, pool, expectedIndexes) +} + +func (suite *AccumulateTestSuite) TestPanicWhenCurrentTimeLessThanPrevious() { + claimType := types.CLAIM_TYPE_SWAP + pool := "btc:usdx" + + swapKeeper := newFakeSwapKeeper().addPool(pool, i(1e6)) + suite.keeper = suite.NewKeeper(&fakeParamSubspace{}, nil, nil, nil, nil, nil, swapKeeper, nil, nil, nil) + + previousAccrualTime := time.Date(1998, 1, 1, 0, 0, 0, 0, time.UTC) + suite.keeper.SetRewardAccrualTime(suite.ctx, claimType, pool, previousAccrualTime) + + firstAccrualTime := time.Time{} + + period := types.NewMultiRewardPeriod( + true, + pool, + time.Time{}, // start time after accrual time + distantFuture, + cs(c("swap", 2000), c("ukava", 1000)), + ) + + suite.ctx = suite.ctx.WithBlockTime(firstAccrualTime) + + suite.Panics(func() { + suite.keeper.AccumulateRewards(suite.ctx, claimType, period) + }) +} diff --git a/x/incentive/types/genesis_test.go b/x/incentive/types/genesis_test.go index dbb6b793..3a3a0e75 100644 --- a/x/incentive/types/genesis_test.go +++ b/x/incentive/types/genesis_test.go @@ -56,6 +56,7 @@ func TestGenesisState_Validate(t *testing.T) { }, }, time.Date(2025, 10, 15, 14, 0, 0, 0, time.UTC), + DefaultTypedMultiRewardPeriods, ), USDXRewardState: GenesisRewardState{ AccumulationTimes: AccumulationTimes{{ diff --git a/x/incentive/types/params.go b/x/incentive/types/params.go index 05184a7f..a0fc0e81 100644 --- a/x/incentive/types/params.go +++ b/x/incentive/types/params.go @@ -24,12 +24,14 @@ var ( KeyEarnRewardPeriods = []byte("EarnRewardPeriods") KeyClaimEnd = []byte("ClaimEnd") KeyMultipliers = []byte("ClaimMultipliers") + KeyTypedMultiRewardPeriods = []byte("TypedMultiRewardPeriods") - DefaultActive = false - DefaultRewardPeriods = RewardPeriods{} - DefaultMultiRewardPeriods = MultiRewardPeriods{} - DefaultMultipliers = MultipliersPerDenoms{} - DefaultClaimEnd = tmtime.Canonical(time.Unix(1, 0)) + DefaultActive = false + DefaultRewardPeriods = RewardPeriods{} + DefaultMultiRewardPeriods = MultiRewardPeriods{} + DefaultMultipliers = MultipliersPerDenoms{} + DefaultTypedMultiRewardPeriods = TypedMultiRewardPeriods{} + DefaultClaimEnd = tmtime.Canonical(time.Unix(1, 0)) BondDenom = "ukava" USDXMintingRewardDenom = "ukava" @@ -44,6 +46,7 @@ func NewParams( hardSupply, hardBorrow, delegator, swap, savings, earn MultiRewardPeriods, multipliers MultipliersPerDenoms, claimEnd time.Time, + rewardPeriods TypedMultiRewardPeriods, ) Params { return Params{ USDXMintingRewardPeriods: usdxMinting, @@ -52,8 +55,10 @@ func NewParams( DelegatorRewardPeriods: delegator, SwapRewardPeriods: swap, SavingsRewardPeriods: savings, + EarnRewardPeriods: earn, ClaimMultipliers: multipliers, ClaimEnd: claimEnd, + RewardPeriods: rewardPeriods, } } @@ -69,6 +74,7 @@ func DefaultParams() Params { DefaultMultiRewardPeriods, DefaultMultipliers, DefaultClaimEnd, + DefaultTypedMultiRewardPeriods, ) } @@ -89,6 +95,7 @@ func (p *Params) ParamSetPairs() paramtypes.ParamSetPairs { paramtypes.NewParamSetPair(KeyEarnRewardPeriods, &p.EarnRewardPeriods, validateMultiRewardPeriodsParam), paramtypes.NewParamSetPair(KeyMultipliers, &p.ClaimMultipliers, validateMultipliersPerDenomParam), paramtypes.NewParamSetPair(KeyClaimEnd, &p.ClaimEnd, validateClaimEndParam), + paramtypes.NewParamSetPair(KeyTypedMultiRewardPeriods, &p.RewardPeriods, validatedRewardPeriodsParam), } } @@ -166,6 +173,15 @@ func validateClaimEndParam(i interface{}) error { return nil } +func validatedRewardPeriodsParam(i interface{}) error { + periods, ok := i.(TypedMultiRewardPeriods) + if !ok { + return fmt.Errorf("invalid parameter type: %T", i) + } + + return periods.Validate() +} + // NewRewardPeriod returns a new RewardPeriod func NewRewardPeriod(active bool, collateralType string, start time.Time, end time.Time, reward sdk.Coin) RewardPeriod { return RewardPeriod{ @@ -306,3 +322,45 @@ func (mrps MultiRewardPeriods) Validate() error { return nil } + +// NewTypedMultiRewardPeriod returns a new TypedMultiRewardPeriod +func NewTypedMultiRewardPeriod(claimType ClaimType, rewardPeriods MultiRewardPeriods) TypedMultiRewardPeriod { + return TypedMultiRewardPeriod{ + ClaimType: claimType, + RewardPeriods: rewardPeriods, + } +} + +// Validate performs a basic check of a TypedMultiRewardPeriod fields. +func (mrp TypedMultiRewardPeriod) Validate() error { + if err := mrp.ClaimType.Validate(); err != nil { + return fmt.Errorf("invalid claim type: %w", err) + } + if err := mrp.RewardPeriods.Validate(); err != nil { + return fmt.Errorf("invalid reward periods: %w", err) + } + + return nil +} + +// TypedMultiRewardPeriods array of TypedMultiRewardPeriod +type TypedMultiRewardPeriods []TypedMultiRewardPeriod + +// Validate checks if all the TypedMultiRewardPeriods are valid and there +// are no duplicated entries. +func (mrps TypedMultiRewardPeriods) Validate() error { + seenClaimTypes := make(map[ClaimType]bool) + for _, mrp := range mrps { + if seenClaimTypes[mrp.ClaimType] { + return fmt.Errorf("duplicated reward period with claim type %s", mrp.ClaimType) + } + + if err := mrp.Validate(); err != nil { + return fmt.Errorf("invalid reward period for claimType %s: %w", mrp.ClaimType, err) + } + + seenClaimTypes[mrp.ClaimType] = true + } + + return nil +} diff --git a/x/incentive/types/params.pb.go b/x/incentive/types/params.pb.go index 05faf395..565b74a1 100644 --- a/x/incentive/types/params.pb.go +++ b/x/incentive/types/params.pb.go @@ -113,7 +113,47 @@ func (m *MultiRewardPeriod) XXX_DiscardUnknown() { var xxx_messageInfo_MultiRewardPeriod proto.InternalMessageInfo -// Multiplier amount the claim rewards get increased by, along with how long the claim rewards are locked +// TypedMultiRewardPeriod stores mutiple reward types of a claim type +type TypedMultiRewardPeriod struct { + ClaimType ClaimType `protobuf:"varint,1,opt,name=claim_type,json=claimType,proto3,enum=kava.incentive.v1beta1.ClaimType" json:"claim_type,omitempty"` + RewardPeriods MultiRewardPeriods `protobuf:"bytes,2,rep,name=reward_periods,json=rewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"reward_periods"` +} + +func (m *TypedMultiRewardPeriod) Reset() { *m = TypedMultiRewardPeriod{} } +func (m *TypedMultiRewardPeriod) String() string { return proto.CompactTextString(m) } +func (*TypedMultiRewardPeriod) ProtoMessage() {} +func (*TypedMultiRewardPeriod) Descriptor() ([]byte, []int) { + return fileDescriptor_bb8833f5d745eac9, []int{2} +} +func (m *TypedMultiRewardPeriod) XXX_Unmarshal(b []byte) error { + return m.Unmarshal(b) +} +func (m *TypedMultiRewardPeriod) XXX_Marshal(b []byte, deterministic bool) ([]byte, error) { + if deterministic { + return xxx_messageInfo_TypedMultiRewardPeriod.Marshal(b, m, deterministic) + } else { + b = b[:cap(b)] + n, err := m.MarshalToSizedBuffer(b) + if err != nil { + return nil, err + } + return b[:n], nil + } +} +func (m *TypedMultiRewardPeriod) XXX_Merge(src proto.Message) { + xxx_messageInfo_TypedMultiRewardPeriod.Merge(m, src) +} +func (m *TypedMultiRewardPeriod) XXX_Size() int { + return m.Size() +} +func (m *TypedMultiRewardPeriod) XXX_DiscardUnknown() { + xxx_messageInfo_TypedMultiRewardPeriod.DiscardUnknown(m) +} + +var xxx_messageInfo_TypedMultiRewardPeriod proto.InternalMessageInfo + +// Multiplier amount the claim rewards get increased by, along with how long the +// claim rewards are locked type Multiplier struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` MonthsLockup int64 `protobuf:"varint,2,opt,name=months_lockup,json=monthsLockup,proto3" json:"months_lockup,omitempty"` @@ -124,7 +164,7 @@ func (m *Multiplier) Reset() { *m = Multiplier{} } func (m *Multiplier) String() string { return proto.CompactTextString(m) } func (*Multiplier) ProtoMessage() {} func (*Multiplier) Descriptor() ([]byte, []int) { - return fileDescriptor_bb8833f5d745eac9, []int{2} + return fileDescriptor_bb8833f5d745eac9, []int{3} } func (m *Multiplier) XXX_Unmarshal(b []byte) error { return m.Unmarshal(b) @@ -163,7 +203,7 @@ func (m *MultipliersPerDenom) Reset() { *m = MultipliersPerDenom{} } func (m *MultipliersPerDenom) String() string { return proto.CompactTextString(m) } func (*MultipliersPerDenom) ProtoMessage() {} func (*MultipliersPerDenom) Descriptor() ([]byte, []int) { - return fileDescriptor_bb8833f5d745eac9, []int{3} + return fileDescriptor_bb8833f5d745eac9, []int{4} } func (m *MultipliersPerDenom) XXX_Unmarshal(b []byte) error { return m.Unmarshal(b) @@ -194,22 +234,23 @@ var xxx_messageInfo_MultipliersPerDenom proto.InternalMessageInfo // Params type Params struct { - USDXMintingRewardPeriods RewardPeriods `protobuf:"bytes,1,rep,name=usdx_minting_reward_periods,json=usdxMintingRewardPeriods,proto3,castrepeated=RewardPeriods" json:"usdx_minting_reward_periods"` - HardSupplyRewardPeriods MultiRewardPeriods `protobuf:"bytes,2,rep,name=hard_supply_reward_periods,json=hardSupplyRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"hard_supply_reward_periods"` - HardBorrowRewardPeriods MultiRewardPeriods `protobuf:"bytes,3,rep,name=hard_borrow_reward_periods,json=hardBorrowRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"hard_borrow_reward_periods"` - DelegatorRewardPeriods MultiRewardPeriods `protobuf:"bytes,4,rep,name=delegator_reward_periods,json=delegatorRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"delegator_reward_periods"` - SwapRewardPeriods MultiRewardPeriods `protobuf:"bytes,5,rep,name=swap_reward_periods,json=swapRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"swap_reward_periods"` - ClaimMultipliers MultipliersPerDenoms `protobuf:"bytes,6,rep,name=claim_multipliers,json=claimMultipliers,proto3,castrepeated=MultipliersPerDenoms" json:"claim_multipliers"` - ClaimEnd time.Time `protobuf:"bytes,7,opt,name=claim_end,json=claimEnd,proto3,stdtime" json:"claim_end"` - SavingsRewardPeriods MultiRewardPeriods `protobuf:"bytes,8,rep,name=savings_reward_periods,json=savingsRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"savings_reward_periods"` - EarnRewardPeriods MultiRewardPeriods `protobuf:"bytes,9,rep,name=earn_reward_periods,json=earnRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"earn_reward_periods"` + USDXMintingRewardPeriods RewardPeriods `protobuf:"bytes,1,rep,name=usdx_minting_reward_periods,json=usdxMintingRewardPeriods,proto3,castrepeated=RewardPeriods" json:"usdx_minting_reward_periods"` + HardSupplyRewardPeriods MultiRewardPeriods `protobuf:"bytes,2,rep,name=hard_supply_reward_periods,json=hardSupplyRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"hard_supply_reward_periods"` + HardBorrowRewardPeriods MultiRewardPeriods `protobuf:"bytes,3,rep,name=hard_borrow_reward_periods,json=hardBorrowRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"hard_borrow_reward_periods"` + DelegatorRewardPeriods MultiRewardPeriods `protobuf:"bytes,4,rep,name=delegator_reward_periods,json=delegatorRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"delegator_reward_periods"` + SwapRewardPeriods MultiRewardPeriods `protobuf:"bytes,5,rep,name=swap_reward_periods,json=swapRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"swap_reward_periods"` + ClaimMultipliers MultipliersPerDenoms `protobuf:"bytes,6,rep,name=claim_multipliers,json=claimMultipliers,proto3,castrepeated=MultipliersPerDenoms" json:"claim_multipliers"` + ClaimEnd time.Time `protobuf:"bytes,7,opt,name=claim_end,json=claimEnd,proto3,stdtime" json:"claim_end"` + SavingsRewardPeriods MultiRewardPeriods `protobuf:"bytes,8,rep,name=savings_reward_periods,json=savingsRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"savings_reward_periods"` + EarnRewardPeriods MultiRewardPeriods `protobuf:"bytes,9,rep,name=earn_reward_periods,json=earnRewardPeriods,proto3,castrepeated=MultiRewardPeriods" json:"earn_reward_periods"` + RewardPeriods TypedMultiRewardPeriods `protobuf:"bytes,10,rep,name=reward_periods,json=rewardPeriods,proto3,castrepeated=TypedMultiRewardPeriods" json:"reward_periods"` } func (m *Params) Reset() { *m = Params{} } func (m *Params) String() string { return proto.CompactTextString(m) } func (*Params) ProtoMessage() {} func (*Params) Descriptor() ([]byte, []int) { - return fileDescriptor_bb8833f5d745eac9, []int{4} + return fileDescriptor_bb8833f5d745eac9, []int{5} } func (m *Params) XXX_Unmarshal(b []byte) error { return m.Unmarshal(b) @@ -241,6 +282,7 @@ var xxx_messageInfo_Params proto.InternalMessageInfo func init() { proto.RegisterType((*RewardPeriod)(nil), "kava.incentive.v1beta1.RewardPeriod") proto.RegisterType((*MultiRewardPeriod)(nil), "kava.incentive.v1beta1.MultiRewardPeriod") + proto.RegisterType((*TypedMultiRewardPeriod)(nil), "kava.incentive.v1beta1.TypedMultiRewardPeriod") proto.RegisterType((*Multiplier)(nil), "kava.incentive.v1beta1.Multiplier") proto.RegisterType((*MultipliersPerDenom)(nil), "kava.incentive.v1beta1.MultipliersPerDenom") proto.RegisterType((*Params)(nil), "kava.incentive.v1beta1.Params") @@ -251,56 +293,60 @@ func init() { } var fileDescriptor_bb8833f5d745eac9 = []byte{ - // 774 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xd4, 0x96, 0xcf, 0x6e, 0xd3, 0x4a, - 0x14, 0xc6, 0xe3, 0xfc, 0xbb, 0xc9, 0xb4, 0xbd, 0xb7, 0x9d, 0x46, 0xb9, 0xbe, 0xb9, 0xc8, 0xa9, - 0x52, 0x04, 0x41, 0x55, 0x6d, 0x0a, 0x12, 0x0b, 0x76, 0x98, 0x82, 0x84, 0x44, 0xa5, 0xca, 0x2d, - 0x12, 0xb0, 0x89, 0x26, 0xf6, 0xd4, 0xb5, 0x6a, 0x7b, 0xac, 0x99, 0x49, 0xda, 0x88, 0x05, 0x12, - 0x0b, 0x76, 0x48, 0x15, 0x0b, 0x1e, 0xa2, 0xaf, 0xc1, 0xa6, 0xcb, 0x8a, 0x15, 0x62, 0xd1, 0x42, - 0xfa, 0x22, 0x68, 0xc6, 0x6e, 0xe3, 0xa4, 0x69, 0xa1, 0x52, 0x36, 0xac, 0x32, 0x3e, 0x73, 0xce, - 0xf9, 0x7d, 0xfe, 0xc6, 0x67, 0x14, 0xb0, 0xb8, 0x83, 0xba, 0xc8, 0xf0, 0x42, 0x1b, 0x87, 0xdc, - 0xeb, 0x62, 0xa3, 0xbb, 0xd2, 0xc6, 0x1c, 0xad, 0x18, 0x11, 0xa2, 0x28, 0x60, 0x7a, 0x44, 0x09, - 0x27, 0xb0, 0x2a, 0x92, 0xf4, 0xf3, 0x24, 0x3d, 0x49, 0xaa, 0x69, 0x36, 0x61, 0x01, 0x61, 0x46, - 0x1b, 0xb1, 0x41, 0xa5, 0x4d, 0xbc, 0x30, 0xae, 0xab, 0x55, 0x5c, 0xe2, 0x12, 0xb9, 0x34, 0xc4, - 0x2a, 0x89, 0xd6, 0x5d, 0x42, 0x5c, 0x1f, 0x1b, 0xf2, 0xa9, 0xdd, 0xd9, 0x32, 0xb8, 0x17, 0x60, - 0xc6, 0x51, 0x10, 0xc5, 0x09, 0x8d, 0x8f, 0x59, 0x30, 0x6d, 0xe1, 0x5d, 0x44, 0x9d, 0x75, 0x4c, - 0x3d, 0xe2, 0xc0, 0x2a, 0x28, 0x22, 0x5b, 0x90, 0x55, 0x65, 0x41, 0x69, 0x96, 0xac, 0xe4, 0x09, - 0xde, 0x06, 0xff, 0xd8, 0xc4, 0xf7, 0x11, 0xc7, 0x14, 0xf9, 0x2d, 0xde, 0x8b, 0xb0, 0x9a, 0x5d, - 0x50, 0x9a, 0x65, 0xeb, 0xef, 0x41, 0x78, 0xb3, 0x17, 0x61, 0xf8, 0x10, 0x14, 0x18, 0x47, 0x94, - 0xab, 0xb9, 0x05, 0xa5, 0x39, 0x75, 0xaf, 0xa6, 0xc7, 0x12, 0xf4, 0x33, 0x09, 0xfa, 0xe6, 0x99, - 0x04, 0xb3, 0x74, 0x78, 0x5c, 0xcf, 0xec, 0x9f, 0xd4, 0x15, 0x2b, 0x2e, 0x81, 0x0f, 0x40, 0x0e, - 0x87, 0x8e, 0x9a, 0xbf, 0x46, 0xa5, 0x28, 0x80, 0x6b, 0x00, 0x52, 0xf9, 0x12, 0xac, 0x15, 0x61, - 0xda, 0x62, 0xd8, 0x26, 0xa1, 0xa3, 0x16, 0x64, 0x9b, 0xff, 0xf4, 0xd8, 0x39, 0x5d, 0x38, 0x77, - 0x66, 0xa7, 0xfe, 0x98, 0x78, 0xa1, 0x99, 0x17, 0x5d, 0xac, 0xd9, 0xa4, 0x74, 0x1d, 0xd3, 0x0d, - 0x59, 0xd8, 0xf8, 0x9c, 0x05, 0x73, 0x6b, 0x1d, 0x9f, 0x7b, 0x7f, 0xbe, 0x33, 0xbd, 0x4b, 0x9c, - 0xc9, 0x5d, 0xed, 0xcc, 0x5d, 0xd1, 0xe5, 0xe0, 0xa4, 0xde, 0x74, 0x3d, 0xbe, 0xdd, 0x69, 0xeb, - 0x36, 0x09, 0x8c, 0xe4, 0x03, 0x8c, 0x7f, 0x96, 0x99, 0xb3, 0x63, 0x88, 0x77, 0x65, 0xb2, 0x80, - 0x8d, 0x71, 0xf1, 0x83, 0x02, 0x80, 0x74, 0x31, 0xf2, 0x3d, 0x4c, 0x21, 0x04, 0xf9, 0x10, 0x05, - 0xb1, 0x79, 0x65, 0x4b, 0xae, 0xe1, 0x22, 0x98, 0x09, 0x48, 0xc8, 0xb7, 0x59, 0xcb, 0x27, 0xf6, - 0x4e, 0x27, 0x92, 0xc6, 0xe5, 0xac, 0xe9, 0x38, 0xf8, 0x5c, 0xc6, 0xe0, 0x53, 0x50, 0xdc, 0x42, - 0x36, 0x27, 0x54, 0xfa, 0x36, 0x6d, 0xea, 0x42, 0xdb, 0xb7, 0xe3, 0xfa, 0xad, 0xdf, 0xd0, 0xb6, - 0x8a, 0x6d, 0x2b, 0xa9, 0x6e, 0xbc, 0x57, 0xc0, 0xfc, 0x40, 0x8f, 0x10, 0xba, 0x8a, 0x43, 0x12, - 0xc0, 0x0a, 0x28, 0x38, 0x62, 0x91, 0x28, 0x8b, 0x1f, 0xe0, 0x2b, 0x30, 0x15, 0x0c, 0x92, 0xd5, - 0xac, 0x74, 0xac, 0xa1, 0x8f, 0x9f, 0x4e, 0x7d, 0xd0, 0xd7, 0x9c, 0x4f, 0xac, 0x9b, 0x4a, 0xb1, - 0xac, 0x74, 0xaf, 0xc6, 0x97, 0x12, 0x28, 0xae, 0xcb, 0x99, 0x87, 0x9f, 0x14, 0xf0, 0x7f, 0x87, - 0x39, 0x7b, 0xad, 0xc0, 0x0b, 0xb9, 0x17, 0xba, 0xad, 0xd8, 0x45, 0x71, 0x56, 0x1e, 0x71, 0x98, - 0xaa, 0x48, 0xec, 0xcd, 0xcb, 0xb0, 0xe9, 0xef, 0xd3, 0x5c, 0x11, 0xe0, 0xfe, 0x71, 0x5d, 0x7d, - 0xb1, 0xb1, 0xfa, 0x72, 0x2d, 0xee, 0x97, 0x4e, 0x60, 0x07, 0x27, 0xf5, 0x99, 0xa1, 0x80, 0xa5, - 0x0a, 0xf6, 0xb8, 0x54, 0xf8, 0x4e, 0x01, 0xb5, 0x6d, 0xa1, 0x84, 0x75, 0xa2, 0xc8, 0xef, 0x8d, - 0xea, 0x8a, 0xed, 0xb8, 0x73, 0xa5, 0x1d, 0x43, 0xe2, 0x6a, 0x89, 0x2b, 0xf0, 0xc2, 0x16, 0xb3, - 0xfe, 0x15, 0xa0, 0x0d, 0xc9, 0xb9, 0x44, 0x44, 0x9b, 0x50, 0x4a, 0x76, 0x47, 0x45, 0xe4, 0x26, - 0x2e, 0xc2, 0x94, 0x9c, 0x61, 0x11, 0x6f, 0x81, 0xea, 0x60, 0x1f, 0xbb, 0x88, 0x13, 0x3a, 0xaa, - 0x20, 0x3f, 0x49, 0x05, 0xd5, 0x73, 0xcc, 0xb0, 0x80, 0x0e, 0x98, 0x67, 0xbb, 0x28, 0x1a, 0x65, - 0x17, 0x26, 0xc9, 0x9e, 0x13, 0x84, 0x61, 0x6c, 0x17, 0xcc, 0xd9, 0x3e, 0xf2, 0x82, 0x56, 0x7a, - 0x0c, 0x8a, 0x12, 0xba, 0xf4, 0xeb, 0x31, 0x38, 0x1f, 0x2f, 0xf3, 0x46, 0x82, 0xad, 0x8c, 0xd9, - 0x64, 0xd6, 0xac, 0x64, 0xa4, 0xb6, 0xe0, 0x23, 0x50, 0x8e, 0xb9, 0xe2, 0xbe, 0xfb, 0xeb, 0x1a, - 0xf7, 0x5d, 0x49, 0x96, 0x3d, 0x09, 0x1d, 0xf8, 0x06, 0x54, 0x19, 0xea, 0x7a, 0xa1, 0xcb, 0x46, - 0x4d, 0x2b, 0x4d, 0xd2, 0xb4, 0x4a, 0x02, 0xb9, 0x70, 0x5c, 0x18, 0xd1, 0x70, 0x94, 0x5c, 0x9e, - 0xe8, 0x71, 0x09, 0xc2, 0x50, 0xc8, 0x7c, 0x76, 0xf8, 0x43, 0xcb, 0x1c, 0xf6, 0x35, 0xe5, 0xa8, - 0xaf, 0x29, 0xdf, 0xfb, 0x9a, 0xb2, 0x7f, 0xaa, 0x65, 0x8e, 0x4e, 0xb5, 0xcc, 0xd7, 0x53, 0x2d, - 0xf3, 0x7a, 0x29, 0x75, 0x57, 0x0a, 0x05, 0xcb, 0x3e, 0x6a, 0x33, 0xb9, 0x32, 0xf6, 0x52, 0xff, - 0x48, 0xe4, 0xa5, 0xd9, 0x2e, 0x4a, 0x9b, 0xef, 0xff, 0x0c, 0x00, 0x00, 0xff, 0xff, 0xca, 0x77, - 0xf8, 0x09, 0xb0, 0x08, 0x00, 0x00, + // 844 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0xd4, 0x56, 0xcd, 0x6e, 0xeb, 0x44, + 0x14, 0x8e, 0xf3, 0x47, 0x32, 0xfd, 0xa1, 0x9d, 0x46, 0xa9, 0x09, 0xc8, 0x2e, 0x29, 0x82, 0xa0, + 0xaa, 0x36, 0x2d, 0x12, 0x0b, 0x56, 0xe0, 0x16, 0x24, 0x24, 0x2a, 0x55, 0x6e, 0x91, 0x80, 0x8d, + 0x35, 0xb1, 0xa7, 0xae, 0x55, 0xdb, 0x63, 0xcd, 0x38, 0x69, 0x23, 0x16, 0x48, 0x2c, 0xd8, 0x21, + 0x55, 0x2c, 0x78, 0x88, 0xbe, 0x06, 0x9b, 0x88, 0x55, 0x97, 0x88, 0x45, 0xcb, 0x4d, 0x5f, 0xe4, + 0x6a, 0xc6, 0x4e, 0x93, 0x38, 0x49, 0xef, 0xad, 0x94, 0xbb, 0xb8, 0xab, 0x9c, 0x99, 0x39, 0xe7, + 0x7c, 0xdf, 0xf9, 0xce, 0xcc, 0x89, 0xc1, 0xf6, 0x05, 0xea, 0x22, 0xdd, 0x0b, 0x6d, 0x1c, 0xc6, + 0x5e, 0x17, 0xeb, 0xdd, 0xbd, 0x36, 0x8e, 0xd1, 0x9e, 0x1e, 0x21, 0x8a, 0x02, 0xa6, 0x45, 0x94, + 0xc4, 0x04, 0xd6, 0xb9, 0x93, 0xf6, 0xe8, 0xa4, 0xa5, 0x4e, 0x0d, 0xc5, 0x26, 0x2c, 0x20, 0x4c, + 0x6f, 0x23, 0x36, 0x8a, 0xb4, 0x89, 0x17, 0x26, 0x71, 0x8d, 0x9a, 0x4b, 0x5c, 0x22, 0x4c, 0x9d, + 0x5b, 0xe9, 0xae, 0xea, 0x12, 0xe2, 0xfa, 0x58, 0x17, 0xab, 0x76, 0xe7, 0x4c, 0x8f, 0xbd, 0x00, + 0xb3, 0x18, 0x05, 0x51, 0xea, 0x30, 0x8f, 0x93, 0xed, 0x23, 0x6f, 0xc8, 0xa9, 0xf9, 0x67, 0x1e, + 0x2c, 0x9b, 0xf8, 0x12, 0x51, 0xe7, 0x18, 0x53, 0x8f, 0x38, 0xb0, 0x0e, 0xca, 0xc8, 0xe6, 0xfe, + 0xb2, 0xb4, 0x25, 0xb5, 0x2a, 0x66, 0xba, 0x82, 0x9f, 0x80, 0x77, 0x6d, 0xe2, 0xfb, 0x28, 0xc6, + 0x14, 0xf9, 0x56, 0xdc, 0x8b, 0xb0, 0x9c, 0xdf, 0x92, 0x5a, 0x55, 0x73, 0x75, 0xb4, 0x7d, 0xda, + 0x8b, 0x30, 0xfc, 0x12, 0x94, 0x58, 0x8c, 0x68, 0x2c, 0x17, 0xb6, 0xa4, 0xd6, 0xd2, 0x7e, 0x43, + 0x4b, 0x78, 0x6a, 0x43, 0x9e, 0xda, 0xe9, 0x90, 0xa7, 0x51, 0xe9, 0xdf, 0xa9, 0xb9, 0xeb, 0x7b, + 0x55, 0x32, 0x93, 0x10, 0xf8, 0x05, 0x28, 0xe0, 0xd0, 0x91, 0x8b, 0xcf, 0x88, 0xe4, 0x01, 0xf0, + 0x08, 0x40, 0x2a, 0x8a, 0x60, 0x56, 0x84, 0xa9, 0xc5, 0xb0, 0x4d, 0x42, 0x47, 0x2e, 0x89, 0x34, + 0xef, 0x69, 0x89, 0xbc, 0x1a, 0x97, 0x77, 0xa8, 0xb9, 0x76, 0x40, 0xbc, 0xd0, 0x28, 0xf2, 0x2c, + 0xe6, 0x5a, 0x1a, 0x7a, 0x8c, 0xe9, 0x89, 0x08, 0x6c, 0xfe, 0x9d, 0x07, 0xeb, 0x47, 0x1d, 0x3f, + 0xf6, 0xde, 0x7e, 0x65, 0x7a, 0x73, 0x94, 0x29, 0x3c, 0xad, 0xcc, 0x67, 0x3c, 0xcb, 0xcd, 0xbd, + 0xda, 0x72, 0xbd, 0xf8, 0xbc, 0xd3, 0xd6, 0x6c, 0x12, 0xe8, 0xe9, 0x2d, 0x4d, 0x7e, 0x76, 0x99, + 0x73, 0xa1, 0xf3, 0x5a, 0x99, 0x08, 0x60, 0x33, 0x54, 0xec, 0x4b, 0xa0, 0xce, 0xeb, 0x76, 0xa6, + 0xa5, 0xfc, 0x0a, 0x00, 0x71, 0x0b, 0x13, 0xb5, 0xb8, 0x9c, 0xab, 0xfb, 0x1f, 0x6a, 0xb3, 0x9f, + 0x87, 0x76, 0xc0, 0x3d, 0x79, 0x22, 0xb3, 0x6a, 0x0f, 0x4d, 0xe8, 0x83, 0xd5, 0x04, 0x90, 0x97, + 0xe5, 0x11, 0x87, 0xc9, 0x79, 0x51, 0xd3, 0xa7, 0xf3, 0xb2, 0x4c, 0x91, 0x30, 0x1a, 0x69, 0x8d, + 0x70, 0xea, 0x88, 0x99, 0x2b, 0x74, 0x7c, 0xd9, 0xfc, 0x43, 0x02, 0x40, 0x78, 0x45, 0xbe, 0x87, + 0x29, 0x84, 0xa0, 0x18, 0xa2, 0x20, 0x21, 0x5e, 0x35, 0x85, 0x0d, 0xb7, 0xc1, 0x4a, 0x40, 0xc2, + 0xf8, 0x9c, 0x59, 0x3e, 0xb1, 0x2f, 0x3a, 0x91, 0xb8, 0x03, 0x05, 0x73, 0x39, 0xd9, 0xfc, 0x5e, + 0xec, 0xc1, 0x6f, 0x41, 0xf9, 0x0c, 0xd9, 0x31, 0xa1, 0xe2, 0x0a, 0x2c, 0x1b, 0x1a, 0xa7, 0xf0, + 0xdf, 0x9d, 0xfa, 0xf1, 0x6b, 0xc8, 0x7c, 0x88, 0x6d, 0x33, 0x8d, 0x6e, 0xfe, 0x2e, 0x81, 0x8d, + 0x11, 0x1f, 0xae, 0xf9, 0x21, 0x0e, 0x49, 0x00, 0x6b, 0xa0, 0xe4, 0x70, 0x23, 0x65, 0x96, 0x2c, + 0xe0, 0x4f, 0x60, 0x29, 0x18, 0x39, 0xa7, 0x42, 0x35, 0x9f, 0x14, 0x4a, 0xb8, 0x1a, 0x1b, 0xa9, + 0x42, 0x4b, 0x63, 0x58, 0xe6, 0x78, 0xae, 0xe6, 0x3f, 0x55, 0x50, 0x3e, 0x16, 0x33, 0x0e, 0xfe, + 0x25, 0x81, 0xf7, 0x3b, 0xcc, 0xb9, 0xb2, 0x02, 0x2f, 0x8c, 0xbd, 0xd0, 0xb5, 0x32, 0xfd, 0x91, + 0x04, 0xec, 0x47, 0xf3, 0x60, 0x27, 0x5a, 0xb3, 0xc7, 0x81, 0x07, 0x77, 0xaa, 0xfc, 0xc3, 0xc9, + 0xe1, 0x8f, 0x47, 0x49, 0xbe, 0x89, 0x06, 0xdd, 0xdc, 0xab, 0x2b, 0x93, 0x1d, 0x93, 0x39, 0xf6, + 0x2c, 0x57, 0xf8, 0x9b, 0x04, 0x1a, 0xe7, 0x9c, 0x09, 0xeb, 0x44, 0x91, 0xdf, 0xb3, 0xde, 0xe4, + 0xbd, 0xd9, 0xe4, 0x40, 0x27, 0x02, 0x67, 0x0e, 0x89, 0x36, 0xa1, 0x94, 0x5c, 0x66, 0x49, 0x14, + 0x16, 0x4e, 0xc2, 0x10, 0x38, 0x93, 0x24, 0x7e, 0x05, 0xb2, 0x83, 0x7d, 0xec, 0xa2, 0x98, 0xd0, + 0x2c, 0x83, 0xe2, 0x22, 0x19, 0xd4, 0x1f, 0x61, 0x26, 0x09, 0x74, 0xc0, 0x06, 0xbb, 0x44, 0x51, + 0x16, 0xbb, 0xb4, 0x48, 0xec, 0x75, 0x8e, 0x30, 0x09, 0xdb, 0x05, 0xeb, 0xc9, 0xb8, 0x19, 0x7f, + 0x06, 0x65, 0x01, 0xba, 0xf3, 0xea, 0x67, 0xf0, 0xf8, 0xbc, 0x8c, 0x0f, 0x52, 0xd8, 0xda, 0x8c, + 0x43, 0x66, 0xae, 0x09, 0x8c, 0xb1, 0x23, 0xf8, 0x35, 0x48, 0x26, 0x96, 0xc5, 0x47, 0xf7, 0x3b, + 0xcf, 0x18, 0xdd, 0x15, 0x11, 0xf6, 0x4d, 0xe8, 0xc0, 0x5f, 0x40, 0x9d, 0xa1, 0xae, 0x17, 0xba, + 0x2c, 0x2b, 0x5a, 0x65, 0x91, 0xa2, 0xd5, 0x52, 0x90, 0xa9, 0x76, 0x61, 0x44, 0xc3, 0x2c, 0x72, + 0x75, 0xa1, 0xed, 0xe2, 0x08, 0xd9, 0x76, 0x65, 0x67, 0x3b, 0x10, 0x88, 0xda, 0x3c, 0xc4, 0xd9, + 0xff, 0x32, 0x86, 0x9a, 0xc2, 0x6e, 0xce, 0x3e, 0xcf, 0x4e, 0x79, 0xe3, 0xbb, 0xfe, 0x0b, 0x25, + 0xd7, 0x1f, 0x28, 0xd2, 0xed, 0x40, 0x91, 0xfe, 0x1f, 0x28, 0xd2, 0xf5, 0x83, 0x92, 0xbb, 0x7d, + 0x50, 0x72, 0xff, 0x3e, 0x28, 0xb9, 0x9f, 0x77, 0xc6, 0x66, 0x34, 0xe7, 0xb1, 0xeb, 0xa3, 0x36, + 0x13, 0x96, 0x7e, 0x35, 0xf6, 0x95, 0x25, 0x86, 0x75, 0xbb, 0x2c, 0xda, 0xfb, 0xf9, 0xcb, 0x00, + 0x00, 0x00, 0xff, 0xff, 0x4c, 0xba, 0x2a, 0x08, 0x18, 0x0a, 0x00, 0x00, } func (m *RewardPeriod) Marshal() (dAtA []byte, err error) { @@ -439,6 +485,48 @@ func (m *MultiRewardPeriod) MarshalToSizedBuffer(dAtA []byte) (int, error) { return len(dAtA) - i, nil } +func (m *TypedMultiRewardPeriod) Marshal() (dAtA []byte, err error) { + size := m.Size() + dAtA = make([]byte, size) + n, err := m.MarshalToSizedBuffer(dAtA[:size]) + if err != nil { + return nil, err + } + return dAtA[:n], nil +} + +func (m *TypedMultiRewardPeriod) MarshalTo(dAtA []byte) (int, error) { + size := m.Size() + return m.MarshalToSizedBuffer(dAtA[:size]) +} + +func (m *TypedMultiRewardPeriod) MarshalToSizedBuffer(dAtA []byte) (int, error) { + i := len(dAtA) + _ = i + var l int + _ = l + if len(m.RewardPeriods) > 0 { + for iNdEx := len(m.RewardPeriods) - 1; iNdEx >= 0; iNdEx-- { + { + size, err := m.RewardPeriods[iNdEx].MarshalToSizedBuffer(dAtA[:i]) + if err != nil { + return 0, err + } + i -= size + i = encodeVarintParams(dAtA, i, uint64(size)) + } + i-- + dAtA[i] = 0x12 + } + } + if m.ClaimType != 0 { + i = encodeVarintParams(dAtA, i, uint64(m.ClaimType)) + i-- + dAtA[i] = 0x8 + } + return len(dAtA) - i, nil +} + func (m *Multiplier) Marshal() (dAtA []byte, err error) { size := m.Size() dAtA = make([]byte, size) @@ -548,6 +636,20 @@ func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l + if len(m.RewardPeriods) > 0 { + for iNdEx := len(m.RewardPeriods) - 1; iNdEx >= 0; iNdEx-- { + { + size, err := m.RewardPeriods[iNdEx].MarshalToSizedBuffer(dAtA[:i]) + if err != nil { + return 0, err + } + i -= size + i = encodeVarintParams(dAtA, i, uint64(size)) + } + i-- + dAtA[i] = 0x52 + } + } if len(m.EarnRewardPeriods) > 0 { for iNdEx := len(m.EarnRewardPeriods) - 1; iNdEx >= 0; iNdEx-- { { @@ -730,6 +832,24 @@ func (m *MultiRewardPeriod) Size() (n int) { return n } +func (m *TypedMultiRewardPeriod) Size() (n int) { + if m == nil { + return 0 + } + var l int + _ = l + if m.ClaimType != 0 { + n += 1 + sovParams(uint64(m.ClaimType)) + } + if len(m.RewardPeriods) > 0 { + for _, e := range m.RewardPeriods { + l = e.Size() + n += 1 + l + sovParams(uint64(l)) + } + } + return n +} + func (m *Multiplier) Size() (n int) { if m == nil { return 0 @@ -823,6 +943,12 @@ func (m *Params) Size() (n int) { n += 1 + l + sovParams(uint64(l)) } } + if len(m.RewardPeriods) > 0 { + for _, e := range m.RewardPeriods { + l = e.Size() + n += 1 + l + sovParams(uint64(l)) + } + } return n } @@ -1235,6 +1361,109 @@ func (m *MultiRewardPeriod) Unmarshal(dAtA []byte) error { } return nil } +func (m *TypedMultiRewardPeriod) Unmarshal(dAtA []byte) error { + l := len(dAtA) + iNdEx := 0 + for iNdEx < l { + preIndex := iNdEx + var wire uint64 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowParams + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + wire |= uint64(b&0x7F) << shift + if b < 0x80 { + break + } + } + fieldNum := int32(wire >> 3) + wireType := int(wire & 0x7) + if wireType == 4 { + return fmt.Errorf("proto: TypedMultiRewardPeriod: wiretype end group for non-group") + } + if fieldNum <= 0 { + return fmt.Errorf("proto: TypedMultiRewardPeriod: illegal tag %d (wire type %d)", fieldNum, wire) + } + switch fieldNum { + case 1: + if wireType != 0 { + return fmt.Errorf("proto: wrong wireType = %d for field ClaimType", wireType) + } + m.ClaimType = 0 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowParams + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + m.ClaimType |= ClaimType(b&0x7F) << shift + if b < 0x80 { + break + } + } + case 2: + if wireType != 2 { + return fmt.Errorf("proto: wrong wireType = %d for field RewardPeriods", wireType) + } + var msglen int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowParams + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + msglen |= int(b&0x7F) << shift + if b < 0x80 { + break + } + } + if msglen < 0 { + return ErrInvalidLengthParams + } + postIndex := iNdEx + msglen + if postIndex < 0 { + return ErrInvalidLengthParams + } + if postIndex > l { + return io.ErrUnexpectedEOF + } + m.RewardPeriods = append(m.RewardPeriods, MultiRewardPeriod{}) + if err := m.RewardPeriods[len(m.RewardPeriods)-1].Unmarshal(dAtA[iNdEx:postIndex]); err != nil { + return err + } + iNdEx = postIndex + default: + iNdEx = preIndex + skippy, err := skipParams(dAtA[iNdEx:]) + if err != nil { + return err + } + if (skippy < 0) || (iNdEx+skippy) < 0 { + return ErrInvalidLengthParams + } + if (iNdEx + skippy) > l { + return io.ErrUnexpectedEOF + } + iNdEx += skippy + } + } + + if iNdEx > l { + return io.ErrUnexpectedEOF + } + return nil +} func (m *Multiplier) Unmarshal(dAtA []byte) error { l := len(dAtA) iNdEx := 0 @@ -1819,6 +2048,40 @@ func (m *Params) Unmarshal(dAtA []byte) error { return err } iNdEx = postIndex + case 10: + if wireType != 2 { + return fmt.Errorf("proto: wrong wireType = %d for field RewardPeriods", wireType) + } + var msglen int + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowParams + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + msglen |= int(b&0x7F) << shift + if b < 0x80 { + break + } + } + if msglen < 0 { + return ErrInvalidLengthParams + } + postIndex := iNdEx + msglen + if postIndex < 0 { + return ErrInvalidLengthParams + } + if postIndex > l { + return io.ErrUnexpectedEOF + } + m.RewardPeriods = append(m.RewardPeriods, TypedMultiRewardPeriod{}) + if err := m.RewardPeriods[len(m.RewardPeriods)-1].Unmarshal(dAtA[iNdEx:postIndex]); err != nil { + return err + } + iNdEx = postIndex default: iNdEx = preIndex skippy, err := skipParams(dAtA[iNdEx:])