Elastic Peripheral Base Contracts
DeadlineValidation
Validate if the block timestamp has not reached the deadline yet, use for transactions with a deadline.
Modifier: onlyNotExpired()
onlyNotExpired()Reverts if the current block's timestamp is greater than the specified deadline.
deadline
uint256
Timestamp to check against current block's timestamp
_blockTimestamp()
_blockTimestamp()Returns the current block timestamp. Used for overriding by mock contracts for tests.
ERC721Permit
Nonfungible tokens that support an approve via signature, i.e. permit for ERC721.
ImmutableRouterStorage
Immutable variables that are used by Periphery contracts.
Immutables
factory
address
Factory contract address
WETH
address
Canonical WETH address
poolInitHash
bytes32
keccak256 hash of the pool's creation code. Used to compute the pool address without reading storage from the Factory
RouterTokenHelper
A helper contract to handle transfers, wrapping and unwrapping of tokens.
unwrapWeth()
unwrapWeth()Unwraps the contract's entire WETH balance to ETH, then transfers them to the recipient.
minAmount
uint256
Contract's WETH balance should not be lower than this amount
recioient
address
Desired recipient of unwrapped ETH
transferAllTokens()
transferAllTokens()Transfers the contract's entire token balance to the recipient
token
address
Token to transfer
minAmount
uint256
Contract's token balance should not be lower than this amount
recipient
address
Desired recipient of the token
refundEth()
refundEth()Transfers all ETH balance to the sender.
_transferTokens()
_transferTokens()Internal function to help transfer tokens from the sender to the recipient. If token is WETH and the contract has enough ETH balance, then wrap and transfer WETH, otherwise use RouterTokenHelper to handle transfers.
token
address
Token to transfer
sender
address
Address to pull token funds from
recipient
address
Desired recipient of the token
amount
uint256
Amount to be transferred
RouterTokenHelperWithFee
Inherits RouteTokenHelper. Contains additional functions to charge a fee for transfers as well.
unwrapWethWithFee()
unwrapWethWithFee()Unwraps the contract's entire WETH balance to ETH, then transfers them to the recipient. Charges a fee which is transferred to feeRecipient
minAmount
uint256
Contract's WETH balance should not be lower than this amount
recipient
address
Desired recipient of unwrapped ETH
feeBps
uint256
Fee to charge in basis points
feeRecipient
address
Address to receive the fee charged
transferAllTokensWithFee()
transferAllTokensWithFee()Transfers the contract's entire token balance to the recipient. Charges a fee which is transferred to feeRecipient.
token
address
Token to transfer
minAmount
uint256
Contract's token balance should not be lower than this amount
recipient
address
Desired recipient of the token
feeBps
uint256
Fee to charge in basis points
feeRecipient
address
Address to receive the fee charged
Multicall
Enables calling multiple methods in a single call to the contract.
multicall()
multicall()Uses delegateCall to sequentially execute functions, then return the result of each execution.
Input
data
bytes[]
encoded function data for each of the calls to make to this contract
Output
results
bytes[]
results from each of the calls passed in
LiquidityHelper
A helper contract to handle liquidity related actions, including mint/add/remove liquidity.
Struct: AddLiquidityParams
Used when minting a new position or adding liquidity to an existing one.
token0
address
first token of the pool
token1
address
second token of the pool
fee
uint16
the pool's swap fee
tickLower
int24
position's lower tick
tickUpper
int24
position's upper tick
ticksPrevious
int24[2]
an array containing 2 values tickLowerPrevious and tickUpperPrevious which are expected to be the nearest initialized tick <= tickLower and tickUpper respectively
amount0Desired
uint256
token0 amount user wants to add
amount1Desired
uint256
token1 amount user wants to add
amount0Min
uint256
minimum token0 amount that should be used
amount1Min
uint256
minimum token1 amount that should be used
Struct: CallbackData
Data for callback from Pool contract.
token0
address
first token of the pool
token1
address
second token of the pool
fee
uint16
the pool's swap fee
source
address
address to transfer token0/token1 from
proAMMMintCallback()
proAMMMintCallback()Mint callback function implementation called by a Pool.
deltaQty0
uint256
token0 amount requested by the pool
deltaQty1
uint256
token1 amount requested by the pool
data
bytes
Encoded CallbackData
_addLiquidity()
_addLiquidity()Add liquidity to a pool. token0 and token1 should be in the correct order, i.e token0 < token1.
Input
Parameters for addiing liquidity to a pool
Output
liquidity
uint128
amount of liquidity added
amount0
uint256
amount of token0 required
amount1
uint256
amount of token1 required
feeGrowthInsideLast
uint256
latest feeGrowthInsideLast calculated by the pool
pool
IProAMMPool
pool address
_callbackData()
_callbackData()Function to encode input parameters to CallbackData
token0
address
first token of the pool
token1
address
second token of the pool
fee
uint16
the pool's swap fee
_getPool()
_getPool()Function for computing the pool address with the given input parameters.
token0
address
first token of the pool
token1
address
second token of the pool
fee
uint16
the pool's swap fee
Last updated