Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change the logic to determine if the pool was depleted #369

Merged
merged 4 commits into from Jun 3, 2021
Merged

Change the logic to determine if the pool was depleted #369

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c55b4ad
keep zero reserve coins from GetReserveCoins
hallazzang May 27, 2021
25dbb2d
treat pool with zero pool coin supply as depleted
hallazzang May 27, 2021
c391959
rollback change of Quo/MulTruncate to Quo/Mul
hallazzang Jun 2, 2021
096a0a0
Merge branch 'develop' of github.com:tendermint/liquidity into hallaz…
hallazzang Jun 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
86 changes: 45 additions & 41 deletions x/liquidity/keeper/liquidity_pool.go
View file
Open in desktop
Expand Up @@ -77,32 +77,32 @@ func (k Keeper) CreatePool(ctx sdk.Context, msg *types.MsgCreatePool) (types.Poo
poolName := types.PoolName(reserveCoinDenoms, msg.PoolTypeId)
reserveAcc := types.GetPoolReserveAcc(poolName)

poolCreator := msg.GetPoolCreator()
accPoolCreator := k.accountKeeper.GetAccount(ctx, poolCreator)
poolCreatorBalances := k.bankKeeper.GetAllBalances(ctx, accPoolCreator.GetAddress())

if !poolCreatorBalances.IsAllGTE(msg.DepositCoins) {
return types.Pool{}, types.ErrInsufficientBalance
poolCoinDenom := types.GetPoolCoinDenom(poolName)
pool := types.Pool{
//Id: will set on SetPoolAtomic
TypeId: msg.PoolTypeId,
ReserveCoinDenoms: reserveCoinDenoms,
ReserveAccountAddress: reserveAcc.String(),
PoolCoinDenom: poolCoinDenom,
}

reserveCoins := k.GetReserveCoins(ctx, pool)

poolCreator := msg.GetPoolCreator()
poolCreatorBalances := k.bankKeeper.GetAllBalances(ctx, poolCreator)

for _, coin := range msg.DepositCoins {
if coin.Amount.LT(params.MinInitDepositAmount) {
if coin.Amount.Add(reserveCoins.AmountOf(coin.Denom)).LT(params.MinInitDepositAmount) {
return types.Pool{}, types.ErrLessThanMinInitDeposit
}
}

if !poolCreatorBalances.IsAllGTE(params.PoolCreationFee.Add(msg.DepositCoins...)) {
return types.Pool{}, types.ErrInsufficientPoolCreationFee
if !poolCreatorBalances.IsAllGTE(msg.DepositCoins) {
return types.Pool{}, types.ErrInsufficientBalance
}

PoolCoinDenom := types.GetPoolCoinDenom(poolName)

pool := types.Pool{
//Id: will set on SetPoolAtomic
TypeId: msg.PoolTypeId,
ReserveCoinDenoms: reserveCoinDenoms,
ReserveAccountAddress: reserveAcc.String(),
PoolCoinDenom: PoolCoinDenom,
if !poolCreatorBalances.IsAllGTE(msg.DepositCoins.Add(params.PoolCreationFee...)) {
return types.Pool{}, types.ErrInsufficientPoolCreationFee
}

batchEscrowAcc := k.accountKeeper.GetModuleAddress(types.ModuleName)
Expand Down Expand Up @@ -136,8 +136,8 @@ func (k Keeper) CreatePool(ctx sdk.Context, msg *types.MsgCreatePool) (types.Poo

k.SetPoolBatch(ctx, batch)

reserveCoins := k.GetReserveCoins(ctx, pool)
lastReserveRatio := sdk.NewDecFromInt(reserveCoins[0].Amount).QuoTruncate(sdk.NewDecFromInt(reserveCoins[1].Amount))
reserveCoins = k.GetReserveCoins(ctx, pool)
lastReserveRatio := sdk.NewDecFromInt(reserveCoins[0].Amount).Quo(sdk.NewDecFromInt(reserveCoins[1].Amount))
logger := k.Logger(ctx)
logger.Debug("createPool", msg, "pool", pool, "reserveCoins", reserveCoins, "lastReserveRatio", lastReserveRatio)
return pool, nil
Expand Down Expand Up @@ -172,10 +172,10 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,

reserveCoins := k.GetReserveCoins(ctx, pool)

// reinitialize pool in case of reserve coins has run out
if reserveCoins.IsZero() {
// reinitialize pool if the pool is depleted
if k.IsDepletedPool(ctx, pool) {
for _, depositCoin := range msg.Msg.DepositCoins {
if depositCoin.Amount.LT(params.MinInitDepositAmount) {
if depositCoin.Amount.Add(reserveCoins.AmountOf(depositCoin.Denom)).LT(params.MinInitDepositAmount) {
return types.ErrLessThanMinInitDeposit
}
}
Expand All @@ -202,10 +202,10 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,
msg.ToBeDeleted = true
k.SetPoolBatchDepositMsgState(ctx, msg.Msg.PoolId, msg)

reserveCoins := k.GetReserveCoins(ctx, pool)
reserveCoins = k.GetReserveCoins(ctx, pool)
lastReserveCoinA := sdk.NewDecFromInt(reserveCoins[0].Amount)
lastReserveCoinB := sdk.NewDecFromInt(reserveCoins[1].Amount)
lastReserveRatio := lastReserveCoinA.QuoTruncate(lastReserveCoinB)
lastReserveRatio := lastReserveCoinA.Quo(lastReserveCoinB)
ctx.EventManager().EmitEvent(
sdk.NewEvent(
types.EventTypeDepositToPool,
Expand Down Expand Up @@ -236,13 +236,13 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,
// Decimal Error, divide the Int coin amount by the Decimal Rate and erase the decimal point to deposit a lower value
lastReserveCoinA := sdk.NewDecFromInt(reserveCoins[0].Amount)
lastReserveCoinB := sdk.NewDecFromInt(reserveCoins[1].Amount)
lastReserveRatio := lastReserveCoinA.QuoTruncate(lastReserveCoinB)
lastReserveRatio := lastReserveCoinA.Quo(lastReserveCoinB)

depositCoinA := depositCoins[0]
depositCoinB := depositCoins[1]
depositCoinAmountA := depositCoinA.Amount
depositCoinAmountB := depositCoinB.Amount
depositableCoinAmountA := depositCoinB.Amount.ToDec().MulTruncate(lastReserveRatio).TruncateInt()
depositableCoinAmountA := depositCoinB.Amount.ToDec().Mul(lastReserveRatio).TruncateInt()

acceptedCoins := sdk.NewCoins()
refundedCoins := sdk.NewCoins()
Expand All @@ -251,7 +251,7 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,

// handle when depositing coin A amount is less than, greater than or equal to depositable amount
if depositCoinA.Amount.LT(depositableCoinAmountA) {
depositCoinAmountB = depositCoinA.Amount.ToDec().QuoTruncate(lastReserveRatio).TruncateInt()
depositCoinAmountB = depositCoinA.Amount.ToDec().Quo(lastReserveRatio).TruncateInt()
acceptedCoins = sdk.NewCoins(depositCoinA, sdk.NewCoin(depositCoinB.Denom, depositCoinAmountB))

inputs = append(inputs, banktypes.NewInput(batchEscrowAcc, acceptedCoins))
Expand All @@ -265,7 +265,7 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,
outputs = append(outputs, banktypes.NewOutput(depositor, refundedCoins))
}
} else if depositCoinA.Amount.GT(depositableCoinAmountA) {
depositCoinAmountA = depositCoinB.Amount.ToDec().MulTruncate(lastReserveRatio).TruncateInt()
depositCoinAmountA = depositCoinB.Amount.ToDec().Mul(lastReserveRatio).TruncateInt()
acceptedCoins = sdk.NewCoins(depositCoinB, sdk.NewCoin(depositCoinA.Denom, depositCoinAmountA))

inputs = append(inputs, banktypes.NewInput(batchEscrowAcc, acceptedCoins))
Expand Down Expand Up @@ -313,7 +313,7 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,
afterReserveCoins := k.GetReserveCoins(ctx, pool)
afterReserveCoinA := sdk.NewDecFromInt(afterReserveCoins[0].Amount)
afterReserveCoinB := sdk.NewDecFromInt(afterReserveCoins[1].Amount)
afterReserveRatio := afterReserveCoinA.QuoTruncate(afterReserveCoinB)
afterReserveRatio := afterReserveCoinA.Quo(afterReserveCoinB)
poolCoinTotalSupplyDec := sdk.NewDecFromInt(poolCoinTotalSupply)
mintPoolCoinDec := sdk.NewDecFromInt(mintPoolCoin.Amount)
depositCoinADec := sdk.NewDecFromInt(depositCoinA.Amount)
Expand Down Expand Up @@ -345,7 +345,7 @@ func (k Keeper) DepositLiquidityPool(ctx sdk.Context, msg types.DepositMsgState,
)

reserveCoins = k.GetReserveCoins(ctx, pool)
lastReserveRatio = sdk.NewDecFromInt(reserveCoins[0].Amount).QuoTruncate(sdk.NewDecFromInt(reserveCoins[1].Amount))
lastReserveRatio = sdk.NewDecFromInt(reserveCoins[0].Amount).Quo(sdk.NewDecFromInt(reserveCoins[1].Amount))

logger := k.Logger(ctx)
logger.Debug("deposit", msg, "pool", pool, "inputs", inputs, "outputs", outputs, "reserveCoins", reserveCoins, "lastReserveRatio", lastReserveRatio)
Expand Down Expand Up @@ -393,7 +393,7 @@ func (k Keeper) WithdrawLiquidityPool(ctx sdk.Context, msg types.WithdrawMsgStat
// Calculate withdraw amount of respective reserve coin considering fees and pool coin's totally supply
for _, reserveCoin := range reserveCoins {
// WithdrawAmount = ReserveAmount * PoolCoinAmount * WithdrawFeeProportion / TotalSupply
withdrawAmt := reserveCoin.Amount.Mul(msg.Msg.PoolCoin.Amount).ToDec().MulTruncate(withdrawProportion).TruncateInt().Quo(poolCoinTotalSupply)
withdrawAmt := reserveCoin.Amount.Mul(msg.Msg.PoolCoin.Amount).ToDec().Mul(withdrawProportion).TruncateInt().Quo(poolCoinTotalSupply)
withdrawCoins = append(withdrawCoins, sdk.NewCoin(reserveCoin.Denom, withdrawAmt))
}
}
Expand Down Expand Up @@ -462,10 +462,10 @@ func (k Keeper) WithdrawLiquidityPool(ctx sdk.Context, msg types.WithdrawMsgStat
reserveCoins = k.GetReserveCoins(ctx, pool)

var lastReserveRatio sdk.Dec
if reserveCoins.Empty() {
if reserveCoins.IsZero() {
lastReserveRatio = sdk.ZeroDec()
} else {
lastReserveRatio = sdk.NewDecFromInt(reserveCoins[0].Amount).QuoTruncate(sdk.NewDecFromInt(reserveCoins[1].Amount))
lastReserveRatio = sdk.NewDecFromInt(reserveCoins[0].Amount).Quo(sdk.NewDecFromInt(reserveCoins[1].Amount))
}

logger := k.Logger(ctx)
Expand All @@ -481,6 +481,11 @@ func (k Keeper) GetPoolCoinTotalSupply(ctx sdk.Context, pool types.Pool) sdk.Int
return total.AmountOf(pool.PoolCoinDenom)
}

// IsDepletedPool returns true if the pool is depleted.
func (k Keeper) IsDepletedPool(ctx sdk.Context, pool types.Pool) bool {
return !k.GetPoolCoinTotalSupply(ctx, pool).IsPositive()
}

// GetPoolCoinTotal returns total supply of pool coin of the pool in form of sdk.Coin
func (k Keeper) GetPoolCoinTotal(ctx sdk.Context, pool types.Pool) sdk.Coin {
return sdk.NewCoin(pool.PoolCoinDenom, k.GetPoolCoinTotalSupply(ctx, pool))
Expand All @@ -491,7 +496,7 @@ func (k Keeper) GetReserveCoins(ctx sdk.Context, pool types.Pool) (reserveCoins
reserveAcc := pool.GetReserveAccount()
reserveCoins = sdk.NewCoins()
for _, denom := range pool.ReserveCoinDenoms {
reserveCoins = reserveCoins.Add(k.bankKeeper.GetBalance(ctx, reserveAcc, denom))
reserveCoins = append(reserveCoins, k.bankKeeper.GetBalance(ctx, reserveAcc, denom))
}
return
}
Expand Down Expand Up @@ -738,8 +743,7 @@ func (k Keeper) ValidateMsgWithdrawLiquidityPool(ctx sdk.Context, msg types.MsgW
}

poolCoinTotalSupply := k.GetPoolCoinTotalSupply(ctx, pool)

if !poolCoinTotalSupply.IsPositive() || !k.GetReserveCoins(ctx, pool).IsAllPositive() {
if !poolCoinTotalSupply.IsPositive() {
return types.ErrDepletedPool
}

Expand All @@ -765,17 +769,17 @@ func (k Keeper) ValidateMsgSwapWithinBatch(ctx sdk.Context, msg types.MsgSwapWit
return types.ErrNotMatchedReserveCoin
}

if k.IsDepletedPool(ctx, pool) {
return types.ErrDepletedPool
}

params := k.GetParams(ctx)

// can not exceed max order ratio of reserve coins that can be ordered at a order
reserveCoinAmt := k.GetReserveCoins(ctx, pool).AmountOf(msg.OfferCoin.Denom)

if !reserveCoinAmt.IsPositive() {
return types.ErrDepletedPool
}

// Decimal Error, Multiply the Int coin amount by the Decimal Rate and erase the decimal point to order a lower value
maximumOrderableAmt := reserveCoinAmt.ToDec().MulTruncate(params.MaxOrderAmountRatio).TruncateInt()
maximumOrderableAmt := reserveCoinAmt.ToDec().Mul(params.MaxOrderAmountRatio).TruncateInt()
if msg.OfferCoin.Amount.GT(maximumOrderableAmt) {
return types.ErrExceededMaxOrderable
}
Expand Down