SwapUtils
A library to be used within Swap.sol. Contains functions responsible for custody and AMM functionalities.
Contracts relying on this library must initialize SwapUtils.Swap struct then use this library for SwapUtils.Swap struct. Note that this library contains both functions called by users and admins. Admin functions should be protected within contracts using this library.

Functions:

Events:

Function calculateWithdrawOneToken(struct SwapUtils.Swap self, uint256 tokenAmount, uint8 tokenIndex) → uint256

Calculate the dy, the amount of selected token that user receives and the fee of withdrawing in one token

Parameters:

  • tokenAmount: the amount to withdraw in the pool's precision
  • tokenIndex: which token will be withdrawn
  • self: Swap struct to read from

Return Values:

  • the amount of token user will receive

Function getVirtualPrice(struct SwapUtils.Swap self) → uint256

Get the virtual price, to help calculate profit

Parameters:

  • self: Swap struct to read from

Return Values:

  • the virtual price, scaled to precision of POOL_PRECISION_DECIMALS

Function calculateSwap(struct SwapUtils.Swap self, uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx) → uint256 dy

Externally calculates a swap between two tokens.

Parameters:

  • self: Swap struct to read from
  • tokenIndexFrom: the token to sell
  • tokenIndexTo: the token to buy
  • dx: the number of tokens to sell. If the token charges a fee on transfers, use the amount that gets transferred after the fee.

Return Values:

  • dy the number of tokens the user will get

Function calculateRemoveLiquidity(struct SwapUtils.Swap self, uint256 amount) → uint256[]

A simple method to calculate amount of each underlying tokens that is returned upon burning given amount of LP tokens

Parameters:

  • amount: the amount of LP tokens that would to be burned on withdrawal

Return Values:

  • array of amounts of tokens user will receive

Function calculateTokenAmount(struct SwapUtils.Swap self, uint256[] amounts, bool deposit) → uint256

A simple method to calculate prices from deposits or withdrawals, excluding fees but including slippage. This is helpful as an input into the various "min" parameters on calls to fight front-running
This shouldn't be used outside frontends for user estimates.

Parameters:

  • self: Swap struct to read from
  • amounts: an array of token amounts to deposit or withdrawal, corresponding to pooledTokens. The amount should be in each pooled token's native precision. If a token charges a fee on transfers, use the amount that gets transferred after the fee.
  • deposit: whether this is a deposit or a withdrawal

Return Values:

  • if deposit was true, total amount of lp token that will be minted and if deposit was false, total amount of lp token that will be burned

Function getAdminBalance(struct SwapUtils.Swap self, uint256 index) → uint256

return accumulated amount of admin fees of the token with given index

Parameters:

  • self: Swap struct to read from
  • index: Index of the pooled token

Return Values:

  • admin balance in the token's precision

Function swap(struct SwapUtils.Swap self, uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy) → uint256

swap two tokens in the pool

Parameters:

  • self: Swap struct to read from and write to
  • tokenIndexFrom: the token the user wants to sell
  • tokenIndexTo: the token the user wants to buy
  • dx: the amount of tokens the user wants to sell
  • minDy: the min amount the user would like to receive, or revert.

Return Values:

  • amount of token user received on swap

Function addLiquidity(struct SwapUtils.Swap self, uint256[] amounts, uint256 minToMint) → uint256

Add liquidity to the pool

Parameters:

  • self: Swap struct to read from and write to
  • amounts: the amounts of each token to add, in their native precision
  • minToMint: the minimum LP tokens adding this amount of liquidity should mint, otherwise revert. Handy for front-running mitigation allowed addresses. If the pool is not in the guarded launch phase, this parameter will be ignored.

Return Values:

  • amount of LP token user received

Function removeLiquidity(struct SwapUtils.Swap self, uint256 amount, uint256[] minAmounts) → uint256[]

Burn LP tokens to remove liquidity from the pool.
Liquidity can always be removed, even when the pool is paused.

Parameters:

  • self: Swap struct to read from and write to
  • amount: the amount of LP tokens to burn
  • minAmounts: the minimum amounts of each token in the pool acceptable for this burn. Useful as a front-running mitigation

Return Values:

  • amounts of tokens the user received

Function removeLiquidityOneToken(struct SwapUtils.Swap self, uint256 tokenAmount, uint8 tokenIndex, uint256 minAmount) → uint256

Remove liquidity from the pool all in one token.

Parameters:

  • self: Swap struct to read from and write to
  • tokenAmount: the amount of the lp tokens to burn
  • tokenIndex: the index of the token you want to receive
  • minAmount: the minimum amount to withdraw, otherwise revert

Return Values:

  • amount chosen token that user received

Function removeLiquidityImbalance(struct SwapUtils.Swap self, uint256[] amounts, uint256 maxBurnAmount) → uint256

Remove liquidity from the pool, weighted differently than the pool's current balances.

Parameters:

  • self: Swap struct to read from and write to
  • amounts: how much of each token to withdraw
  • maxBurnAmount: the max LP token provider is willing to pay to remove liquidity. Useful as a front-running mitigation.

Return Values:

  • actual amount of LP tokens burned in the withdrawal

Function withdrawAdminFees(struct SwapUtils.Swap self, address to)

withdraw all admin fees to a given address

Parameters:

  • self: Swap struct to withdraw fees from
  • to: Address to send the fees to

Function setAdminFee(struct SwapUtils.Swap self, uint256 newAdminFee)

Sets the admin fee
adminFee cannot be higher than 100% of the swap fee

Parameters:

  • self: Swap struct to update
  • newAdminFee: new admin fee to be applied on future transactions

Function setSwapFee(struct SwapUtils.Swap self, uint256 newSwapFee)

update the swap fee
fee cannot be higher than 1% of each swap

Parameters:

  • self: Swap struct to update
  • newSwapFee: new swap fee to be applied on future transactions

Event TokenSwap(address buyer, uint256 tokensSold, uint256 tokensBought, uint128 soldId, uint128 boughtId)

No description

Event AddLiquidity(address provider, uint256[] tokenAmounts, uint256[] fees, uint256 invariant, uint256 lpTokenSupply)

No description

Event RemoveLiquidity(address provider, uint256[] tokenAmounts, uint256 lpTokenSupply)

No description

Event RemoveLiquidityOne(address provider, uint256 lpTokenAmount, uint256 lpTokenSupply, uint256 boughtId, uint256 tokensBought)

No description

Event RemoveLiquidityImbalance(address provider, uint256[] tokenAmounts, uint256[] fees, uint256 invariant, uint256 lpTokenSupply)

No description

Event NewAdminFee(uint256 newAdminFee)

No description

Event NewSwapFee(uint256 newSwapFee)

No description
Copy link
On this page
Functions:
Events:
Function calculateWithdrawOneToken(struct SwapUtils.Swap self, uint256 tokenAmount, uint8 tokenIndex) → uint256
Parameters:
Return Values:
Function getVirtualPrice(struct SwapUtils.Swap self) → uint256
Parameters:
Return Values:
Function calculateSwap(struct SwapUtils.Swap self, uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx) → uint256 dy
Parameters:
Return Values:
Function calculateRemoveLiquidity(struct SwapUtils.Swap self, uint256 amount) → uint256[]
Parameters:
Return Values:
Function calculateTokenAmount(struct SwapUtils.Swap self, uint256[] amounts, bool deposit) → uint256
Parameters:
Return Values:
Function getAdminBalance(struct SwapUtils.Swap self, uint256 index) → uint256
Parameters:
Return Values:
Function swap(struct SwapUtils.Swap self, uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy) → uint256
Parameters:
Return Values:
Function addLiquidity(struct SwapUtils.Swap self, uint256[] amounts, uint256 minToMint) → uint256
Parameters:
Return Values:
Function removeLiquidity(struct SwapUtils.Swap self, uint256 amount, uint256[] minAmounts) → uint256[]
Parameters:
Return Values:
Function removeLiquidityOneToken(struct SwapUtils.Swap self, uint256 tokenAmount, uint8 tokenIndex, uint256 minAmount) → uint256
Parameters:
Return Values:
Function removeLiquidityImbalance(struct SwapUtils.Swap self, uint256[] amounts, uint256 maxBurnAmount) → uint256
Parameters:
Return Values:
Function withdrawAdminFees(struct SwapUtils.Swap self, address to)
Parameters:
Function setAdminFee(struct SwapUtils.Swap self, uint256 newAdminFee)
Parameters:
Function setSwapFee(struct SwapUtils.Swap self, uint256 newSwapFee)
Parameters:
Event TokenSwap(address buyer, uint256 tokensSold, uint256 tokensBought, uint128 soldId, uint128 boughtId)
Event AddLiquidity(address provider, uint256[] tokenAmounts, uint256[] fees, uint256 invariant, uint256 lpTokenSupply)
Event RemoveLiquidity(address provider, uint256[] tokenAmounts, uint256 lpTokenSupply)
Event RemoveLiquidityOne(address provider, uint256 lpTokenAmount, uint256 lpTokenSupply, uint256 boughtId, uint256 tokensBought)
Event RemoveLiquidityImbalance(address provider, uint256[] tokenAmounts, uint256[] fees, uint256 invariant, uint256 lpTokenSupply)
Event NewAdminFee(uint256 newAdminFee)
Event NewSwapFee(uint256 newSwapFee)