Comment on page
Elastic Peripheral Library Contracts
Field | Type | Formula Variable | Explanation |
---|---|---|---|
lastActionTime | uint32 | | timestamp of last action performed |
lockTime | uint32 | | average start time of lock schedule |
unlockTime | uint32 | | average unlock time of locked fees |
feesLocked | uint32 | | locked rToken qty since last update |
Initializes Data values for a new position. The time variables are set to the current timestamp, while
feesLocked
is set to zero.Updates Data values for an existing position. Calculates the amount of claimable reinvestment tokens to be sent to the user and, in the case of liquidity removal, the amount of burnable reinvestment tokens as well.
- If adding liquidity, update
- If removing liquidity,
-
- -=
Field | Type | Formula Variable | Explanation |
---|---|---|---|
self | N.A. | stored data values for an existing position | |
currentLiquidity | uint128 | | current position liquidity |
liquidityDelta | uint128 | | quantity change to be applied |
currentTime | uint32 | | current block timestamp |
isAddLiquidity | bool | N.A. | true = add liquidity, false = remove liquidity |
feesSinceLastAction | uint256 | | fees accrued since last action |
vestingPeriod | uint256 | | maximum time duration for which LP fees are proportionally burnt upon LP removals |
Field | Type | Formula Variable | Explanation |
---|---|---|---|
feesClaimable | uint256 | | claimable reinvestment token amount |
feesBurnable | uint256 | | reinvestment token amount to burn |
Calculates the proportion of locked fees and claimable fees given the fee amounts and claimable fee basis points.
Field | Type | Formula Variable | Explanation |
---|---|---|---|
currentFees | uint256 | | currently locked fees |
nextFees | uint256 | | fees since last action |
currentClaimableBps | uint256 | | proportion of claimable / unlocked currentFees in basis points |
nextClaimableBps | uint256 | | proportion of claimable nextFees in basis points |
Field | Type | Formula Variable | Explanation |
---|---|---|---|
feesLockedNew | uint256 | | new fee amount to be locked |
feesClaimable | uint256 | | claimable fees to be sent to user |
Bytes tightly packed arrays utility library for ethereum contracts written in Solidity. The library lets you slice and type cast bytes arrays both in memory and storage.
Contract to calculate the expected amount of liquidity given the amounts of tokens.
Params:
uint160 lowerSqrtP // a lower sqrt price of the position
uint160 upperSqrtP // a upper sqrt price of the position
uint256 qty0 // the amount of token0 to add
Returns:
uint128 liquidity // amount of liquidity to receive
Get liquidity from qty0 of the first token given the price range.
Params:
uint160 lowerSqrtP // a lower sqrt price of the position
uint160 upperSqrtP // a upper sqrt price of the position
uint256 qty1 // the amount of token1 to add
Returns:
uint128 liquidity // amount of liquidity to receive
Get liquidity from qty1 of the second token given the price range.
Params:
uint160 currentSqrtP // the current price, e.g the pool's current price
uint160 lowerSqrtP // a lower sqrt price of the position
uint160 upperSqrtP // a upper sqrt price of the position
uint256 qty0 // the amount of token0 to add
uint256 qty1 // the amount of token1 to add
Returns:
uint128 liquidity // amount of liquidity to receive
Get liquidity given the price range and amounts of 2 tokens
Functions for manipulating path data for multihop swaps
ADDR_SIZE = 20 // length of the address, i.e 20 bytes
FEE_SIZE = 2 // length of the fee, i.e 2 bytes
TOKEN_AND_POOL_OFFSET = ADDR_SIZE + FEE_SIZE// the offset of a single token address + pool fee
POOL_DATA_OFFSET = TOKEN_AND_POOL_OFFSET + ADDR_SIZE // the offset of 2 token addresses + pool fee
MULTIPLE_POOLS_MIN_LENGTH = POOL_DATA_OFFSET + TOKEN_AND_POOL_OFFSET // min length that contains at least 2 pools
Params:
bytes path
Returns:
bool
Return true if the path contains 2 or more pools, false otherwise
Params:
bytes path
Returns:
uint256
Returns the number of pools in the path.
Params:
bytes path
Returns:
address tokenA
address tokenB
uint16 fee
Return the first pool's data from the path, including tokenA, tokenB and fee.
Params:
bytes path
Returns:
bytes data
Return the segment corresponding to the first pool in the path.
Params:
bytes path
Returns:
bytes newPath
Skip a token + fee from the buffer and returns the remainder.
Provides a function for deriving a pool address from the factory, tokens, and swap fee
Params:
address factory // DMMv2 factory contract
address token0 // the first token of the pool
address token1 // the second token of the pool
uint16 swapFee // the fee of the pool
bytes32 poolInitHash // the keccake256 hash of the Pool creation code
Returns:
address pool // the pool address
Deterministically computes the pool address from the given data.
Params:
IProAMMPool
int24 nearestCurrentTickBefore
int24 nearestCurrentTickAfter
Returns:
uint32 initializedTicksCrossed
Count the number of initialized ticks have been crossed given the previous/current nearest initialized ticks to the current tick.
A helper contract to transfer token/ETH.
Params:
IERC20 token
uint256 amount
address sender
address receiver
Transfer an amount of ERC20 token from the sender to the receiver.
Params:
uint256 amount
address receiver
Transfer an amount of ETH to the receiver.
Last modified 8mo ago