2021-01-18 19:12:37 +00:00
|
|
|
package keeper
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
2021-01-25 12:58:12 +00:00
|
|
|
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
|
|
|
|
2021-01-18 19:12:37 +00:00
|
|
|
cdptypes "github.com/kava-labs/kava/x/cdp/types"
|
2022-09-22 18:26:08 +00:00
|
|
|
earntypes "github.com/kava-labs/kava/x/earn/types"
|
2021-01-21 13:52:09 +00:00
|
|
|
hardtypes "github.com/kava-labs/kava/x/hard/types"
|
2022-03-31 09:07:19 +00:00
|
|
|
savingstypes "github.com/kava-labs/kava/x/savings/types"
|
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
|
|
|
swaptypes "github.com/kava-labs/kava/x/swap/types"
|
2021-01-18 19:12:37 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Hooks wrapper struct for hooks
|
|
|
|
|
type Hooks struct {
|
|
|
|
|
k Keeper
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-09 18:37:36 +00:00
|
|
|
var (
|
|
|
|
|
_ cdptypes.CDPHooks = Hooks{}
|
|
|
|
|
_ hardtypes.HARDHooks = Hooks{}
|
|
|
|
|
_ stakingtypes.StakingHooks = Hooks{}
|
|
|
|
|
_ swaptypes.SwapHooks = Hooks{}
|
|
|
|
|
_ savingstypes.SavingsHooks = Hooks{}
|
2022-09-22 18:26:08 +00:00
|
|
|
_ earntypes.EarnHooks = Hooks{}
|
2022-05-09 18:37:36 +00:00
|
|
|
)
|
2021-01-18 19:12:37 +00:00
|
|
|
|
|
|
|
|
// Hooks create new incentive hooks
|
|
|
|
|
func (k Keeper) Hooks() Hooks { return Hooks{k} }
|
|
|
|
|
|
2021-01-25 12:58:12 +00:00
|
|
|
// ------------------- Cdp Module Hooks -------------------
|
|
|
|
|
|
2021-01-18 19:12:37 +00:00
|
|
|
// AfterCDPCreated function that runs after a cdp is created
|
|
|
|
|
func (h Hooks) AfterCDPCreated(ctx sdk.Context, cdp cdptypes.CDP) {
|
2021-01-21 13:52:09 +00:00
|
|
|
h.k.InitializeUSDXMintingClaim(ctx, cdp)
|
2021-01-18 19:12:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeCDPModified function that runs before a cdp is modified
|
|
|
|
|
// note that this is called immediately after interest is synchronized, and so could potentially
|
|
|
|
|
// be called AfterCDPInterestUpdated or something like that, if we we're to expand the scope of cdp hooks
|
|
|
|
|
func (h Hooks) BeforeCDPModified(ctx sdk.Context, cdp cdptypes.CDP) {
|
2021-01-21 13:52:09 +00:00
|
|
|
h.k.SynchronizeUSDXMintingReward(ctx, cdp)
|
|
|
|
|
}
|
|
|
|
|
|
2021-01-25 12:58:12 +00:00
|
|
|
// ------------------- Hard Module Hooks -------------------
|
|
|
|
|
|
2021-01-21 13:52:09 +00:00
|
|
|
// AfterDepositCreated function that runs after a deposit is created
|
|
|
|
|
func (h Hooks) AfterDepositCreated(ctx sdk.Context, deposit hardtypes.Deposit) {
|
|
|
|
|
h.k.InitializeHardSupplyReward(ctx, deposit)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeDepositModified function that runs before a deposit is modified
|
|
|
|
|
func (h Hooks) BeforeDepositModified(ctx sdk.Context, deposit hardtypes.Deposit) {
|
|
|
|
|
h.k.SynchronizeHardSupplyReward(ctx, deposit)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AfterDepositModified function that runs after a deposit is modified
|
|
|
|
|
func (h Hooks) AfterDepositModified(ctx sdk.Context, deposit hardtypes.Deposit) {
|
|
|
|
|
h.k.UpdateHardSupplyIndexDenoms(ctx, deposit)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AfterBorrowCreated function that runs after a borrow is created
|
|
|
|
|
func (h Hooks) AfterBorrowCreated(ctx sdk.Context, borrow hardtypes.Borrow) {
|
|
|
|
|
h.k.InitializeHardBorrowReward(ctx, borrow)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeBorrowModified function that runs before a borrow is modified
|
|
|
|
|
func (h Hooks) BeforeBorrowModified(ctx sdk.Context, borrow hardtypes.Borrow) {
|
|
|
|
|
h.k.SynchronizeHardBorrowReward(ctx, borrow)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AfterBorrowModified function that runs after a borrow is modified
|
|
|
|
|
func (h Hooks) AfterBorrowModified(ctx sdk.Context, borrow hardtypes.Borrow) {
|
|
|
|
|
h.k.UpdateHardBorrowIndexDenoms(ctx, borrow)
|
2021-01-18 19:12:37 +00:00
|
|
|
}
|
2021-01-25 12:58:12 +00:00
|
|
|
|
2021-03-25 06:10:13 +00:00
|
|
|
/* ------------------- Staking Module Hooks -------------------
|
|
|
|
|
|
|
|
|
|
Rewards are calculated based on total delegated tokens to bonded validators (not shares).
|
|
|
|
|
We need to sync the claim before the user's delegated tokens are changed.
|
|
|
|
|
|
|
|
|
|
When delegated tokens (to bonded validators) are changed:
|
|
|
|
|
- user creates new delegation
|
|
|
|
|
- total bonded delegation increases
|
|
|
|
|
- user delegates or beginUnbonding or beginRedelegate an existing delegation
|
|
|
|
|
- total bonded delegation increases or decreases
|
|
|
|
|
- validator is slashed and Jailed/Tombstoned (tokens reduce, and validator is unbonded)
|
|
|
|
|
- slash: total bonded delegation decreases (less tokens)
|
|
|
|
|
- jail: total bonded delegation decreases (tokens no longer bonded (after end blocker runs))
|
|
|
|
|
- validator becomes unbonded (ie when they drop out of the top 100)
|
|
|
|
|
- total bonded delegation decreases (tokens no longer bonded)
|
2021-06-21 21:05:17 +00:00
|
|
|
- validator becomes bonded (ie when they're promoted into the top 100)
|
|
|
|
|
- total bonded delegation increases (tokens become bonded)
|
2021-03-25 06:10:13 +00:00
|
|
|
|
|
|
|
|
*/
|
2021-01-25 12:58:12 +00:00
|
|
|
|
|
|
|
|
// BeforeDelegationCreated runs before a delegation is created
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) BeforeDelegationCreated(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
2021-03-25 06:10:13 +00:00
|
|
|
// Add a claim if one doesn't exist, otherwise sync the existing.
|
2021-07-07 16:50:14 +00:00
|
|
|
h.k.InitializeDelegatorReward(ctx, delAddr)
|
2023-04-04 00:08:45 +00:00
|
|
|
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeDelegationSharesModified runs before an existing delegation is modified
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) BeforeDelegationSharesModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
2021-03-25 06:10:13 +00:00
|
|
|
// Sync rewards based on total delegated to bonded validators.
|
2021-07-07 16:50:14 +00:00
|
|
|
h.k.SynchronizeDelegatorRewards(ctx, delAddr, nil, false)
|
2023-04-04 00:08:45 +00:00
|
|
|
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeValidatorSlashed is called before a validator is slashed
|
2021-03-25 06:10:13 +00:00
|
|
|
// Validator status is not updated when Slash or Jail is called
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) BeforeValidatorSlashed(ctx sdk.Context, valAddr sdk.ValAddress, fraction sdk.Dec) error {
|
2021-03-25 06:10:13 +00:00
|
|
|
// Sync all claims for users delegated to this validator.
|
|
|
|
|
// For each claim, sync based on the total delegated to bonded validators.
|
|
|
|
|
for _, delegation := range h.k.stakingKeeper.GetValidatorDelegations(ctx, valAddr) {
|
2022-01-08 00:39:27 +00:00
|
|
|
h.k.SynchronizeDelegatorRewards(ctx, delegation.GetDelegatorAddr(), nil, false)
|
2021-03-25 06:10:13 +00:00
|
|
|
}
|
2023-04-04 00:08:45 +00:00
|
|
|
|
|
|
|
|
return nil
|
2021-03-25 06:10:13 +00:00
|
|
|
}
|
2021-01-25 12:58:12 +00:00
|
|
|
|
|
|
|
|
// AfterValidatorBeginUnbonding is called after a validator begins unbonding
|
2021-03-25 06:10:13 +00:00
|
|
|
// Validator status is set to Unbonding prior to hook running
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) AfterValidatorBeginUnbonding(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress) error {
|
2021-03-25 06:10:13 +00:00
|
|
|
// Sync all claims for users delegated to this validator.
|
|
|
|
|
// For each claim, sync based on the total delegated to bonded validators, and also delegations to valAddr.
|
|
|
|
|
// valAddr's status has just been set to Unbonding, but we want to include delegations to it in the sync.
|
|
|
|
|
for _, delegation := range h.k.stakingKeeper.GetValidatorDelegations(ctx, valAddr) {
|
2022-01-08 00:39:27 +00:00
|
|
|
h.k.SynchronizeDelegatorRewards(ctx, delegation.GetDelegatorAddr(), valAddr, true)
|
2021-03-25 06:10:13 +00:00
|
|
|
}
|
2023-04-04 00:08:45 +00:00
|
|
|
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AfterValidatorBonded is called after a validator is bonded
|
2021-03-25 06:10:13 +00:00
|
|
|
// Validator status is set to Bonded prior to hook running
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) AfterValidatorBonded(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress) error {
|
2021-03-25 06:10:13 +00:00
|
|
|
// Sync all claims for users delegated to this validator.
|
|
|
|
|
// For each claim, sync based on the total delegated to bonded validators, except for delegations to valAddr.
|
|
|
|
|
// valAddr's status has just been set to Bonded, but we don't want to include delegations to it in the sync
|
|
|
|
|
for _, delegation := range h.k.stakingKeeper.GetValidatorDelegations(ctx, valAddr) {
|
2022-01-08 00:39:27 +00:00
|
|
|
h.k.SynchronizeDelegatorRewards(ctx, delegation.GetDelegatorAddr(), valAddr, false)
|
2021-03-25 06:10:13 +00:00
|
|
|
}
|
2023-04-04 00:08:45 +00:00
|
|
|
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
2021-03-25 06:10:13 +00:00
|
|
|
// NOTE: following hooks are just implemented to ensure StakingHooks interface compliance
|
|
|
|
|
|
2021-01-25 12:58:12 +00:00
|
|
|
// AfterDelegationModified runs after a delegation is modified
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) AfterDelegationModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
2021-07-26 19:07:24 +00:00
|
|
|
// BeforeDelegationRemoved runs directly before a delegation is deleted. BeforeDelegationSharesModified is run prior to this.
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) BeforeDelegationRemoved(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// AfterValidatorCreated runs after a validator is created
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) AfterValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress) error {
|
|
|
|
|
return nil
|
|
|
|
|
}
|
2021-01-25 12:58:12 +00:00
|
|
|
|
|
|
|
|
// BeforeValidatorModified runs before a validator is modified
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) BeforeValidatorModified(ctx sdk.Context, valAddr sdk.ValAddress) error {
|
|
|
|
|
return nil
|
|
|
|
|
}
|
2021-01-25 12:58:12 +00:00
|
|
|
|
|
|
|
|
// AfterValidatorRemoved runs after a validator is removed
|
2023-04-04 00:08:45 +00:00
|
|
|
func (h Hooks) AfterValidatorRemoved(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress) error {
|
|
|
|
|
return nil
|
2021-01-25 12:58:12 +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
|
|
|
|
|
|
|
|
// ------------------- Swap Module Hooks -------------------
|
|
|
|
|
|
|
|
|
|
func (h Hooks) AfterPoolDepositCreated(ctx sdk.Context, poolID string, depositor sdk.AccAddress, _ sdk.Int) {
|
|
|
|
|
h.k.InitializeSwapReward(ctx, poolID, depositor)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (h Hooks) BeforePoolDepositModified(ctx sdk.Context, poolID string, depositor sdk.AccAddress, sharesOwned sdk.Int) {
|
|
|
|
|
h.k.SynchronizeSwapReward(ctx, poolID, depositor, sharesOwned)
|
|
|
|
|
}
|
2022-03-31 09:07:19 +00:00
|
|
|
|
|
|
|
|
// ------------------- Savings Module Hooks -------------------
|
|
|
|
|
|
|
|
|
|
// AfterSavingsDepositCreated function that runs after a deposit is created
|
|
|
|
|
func (h Hooks) AfterSavingsDepositCreated(ctx sdk.Context, deposit savingstypes.Deposit) {
|
2022-09-29 20:18:06 +00:00
|
|
|
// h.k.InitializeSavingsReward(ctx, deposit)
|
2022-03-31 09:07:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeSavingsDepositModified function that runs before a deposit is modified
|
|
|
|
|
func (h Hooks) BeforeSavingsDepositModified(ctx sdk.Context, deposit savingstypes.Deposit, incomingDenoms []string) {
|
2022-09-29 20:18:06 +00:00
|
|
|
// h.k.SynchronizeSavingsReward(ctx, deposit, incomingDenoms)
|
2022-03-31 09:07:19 +00:00
|
|
|
}
|
2022-09-22 18:26:08 +00:00
|
|
|
|
|
|
|
|
// ------------------- Earn Module Hooks -------------------
|
|
|
|
|
|
|
|
|
|
// AfterVaultDepositCreated function that runs after a vault deposit is created
|
|
|
|
|
func (h Hooks) AfterVaultDepositCreated(
|
|
|
|
|
ctx sdk.Context,
|
|
|
|
|
vaultDenom string,
|
|
|
|
|
depositor sdk.AccAddress,
|
|
|
|
|
_ sdk.Dec,
|
|
|
|
|
) {
|
|
|
|
|
h.k.InitializeEarnReward(ctx, vaultDenom, depositor)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// BeforeVaultDepositModified function that runs before a vault deposit is modified
|
|
|
|
|
func (h Hooks) BeforeVaultDepositModified(
|
|
|
|
|
ctx sdk.Context,
|
|
|
|
|
vaultDenom string,
|
|
|
|
|
depositor sdk.AccAddress,
|
|
|
|
|
sharesOwned sdk.Dec,
|
|
|
|
|
) {
|
|
|
|
|
h.k.SynchronizeEarnReward(ctx, vaultDenom, depositor, sharesOwned)
|
|
|
|
|
}
|