mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-11-10 18:15:19 +00:00
65052ce31a
* 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>
174 lines
5.3 KiB
Go
174 lines
5.3 KiB
Go
package keeper_test
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/stretchr/testify/suite"
|
|
abci "github.com/tendermint/tendermint/abci/types"
|
|
|
|
"github.com/kava-labs/kava/app"
|
|
"github.com/kava-labs/kava/x/swap/keeper"
|
|
"github.com/kava-labs/kava/x/swap/testutil"
|
|
"github.com/kava-labs/kava/x/swap/types"
|
|
)
|
|
|
|
type querierTestSuite struct {
|
|
testutil.Suite
|
|
querier sdk.Querier
|
|
addresses []sdk.AccAddress
|
|
}
|
|
|
|
func (suite *querierTestSuite) SetupTest() {
|
|
suite.Suite.SetupTest()
|
|
|
|
// Set up auth GenesisState
|
|
_, addrs := app.GeneratePrivKeyAddressPairs(5)
|
|
coins := []sdk.Coins{}
|
|
for j := 0; j < 5; j++ {
|
|
coins = append(coins, cs(c("ukava", 10000000000), c("bnb", 10000000000), c("usdx", 10000000000)))
|
|
}
|
|
suite.addresses = addrs
|
|
authGS := app.NewAuthGenState(addrs, coins)
|
|
|
|
suite.App.InitializeFromGenesisStates(
|
|
authGS,
|
|
NewSwapGenStateMulti(),
|
|
)
|
|
suite.querier = keeper.NewQuerier(suite.Keeper)
|
|
}
|
|
|
|
func (suite *querierTestSuite) TestUnkownRequest() {
|
|
ctx := suite.Ctx.WithIsCheckTx(false)
|
|
bz, err := suite.querier(ctx, []string{"invalid-path"}, abci.RequestQuery{})
|
|
suite.Nil(bz)
|
|
suite.EqualError(err, "unknown request: unknown swap query endpoint")
|
|
}
|
|
|
|
func (suite *querierTestSuite) TestQueryParams() {
|
|
ctx := suite.Ctx.WithIsCheckTx(false)
|
|
bz, err := suite.querier(ctx, []string{types.QueryGetParams}, abci.RequestQuery{})
|
|
suite.Nil(err)
|
|
suite.NotNil(bz)
|
|
|
|
var p types.Params
|
|
suite.Nil(types.ModuleCdc.UnmarshalJSON(bz, &p))
|
|
|
|
swapGenesisState := NewSwapGenStateMulti()
|
|
gs := types.GenesisState{}
|
|
err = types.ModuleCdc.UnmarshalJSON(swapGenesisState["swap"], &gs)
|
|
suite.Require().NoError(err)
|
|
|
|
suite.Equal(gs.Params, p)
|
|
}
|
|
|
|
func (suite *querierTestSuite) TestQueryPool() {
|
|
// Set up pool in store
|
|
coinA := sdk.NewCoin("ukava", sdk.NewInt(10))
|
|
coinB := sdk.NewCoin("usdx", sdk.NewInt(200))
|
|
|
|
pool, err := types.NewDenominatedPool(sdk.NewCoins(coinA, coinB))
|
|
suite.Nil(err)
|
|
poolRecord := types.NewPoolRecord(pool)
|
|
suite.Keeper.SetPool(suite.Ctx, poolRecord)
|
|
|
|
ctx := suite.Ctx.WithIsCheckTx(false)
|
|
// Set up request query
|
|
query := abci.RequestQuery{
|
|
Path: strings.Join([]string{"custom", types.QuerierRoute, types.QueryGetPool}, "/"),
|
|
Data: types.ModuleCdc.MustMarshalJSON(types.NewQueryPoolParams(poolRecord.PoolID)),
|
|
}
|
|
|
|
bz, err := suite.querier(ctx, []string{types.QueryGetPool}, query)
|
|
suite.Nil(err)
|
|
suite.NotNil(bz)
|
|
|
|
var res types.PoolStatsQueryResult
|
|
suite.Nil(types.ModuleCdc.UnmarshalJSON(bz, &res))
|
|
|
|
// Check that result matches expected result
|
|
totalCoins := pool.ShareValue(pool.TotalShares())
|
|
expectedResult := types.NewPoolStatsQueryResult(poolRecord.PoolID, totalCoins, pool.TotalShares())
|
|
suite.Equal(expectedResult, res)
|
|
}
|
|
|
|
func (suite *querierTestSuite) TestQueryPools() {
|
|
// Set up pools in store
|
|
coinA := sdk.NewCoin("ukava", sdk.NewInt(10))
|
|
coinB := sdk.NewCoin("usdx", sdk.NewInt(200))
|
|
coinC := sdk.NewCoin("usdx", sdk.NewInt(200))
|
|
|
|
poolAB, err := types.NewDenominatedPool(sdk.NewCoins(coinA, coinB))
|
|
suite.Nil(err)
|
|
poolRecordAB := types.NewPoolRecord(poolAB)
|
|
suite.Keeper.SetPool(suite.Ctx, poolRecordAB)
|
|
|
|
poolAC, err := types.NewDenominatedPool(sdk.NewCoins(coinA, coinC))
|
|
suite.Nil(err)
|
|
poolRecordAC := types.NewPoolRecord(poolAC)
|
|
suite.Keeper.SetPool(suite.Ctx, poolRecordAC)
|
|
|
|
// Build a map of pools to compare to query results
|
|
pools := []types.PoolRecord{poolRecordAB, poolRecordAC}
|
|
poolsMap := make(map[string]types.PoolRecord)
|
|
for _, pool := range pools {
|
|
poolsMap[pool.PoolID] = pool
|
|
}
|
|
|
|
ctx := suite.Ctx.WithIsCheckTx(false)
|
|
bz, err := suite.querier(ctx, []string{types.QueryGetPools}, abci.RequestQuery{})
|
|
suite.Nil(err)
|
|
suite.NotNil(bz)
|
|
|
|
var res types.PoolStatsQueryResults
|
|
suite.Nil(types.ModuleCdc.UnmarshalJSON(bz, &res))
|
|
|
|
// Check that all pools are accounted for
|
|
suite.Equal(len(poolsMap), len(res))
|
|
// Check that each individual result matches the expected result
|
|
for _, pool := range res {
|
|
expectedPool, ok := poolsMap[pool.Name]
|
|
suite.True(ok)
|
|
suite.Equal(expectedPool.PoolID, pool.Name)
|
|
suite.Equal(sdk.NewCoins(expectedPool.ReservesA, expectedPool.ReservesB), pool.Coins)
|
|
suite.Equal(expectedPool.TotalShares, pool.TotalShares)
|
|
}
|
|
}
|
|
|
|
func (suite *querierTestSuite) TestQueryDeposit() {
|
|
// Set up pool in store
|
|
coinA := sdk.NewCoin("ukava", sdk.NewInt(10))
|
|
coinB := sdk.NewCoin("usdx", sdk.NewInt(200))
|
|
pool, err := types.NewDenominatedPool(sdk.NewCoins(coinA, coinB))
|
|
suite.Nil(err)
|
|
poolRecord := types.NewPoolRecord(pool)
|
|
suite.Keeper.SetPool(suite.Ctx, poolRecord)
|
|
|
|
// Deposit into pool
|
|
owner := suite.addresses[0]
|
|
err = suite.Keeper.Deposit(suite.Ctx, owner, coinA, coinB, sdk.MustNewDecFromStr("0.20"))
|
|
suite.Nil(err)
|
|
|
|
ctx := suite.Ctx.WithIsCheckTx(false)
|
|
// Set up request query
|
|
query := abci.RequestQuery{
|
|
Path: strings.Join([]string{"custom", types.QuerierRoute, types.QueryGetDeposits}, "/"),
|
|
Data: types.ModuleCdc.MustMarshalJSON(types.NewQueryDepositsParams(1, 100, owner, poolRecord.PoolID)),
|
|
}
|
|
|
|
bz, err := suite.querier(ctx, []string{types.QueryGetDeposits}, query)
|
|
suite.Nil(err)
|
|
suite.NotNil(bz)
|
|
|
|
var res types.DepositsQueryResults
|
|
suite.Nil(types.ModuleCdc.UnmarshalJSON(bz, &res))
|
|
|
|
// As the only depositor all pool shares should belong to the owner
|
|
suite.Equal(poolRecord.TotalShares, res[0].SharesOwned)
|
|
}
|
|
|
|
func TestQuerierTestSuite(t *testing.T) {
|
|
suite.Run(t, new(querierTestSuite))
|
|
}
|