2020-04-24 15:20:34 +00:00
|
|
|
package incentive
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
2021-07-15 14:41:55 +00:00
|
|
|
"time"
|
2020-04-24 15:20:34 +00:00
|
|
|
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
2020-04-30 14:13:31 +00:00
|
|
|
|
2020-04-24 15:20:34 +00:00
|
|
|
"github.com/kava-labs/kava/x/incentive/keeper"
|
|
|
|
"github.com/kava-labs/kava/x/incentive/types"
|
|
|
|
)
|
|
|
|
|
2021-07-22 12:53:18 +00:00
|
|
|
const year = 365 * 24 * time.Hour
|
|
|
|
|
|
|
|
// EarliestValidAccumulationTime is how far behind the genesis time an accumulation time can be for it to be valid.
|
|
|
|
// It's a safety check to ensure rewards aren't accidentally accumulated for many years on the first block (eg since Jan 1970).
|
|
|
|
var EarliestValidAccumulationTime time.Duration = year
|
|
|
|
|
2020-04-24 15:20:34 +00:00
|
|
|
// InitGenesis initializes the store state from a genesis state.
|
2022-01-08 00:39:27 +00:00
|
|
|
func InitGenesis(
|
|
|
|
ctx sdk.Context,
|
|
|
|
k keeper.Keeper,
|
|
|
|
accountKeeper types.AccountKeeper,
|
|
|
|
bankKeeper types.BankKeeper,
|
|
|
|
cdpKeeper types.CdpKeeper,
|
|
|
|
gs types.GenesisState,
|
|
|
|
) {
|
2020-04-24 15:20:34 +00:00
|
|
|
// check if the module account exists
|
2022-01-08 00:39:27 +00:00
|
|
|
moduleAcc := accountKeeper.GetModuleAccount(ctx, types.IncentiveMacc)
|
2020-04-24 15:20:34 +00:00
|
|
|
if moduleAcc == nil {
|
|
|
|
panic(fmt.Sprintf("%s module account has not been set", types.IncentiveMacc))
|
|
|
|
}
|
|
|
|
|
|
|
|
if err := gs.Validate(); err != nil {
|
|
|
|
panic(fmt.Sprintf("failed to validate %s genesis state: %s", types.ModuleName, err))
|
|
|
|
}
|
|
|
|
|
2021-01-21 13:52:09 +00:00
|
|
|
for _, rp := range gs.Params.USDXMintingRewardPeriods {
|
2021-07-15 14:41:55 +00:00
|
|
|
if _, found := cdpKeeper.GetCollateral(ctx, rp.CollateralType); !found {
|
|
|
|
panic(fmt.Sprintf("incentive params contain collateral not found in cdp params: %s", rp.CollateralType))
|
2021-01-20 05:42:50 +00:00
|
|
|
}
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
// TODO more param validation?
|
2021-01-20 05:42:50 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetParams(ctx, gs.Params)
|
2020-04-24 15:20:34 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
// USDX Minting
|
|
|
|
for _, claim := range gs.USDXMintingClaims {
|
|
|
|
k.SetUSDXMintingClaim(ctx, claim)
|
2021-02-09 00:32:54 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, gat := range gs.USDXRewardState.AccumulationTimes {
|
2021-07-22 12:53:18 +00:00
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetPreviousUSDXMintingAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
|
|
|
}
|
|
|
|
for _, mri := range gs.USDXRewardState.MultiRewardIndexes {
|
|
|
|
factor, found := mri.RewardIndexes.Get(types.USDXMintingRewardDenom)
|
|
|
|
if !found || len(mri.RewardIndexes) != 1 {
|
|
|
|
panic(fmt.Sprintf("USDX Minting reward factors must only have denom %s", types.USDXMintingRewardDenom))
|
2021-07-05 22:01:25 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetUSDXMintingRewardFactor(ctx, mri.CollateralType, factor)
|
2021-02-09 00:32:54 +00:00
|
|
|
}
|
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
// Hard Supply / Borrow
|
|
|
|
for _, claim := range gs.HardLiquidityProviderClaims {
|
|
|
|
k.SetHardLiquidityProviderClaim(ctx, claim)
|
2020-04-24 15:20:34 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, gat := range gs.HardSupplyRewardState.AccumulationTimes {
|
2021-07-22 12:53:18 +00:00
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
2021-02-08 20:47:29 +00:00
|
|
|
k.SetPreviousHardSupplyRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, mri := range gs.HardSupplyRewardState.MultiRewardIndexes {
|
|
|
|
k.SetHardSupplyRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
2021-02-08 20:47:29 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, gat := range gs.HardBorrowRewardState.AccumulationTimes {
|
2021-07-22 12:53:18 +00:00
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetPreviousHardBorrowRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
2021-02-08 20:47:29 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, mri := range gs.HardBorrowRewardState.MultiRewardIndexes {
|
|
|
|
k.SetHardBorrowRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
2021-07-07 13:23:06 +00:00
|
|
|
}
|
2021-02-08 20:47:29 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
// Delegator
|
|
|
|
for _, claim := range gs.DelegatorClaims {
|
|
|
|
k.SetDelegatorClaim(ctx, claim)
|
2020-04-24 15:20:34 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, gat := range gs.DelegatorRewardState.AccumulationTimes {
|
2021-07-22 12:53:18 +00:00
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetPreviousDelegatorRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
2021-07-07 16:50:14 +00:00
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, mri := range gs.DelegatorRewardState.MultiRewardIndexes {
|
|
|
|
k.SetDelegatorRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
2021-02-09 00:32:54 +00:00
|
|
|
}
|
Swap users accumulate rewards (#950)
* add swap claim type
* add store methods for swap claims
* add swap claims to genesis state
* tidy up cdp and hard hook doc comments
* add uncalled hooks to the swap keeper
* add swap rewards sync method
* add swap rewards init method
* connect swap rewards via swap hooks
* Update querier and client for swap claims (#951)
* refactor querier to dedupe code
* add swap claims querier endpoint
* add swap claim querying to rest
* add swap claim querying to cli
* add keeper method to iterate swap reward indexes
* simplify reward-factors query endpoint, add swap
* update swap hook to match latest swap branch
* rename func to not collide with latest swap branch
* Squash merge swap-acceptance branch (#956)
* add failing acceptance test for a user depositing into a pool
* implement GetAccount test helper
* implement swap.MsgDeposit for creating and adding liquidity to a pool
* update aliases, add event types, and fix typo/compiler errors in handler
test
* use only aliases names in handler test (don't use swap types -- ensures
we have run aliasgen), add assertion for even type message
* implement account and module account balance checks in handler test
* fill out handler assertions for testing keeper state and events
* update signed json representation and register swap/MsgDeposit for
proper encoding
* fill out boilerplate to get handler test to compile
* alias gen for pool
* add handling of message type; fill in deposit keeper method for
succesful compile; noop but test assertions now run up to module acc not
nil check
* add module account permissions for swap module -- fixes module account
creation; pass account keeper and supply keeper into swap keeper to
allow the ability to work with user and module accounts
* implement create pool logic for msg deposit; allows creation of a of new
pool, checking params to see if it is allowed. Initi shares are set,
and senders number of shares are stored
* Swap migrations scaffolding (#925)
* swap module scaffolding
* global swap fee
* can't think of a reason for begin blocker; removing for abci.go for now;
* test pair types; refactor pair name logic; simplify pairs validation and
fix stack overflow error
* check comparison
* use test package
* init swap module genesis
* add basic marshall tests
* remove reward apy from pairs
* fix integration helpers
* use max swap fee constant; fix validation of swap fee; add tests to
cover param validation and param set setup
* use noerror over nil
* start genesis tests
* test param set validation mirrors param validation
* add genesis tests
* remove print statement
* add subtests for genesis test cases; add extra querier test for unknown
route; add keeper params testing
* add spec
* update swagger
* find replace hard -> swap in comments
* remove unused method
* rename pairs to allowed pools; pool is more commonly used, and
allowedPool makes it more clear what swap parameter is for. In
addition, we won't conflict with Pool data structure for storing a
created pool in the store.
* remove generated link
* missed spec rename
* validate token order for allowed pools
* fix swagger
* json should be snakecase; change allowedPools to allowed_pools
* add legacy types
* add swap genesis to v0_15 migration
* add legacy types
* add swap genesis to v0_15 migration
* migration revisions
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
* keeper todos
* update keeper tests
* type todos
* update types tests
* tx deposit cli cmd
* tx deposit rest
* Swap module simulation scaffolding (#924)
* sims scaffolding
* add noop operation
* genesis revisions
* add param changes
* mvoe persistance methods to main keeper file, consolidate tests
* make helper methods private. they are tested via deposit method, and
unit testing them would make test suite brittle and refactoring
difficult
* use more clear coin variables
* code 1 is reserved, use code 2 and sequence all errors
* remove todo
* Implement deadline for swap module module message. This is implemented in
handler with a interface to easily apply to it to all messages, and
separate msg validation concerns from the keeper
* move allowed pools to params -- let pool and pool_test focus on pool domain logic, not
parameter & governance concerns
* update alias
* add unitless implementatin of constant product liquidity pool to
isolate and enapsulate liquidity logic. Swap methods interfaces are
added, but implementation not yet added
* nits and todos
* add ErrInvalidPool
* add tests for edge cases around pool depletion; add explicit panic for
edge case that results in a pool reserve being zero; handle pool
reinitialization if it is empty
* touch up comments and flush out the rest of assertions
* add data structures for keeper state storage separate from pool domain
objects, and improve structure for easier querying
* rename pool name to pool key for events
* add support for a denominated pool that uses sdk.Coins and sdk.Coin
arguments, keeping tracking of the units in the base pool. This gives
nice separation between pool logic, and coin/denom logic
* refactor keeper to use new records for storage, and implement pool
deposit using the denominated pool
* address previous PR comment - reminder for migration if changing
account permissions
* msg deposit should validate that denoms are not equal
* add godoc comments
* golint and some poolName -> poolID cleanup
* implement adding liquidity to an existing pool
* hardcode pools in sims
* touch up comment
* withdraw keeper logic
* withdraw type updates
* add withdraw msg tx handler
* initial withdraw test
* fix panic
* use new denominated pool with existing shares
* fix: check args on deposit cmd
* add slippage limit check for depositing to an existing pool
* send coins just before event emission
* check liquidity returned is greater than zero for both coins; ensure
returned number of shares are greater than zero
* add deadline to msgwithdraw
* register msgwithdraw
* scaffold msgwithdraw types test
* register the correct msg
* modify swap functions to also return the amount paid for the pool swap
fee. This will be used to calculate slippage and for event tracking
* add slippage types
* add expected withdrawal coins
* calculate slippage against expected coins
* update withdraw keeper tests
* spelling, improve comments on add liquidity math
* typo
* typo
* grammer
* typo / grammer
* remove pool_id from withdraw msg
* add slippage to tx cmd
* TestWithdraw_Partial
* nit
* add withdraw no pool, no deposit record tests
* drop event check on partial withdraw test
* fix broken link
* fix broken link
* resolve merge conflicts
* ensure swap fee can not be equal to 1; add full implementation of swap
pool methods; these implementation ensure that the pool invariant is
always greater or equal to the previous invariant
* refactor duplicated code into private swap methods
* add runtime assertion to always ensure invariant is greater or equal
to the previous invariant sub fee on swaps
* improve comments for base pool swap functions
* add swap exact input and output methods to denominated pool that wrap
the base pool interface for swapping
* comment touch ups
* more comment touchups
* fix msg deposit struct tag (#943)
* use better name for swap calculation private methods
* nits: golint
* fix misspelling in method name
* Add HARD token governance committee for Hard module (#941)
* add hard gov token committee
* revisions: update migration
* revisions: update test/data file
* initial revisions
* add TokenCommittee JSONMarshal test
* fix SetPermissions method
* remove BaseCommittee Type field
* add incentive params to allowed params
* Add SWP token governance committee for Swap module (#946)
* add swp token commitee to migration
* update test, add gen export utility method
* final revisions: add TODO
* remove slippage from withdraw to use min values for coins; add
additional validation test cases
* update alias for swap module
* add withdraw tests to handler for increased coverage; note: first pass,
improvements still yet to be made here
* refact withdraw keeper to use min amounts; panic for cases that do not
happen in normal situations
* lint fixes
* use total shares to track if pool should be deleted; add more in depth
withdraw comment
* add exact args for withdraw cmd
* extract record update methods
* update depositor share record if it exists -- do not overwrite an
existing record; ensures no loss of shares if the same address deposits
more than once
* Swap queries: deposit, pool, pools (#949)
* query deposits types
* implement deposit querier keeper methods
* query deposits CLI
* query deposits REST
* query types for pool/pools
* pool/pools querier keeper methods
* pool/pools CLI
* pool/pools REST
* basic pool/pools query tests
* basic deposit querier test
* iterate share records via owner bytes
* nit: add example for querying deposits by owner only
Co-authored-by: karzak <kjydavis3@gmail.com>
* feat: add REST tx handler for swap LP withdrawals
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* expand incentive cli query docs
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* minor update to godoc comment
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
2021-07-13 12:35:02 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
// Swap
|
Swap users accumulate rewards (#950)
* add swap claim type
* add store methods for swap claims
* add swap claims to genesis state
* tidy up cdp and hard hook doc comments
* add uncalled hooks to the swap keeper
* add swap rewards sync method
* add swap rewards init method
* connect swap rewards via swap hooks
* Update querier and client for swap claims (#951)
* refactor querier to dedupe code
* add swap claims querier endpoint
* add swap claim querying to rest
* add swap claim querying to cli
* add keeper method to iterate swap reward indexes
* simplify reward-factors query endpoint, add swap
* update swap hook to match latest swap branch
* rename func to not collide with latest swap branch
* Squash merge swap-acceptance branch (#956)
* add failing acceptance test for a user depositing into a pool
* implement GetAccount test helper
* implement swap.MsgDeposit for creating and adding liquidity to a pool
* update aliases, add event types, and fix typo/compiler errors in handler
test
* use only aliases names in handler test (don't use swap types -- ensures
we have run aliasgen), add assertion for even type message
* implement account and module account balance checks in handler test
* fill out handler assertions for testing keeper state and events
* update signed json representation and register swap/MsgDeposit for
proper encoding
* fill out boilerplate to get handler test to compile
* alias gen for pool
* add handling of message type; fill in deposit keeper method for
succesful compile; noop but test assertions now run up to module acc not
nil check
* add module account permissions for swap module -- fixes module account
creation; pass account keeper and supply keeper into swap keeper to
allow the ability to work with user and module accounts
* implement create pool logic for msg deposit; allows creation of a of new
pool, checking params to see if it is allowed. Initi shares are set,
and senders number of shares are stored
* Swap migrations scaffolding (#925)
* swap module scaffolding
* global swap fee
* can't think of a reason for begin blocker; removing for abci.go for now;
* test pair types; refactor pair name logic; simplify pairs validation and
fix stack overflow error
* check comparison
* use test package
* init swap module genesis
* add basic marshall tests
* remove reward apy from pairs
* fix integration helpers
* use max swap fee constant; fix validation of swap fee; add tests to
cover param validation and param set setup
* use noerror over nil
* start genesis tests
* test param set validation mirrors param validation
* add genesis tests
* remove print statement
* add subtests for genesis test cases; add extra querier test for unknown
route; add keeper params testing
* add spec
* update swagger
* find replace hard -> swap in comments
* remove unused method
* rename pairs to allowed pools; pool is more commonly used, and
allowedPool makes it more clear what swap parameter is for. In
addition, we won't conflict with Pool data structure for storing a
created pool in the store.
* remove generated link
* missed spec rename
* validate token order for allowed pools
* fix swagger
* json should be snakecase; change allowedPools to allowed_pools
* add legacy types
* add swap genesis to v0_15 migration
* add legacy types
* add swap genesis to v0_15 migration
* migration revisions
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
* keeper todos
* update keeper tests
* type todos
* update types tests
* tx deposit cli cmd
* tx deposit rest
* Swap module simulation scaffolding (#924)
* sims scaffolding
* add noop operation
* genesis revisions
* add param changes
* mvoe persistance methods to main keeper file, consolidate tests
* make helper methods private. they are tested via deposit method, and
unit testing them would make test suite brittle and refactoring
difficult
* use more clear coin variables
* code 1 is reserved, use code 2 and sequence all errors
* remove todo
* Implement deadline for swap module module message. This is implemented in
handler with a interface to easily apply to it to all messages, and
separate msg validation concerns from the keeper
* move allowed pools to params -- let pool and pool_test focus on pool domain logic, not
parameter & governance concerns
* update alias
* add unitless implementatin of constant product liquidity pool to
isolate and enapsulate liquidity logic. Swap methods interfaces are
added, but implementation not yet added
* nits and todos
* add ErrInvalidPool
* add tests for edge cases around pool depletion; add explicit panic for
edge case that results in a pool reserve being zero; handle pool
reinitialization if it is empty
* touch up comments and flush out the rest of assertions
* add data structures for keeper state storage separate from pool domain
objects, and improve structure for easier querying
* rename pool name to pool key for events
* add support for a denominated pool that uses sdk.Coins and sdk.Coin
arguments, keeping tracking of the units in the base pool. This gives
nice separation between pool logic, and coin/denom logic
* refactor keeper to use new records for storage, and implement pool
deposit using the denominated pool
* address previous PR comment - reminder for migration if changing
account permissions
* msg deposit should validate that denoms are not equal
* add godoc comments
* golint and some poolName -> poolID cleanup
* implement adding liquidity to an existing pool
* hardcode pools in sims
* touch up comment
* withdraw keeper logic
* withdraw type updates
* add withdraw msg tx handler
* initial withdraw test
* fix panic
* use new denominated pool with existing shares
* fix: check args on deposit cmd
* add slippage limit check for depositing to an existing pool
* send coins just before event emission
* check liquidity returned is greater than zero for both coins; ensure
returned number of shares are greater than zero
* add deadline to msgwithdraw
* register msgwithdraw
* scaffold msgwithdraw types test
* register the correct msg
* modify swap functions to also return the amount paid for the pool swap
fee. This will be used to calculate slippage and for event tracking
* add slippage types
* add expected withdrawal coins
* calculate slippage against expected coins
* update withdraw keeper tests
* spelling, improve comments on add liquidity math
* typo
* typo
* grammer
* typo / grammer
* remove pool_id from withdraw msg
* add slippage to tx cmd
* TestWithdraw_Partial
* nit
* add withdraw no pool, no deposit record tests
* drop event check on partial withdraw test
* fix broken link
* fix broken link
* resolve merge conflicts
* ensure swap fee can not be equal to 1; add full implementation of swap
pool methods; these implementation ensure that the pool invariant is
always greater or equal to the previous invariant
* refactor duplicated code into private swap methods
* add runtime assertion to always ensure invariant is greater or equal
to the previous invariant sub fee on swaps
* improve comments for base pool swap functions
* add swap exact input and output methods to denominated pool that wrap
the base pool interface for swapping
* comment touch ups
* more comment touchups
* fix msg deposit struct tag (#943)
* use better name for swap calculation private methods
* nits: golint
* fix misspelling in method name
* Add HARD token governance committee for Hard module (#941)
* add hard gov token committee
* revisions: update migration
* revisions: update test/data file
* initial revisions
* add TokenCommittee JSONMarshal test
* fix SetPermissions method
* remove BaseCommittee Type field
* add incentive params to allowed params
* Add SWP token governance committee for Swap module (#946)
* add swp token commitee to migration
* update test, add gen export utility method
* final revisions: add TODO
* remove slippage from withdraw to use min values for coins; add
additional validation test cases
* update alias for swap module
* add withdraw tests to handler for increased coverage; note: first pass,
improvements still yet to be made here
* refact withdraw keeper to use min amounts; panic for cases that do not
happen in normal situations
* lint fixes
* use total shares to track if pool should be deleted; add more in depth
withdraw comment
* add exact args for withdraw cmd
* extract record update methods
* update depositor share record if it exists -- do not overwrite an
existing record; ensures no loss of shares if the same address deposits
more than once
* Swap queries: deposit, pool, pools (#949)
* query deposits types
* implement deposit querier keeper methods
* query deposits CLI
* query deposits REST
* query types for pool/pools
* pool/pools querier keeper methods
* pool/pools CLI
* pool/pools REST
* basic pool/pools query tests
* basic deposit querier test
* iterate share records via owner bytes
* nit: add example for querying deposits by owner only
Co-authored-by: karzak <kjydavis3@gmail.com>
* feat: add REST tx handler for swap LP withdrawals
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* expand incentive cli query docs
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* minor update to godoc comment
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
2021-07-13 12:35:02 +00:00
|
|
|
for _, claim := range gs.SwapClaims {
|
|
|
|
k.SetSwapClaim(ctx, claim)
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
for _, gat := range gs.SwapRewardState.AccumulationTimes {
|
2021-07-22 12:53:18 +00:00
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
2021-07-15 14:41:55 +00:00
|
|
|
k.SetSwapRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
|
|
|
}
|
|
|
|
for _, mri := range gs.SwapRewardState.MultiRewardIndexes {
|
|
|
|
k.SetSwapRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
|
|
|
}
|
2022-04-04 20:01:48 +00:00
|
|
|
|
|
|
|
// Savings
|
|
|
|
for _, claim := range gs.SavingsClaims {
|
|
|
|
k.SetSavingsClaim(ctx, claim)
|
|
|
|
}
|
|
|
|
for _, gat := range gs.SavingsRewardState.AccumulationTimes {
|
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
|
|
|
k.SetSavingsRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
|
|
|
}
|
|
|
|
for _, mri := range gs.SavingsRewardState.MultiRewardIndexes {
|
|
|
|
k.SetSavingsRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
|
|
|
}
|
2022-09-22 18:26:08 +00:00
|
|
|
|
|
|
|
// Earn
|
|
|
|
for _, claim := range gs.EarnClaims {
|
|
|
|
k.SetEarnClaim(ctx, claim)
|
|
|
|
}
|
|
|
|
for _, gat := range gs.EarnRewardState.AccumulationTimes {
|
|
|
|
if err := ValidateAccumulationTime(gat.PreviousAccumulationTime, ctx.BlockTime()); err != nil {
|
|
|
|
panic(err.Error())
|
|
|
|
}
|
|
|
|
k.SetEarnRewardAccrualTime(ctx, gat.CollateralType, gat.PreviousAccumulationTime)
|
|
|
|
}
|
|
|
|
for _, mri := range gs.EarnRewardState.MultiRewardIndexes {
|
|
|
|
k.SetEarnRewardIndexes(ctx, mri.CollateralType, mri.RewardIndexes)
|
|
|
|
}
|
2020-04-24 15:20:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// ExportGenesis export genesis state for incentive module
|
|
|
|
func ExportGenesis(ctx sdk.Context, k keeper.Keeper) types.GenesisState {
|
|
|
|
params := k.GetParams(ctx)
|
|
|
|
|
2021-02-08 20:47:29 +00:00
|
|
|
usdxClaims := k.GetAllUSDXMintingClaims(ctx)
|
2021-07-15 14:41:55 +00:00
|
|
|
usdxRewardState := getUSDXMintingGenesisRewardState(ctx, k)
|
|
|
|
|
2021-02-08 20:47:29 +00:00
|
|
|
hardClaims := k.GetAllHardLiquidityProviderClaims(ctx)
|
2021-07-15 14:41:55 +00:00
|
|
|
hardSupplyRewardState := getHardSupplyGenesisRewardState(ctx, k)
|
|
|
|
hardBorrowRewardState := getHardBorrowGenesisRewardState(ctx, k)
|
|
|
|
|
2021-07-07 16:50:14 +00:00
|
|
|
delegatorClaims := k.GetAllDelegatorClaims(ctx)
|
2021-07-15 14:41:55 +00:00
|
|
|
delegatorRewardState := getDelegatorGenesisRewardState(ctx, k)
|
|
|
|
|
Swap users accumulate rewards (#950)
* add swap claim type
* add store methods for swap claims
* add swap claims to genesis state
* tidy up cdp and hard hook doc comments
* add uncalled hooks to the swap keeper
* add swap rewards sync method
* add swap rewards init method
* connect swap rewards via swap hooks
* Update querier and client for swap claims (#951)
* refactor querier to dedupe code
* add swap claims querier endpoint
* add swap claim querying to rest
* add swap claim querying to cli
* add keeper method to iterate swap reward indexes
* simplify reward-factors query endpoint, add swap
* update swap hook to match latest swap branch
* rename func to not collide with latest swap branch
* Squash merge swap-acceptance branch (#956)
* add failing acceptance test for a user depositing into a pool
* implement GetAccount test helper
* implement swap.MsgDeposit for creating and adding liquidity to a pool
* update aliases, add event types, and fix typo/compiler errors in handler
test
* use only aliases names in handler test (don't use swap types -- ensures
we have run aliasgen), add assertion for even type message
* implement account and module account balance checks in handler test
* fill out handler assertions for testing keeper state and events
* update signed json representation and register swap/MsgDeposit for
proper encoding
* fill out boilerplate to get handler test to compile
* alias gen for pool
* add handling of message type; fill in deposit keeper method for
succesful compile; noop but test assertions now run up to module acc not
nil check
* add module account permissions for swap module -- fixes module account
creation; pass account keeper and supply keeper into swap keeper to
allow the ability to work with user and module accounts
* implement create pool logic for msg deposit; allows creation of a of new
pool, checking params to see if it is allowed. Initi shares are set,
and senders number of shares are stored
* Swap migrations scaffolding (#925)
* swap module scaffolding
* global swap fee
* can't think of a reason for begin blocker; removing for abci.go for now;
* test pair types; refactor pair name logic; simplify pairs validation and
fix stack overflow error
* check comparison
* use test package
* init swap module genesis
* add basic marshall tests
* remove reward apy from pairs
* fix integration helpers
* use max swap fee constant; fix validation of swap fee; add tests to
cover param validation and param set setup
* use noerror over nil
* start genesis tests
* test param set validation mirrors param validation
* add genesis tests
* remove print statement
* add subtests for genesis test cases; add extra querier test for unknown
route; add keeper params testing
* add spec
* update swagger
* find replace hard -> swap in comments
* remove unused method
* rename pairs to allowed pools; pool is more commonly used, and
allowedPool makes it more clear what swap parameter is for. In
addition, we won't conflict with Pool data structure for storing a
created pool in the store.
* remove generated link
* missed spec rename
* validate token order for allowed pools
* fix swagger
* json should be snakecase; change allowedPools to allowed_pools
* add legacy types
* add swap genesis to v0_15 migration
* add legacy types
* add swap genesis to v0_15 migration
* migration revisions
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
* keeper todos
* update keeper tests
* type todos
* update types tests
* tx deposit cli cmd
* tx deposit rest
* Swap module simulation scaffolding (#924)
* sims scaffolding
* add noop operation
* genesis revisions
* add param changes
* mvoe persistance methods to main keeper file, consolidate tests
* make helper methods private. they are tested via deposit method, and
unit testing them would make test suite brittle and refactoring
difficult
* use more clear coin variables
* code 1 is reserved, use code 2 and sequence all errors
* remove todo
* Implement deadline for swap module module message. This is implemented in
handler with a interface to easily apply to it to all messages, and
separate msg validation concerns from the keeper
* move allowed pools to params -- let pool and pool_test focus on pool domain logic, not
parameter & governance concerns
* update alias
* add unitless implementatin of constant product liquidity pool to
isolate and enapsulate liquidity logic. Swap methods interfaces are
added, but implementation not yet added
* nits and todos
* add ErrInvalidPool
* add tests for edge cases around pool depletion; add explicit panic for
edge case that results in a pool reserve being zero; handle pool
reinitialization if it is empty
* touch up comments and flush out the rest of assertions
* add data structures for keeper state storage separate from pool domain
objects, and improve structure for easier querying
* rename pool name to pool key for events
* add support for a denominated pool that uses sdk.Coins and sdk.Coin
arguments, keeping tracking of the units in the base pool. This gives
nice separation between pool logic, and coin/denom logic
* refactor keeper to use new records for storage, and implement pool
deposit using the denominated pool
* address previous PR comment - reminder for migration if changing
account permissions
* msg deposit should validate that denoms are not equal
* add godoc comments
* golint and some poolName -> poolID cleanup
* implement adding liquidity to an existing pool
* hardcode pools in sims
* touch up comment
* withdraw keeper logic
* withdraw type updates
* add withdraw msg tx handler
* initial withdraw test
* fix panic
* use new denominated pool with existing shares
* fix: check args on deposit cmd
* add slippage limit check for depositing to an existing pool
* send coins just before event emission
* check liquidity returned is greater than zero for both coins; ensure
returned number of shares are greater than zero
* add deadline to msgwithdraw
* register msgwithdraw
* scaffold msgwithdraw types test
* register the correct msg
* modify swap functions to also return the amount paid for the pool swap
fee. This will be used to calculate slippage and for event tracking
* add slippage types
* add expected withdrawal coins
* calculate slippage against expected coins
* update withdraw keeper tests
* spelling, improve comments on add liquidity math
* typo
* typo
* grammer
* typo / grammer
* remove pool_id from withdraw msg
* add slippage to tx cmd
* TestWithdraw_Partial
* nit
* add withdraw no pool, no deposit record tests
* drop event check on partial withdraw test
* fix broken link
* fix broken link
* resolve merge conflicts
* ensure swap fee can not be equal to 1; add full implementation of swap
pool methods; these implementation ensure that the pool invariant is
always greater or equal to the previous invariant
* refactor duplicated code into private swap methods
* add runtime assertion to always ensure invariant is greater or equal
to the previous invariant sub fee on swaps
* improve comments for base pool swap functions
* add swap exact input and output methods to denominated pool that wrap
the base pool interface for swapping
* comment touch ups
* more comment touchups
* fix msg deposit struct tag (#943)
* use better name for swap calculation private methods
* nits: golint
* fix misspelling in method name
* Add HARD token governance committee for Hard module (#941)
* add hard gov token committee
* revisions: update migration
* revisions: update test/data file
* initial revisions
* add TokenCommittee JSONMarshal test
* fix SetPermissions method
* remove BaseCommittee Type field
* add incentive params to allowed params
* Add SWP token governance committee for Swap module (#946)
* add swp token commitee to migration
* update test, add gen export utility method
* final revisions: add TODO
* remove slippage from withdraw to use min values for coins; add
additional validation test cases
* update alias for swap module
* add withdraw tests to handler for increased coverage; note: first pass,
improvements still yet to be made here
* refact withdraw keeper to use min amounts; panic for cases that do not
happen in normal situations
* lint fixes
* use total shares to track if pool should be deleted; add more in depth
withdraw comment
* add exact args for withdraw cmd
* extract record update methods
* update depositor share record if it exists -- do not overwrite an
existing record; ensures no loss of shares if the same address deposits
more than once
* Swap queries: deposit, pool, pools (#949)
* query deposits types
* implement deposit querier keeper methods
* query deposits CLI
* query deposits REST
* query types for pool/pools
* pool/pools querier keeper methods
* pool/pools CLI
* pool/pools REST
* basic pool/pools query tests
* basic deposit querier test
* iterate share records via owner bytes
* nit: add example for querying deposits by owner only
Co-authored-by: karzak <kjydavis3@gmail.com>
* feat: add REST tx handler for swap LP withdrawals
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* expand incentive cli query docs
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
* minor update to godoc comment
Co-authored-by: Nick DeLuca <nickdeluca08@gmail.com>
Co-authored-by: Denali Marsh <denali@kava.io>
Co-authored-by: denalimarsh <denalimarsh@gmail.com>
Co-authored-by: karzak <kjydavis3@gmail.com>
2021-07-13 12:35:02 +00:00
|
|
|
swapClaims := k.GetAllSwapClaims(ctx)
|
2021-07-15 14:41:55 +00:00
|
|
|
swapRewardState := getSwapGenesisRewardState(ctx, k)
|
2020-04-24 15:20:34 +00:00
|
|
|
|
2022-04-04 20:01:48 +00:00
|
|
|
savingsClaims := k.GetAllSavingsClaims(ctx)
|
|
|
|
savingsRewardState := getSavingsGenesisRewardState(ctx, k)
|
|
|
|
|
2022-09-22 18:26:08 +00:00
|
|
|
earnClaims := k.GetAllEarnClaims(ctx)
|
|
|
|
earnRewardState := getEarnGenesisRewardState(ctx, k)
|
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
return types.NewGenesisState(
|
|
|
|
params,
|
2022-09-22 18:26:08 +00:00
|
|
|
// Reward states
|
|
|
|
usdxRewardState, hardSupplyRewardState, hardBorrowRewardState, delegatorRewardState, swapRewardState, savingsRewardState, earnRewardState,
|
|
|
|
// Claims
|
|
|
|
usdxClaims, hardClaims, delegatorClaims, swapClaims, savingsClaims, earnClaims,
|
2021-07-15 14:41:55 +00:00
|
|
|
)
|
|
|
|
}
|
2021-02-09 00:32:54 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
func getUSDXMintingGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
2022-01-08 00:39:27 +00:00
|
|
|
var ats types.AccumulationTimes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateUSDXMintingAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
2022-01-08 00:39:27 +00:00
|
|
|
var mris types.MultiRewardIndexes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateUSDXMintingRewardFactors(ctx, func(ctype string, factor sdk.Dec) bool {
|
|
|
|
mris = append(
|
|
|
|
mris,
|
|
|
|
types.NewMultiRewardIndex(
|
|
|
|
ctype,
|
|
|
|
types.RewardIndexes{types.NewRewardIndex(types.USDXMintingRewardDenom, factor)},
|
|
|
|
),
|
|
|
|
)
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
2021-02-09 00:32:54 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
func getHardSupplyGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
2022-01-08 00:39:27 +00:00
|
|
|
var ats types.AccumulationTimes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateHardSupplyRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
2021-02-09 00:32:54 +00:00
|
|
|
|
2022-01-08 00:39:27 +00:00
|
|
|
var mris types.MultiRewardIndexes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateHardSupplyRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
2021-03-11 04:32:35 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
2021-03-11 04:32:35 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
func getHardBorrowGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
2022-01-08 00:39:27 +00:00
|
|
|
var ats types.AccumulationTimes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateHardBorrowRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
2021-01-18 19:12:37 +00:00
|
|
|
|
2022-01-08 00:39:27 +00:00
|
|
|
var mris types.MultiRewardIndexes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateHardBorrowRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
2021-07-07 13:23:06 +00:00
|
|
|
|
2021-07-15 14:41:55 +00:00
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
|
|
|
|
|
|
|
func getDelegatorGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
2022-01-08 00:39:27 +00:00
|
|
|
var ats types.AccumulationTimes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateDelegatorRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
2022-01-08 00:39:27 +00:00
|
|
|
var mris types.MultiRewardIndexes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateDelegatorRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
|
|
|
|
|
|
|
func getSwapGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
2022-01-08 00:39:27 +00:00
|
|
|
var ats types.AccumulationTimes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateSwapRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
2022-01-08 00:39:27 +00:00
|
|
|
var mris types.MultiRewardIndexes
|
2021-07-15 14:41:55 +00:00
|
|
|
keeper.IterateSwapRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
2020-04-24 15:20:34 +00:00
|
|
|
}
|
2021-07-22 12:53:18 +00:00
|
|
|
|
2022-04-04 20:01:48 +00:00
|
|
|
func getSavingsGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
|
|
|
var ats types.AccumulationTimes
|
|
|
|
keeper.IterateSavingsRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
var mris types.MultiRewardIndexes
|
|
|
|
keeper.IterateSavingsRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
|
|
|
|
2022-09-22 18:26:08 +00:00
|
|
|
func getEarnGenesisRewardState(ctx sdk.Context, keeper keeper.Keeper) types.GenesisRewardState {
|
|
|
|
var ats types.AccumulationTimes
|
|
|
|
keeper.IterateEarnRewardAccrualTimes(ctx, func(ctype string, accTime time.Time) bool {
|
|
|
|
ats = append(ats, types.NewAccumulationTime(ctype, accTime))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
var mris types.MultiRewardIndexes
|
|
|
|
keeper.IterateEarnRewardIndexes(ctx, func(ctype string, indexes types.RewardIndexes) bool {
|
|
|
|
mris = append(mris, types.NewMultiRewardIndex(ctype, indexes))
|
|
|
|
return false
|
|
|
|
})
|
|
|
|
|
|
|
|
return types.NewGenesisRewardState(ats, mris)
|
|
|
|
}
|
|
|
|
|
2021-07-22 12:53:18 +00:00
|
|
|
func ValidateAccumulationTime(previousAccumulationTime, genesisTime time.Time) error {
|
|
|
|
if previousAccumulationTime.Before(genesisTime.Add(-1 * EarliestValidAccumulationTime)) {
|
|
|
|
return fmt.Errorf(
|
|
|
|
"found accumulation time '%s' more than '%s' behind genesis time '%s'",
|
|
|
|
previousAccumulationTime,
|
|
|
|
EarliestValidAccumulationTime,
|
|
|
|
genesisTime,
|
|
|
|
)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|