mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-11-10 10:05:18 +00:00
genesis updates for incentive migration (#806)
This commit is contained in:
parent
176c1973d3
commit
e9eb5ea20c
@ -8,29 +8,39 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
AttributeKeyClaimAmount = types.AttributeKeyClaimAmount
|
BeginningOfMonth = keeper.BeginningOfMonth
|
||||||
AttributeKeyClaimPeriod = types.AttributeKeyClaimPeriod
|
MidMonth = keeper.MidMonth
|
||||||
AttributeKeyClaimedBy = types.AttributeKeyClaimedBy
|
PaymentHour = keeper.PaymentHour
|
||||||
AttributeKeyRewardPeriod = types.AttributeKeyRewardPeriod
|
AttributeKeyClaimAmount = types.AttributeKeyClaimAmount
|
||||||
AttributeValueCategory = types.AttributeValueCategory
|
AttributeKeyClaimPeriod = types.AttributeKeyClaimPeriod
|
||||||
DefaultParamspace = types.DefaultParamspace
|
AttributeKeyClaimType = types.AttributeKeyClaimType
|
||||||
EventTypeClaim = types.EventTypeClaim
|
AttributeKeyClaimedBy = types.AttributeKeyClaimedBy
|
||||||
EventTypeClaimPeriod = types.EventTypeClaimPeriod
|
AttributeKeyRewardPeriod = types.AttributeKeyRewardPeriod
|
||||||
EventTypeClaimPeriodExpiry = types.EventTypeClaimPeriodExpiry
|
AttributeValueCategory = types.AttributeValueCategory
|
||||||
EventTypeRewardPeriod = types.EventTypeRewardPeriod
|
BondDenom = types.BondDenom
|
||||||
Large = types.Large
|
DefaultParamspace = types.DefaultParamspace
|
||||||
Medium = types.Medium
|
EventTypeClaim = types.EventTypeClaim
|
||||||
ModuleName = types.ModuleName
|
EventTypeClaimPeriod = types.EventTypeClaimPeriod
|
||||||
QuerierRoute = types.QuerierRoute
|
EventTypeClaimPeriodExpiry = types.EventTypeClaimPeriodExpiry
|
||||||
QueryGetClaimPeriods = types.QueryGetClaimPeriods
|
EventTypeRewardPeriod = types.EventTypeRewardPeriod
|
||||||
QueryGetRewards = types.QueryGetRewards
|
HardLiquidityProviderClaimType = types.HardLiquidityProviderClaimType
|
||||||
QueryGetParams = types.QueryGetParams
|
Large = types.Large
|
||||||
QueryGetRewardPeriods = types.QueryGetRewardPeriods
|
Medium = types.Medium
|
||||||
RestClaimCollateralType = types.RestClaimCollateralType
|
ModuleName = types.ModuleName
|
||||||
RestClaimOwner = types.RestClaimOwner
|
QuerierRoute = types.QuerierRoute
|
||||||
RouterKey = types.RouterKey
|
QueryGetClaimPeriods = types.QueryGetClaimPeriods
|
||||||
Small = types.Small
|
QueryGetHardRewards = types.QueryGetHardRewards
|
||||||
StoreKey = types.StoreKey
|
QueryGetParams = types.QueryGetParams
|
||||||
|
QueryGetRewardPeriods = types.QueryGetRewardPeriods
|
||||||
|
QueryGetRewards = types.QueryGetRewards
|
||||||
|
QueryGetUSDXMintingRewards = types.QueryGetUSDXMintingRewards
|
||||||
|
RestClaimCollateralType = types.RestClaimCollateralType
|
||||||
|
RestClaimOwner = types.RestClaimOwner
|
||||||
|
RestClaimType = types.RestClaimType
|
||||||
|
RouterKey = types.RouterKey
|
||||||
|
Small = types.Small
|
||||||
|
StoreKey = types.StoreKey
|
||||||
|
USDXMintingClaimType = types.USDXMintingClaimType
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
@ -43,74 +53,103 @@ var (
|
|||||||
GetTotalVestingPeriodLength = types.GetTotalVestingPeriodLength
|
GetTotalVestingPeriodLength = types.GetTotalVestingPeriodLength
|
||||||
NewGenesisAccumulationTime = types.NewGenesisAccumulationTime
|
NewGenesisAccumulationTime = types.NewGenesisAccumulationTime
|
||||||
NewGenesisState = types.NewGenesisState
|
NewGenesisState = types.NewGenesisState
|
||||||
NewMsgClaimUSDXMintingReward = types.NewMsgClaimUSDXMintingReward
|
NewHardLiquidityProviderClaim = types.NewHardLiquidityProviderClaim
|
||||||
NewMsgClaimHardLiquidityProviderReward = types.NewMsgClaimHardLiquidityProviderReward
|
NewMsgClaimHardLiquidityProviderReward = types.NewMsgClaimHardLiquidityProviderReward
|
||||||
|
NewMsgClaimUSDXMintingReward = types.NewMsgClaimUSDXMintingReward
|
||||||
|
NewMultiRewardIndex = types.NewMultiRewardIndex
|
||||||
|
NewMultiRewardPeriod = types.NewMultiRewardPeriod
|
||||||
NewMultiplier = types.NewMultiplier
|
NewMultiplier = types.NewMultiplier
|
||||||
NewParams = types.NewParams
|
NewParams = types.NewParams
|
||||||
NewPeriod = types.NewPeriod
|
NewPeriod = types.NewPeriod
|
||||||
|
NewQueryHardRewardsParams = types.NewQueryHardRewardsParams
|
||||||
NewQueryRewardsParams = types.NewQueryRewardsParams
|
NewQueryRewardsParams = types.NewQueryRewardsParams
|
||||||
|
NewQueryUSDXMintingRewardsParams = types.NewQueryUSDXMintingRewardsParams
|
||||||
NewRewardIndex = types.NewRewardIndex
|
NewRewardIndex = types.NewRewardIndex
|
||||||
NewRewardPeriod = types.NewRewardPeriod
|
NewRewardPeriod = types.NewRewardPeriod
|
||||||
NewMultiRewardPeriod = types.NewMultiRewardPeriod
|
|
||||||
NewUSDXMintingClaim = types.NewUSDXMintingClaim
|
NewUSDXMintingClaim = types.NewUSDXMintingClaim
|
||||||
NewHardLiquidityProviderClaim = types.NewHardLiquidityProviderClaim
|
|
||||||
ParamKeyTable = types.ParamKeyTable
|
ParamKeyTable = types.ParamKeyTable
|
||||||
RegisterCodec = types.RegisterCodec
|
RegisterCodec = types.RegisterCodec
|
||||||
|
|
||||||
// variable aliases
|
// variable aliases
|
||||||
PreviousUSDXMintingRewardAccrualTimeKeyPrefix = types.PreviousUSDXMintingRewardAccrualTimeKeyPrefix
|
DefaultActive = types.DefaultActive
|
||||||
USDXMintingClaimKeyPrefix = types.USDXMintingClaimKeyPrefix
|
DefaultClaimEnd = types.DefaultClaimEnd
|
||||||
DefaultActive = types.DefaultActive
|
DefaultGenesisAccumulationTimes = types.DefaultGenesisAccumulationTimes
|
||||||
DefaultClaimEnd = types.DefaultClaimEnd
|
DefaultHardClaims = types.DefaultHardClaims
|
||||||
DefaultClaims = types.DefaultClaims
|
DefaultMultiRewardPeriods = types.DefaultMultiRewardPeriods
|
||||||
DefaultGenesisAccumulationTimes = types.DefaultGenesisAccumulationTimes
|
DefaultMultipliers = types.DefaultMultipliers
|
||||||
DefaultMultipliers = types.DefaultMultipliers
|
DefaultRewardPeriods = types.DefaultRewardPeriods
|
||||||
DefaultRewardPeriods = types.DefaultRewardPeriods
|
DefaultUSDXClaims = types.DefaultUSDXClaims
|
||||||
DefaultMultiRewardPeriods = types.DefaultMultiRewardPeriods
|
ErrAccountNotFound = types.ErrAccountNotFound
|
||||||
ErrAccountNotFound = types.ErrAccountNotFound
|
ErrClaimExpired = types.ErrClaimExpired
|
||||||
ErrClaimExpired = types.ErrClaimExpired
|
ErrClaimNotFound = types.ErrClaimNotFound
|
||||||
ErrClaimNotFound = types.ErrClaimNotFound
|
ErrInsufficientModAccountBalance = types.ErrInsufficientModAccountBalance
|
||||||
ErrInsufficientModAccountBalance = types.ErrInsufficientModAccountBalance
|
ErrInvalidAccountType = types.ErrInvalidAccountType
|
||||||
ErrInvalidAccountType = types.ErrInvalidAccountType
|
ErrInvalidClaimType = types.ErrInvalidClaimType
|
||||||
ErrInvalidMultiplier = types.ErrInvalidMultiplier
|
ErrInvalidMultiplier = types.ErrInvalidMultiplier
|
||||||
ErrNoClaimsFound = types.ErrNoClaimsFound
|
ErrNoClaimsFound = types.ErrNoClaimsFound
|
||||||
ErrRewardPeriodNotFound = types.ErrRewardPeriodNotFound
|
ErrRewardPeriodNotFound = types.ErrRewardPeriodNotFound
|
||||||
ErrZeroClaim = types.ErrZeroClaim
|
ErrZeroClaim = types.ErrZeroClaim
|
||||||
GovDenom = types.GovDenom
|
GovDenom = types.GovDenom
|
||||||
IncentiveMacc = types.IncentiveMacc
|
HardBorrowRewardIndexesKeyPrefix = types.HardBorrowRewardIndexesKeyPrefix
|
||||||
KeyClaimEnd = types.KeyClaimEnd
|
HardDelegatorRewardFactorKeyPrefix = types.HardDelegatorRewardFactorKeyPrefix
|
||||||
KeyMultipliers = types.KeyMultipliers
|
HardLiquidityClaimKeyPrefix = types.HardLiquidityClaimKeyPrefix
|
||||||
KeyUSDXMintingRewardPeriods = types.KeyUSDXMintingRewardPeriods
|
HardLiquidityRewardDenom = types.HardLiquidityRewardDenom
|
||||||
ModuleCdc = types.ModuleCdc
|
HardSupplyRewardIndexesKeyPrefix = types.HardSupplyRewardIndexesKeyPrefix
|
||||||
PrincipalDenom = types.PrincipalDenom
|
IncentiveMacc = types.IncentiveMacc
|
||||||
USDXMintingRewardFactorKeyPrefix = types.USDXMintingRewardFactorKeyPrefix
|
KeyClaimEnd = types.KeyClaimEnd
|
||||||
USDXMintingRewardDenom = types.USDXMintingRewardDenom
|
KeyHardBorrowRewardPeriods = types.KeyHardBorrowRewardPeriods
|
||||||
|
KeyHardDelegatorRewardPeriods = types.KeyHardDelegatorRewardPeriods
|
||||||
|
KeyHardSupplyRewardPeriods = types.KeyHardSupplyRewardPeriods
|
||||||
|
KeyMultipliers = types.KeyMultipliers
|
||||||
|
KeyUSDXMintingRewardPeriods = types.KeyUSDXMintingRewardPeriods
|
||||||
|
ModuleCdc = types.ModuleCdc
|
||||||
|
PreviousHardBorrowRewardAccrualTimeKeyPrefix = types.PreviousHardBorrowRewardAccrualTimeKeyPrefix
|
||||||
|
PreviousHardDelegatorRewardAccrualTimeKeyPrefix = types.PreviousHardDelegatorRewardAccrualTimeKeyPrefix
|
||||||
|
PreviousHardSupplyRewardAccrualTimeKeyPrefix = types.PreviousHardSupplyRewardAccrualTimeKeyPrefix
|
||||||
|
PreviousUSDXMintingRewardAccrualTimeKeyPrefix = types.PreviousUSDXMintingRewardAccrualTimeKeyPrefix
|
||||||
|
PrincipalDenom = types.PrincipalDenom
|
||||||
|
USDXMintingClaimKeyPrefix = types.USDXMintingClaimKeyPrefix
|
||||||
|
USDXMintingRewardDenom = types.USDXMintingRewardDenom
|
||||||
|
USDXMintingRewardFactorKeyPrefix = types.USDXMintingRewardFactorKeyPrefix
|
||||||
)
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
Hooks = keeper.Hooks
|
Hooks = keeper.Hooks
|
||||||
Keeper = keeper.Keeper
|
Keeper = keeper.Keeper
|
||||||
AccountKeeper = types.AccountKeeper
|
AccountKeeper = types.AccountKeeper
|
||||||
CDPHooks = types.CDPHooks
|
BaseClaim = types.BaseClaim
|
||||||
HARDHooks = types.HARDHooks
|
BaseMultiClaim = types.BaseMultiClaim
|
||||||
CdpKeeper = types.CdpKeeper
|
CDPHooks = types.CDPHooks
|
||||||
GenesisAccumulationTime = types.GenesisAccumulationTime
|
CdpKeeper = types.CdpKeeper
|
||||||
GenesisAccumulationTimes = types.GenesisAccumulationTimes
|
Claim = types.Claim
|
||||||
GenesisState = types.GenesisState
|
Claims = types.Claims
|
||||||
MsgClaimUSDXMintingReward = types.MsgClaimUSDXMintingReward
|
GenesisAccumulationTime = types.GenesisAccumulationTime
|
||||||
Multiplier = types.Multiplier
|
GenesisAccumulationTimes = types.GenesisAccumulationTimes
|
||||||
MultiplierName = types.MultiplierName
|
GenesisState = types.GenesisState
|
||||||
Multipliers = types.Multipliers
|
HARDHooks = types.HARDHooks
|
||||||
Params = types.Params
|
HardKeeper = types.HardKeeper
|
||||||
PostClaimReq = types.PostClaimReq
|
HardLiquidityProviderClaim = types.HardLiquidityProviderClaim
|
||||||
QueryRewardsParams = types.QueryRewardsParams
|
HardLiquidityProviderClaims = types.HardLiquidityProviderClaims
|
||||||
RewardIndex = types.RewardIndex
|
MsgClaimHardLiquidityProviderReward = types.MsgClaimHardLiquidityProviderReward
|
||||||
RewardIndexes = types.RewardIndexes
|
MsgClaimUSDXMintingReward = types.MsgClaimUSDXMintingReward
|
||||||
RewardPeriod = types.RewardPeriod
|
MultiRewardIndex = types.MultiRewardIndex
|
||||||
RewardPeriods = types.RewardPeriods
|
MultiRewardIndexes = types.MultiRewardIndexes
|
||||||
MultiRewardPeriod = types.MultiRewardPeriod
|
MultiRewardPeriod = types.MultiRewardPeriod
|
||||||
MultiRewardPeriods = types.MultiRewardPeriods
|
MultiRewardPeriods = types.MultiRewardPeriods
|
||||||
SupplyKeeper = types.SupplyKeeper
|
Multiplier = types.Multiplier
|
||||||
USDXMintingClaim = types.USDXMintingClaim
|
MultiplierName = types.MultiplierName
|
||||||
USDXMintingClaims = types.USDXMintingClaims
|
Multipliers = types.Multipliers
|
||||||
|
Params = types.Params
|
||||||
|
PostClaimReq = types.PostClaimReq
|
||||||
|
QueryHardRewardsParams = types.QueryHardRewardsParams
|
||||||
|
QueryRewardsParams = types.QueryRewardsParams
|
||||||
|
QueryUSDXMintingRewardsParams = types.QueryUSDXMintingRewardsParams
|
||||||
|
RewardIndex = types.RewardIndex
|
||||||
|
RewardIndexes = types.RewardIndexes
|
||||||
|
RewardPeriod = types.RewardPeriod
|
||||||
|
RewardPeriods = types.RewardPeriods
|
||||||
|
StakingKeeper = types.StakingKeeper
|
||||||
|
SupplyKeeper = types.SupplyKeeper
|
||||||
|
USDXMintingClaim = types.USDXMintingClaim
|
||||||
|
USDXMintingClaims = types.USDXMintingClaims
|
||||||
)
|
)
|
||||||
|
@ -33,11 +33,23 @@ func InitGenesis(ctx sdk.Context, k keeper.Keeper, supplyKeeper types.SupplyKeep
|
|||||||
|
|
||||||
// TODO: previous hard module accrual times/indexes should be set here
|
// TODO: previous hard module accrual times/indexes should be set here
|
||||||
|
|
||||||
for _, gat := range gs.PreviousAccumulationTimes {
|
for _, gat := range gs.USDXAccumulationTimes {
|
||||||
k.SetPreviousUSDXMintingAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
k.SetPreviousUSDXMintingAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
||||||
k.SetUSDXMintingRewardFactor(ctx, gat.CollateralType, gat.RewardFactor)
|
k.SetUSDXMintingRewardFactor(ctx, gat.CollateralType, gat.RewardFactor)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
for _, gat := range gs.HardSupplyAccumulationTimes {
|
||||||
|
k.SetPreviousHardSupplyRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, gat := range gs.HardBorrowAccumulationTimes {
|
||||||
|
k.SetPreviousHardBorrowRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, gat := range gs.HardDelegatorAccumulationTimes {
|
||||||
|
k.SetPreviousHardDelegatorRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
||||||
|
}
|
||||||
|
|
||||||
for _, claim := range gs.USDXMintingClaims {
|
for _, claim := range gs.USDXMintingClaims {
|
||||||
k.SetUSDXMintingClaim(ctx, claim)
|
k.SetUSDXMintingClaim(ctx, claim)
|
||||||
}
|
}
|
||||||
@ -48,7 +60,8 @@ func InitGenesis(ctx sdk.Context, k keeper.Keeper, supplyKeeper types.SupplyKeep
|
|||||||
func ExportGenesis(ctx sdk.Context, k keeper.Keeper) types.GenesisState {
|
func ExportGenesis(ctx sdk.Context, k keeper.Keeper) types.GenesisState {
|
||||||
params := k.GetParams(ctx)
|
params := k.GetParams(ctx)
|
||||||
|
|
||||||
claims := k.GetAllUSDXMintingClaims(ctx)
|
usdxClaims := k.GetAllUSDXMintingClaims(ctx)
|
||||||
|
hardClaims := k.GetAllHardLiquidityProviderClaims(ctx)
|
||||||
|
|
||||||
var gats GenesisAccumulationTimes
|
var gats GenesisAccumulationTimes
|
||||||
|
|
||||||
@ -65,5 +78,5 @@ func ExportGenesis(ctx sdk.Context, k keeper.Keeper) types.GenesisState {
|
|||||||
gats = append(gats, gat)
|
gats = append(gats, gat)
|
||||||
}
|
}
|
||||||
|
|
||||||
return types.NewGenesisState(params, gats, claims)
|
return types.NewGenesisState(params, gats, DefaultGenesisAccumulationTimes, DefaultGenesisAccumulationTimes, DefaultGenesisAccumulationTimes, usdxClaims, hardClaims)
|
||||||
}
|
}
|
||||||
|
@ -52,7 +52,11 @@ func (suite *HandlerTestSuite) SetupTest() {
|
|||||||
time.Date(2025, 12, 15, 14, 0, 0, 0, time.UTC),
|
time.Date(2025, 12, 15, 14, 0, 0, 0, time.UTC),
|
||||||
),
|
),
|
||||||
incentive.DefaultGenesisAccumulationTimes,
|
incentive.DefaultGenesisAccumulationTimes,
|
||||||
incentive.DefaultClaims,
|
incentive.DefaultGenesisAccumulationTimes,
|
||||||
|
incentive.DefaultGenesisAccumulationTimes,
|
||||||
|
incentive.DefaultGenesisAccumulationTimes,
|
||||||
|
incentive.DefaultUSDXClaims,
|
||||||
|
incentive.DefaultHardClaims,
|
||||||
)
|
)
|
||||||
tApp.InitializeFromGenesisStates(authGS, app.GenesisState{incentive.ModuleName: incentive.ModuleCdc.MustMarshalJSON(incentiveGS)}, NewCDPGenStateMulti(), NewPricefeedGenStateMulti())
|
tApp.InitializeFromGenesisStates(authGS, app.GenesisState{incentive.ModuleName: incentive.ModuleCdc.MustMarshalJSON(incentiveGS)}, NewCDPGenStateMulti(), NewPricefeedGenStateMulti())
|
||||||
|
|
||||||
|
@ -166,7 +166,11 @@ func NewIncentiveGenState(previousAccumTime, endTime time.Time, rewardPeriods ..
|
|||||||
endTime,
|
endTime,
|
||||||
),
|
),
|
||||||
accumulationTimes,
|
accumulationTimes,
|
||||||
incentive.USDXMintingClaims{},
|
accumulationTimes,
|
||||||
|
accumulationTimes,
|
||||||
|
incentive.DefaultGenesisAccumulationTimes,
|
||||||
|
incentive.DefaultUSDXClaims,
|
||||||
|
incentive.DefaultHardClaims,
|
||||||
)
|
)
|
||||||
return app.GenesisState{incentive.ModuleName: incentive.ModuleCdc.MustMarshalJSON(genesis)}
|
return app.GenesisState{incentive.ModuleName: incentive.ModuleCdc.MustMarshalJSON(genesis)}
|
||||||
}
|
}
|
||||||
|
647
x/incentive/legacy/v0_13/types.go
Normal file
647
x/incentive/legacy/v0_13/types.go
Normal file
@ -0,0 +1,647 @@
|
|||||||
|
package v0_13
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
||||||
|
"github.com/cosmos/cosmos-sdk/x/params"
|
||||||
|
|
||||||
|
tmtime "github.com/tendermint/tendermint/types/time"
|
||||||
|
|
||||||
|
cdptypes "github.com/kava-labs/kava/x/cdp/types"
|
||||||
|
kavadistTypes "github.com/kava-labs/kava/x/kavadist/types"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Valid reward multipliers
|
||||||
|
const (
|
||||||
|
Small MultiplierName = "small"
|
||||||
|
Medium MultiplierName = "medium"
|
||||||
|
Large MultiplierName = "large"
|
||||||
|
USDXMintingClaimType = "usdx_minting"
|
||||||
|
HardLiquidityProviderClaimType = "hard_liquidity_provider"
|
||||||
|
BondDenom = "ukava"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Parameter keys and default values
|
||||||
|
var (
|
||||||
|
KeyUSDXMintingRewardPeriods = []byte("USDXMintingRewardPeriods")
|
||||||
|
KeyHardSupplyRewardPeriods = []byte("HardSupplyRewardPeriods")
|
||||||
|
KeyHardBorrowRewardPeriods = []byte("HardBorrowRewardPeriods")
|
||||||
|
KeyHardDelegatorRewardPeriods = []byte("HardDelegatorRewardPeriods")
|
||||||
|
KeyClaimEnd = []byte("ClaimEnd")
|
||||||
|
KeyMultipliers = []byte("ClaimMultipliers")
|
||||||
|
DefaultActive = false
|
||||||
|
DefaultRewardPeriods = RewardPeriods{}
|
||||||
|
DefaultMultipliers = Multipliers{}
|
||||||
|
DefaultUSDXClaims = USDXMintingClaims{}
|
||||||
|
DefaultHardClaims = HardLiquidityProviderClaims{}
|
||||||
|
DefaultGenesisAccumulationTimes = GenesisAccumulationTimes{}
|
||||||
|
DefaultClaimEnd = tmtime.Canonical(time.Unix(0, 0))
|
||||||
|
GovDenom = cdptypes.DefaultGovDenom
|
||||||
|
PrincipalDenom = "usdx"
|
||||||
|
IncentiveMacc = kavadistTypes.ModuleName
|
||||||
|
)
|
||||||
|
|
||||||
|
// GenesisState is the state that must be provided at genesis.
|
||||||
|
type GenesisState struct {
|
||||||
|
Params Params `json:"params" yaml:"params"`
|
||||||
|
USDXAccumulationTimes GenesisAccumulationTimes `json:"usdx_accumulation_times" yaml:"usdx_accumulation_times"`
|
||||||
|
HardSupplyAccumulationTimes GenesisAccumulationTimes `json:"hard_supply_accumulation_times" yaml:"hard_supply_accumulation_times"`
|
||||||
|
HardBorrowAccumulationTimes GenesisAccumulationTimes `json:"hard_borrow_accumulation_times" yaml:"hard_borrow_accumulation_times"`
|
||||||
|
HardDelegatorAccumulationTimes GenesisAccumulationTimes `json:"hard_delegator_accumulation_times" yaml:"hard_delegator_accumulation_times"`
|
||||||
|
USDXMintingClaims USDXMintingClaims `json:"usdx_minting_claims" yaml:"usdx_minting_claims"`
|
||||||
|
HardLiquidityProviderClaims HardLiquidityProviderClaims `json:"hard_liquidity_provider_claims" yaml:"hard_liquidity_provider_claims"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewGenesisState returns a new genesis state
|
||||||
|
func NewGenesisState(params Params, usdxAccumTimes, hardSupplyAccumTimes, hardBorrowAccumTimes, hardDelegatorAccumTimes GenesisAccumulationTimes, c USDXMintingClaims) GenesisState {
|
||||||
|
return GenesisState{
|
||||||
|
Params: params,
|
||||||
|
USDXAccumulationTimes: usdxAccumTimes,
|
||||||
|
HardSupplyAccumulationTimes: hardSupplyAccumTimes,
|
||||||
|
HardBorrowAccumulationTimes: hardBorrowAccumTimes,
|
||||||
|
HardDelegatorAccumulationTimes: hardDelegatorAccumTimes,
|
||||||
|
USDXMintingClaims: c,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultGenesisState returns a default genesis state
|
||||||
|
func DefaultGenesisState() GenesisState {
|
||||||
|
return GenesisState{
|
||||||
|
Params: DefaultParams(),
|
||||||
|
USDXAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
HardSupplyAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
HardBorrowAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
HardDelegatorAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
USDXMintingClaims: DefaultUSDXClaims,
|
||||||
|
HardLiquidityProviderClaims: DefaultHardClaims,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate performs basic validation of genesis data returning an
|
||||||
|
// error for any failed validation criteria.
|
||||||
|
func (gs GenesisState) Validate() error {
|
||||||
|
if err := gs.Params.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.USDXAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardSupplyAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardBorrowAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardDelegatorAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := gs.HardLiquidityProviderClaims.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return gs.USDXMintingClaims.Validate()
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenesisAccumulationTime stores the previous reward distribution time and its corresponding collateral type
|
||||||
|
type GenesisAccumulationTime struct {
|
||||||
|
CollateralType string `json:"collateral_type" yaml:"collateral_type"`
|
||||||
|
PreviousAccumulationTime time.Time `json:"previous_accumulation_time" yaml:"previous_accumulation_time"`
|
||||||
|
RewardFactor sdk.Dec `json:"reward_factor" yaml:"reward_factor"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewGenesisAccumulationTime returns a new GenesisAccumulationTime
|
||||||
|
func NewGenesisAccumulationTime(ctype string, prevTime time.Time, factor sdk.Dec) GenesisAccumulationTime {
|
||||||
|
return GenesisAccumulationTime{
|
||||||
|
CollateralType: ctype,
|
||||||
|
PreviousAccumulationTime: prevTime,
|
||||||
|
RewardFactor: factor,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GenesisAccumulationTimes slice of GenesisAccumulationTime
|
||||||
|
type GenesisAccumulationTimes []GenesisAccumulationTime
|
||||||
|
|
||||||
|
// Validate performs validation of GenesisAccumulationTimes
|
||||||
|
func (gats GenesisAccumulationTimes) Validate() error {
|
||||||
|
for _, gat := range gats {
|
||||||
|
if err := gat.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate performs validation of GenesisAccumulationTime
|
||||||
|
func (gat GenesisAccumulationTime) Validate() error {
|
||||||
|
if gat.RewardFactor.LT(sdk.ZeroDec()) {
|
||||||
|
return fmt.Errorf("reward factor should be ≥ 0.0, is %s for %s", gat.RewardFactor, gat.CollateralType)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Params governance parameters for the incentive module
|
||||||
|
type Params struct {
|
||||||
|
USDXMintingRewardPeriods RewardPeriods `json:"usdx_minting_reward_periods" yaml:"usdx_minting_reward_periods"`
|
||||||
|
HardSupplyRewardPeriods RewardPeriods `json:"hard_supply_reward_periods" yaml:"hard_supply_reward_periods"`
|
||||||
|
HardBorrowRewardPeriods RewardPeriods `json:"hard_borrow_reward_periods" yaml:"hard_borrow_reward_periods"`
|
||||||
|
HardDelegatorRewardPeriods RewardPeriods `json:"hard_delegator_reward_periods" yaml:"hard_delegator_reward_periods"`
|
||||||
|
ClaimMultipliers Multipliers `json:"claim_multipliers" yaml:"claim_multipliers"`
|
||||||
|
ClaimEnd time.Time `json:"claim_end" yaml:"claim_end"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewParams returns a new params object
|
||||||
|
func NewParams(usdxMinting, hardSupply, hardBorrow, hardDelegator RewardPeriods,
|
||||||
|
multipliers Multipliers, claimEnd time.Time) Params {
|
||||||
|
return Params{
|
||||||
|
USDXMintingRewardPeriods: usdxMinting,
|
||||||
|
HardSupplyRewardPeriods: hardSupply,
|
||||||
|
HardBorrowRewardPeriods: hardBorrow,
|
||||||
|
HardDelegatorRewardPeriods: hardDelegator,
|
||||||
|
ClaimMultipliers: multipliers,
|
||||||
|
ClaimEnd: claimEnd,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultParams returns default params for incentive module
|
||||||
|
func DefaultParams() Params {
|
||||||
|
return NewParams(DefaultRewardPeriods, DefaultRewardPeriods,
|
||||||
|
DefaultRewardPeriods, DefaultRewardPeriods, DefaultMultipliers, DefaultClaimEnd)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParamKeyTable Key declaration for parameters
|
||||||
|
func ParamKeyTable() params.KeyTable {
|
||||||
|
return params.NewKeyTable().RegisterParamSet(&Params{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParamSetPairs implements the ParamSet interface and returns all the key/value pairs
|
||||||
|
func (p *Params) ParamSetPairs() params.ParamSetPairs {
|
||||||
|
return params.ParamSetPairs{
|
||||||
|
params.NewParamSetPair(KeyUSDXMintingRewardPeriods, &p.USDXMintingRewardPeriods, validateRewardPeriodsParam),
|
||||||
|
params.NewParamSetPair(KeyHardSupplyRewardPeriods, &p.HardSupplyRewardPeriods, validateRewardPeriodsParam),
|
||||||
|
params.NewParamSetPair(KeyHardBorrowRewardPeriods, &p.HardBorrowRewardPeriods, validateRewardPeriodsParam),
|
||||||
|
params.NewParamSetPair(KeyHardDelegatorRewardPeriods, &p.HardDelegatorRewardPeriods, validateRewardPeriodsParam),
|
||||||
|
params.NewParamSetPair(KeyClaimEnd, &p.ClaimEnd, validateClaimEndParam),
|
||||||
|
params.NewParamSetPair(KeyMultipliers, &p.ClaimMultipliers, validateMultipliersParam),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate checks that the parameters have valid values.
|
||||||
|
func (p Params) Validate() error {
|
||||||
|
|
||||||
|
if err := validateMultipliersParam(p.ClaimMultipliers); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := validateRewardPeriodsParam(p.USDXMintingRewardPeriods); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := validateRewardPeriodsParam(p.HardSupplyRewardPeriods); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := validateRewardPeriodsParam(p.HardBorrowRewardPeriods); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return validateRewardPeriodsParam(p.HardDelegatorRewardPeriods)
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateRewardPeriodsParam(i interface{}) error {
|
||||||
|
rewards, ok := i.(RewardPeriods)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("invalid parameter type: %T", i)
|
||||||
|
}
|
||||||
|
|
||||||
|
return rewards.Validate()
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateMultipliersParam(i interface{}) error {
|
||||||
|
multipliers, ok := i.(Multipliers)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("invalid parameter type: %T", i)
|
||||||
|
}
|
||||||
|
return multipliers.Validate()
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateClaimEndParam(i interface{}) error {
|
||||||
|
endTime, ok := i.(time.Time)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("invalid parameter type: %T", i)
|
||||||
|
}
|
||||||
|
if endTime.IsZero() {
|
||||||
|
return fmt.Errorf("end time should not be zero")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RewardPeriod stores the state of an ongoing reward
|
||||||
|
type RewardPeriod struct {
|
||||||
|
Active bool `json:"active" yaml:"active"`
|
||||||
|
CollateralType string `json:"collateral_type" yaml:"collateral_type"`
|
||||||
|
Start time.Time `json:"start" yaml:"start"`
|
||||||
|
End time.Time `json:"end" yaml:"end"`
|
||||||
|
RewardsPerSecond sdk.Coin `json:"rewards_per_second" yaml:"rewards_per_second"` // per second reward payouts
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (rp RewardPeriod) String() string {
|
||||||
|
return fmt.Sprintf(`Reward Period:
|
||||||
|
Collateral Type: %s,
|
||||||
|
Start: %s,
|
||||||
|
End: %s,
|
||||||
|
Rewards Per Second: %s,
|
||||||
|
Active %t,
|
||||||
|
`, rp.CollateralType, rp.Start, rp.End, rp.RewardsPerSecond, rp.Active)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRewardPeriod returns a new RewardPeriod
|
||||||
|
func NewRewardPeriod(active bool, collateralType string, start time.Time, end time.Time, reward sdk.Coin) RewardPeriod {
|
||||||
|
return RewardPeriod{
|
||||||
|
Active: active,
|
||||||
|
CollateralType: collateralType,
|
||||||
|
Start: start,
|
||||||
|
End: end,
|
||||||
|
RewardsPerSecond: reward,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate performs a basic check of a RewardPeriod fields.
|
||||||
|
func (rp RewardPeriod) Validate() error {
|
||||||
|
if rp.Start.IsZero() {
|
||||||
|
return errors.New("reward period start time cannot be 0")
|
||||||
|
}
|
||||||
|
if rp.End.IsZero() {
|
||||||
|
return errors.New("reward period end time cannot be 0")
|
||||||
|
}
|
||||||
|
if rp.Start.After(rp.End) {
|
||||||
|
return fmt.Errorf("end period time %s cannot be before start time %s", rp.End, rp.Start)
|
||||||
|
}
|
||||||
|
if !rp.RewardsPerSecond.IsValid() {
|
||||||
|
return fmt.Errorf("invalid reward amount: %s", rp.RewardsPerSecond)
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(rp.CollateralType) == "" {
|
||||||
|
return fmt.Errorf("reward period collateral type cannot be blank: %s", rp)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RewardPeriods array of RewardPeriod
|
||||||
|
type RewardPeriods []RewardPeriod
|
||||||
|
|
||||||
|
// Validate checks if all the RewardPeriods are valid and there are no duplicated
|
||||||
|
// entries.
|
||||||
|
func (rps RewardPeriods) Validate() error {
|
||||||
|
seenPeriods := make(map[string]bool)
|
||||||
|
for _, rp := range rps {
|
||||||
|
if seenPeriods[rp.CollateralType] {
|
||||||
|
return fmt.Errorf("duplicated reward period with collateral type %s", rp.CollateralType)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := rp.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
seenPeriods[rp.CollateralType] = true
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Multiplier amount the claim rewards get increased by, along with how long the claim rewards are locked
|
||||||
|
type Multiplier struct {
|
||||||
|
Name MultiplierName `json:"name" yaml:"name"`
|
||||||
|
MonthsLockup int64 `json:"months_lockup" yaml:"months_lockup"`
|
||||||
|
Factor sdk.Dec `json:"factor" yaml:"factor"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMultiplier returns a new Multiplier
|
||||||
|
func NewMultiplier(name MultiplierName, lockup int64, factor sdk.Dec) Multiplier {
|
||||||
|
return Multiplier{
|
||||||
|
Name: name,
|
||||||
|
MonthsLockup: lockup,
|
||||||
|
Factor: factor,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate multiplier param
|
||||||
|
func (m Multiplier) Validate() error {
|
||||||
|
if err := m.Name.IsValid(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if m.MonthsLockup < 0 {
|
||||||
|
return fmt.Errorf("expected non-negative lockup, got %d", m.MonthsLockup)
|
||||||
|
}
|
||||||
|
if m.Factor.IsNegative() {
|
||||||
|
return fmt.Errorf("expected non-negative factor, got %s", m.Factor.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (m Multiplier) String() string {
|
||||||
|
return fmt.Sprintf(`Claim Multiplier:
|
||||||
|
Name: %s
|
||||||
|
Months Lockup %d
|
||||||
|
Factor %s
|
||||||
|
`, m.Name, m.MonthsLockup, m.Factor)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Multipliers slice of Multiplier
|
||||||
|
type Multipliers []Multiplier
|
||||||
|
|
||||||
|
// Validate validates each multiplier
|
||||||
|
func (ms Multipliers) Validate() error {
|
||||||
|
for _, m := range ms {
|
||||||
|
if err := m.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (ms Multipliers) String() string {
|
||||||
|
out := "Claim Multipliers\n"
|
||||||
|
for _, s := range ms {
|
||||||
|
out += fmt.Sprintf("%s\n", s)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// MultiplierName name for valid multiplier
|
||||||
|
type MultiplierName string
|
||||||
|
|
||||||
|
// IsValid checks if the input is one of the expected strings
|
||||||
|
func (mn MultiplierName) IsValid() error {
|
||||||
|
switch mn {
|
||||||
|
case Small, Medium, Large:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("invalid multiplier name: %s", mn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Claim is an interface for handling common claim actions
|
||||||
|
type Claim interface {
|
||||||
|
GetOwner() sdk.AccAddress
|
||||||
|
GetReward() sdk.Coin
|
||||||
|
GetType() string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Claims is a slice of Claim
|
||||||
|
type Claims []Claim
|
||||||
|
|
||||||
|
// BaseClaim is a common type shared by all Claims
|
||||||
|
type BaseClaim struct {
|
||||||
|
Owner sdk.AccAddress `json:"owner" yaml:"owner"`
|
||||||
|
Reward sdk.Coin `json:"reward" yaml:"reward"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetOwner is a getter for Claim Owner
|
||||||
|
func (c BaseClaim) GetOwner() sdk.AccAddress { return c.Owner }
|
||||||
|
|
||||||
|
// GetReward is a getter for Claim Reward
|
||||||
|
func (c BaseClaim) GetReward() sdk.Coin { return c.Reward }
|
||||||
|
|
||||||
|
// GetType returns the claim type, used to identify auctions in event attributes
|
||||||
|
func (c BaseClaim) GetType() string { return "base" }
|
||||||
|
|
||||||
|
// Validate performs a basic check of a BaseClaim fields
|
||||||
|
func (c BaseClaim) Validate() error {
|
||||||
|
if c.Owner.Empty() {
|
||||||
|
return errors.New("claim owner cannot be empty")
|
||||||
|
}
|
||||||
|
if !c.Reward.IsValid() {
|
||||||
|
return fmt.Errorf("invalid reward amount: %s", c.Reward)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (c BaseClaim) String() string {
|
||||||
|
return fmt.Sprintf(`Claim:
|
||||||
|
Owner: %s,
|
||||||
|
Reward: %s,
|
||||||
|
`, c.Owner, c.Reward)
|
||||||
|
}
|
||||||
|
|
||||||
|
// -------------- Custom Claim Types --------------
|
||||||
|
|
||||||
|
// USDXMintingClaim is for USDX minting rewards
|
||||||
|
type USDXMintingClaim struct {
|
||||||
|
BaseClaim `json:"base_claim" yaml:"base_claim"`
|
||||||
|
RewardIndexes RewardIndexes `json:"reward_indexes" yaml:"reward_indexes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewUSDXMintingClaim returns a new USDXMintingClaim
|
||||||
|
func NewUSDXMintingClaim(owner sdk.AccAddress, reward sdk.Coin, rewardIndexes RewardIndexes) USDXMintingClaim {
|
||||||
|
return USDXMintingClaim{
|
||||||
|
BaseClaim: BaseClaim{
|
||||||
|
Owner: owner,
|
||||||
|
Reward: reward,
|
||||||
|
},
|
||||||
|
RewardIndexes: rewardIndexes,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetType returns the claim's type
|
||||||
|
func (c USDXMintingClaim) GetType() string { return USDXMintingClaimType }
|
||||||
|
|
||||||
|
// GetReward returns the claim's reward coin
|
||||||
|
func (c USDXMintingClaim) GetReward() sdk.Coin { return c.Reward }
|
||||||
|
|
||||||
|
// GetOwner returns the claim's owner
|
||||||
|
func (c USDXMintingClaim) GetOwner() sdk.AccAddress { return c.Owner }
|
||||||
|
|
||||||
|
// Validate performs a basic check of a Claim fields
|
||||||
|
func (c USDXMintingClaim) Validate() error {
|
||||||
|
if err := c.RewardIndexes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.BaseClaim.Validate()
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (c USDXMintingClaim) String() string {
|
||||||
|
return fmt.Sprintf(`%s
|
||||||
|
Reward Indexes: %s,
|
||||||
|
`, c.BaseClaim, c.RewardIndexes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasRewardIndex check if a claim has a reward index for the input collateral type
|
||||||
|
func (c USDXMintingClaim) HasRewardIndex(collateralType string) (int64, bool) {
|
||||||
|
for index, ri := range c.RewardIndexes {
|
||||||
|
if ri.CollateralType == collateralType {
|
||||||
|
return int64(index), true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// USDXMintingClaims slice of USDXMintingClaim
|
||||||
|
type USDXMintingClaims []USDXMintingClaim
|
||||||
|
|
||||||
|
// Validate checks if all the claims are valid and there are no duplicated
|
||||||
|
// entries.
|
||||||
|
func (cs USDXMintingClaims) Validate() error {
|
||||||
|
for _, c := range cs {
|
||||||
|
if err := c.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// HardLiquidityProviderClaim stores the hard liquidity provider rewards that can be claimed by owner
|
||||||
|
type HardLiquidityProviderClaim struct {
|
||||||
|
BaseClaim `json:"base_claim" yaml:"base_claim"`
|
||||||
|
SupplyRewardIndexes RewardIndexes `json:"supply_reward_indexes" yaml:"supply_reward_indexes"`
|
||||||
|
BorrowRewardIndexes RewardIndexes `json:"borrow_reward_indexes" yaml:"borrow_reward_indexes"`
|
||||||
|
DelegatorRewardIndexes RewardIndexes `json:"delegator_reward_indexes" yaml:"delegator_reward_indexes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewHardLiquidityProviderClaim returns a new HardLiquidityProviderClaim
|
||||||
|
func NewHardLiquidityProviderClaim(owner sdk.AccAddress, reward sdk.Coin, supplyRewardIndexes,
|
||||||
|
borrowRewardIndexes, delegatorRewardIndexes RewardIndexes) HardLiquidityProviderClaim {
|
||||||
|
return HardLiquidityProviderClaim{
|
||||||
|
BaseClaim: BaseClaim{
|
||||||
|
Owner: owner,
|
||||||
|
Reward: reward,
|
||||||
|
},
|
||||||
|
SupplyRewardIndexes: supplyRewardIndexes,
|
||||||
|
BorrowRewardIndexes: borrowRewardIndexes,
|
||||||
|
DelegatorRewardIndexes: delegatorRewardIndexes,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetType returns the claim's type
|
||||||
|
func (c HardLiquidityProviderClaim) GetType() string { return HardLiquidityProviderClaimType }
|
||||||
|
|
||||||
|
// GetReward returns the claim's reward coin
|
||||||
|
func (c HardLiquidityProviderClaim) GetReward() sdk.Coin { return c.Reward }
|
||||||
|
|
||||||
|
// GetOwner returns the claim's owner
|
||||||
|
func (c HardLiquidityProviderClaim) GetOwner() sdk.AccAddress { return c.Owner }
|
||||||
|
|
||||||
|
// Validate performs a basic check of a HardLiquidityProviderClaim fields
|
||||||
|
func (c HardLiquidityProviderClaim) Validate() error {
|
||||||
|
if err := c.SupplyRewardIndexes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := c.BorrowRewardIndexes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := c.DelegatorRewardIndexes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.BaseClaim.Validate()
|
||||||
|
}
|
||||||
|
|
||||||
|
// String implements fmt.Stringer
|
||||||
|
func (c HardLiquidityProviderClaim) String() string {
|
||||||
|
return fmt.Sprintf(`%s
|
||||||
|
Supply Reward Indexes: %s,
|
||||||
|
Borrow Reward Indexes: %s,
|
||||||
|
Delegator Reward Indexes: %s,
|
||||||
|
`, c.BaseClaim, c.SupplyRewardIndexes, c.BorrowRewardIndexes, c.DelegatorRewardIndexes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasSupplyRewardIndex check if a claim has a supply reward index for the input collateral type
|
||||||
|
func (c HardLiquidityProviderClaim) HasSupplyRewardIndex(denom string) (int64, bool) {
|
||||||
|
for index, ri := range c.SupplyRewardIndexes {
|
||||||
|
if ri.CollateralType == denom {
|
||||||
|
return int64(index), true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasBorrowRewardIndex check if a claim has a borrow reward index for the input collateral type
|
||||||
|
func (c HardLiquidityProviderClaim) HasBorrowRewardIndex(denom string) (int64, bool) {
|
||||||
|
for index, ri := range c.BorrowRewardIndexes {
|
||||||
|
if ri.CollateralType == denom {
|
||||||
|
return int64(index), true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasDelegatorRewardIndex check if a claim has a delegator reward index for the input collateral type
|
||||||
|
func (c HardLiquidityProviderClaim) HasDelegatorRewardIndex(collateralType string) (int64, bool) {
|
||||||
|
for index, ri := range c.DelegatorRewardIndexes {
|
||||||
|
if ri.CollateralType == collateralType {
|
||||||
|
return int64(index), true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// HardLiquidityProviderClaims slice of HardLiquidityProviderClaim
|
||||||
|
type HardLiquidityProviderClaims []HardLiquidityProviderClaim
|
||||||
|
|
||||||
|
// Validate checks if all the claims are valid and there are no duplicated
|
||||||
|
// entries.
|
||||||
|
func (cs HardLiquidityProviderClaims) Validate() error {
|
||||||
|
for _, c := range cs {
|
||||||
|
if err := c.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// -------------- Subcomponents of Custom Claim Types --------------
|
||||||
|
|
||||||
|
// TODO: refactor RewardPeriod name from 'collateralType' to 'denom'
|
||||||
|
|
||||||
|
// RewardIndex stores reward accumulation information
|
||||||
|
type RewardIndex struct {
|
||||||
|
CollateralType string `json:"collateral_type" yaml:"collateral_type"`
|
||||||
|
RewardFactor sdk.Dec `json:"reward_factor" yaml:"reward_factor"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRewardIndex returns a new RewardIndex
|
||||||
|
func NewRewardIndex(collateralType string, factor sdk.Dec) RewardIndex {
|
||||||
|
return RewardIndex{
|
||||||
|
CollateralType: collateralType,
|
||||||
|
RewardFactor: factor,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ri RewardIndex) String() string {
|
||||||
|
return fmt.Sprintf(`Collateral Type: %s, RewardFactor: %s`, ri.CollateralType, ri.RewardFactor)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate validates reward index
|
||||||
|
func (ri RewardIndex) Validate() error {
|
||||||
|
if ri.RewardFactor.IsNegative() {
|
||||||
|
return fmt.Errorf("reward factor value should be positive, is %s for %s", ri.RewardFactor, ri.CollateralType)
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(ri.CollateralType) == "" {
|
||||||
|
return fmt.Errorf("collateral type should not be empty")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RewardIndexes slice of RewardIndex
|
||||||
|
type RewardIndexes []RewardIndex
|
||||||
|
|
||||||
|
// Validate validation for reward indexes
|
||||||
|
func (ris RewardIndexes) Validate() error {
|
||||||
|
for _, ri := range ris {
|
||||||
|
if err := ri.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
@ -10,26 +10,38 @@ import (
|
|||||||
|
|
||||||
// GenesisState is the state that must be provided at genesis.
|
// GenesisState is the state that must be provided at genesis.
|
||||||
type GenesisState struct {
|
type GenesisState struct {
|
||||||
Params Params `json:"params" yaml:"params"`
|
Params Params `json:"params" yaml:"params"`
|
||||||
PreviousAccumulationTimes GenesisAccumulationTimes `json:"previous_accumulation_times" yaml:"previous_accumulation_times"`
|
USDXAccumulationTimes GenesisAccumulationTimes `json:"usdx_accumulation_times" yaml:"usdx_accumulation_times"`
|
||||||
USDXMintingClaims USDXMintingClaims `json:"usdx_minting_claims" yaml:"usdx_minting_claims"`
|
HardSupplyAccumulationTimes GenesisAccumulationTimes `json:"hard_supply_accumulation_times" yaml:"hard_supply_accumulation_times"`
|
||||||
|
HardBorrowAccumulationTimes GenesisAccumulationTimes `json:"hard_borrow_accumulation_times" yaml:"hard_borrow_accumulation_times"`
|
||||||
|
HardDelegatorAccumulationTimes GenesisAccumulationTimes `json:"hard_delegator_accumulation_times" yaml:"hard_delegator_accumulation_times"`
|
||||||
|
USDXMintingClaims USDXMintingClaims `json:"usdx_minting_claims" yaml:"usdx_minting_claims"`
|
||||||
|
HardLiquidityProviderClaims HardLiquidityProviderClaims `json:"hard_liquidity_provider_claims" yaml:"hard_liquidity_provider_claims"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewGenesisState returns a new genesis state
|
// NewGenesisState returns a new genesis state
|
||||||
func NewGenesisState(params Params, prevAccumTimes GenesisAccumulationTimes, c USDXMintingClaims) GenesisState {
|
func NewGenesisState(params Params, usdxAccumTimes, hardSupplyAccumTimes, hardBorrowAccumTimes, hardDelegatorAccumTimes GenesisAccumulationTimes, c USDXMintingClaims, hc HardLiquidityProviderClaims) GenesisState {
|
||||||
return GenesisState{
|
return GenesisState{
|
||||||
Params: params,
|
Params: params,
|
||||||
PreviousAccumulationTimes: prevAccumTimes,
|
USDXAccumulationTimes: usdxAccumTimes,
|
||||||
USDXMintingClaims: c,
|
HardSupplyAccumulationTimes: hardSupplyAccumTimes,
|
||||||
|
HardBorrowAccumulationTimes: hardBorrowAccumTimes,
|
||||||
|
HardDelegatorAccumulationTimes: hardDelegatorAccumTimes,
|
||||||
|
USDXMintingClaims: c,
|
||||||
|
HardLiquidityProviderClaims: hc,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// DefaultGenesisState returns a default genesis state
|
// DefaultGenesisState returns a default genesis state
|
||||||
func DefaultGenesisState() GenesisState {
|
func DefaultGenesisState() GenesisState {
|
||||||
return GenesisState{
|
return GenesisState{
|
||||||
Params: DefaultParams(),
|
Params: DefaultParams(),
|
||||||
PreviousAccumulationTimes: GenesisAccumulationTimes{},
|
USDXAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
USDXMintingClaims: DefaultClaims,
|
HardSupplyAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
HardBorrowAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
HardDelegatorAccumulationTimes: GenesisAccumulationTimes{},
|
||||||
|
USDXMintingClaims: DefaultUSDXClaims,
|
||||||
|
HardLiquidityProviderClaims: DefaultHardClaims,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -39,10 +51,22 @@ func (gs GenesisState) Validate() error {
|
|||||||
if err := gs.Params.Validate(); err != nil {
|
if err := gs.Params.Validate(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := gs.PreviousAccumulationTimes.Validate(); err != nil {
|
if err := gs.USDXAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardSupplyAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardBorrowAccumulationTimes.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := gs.HardDelegatorAccumulationTimes.Validate(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if err := gs.HardLiquidityProviderClaims.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
return gs.USDXMintingClaims.Validate()
|
return gs.USDXMintingClaims.Validate()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -32,7 +32,7 @@ func TestGenesisStateValidate(t *testing.T) {
|
|||||||
args: args{
|
args: args{
|
||||||
params: DefaultParams(),
|
params: DefaultParams(),
|
||||||
genAccTimes: DefaultGenesisAccumulationTimes,
|
genAccTimes: DefaultGenesisAccumulationTimes,
|
||||||
claims: DefaultClaims,
|
claims: DefaultUSDXClaims,
|
||||||
},
|
},
|
||||||
errArgs: errArgs{
|
errArgs: errArgs{
|
||||||
expectPass: true,
|
expectPass: true,
|
||||||
@ -95,7 +95,7 @@ func TestGenesisStateValidate(t *testing.T) {
|
|||||||
RewardFactor: sdk.MustNewDecFromStr("-0.1"),
|
RewardFactor: sdk.MustNewDecFromStr("-0.1"),
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
claims: DefaultClaims,
|
claims: DefaultUSDXClaims,
|
||||||
},
|
},
|
||||||
errArgs: errArgs{
|
errArgs: errArgs{
|
||||||
expectPass: false,
|
expectPass: false,
|
||||||
@ -131,7 +131,7 @@ func TestGenesisStateValidate(t *testing.T) {
|
|||||||
|
|
||||||
for _, tc := range testCases {
|
for _, tc := range testCases {
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
gs := NewGenesisState(tc.args.params, tc.args.genAccTimes, tc.args.claims)
|
gs := NewGenesisState(tc.args.params, tc.args.genAccTimes, tc.args.genAccTimes, tc.args.genAccTimes, tc.args.genAccTimes, tc.args.claims, DefaultHardClaims)
|
||||||
err := gs.Validate()
|
err := gs.Validate()
|
||||||
if tc.errArgs.expectPass {
|
if tc.errArgs.expectPass {
|
||||||
require.NoError(t, err, tc.name)
|
require.NoError(t, err, tc.name)
|
||||||
|
@ -34,7 +34,8 @@ var (
|
|||||||
DefaultRewardPeriods = RewardPeriods{}
|
DefaultRewardPeriods = RewardPeriods{}
|
||||||
DefaultMultiRewardPeriods = MultiRewardPeriods{}
|
DefaultMultiRewardPeriods = MultiRewardPeriods{}
|
||||||
DefaultMultipliers = Multipliers{}
|
DefaultMultipliers = Multipliers{}
|
||||||
DefaultClaims = USDXMintingClaims{}
|
DefaultUSDXClaims = USDXMintingClaims{}
|
||||||
|
DefaultHardClaims = HardLiquidityProviderClaims{}
|
||||||
DefaultGenesisAccumulationTimes = GenesisAccumulationTimes{}
|
DefaultGenesisAccumulationTimes = GenesisAccumulationTimes{}
|
||||||
DefaultClaimEnd = tmtime.Canonical(time.Unix(1, 0))
|
DefaultClaimEnd = tmtime.Canonical(time.Unix(1, 0))
|
||||||
GovDenom = cdptypes.DefaultGovDenom
|
GovDenom = cdptypes.DefaultGovDenom
|
||||||
|
Loading…
Reference in New Issue
Block a user