smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-12-26 16:25:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
290cb61882
0g-chain/x/swap/keeper/deposit_test.go
Ruaridh 65052ce31a
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>
2021-07-13 12:38:15 +01:00

344 lines
13 KiB
Go
Raw Blame History

package keeper_test
import (
"errors"
"fmt"
"github.com/kava-labs/kava/x/swap/types"
sdk "github.com/cosmos/cosmos-sdk/types"
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
abci "github.com/tendermint/tendermint/abci/types"
tmtime "github.com/tendermint/tendermint/types/time"
)
func (suite *keeperTestSuite) TestDeposit_CreatePool_PoolNotAllowed() {
depositor := suite.CreateAccount(sdk.Coins{})
amountA := sdk.NewCoin("ukava", sdk.NewInt(10e6))
amountB := sdk.NewCoin("usdx", sdk.NewInt(50e6))
err := suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), amountA, amountB, sdk.MustNewDecFromStr("0.01"))
suite.Require().EqualError(err, "not allowed: can not create pool 'ukava/usdx'")
}
func (suite *keeperTestSuite) TestDeposit_InsufficientFunds() {
testCases := []struct {
name string
balanceA sdk.Coin
balanceB sdk.Coin
depositA sdk.Coin
depositB sdk.Coin
}{
{
name: "no balance",
balanceA: sdk.Coin{},
balanceB: sdk.Coin{},
depositA: sdk.NewCoin("ukava", sdk.NewInt(100)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(100)),
},
{
name: "low balance",
balanceA: sdk.NewCoin("ukava", sdk.NewInt(1000000)),
balanceB: sdk.NewCoin("usdx", sdk.NewInt(1000000)),
depositA: sdk.NewCoin("ukava", sdk.NewInt(1000001)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(10000001)),
},
{
name: "large balance difference",
balanceA: sdk.NewCoin("ukava", sdk.NewInt(100e6)),
balanceB: sdk.NewCoin("usdx", sdk.NewInt(500e6)),
depositA: sdk.NewCoin("ukava", sdk.NewInt(1000e6)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(5000e6)),
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest()
pool := types.NewAllowedPool(tc.depositA.Denom, tc.depositB.Denom)
suite.Require().NoError(pool.Validate())
suite.Keeper.SetParams(suite.Ctx, types.NewParams(types.NewAllowedPools(pool), types.DefaultSwapFee))
balance := sdk.Coins{tc.balanceA, tc.balanceB}
balance.Sort()
depositor := suite.CreateAccount(balance)
err := suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), tc.depositA, tc.depositB, sdk.MustNewDecFromStr("0"))
// TODO: wrap in module specific error?
suite.Require().True(errors.Is(err, sdkerrors.ErrInsufficientFunds), fmt.Sprintf("got err %s", err))
suite.SetupTest()
// test deposit to existing pool insuffient funds
err = suite.CreatePool(sdk.NewCoins(sdk.NewCoin("ukava", sdk.NewInt(10e6)), sdk.NewCoin("usdx", sdk.NewInt(50e6))))
suite.Require().NoError(err)
err = suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), tc.depositA, tc.depositB, sdk.MustNewDecFromStr("10"))
suite.Require().True(errors.Is(err, sdkerrors.ErrInsufficientFunds))
})
}
}
func (suite *keeperTestSuite) TestDeposit_InsufficientFunds_Vesting() {
testCases := []struct {
name string
balanceA sdk.Coin
balanceB sdk.Coin
vestingA sdk.Coin
vestingB sdk.Coin
depositA sdk.Coin
depositB sdk.Coin
}{
{
name: "no balance, vesting only",
balanceA: sdk.Coin{},
balanceB: sdk.Coin{},
vestingA: sdk.NewCoin("ukava", sdk.NewInt(100)),
vestingB: sdk.NewCoin("ukava", sdk.NewInt(100)),
depositA: sdk.NewCoin("ukava", sdk.NewInt(100)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(100)),
},
{
name: "vesting matches balance exactly",
balanceA: sdk.NewCoin("ukava", sdk.NewInt(1000000)),
balanceB: sdk.NewCoin("usdx", sdk.NewInt(1000000)),
vestingA: sdk.NewCoin("ukava", sdk.NewInt(1)),
vestingB: sdk.NewCoin("usdx", sdk.NewInt(1)),
depositA: sdk.NewCoin("ukava", sdk.NewInt(1000001)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(10000001)),
},
{
name: "large balance difference, vesting covers difference",
balanceA: sdk.NewCoin("ukava", sdk.NewInt(100e6)),
balanceB: sdk.NewCoin("usdx", sdk.NewInt(500e6)),
vestingA: sdk.NewCoin("ukava", sdk.NewInt(1000e6)),
vestingB: sdk.NewCoin("usdx", sdk.NewInt(5000e6)),
depositA: sdk.NewCoin("ukava", sdk.NewInt(1000e6)),
depositB: sdk.NewCoin("usdx", sdk.NewInt(5000e6)),
},
}
for _, tc := range testCases {
suite.Run(tc.name, func() {
suite.SetupTest()
pool := types.NewAllowedPool(tc.depositA.Denom, tc.depositB.Denom)
suite.Require().NoError(pool.Validate())
suite.Keeper.SetParams(suite.Ctx, types.NewParams(types.NewAllowedPools(pool), types.DefaultSwapFee))
balance := sdk.Coins{tc.balanceA, tc.balanceB}
balance.Sort()
vesting := sdk.Coins{tc.vestingA, tc.vestingB}
vesting.Sort()
depositor := suite.CreateVestingAccount(balance, vesting)
// test create pool insuffient funds
err := suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), tc.depositA, tc.depositB, sdk.MustNewDecFromStr("0"))
// TODO: wrap in module specific error?
suite.Require().True(errors.Is(err, sdkerrors.ErrInsufficientFunds))
suite.SetupTest()
// test deposit to existing pool insuffient funds
err = suite.CreatePool(sdk.NewCoins(sdk.NewCoin("ukava", sdk.NewInt(10e6)), sdk.NewCoin("usdx", sdk.NewInt(50e6))))
suite.Require().NoError(err)
err = suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), tc.depositA, tc.depositB, sdk.MustNewDecFromStr("4"))
suite.Require().True(errors.Is(err, sdkerrors.ErrInsufficientFunds))
})
}
}
func (suite *keeperTestSuite) TestDeposit_CreatePool() {
pool := types.NewAllowedPool("ukava", "usdx")
suite.Require().NoError(pool.Validate())
suite.Keeper.SetParams(suite.Ctx, types.NewParams(types.NewAllowedPools(pool), types.DefaultSwapFee))
amountA := sdk.NewCoin(pool.TokenA, sdk.NewInt(11e6))
amountB := sdk.NewCoin(pool.TokenB, sdk.NewInt(51e6))
balance := sdk.NewCoins(amountA, amountB)
depositor := suite.CreateAccount(balance)
depositA := sdk.NewCoin(pool.TokenA, sdk.NewInt(10e6))
depositB := sdk.NewCoin(pool.TokenB, sdk.NewInt(50e6))
deposit := sdk.NewCoins(depositA, depositB)
err := suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), depositA, depositB, sdk.MustNewDecFromStr("0"))
suite.Require().NoError(err)
suite.AccountBalanceEqual(depositor, sdk.NewCoins(amountA.Sub(depositA), amountB.Sub(depositB)))
suite.ModuleAccountBalanceEqual(sdk.NewCoins(depositA, depositB))
suite.PoolLiquidityEqual(deposit)
suite.PoolShareValueEqual(depositor, pool, deposit)
suite.EventsContains(suite.Ctx.EventManager().Events(), sdk.NewEvent(
types.EventTypeSwapDeposit,
sdk.NewAttribute(types.AttributeKeyPoolID, pool.Name()),
sdk.NewAttribute(types.AttributeKeyDepositor, depositor.GetAddress().String()),
sdk.NewAttribute(sdk.AttributeKeyAmount, deposit.String()),
sdk.NewAttribute(types.AttributeKeyShares, "22360679"),
))
}
func (suite *keeperTestSuite) TestDeposit_PoolExists() {
pool := types.NewAllowedPool("ukava", "usdx")
reserves := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(10e6)),
sdk.NewCoin("usdx", sdk.NewInt(50e6)),
)
err := suite.CreatePool(reserves)
suite.Require().NoError(err)
balance := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(5e6)),
sdk.NewCoin("usdx", sdk.NewInt(5e6)),
)
depositor := suite.NewAccountFromAddr(sdk.AccAddress("new depositor"), balance)
depositA := sdk.NewCoin("usdx", depositor.GetCoins().AmountOf("usdx"))
depositB := sdk.NewCoin("ukava", depositor.GetCoins().AmountOf("ukava"))
ctx := suite.App.NewContext(true, abci.Header{Height: 1, Time: tmtime.Now()})
err = suite.Keeper.Deposit(ctx, depositor.GetAddress(), depositA, depositB, sdk.MustNewDecFromStr("4"))
suite.Require().NoError(err)
expectedDeposit := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(1e6)),
sdk.NewCoin("usdx", sdk.NewInt(5e6)),
)
expectedShareValue := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(999999)),
sdk.NewCoin("usdx", sdk.NewInt(4999998)),
)
suite.AccountBalanceEqual(depositor, balance.Sub(expectedDeposit))
suite.ModuleAccountBalanceEqual(reserves.Add(expectedDeposit...))
suite.PoolLiquidityEqual(reserves.Add(expectedDeposit...))
suite.PoolShareValueEqual(depositor, pool, expectedShareValue)
suite.EventsContains(ctx.EventManager().Events(), sdk.NewEvent(
types.EventTypeSwapDeposit,
sdk.NewAttribute(types.AttributeKeyPoolID, types.PoolID(pool.TokenA, pool.TokenB)),
sdk.NewAttribute(types.AttributeKeyDepositor, depositor.GetAddress().String()),
sdk.NewAttribute(sdk.AttributeKeyAmount, expectedDeposit.String()),
sdk.NewAttribute(types.AttributeKeyShares, "2236067"),
))
}
func (suite *keeperTestSuite) TestDeposit_MultipleDeposit() {
fundsToDeposit := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(5e6)),
sdk.NewCoin("usdx", sdk.NewInt(25e6)),
)
owner := suite.CreateAccount(fundsToDeposit)
reserves := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(10e6)),
sdk.NewCoin("usdx", sdk.NewInt(50e6)),
)
initialShares := sdk.NewInt(30e6)
poolID := suite.setupPool(reserves, initialShares, owner.GetAddress())
depositA := sdk.NewCoin("usdx", owner.GetCoins().AmountOf("usdx"))
depositB := sdk.NewCoin("ukava", owner.GetCoins().AmountOf("ukava"))
err := suite.Keeper.Deposit(suite.Ctx, owner.GetAddress(), depositA, depositB, sdk.MustNewDecFromStr("4"))
suite.Require().NoError(err)
totalDeposit := reserves.Add(fundsToDeposit...)
totalShares := initialShares.Add(sdk.NewInt(15e6))
suite.AccountBalanceEqual(owner, sdk.Coins(nil))
suite.ModuleAccountBalanceEqual(totalDeposit)
suite.PoolLiquidityEqual(totalDeposit)
suite.PoolDepositorSharesEqual(owner.GetAddress(), poolID, totalShares)
suite.EventsContains(suite.Ctx.EventManager().Events(), sdk.NewEvent(
types.EventTypeSwapDeposit,
sdk.NewAttribute(types.AttributeKeyPoolID, poolID),
sdk.NewAttribute(types.AttributeKeyDepositor, owner.GetAddress().String()),
sdk.NewAttribute(sdk.AttributeKeyAmount, fundsToDeposit.String()),
sdk.NewAttribute(types.AttributeKeyShares, "15000000"),
))
}
func (suite *keeperTestSuite) TestDeposit_Slippage() {
reserves := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(10e6)),
sdk.NewCoin("usdx", sdk.NewInt(50e6)),
)
testCases := []struct {
depositA sdk.Coin
depositB sdk.Coin
slippage sdk.Dec
shouldFail bool
}{
{sdk.NewCoin("usdx", sdk.NewInt(5e6)), sdk.NewCoin("ukava", sdk.NewInt(5e6)), sdk.MustNewDecFromStr("0.7"), true},
{sdk.NewCoin("usdx", sdk.NewInt(5e6)), sdk.NewCoin("ukava", sdk.NewInt(5e6)), sdk.MustNewDecFromStr("0.8"), true},
{sdk.NewCoin("ukava", sdk.NewInt(5e6)), sdk.NewCoin("usdx", sdk.NewInt(5e6)), sdk.MustNewDecFromStr("3"), true},
{sdk.NewCoin("ukava", sdk.NewInt(5e6)), sdk.NewCoin("usdx", sdk.NewInt(5e6)), sdk.MustNewDecFromStr("4"), false},
{sdk.NewCoin("ukava", sdk.NewInt(1e6)), sdk.NewCoin("usdx", sdk.NewInt(5e6)), sdk.MustNewDecFromStr("0"), false},
{sdk.NewCoin("ukava", sdk.NewInt(1e6)), sdk.NewCoin("usdx", sdk.NewInt(4e6)), sdk.MustNewDecFromStr("0.25"), false},
{sdk.NewCoin("ukava", sdk.NewInt(1e6)), sdk.NewCoin("usdx", sdk.NewInt(4e6)), sdk.MustNewDecFromStr("0.2"), true},
}
for _, tc := range testCases {
suite.Run(fmt.Sprintf("depositA=%s depositB=%s slippage=%s", tc.depositA, tc.depositB, tc.slippage), func() {
suite.SetupTest()
err := suite.CreatePool(reserves)
suite.Require().NoError(err)
balance := sdk.NewCoins(
sdk.NewCoin("ukava", sdk.NewInt(100e6)),
sdk.NewCoin("usdx", sdk.NewInt(100e6)),
)
depositor := suite.CreateAccount(balance)
ctx := suite.App.NewContext(true, abci.Header{Height: 1, Time: tmtime.Now()})
err = suite.Keeper.Deposit(ctx, depositor.GetAddress(), tc.depositA, tc.depositB, tc.slippage)
if tc.shouldFail {
suite.Require().Error(err)
suite.Contains(err.Error(), "slippage exceeded")
} else {
suite.NoError(err)
}
})
}
}
func (suite *keeperTestSuite) TestDeposit_InsufficientLiquidity() {
testCases := []struct {
poolA sdk.Coin
poolB sdk.Coin
poolShares sdk.Int
depositA sdk.Coin
depositB sdk.Coin
}{
// test deposit amount truncating to zero
{sdk.NewCoin("ukava", sdk.NewInt(10e6)), sdk.NewCoin("usdx", sdk.NewInt(50e6)), sdk.NewInt(40e6), sdk.NewCoin("ukava", sdk.NewInt(1)), sdk.NewCoin("usdx", sdk.NewInt(1))},
// test share value rounding to zero
{sdk.NewCoin("ukava", sdk.NewInt(10e6)), sdk.NewCoin("usdx", sdk.NewInt(10e6)), sdk.NewInt(100), sdk.NewCoin("ukava", sdk.NewInt(1000)), sdk.NewCoin("usdx", sdk.NewInt(1000))},
}
for _, tc := range testCases {
suite.Run(fmt.Sprintf("depositA=%s depositB=%s", tc.depositA, tc.depositB), func() {
suite.SetupTest()
record := types.PoolRecord{
PoolID: "ukava/usdx",
ReservesA: tc.poolA,
ReservesB: tc.poolB,
TotalShares: tc.poolShares,
}
suite.Keeper.SetPool(suite.Ctx, record)
balance := sdk.Coins{tc.depositA, tc.depositB}
balance.Sort()
depositor := suite.CreateAccount(balance)
err := suite.Keeper.Deposit(suite.Ctx, depositor.GetAddress(), tc.depositA, tc.depositB, sdk.MustNewDecFromStr("10"))
suite.EqualError(err, "insufficient liquidity: deposit must be increased")
})
}
}
Reference in New Issue View Git Blame Copy Permalink