AlgebraPool
Algebra concentrated liquidity pool
This contract is responsible for liquidity positions, swaps and flashloans
Developer note: Version: Algebra V1.9
Modifiers
onlyFactoryOwner
modifier onlyFactoryOwner()
internal
Developer note: Restricts everyone calling a function except factory owner
onlyValidTicks
modifier onlyValidTicks(int24 bottomTick, int24 topTick)
internal
Variables
mapping(bytes32 => struct AlgebraPool.Position) positions
Returns the information about a position by the position's key
Developer note: This is a public mapping of structures, so the `return` natspec tags are omitted.
Functions
constructor
constructor() public
public
timepoints
function timepoints(uint256 index) external view returns (bool initialized, uint32 blockTimestamp, int56 tickCumulative, uint160 secondsPerLiquidityCumulative, uint88 volatilityCumulative, int24 averageTick, uint144 volumePerLiquidityCumulative)
view external
Returns data about a specific timepoint index Developer note: You most likely want to use #getTimepoints() instead of this method to get an timepoint as of some amount of time ago, rather than at a specific index in the array. This is a public mapping of structures, so the `return` natspec tags are omitted.
Returns:
getInnerCumulatives
function getInnerCumulatives(int24 bottomTick, int24 topTick) external view returns (int56 innerTickCumulative, uint160 innerSecondsSpentPerLiquidity, uint32 innerSecondsSpent)
view external
Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside a tick range Developer note: Snapshots must only be compared to other snapshots, taken over a period for which a position existed. I.e., snapshots cannot be compared if a position is not held for the entire period between when the first snapshot is taken and the second snapshot is taken.
Returns:
getTimepoints
function getTimepoints(uint32[] secondsAgos) external view returns (int56[] tickCumulatives, uint160[] secondsPerLiquidityCumulatives, uint112[] volatilityCumulatives, uint256[] volumePerAvgLiquiditys)
view external
Returns the cumulative tick and liquidity as of each timestamp `secondsAgo` from the current block timestamp Developer note: To get a time weighted average tick or liquidity-in-range, you must call this with two values, one representing the beginning of the period and another for the end of the period. E.g., to get the last hour time-weighted average tick, you must call it with secondsAgos = [3600, 0]. The time weighted average tick represents the geometric time weighted average price of the pool, in log base sqrt(1.0001) of token1 / token0. The TickMath library can be used to go from a tick value to a ratio.
Returns:
initialize
function initialize(uint160 initialPrice) external
external
Sets the initial price for the pool Developer note: Price is represented as a sqrt(amountToken1/amountToken0) Q64.96 value
mint
function mint(address sender, address recipient, int24 bottomTick, int24 topTick, uint128 liquidityDesired, bytes data) external returns (uint256 amount0, uint256 amount1, uint128 liquidityActual)
external
Adds liquidity for the given recipient/bottomTick/topTick position Developer note: The caller of this method receives a callback in the form of IAlgebraMintCallback# AlgebraMintCallback in which they must pay any token0 or token1 owed for the liquidity. The amount of token0/token1 due depends on bottomTick, topTick, the amount of liquidity, and the current price.
Returns:
collect
function collect(address recipient, int24 bottomTick, int24 topTick, uint128 amount0Requested, uint128 amount1Requested) external returns (uint128 amount0, uint128 amount1)
external
Collects tokens owed to a position Developer note: Does not recompute fees earned, which must be done either via mint or burn of any amount of liquidity. Collect must be called by the position owner. To withdraw only token0 or only token1, amount0Requested or amount1Requested may be set to zero. To withdraw all tokens owed, caller may pass any value greater than the actual tokens owed, e.g. type(uint128).max. Tokens owed may be from accumulated swap fees or burned liquidity.
Returns:
burn
function burn(int24 bottomTick, int24 topTick, uint128 amount) external returns (uint256 amount0, uint256 amount1)
external
Burn liquidity from the sender and account tokens owed for the liquidity to the position Developer note: Can be used to trigger a recalculation of fees owed to a position by calling with an amount of 0 Fees must be collected separately via a call to #collect
Returns:
swap
function swap(address recipient, bool zeroToOne, int256 amountRequired, uint160 limitSqrtPrice, bytes data) external returns (int256 amount0, int256 amount1)
external
Swap token0 for token1, or token1 for token0 Developer note: The caller of this method receives a callback in the form of IAlgebraSwapCallback# AlgebraSwapCallback
Returns:
swapSupportingFeeOnInputTokens
function swapSupportingFeeOnInputTokens(address sender, address recipient, bool zeroToOne, int256 amountRequired, uint160 limitSqrtPrice, bytes data) external returns (int256 amount0, int256 amount1)
external
Swap token0 for token1, or token1 for token0 (tokens that have fee on transfer) Developer note: The caller of this method receives a callback in the form of I AlgebraSwapCallback# AlgebraSwapCallback
Returns:
flash
function flash(address recipient, uint256 amount0, uint256 amount1, bytes data) external
external
Receive token0 and/or token1 and pay it back, plus a fee, in the callback Developer note: The caller of this method receives a callback in the form of IAlgebraFlashCallback# AlgebraFlashCallback All excess tokens paid in the callback are distributed to liquidity providers as an additional fee. So this method can be used to donate underlying tokens to currently in-range liquidity providers by calling with 0 amount{0,1} and sending the donation amount(s) from the callback
setCommunityFee
function setCommunityFee(uint8 communityFee0, uint8 communityFee1) external
external
Set the community's % share of the fees. Cannot exceed 25% (250)
setTickSpacing
function setTickSpacing(int24 newTickSpacing) external
external
Set the new tick spacing values. Only factory owner
setIncentive
function setIncentive(address virtualPoolAddress) external
external
Sets an active incentive
setLiquidityCooldown
function setLiquidityCooldown(uint32 newLiquidityCooldown) external
external
Sets new lock time for added liquidity