Pancake V3 池子
Pancake V3 池子(PancakeV3Pool)。
Solidity API
PancakeV3Pool
factory
The contract that deployed the pool, which must adhere to the IPancakeV3Factory interface
Return Values
token0
The first of the two tokens of the pool, sorted by address
Return Values
token1
The second of the two tokens of the pool, sorted by address
Return Values
fee
The pool's fee in hundredths of a bip, i.e. 1e-6
Return Values
tickSpacing
The pool tick spacing
Ticks can only be used at multiples of this value, minimum of 1 and always positive e.g.: a tickSpacing of 3 means ticks can be initialized every 3rd tick, i.e., ..., -6, -3, 0, 3, 6, ... This value is an int24 to avoid casting even though it is always positive.
Return Values
maxLiquidityPerTick
The maximum amount of position liquidity that can use any tick in the range
This parameter is enforced per tick to prevent liquidity from overflowing a uint128 at any point, and also prevents out-of-range liquidity from being used to prevent adding in-range liquidity to a pool
Return Values
PROTOCOL_FEE_SP
PROTOCOL_FEE_DENOMINATOR
Slot0
slot0
The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas when accessed externally.
Return Values
feeGrowthGlobal0X128
The fee growth as a Q128.128 fees of token0 collected per unit of liquidity for the entire life of the pool
This value can overflow the uint256
feeGrowthGlobal1X128
The fee growth as a Q128.128 fees of token1 collected per unit of liquidity for the entire life of the pool
This value can overflow the uint256
ProtocolFees
protocolFees
The amounts of token0 and token1 that are owed to the protocol
Protocol fees will never exceed uint128 max in either token
liquidity
The currently in range liquidity available to the pool
This value has no relationship to the total liquidity across all ticks
ticks
Look up information about a specific tick in the pool
Parameters
Return Values
tickBitmap
Returns 256 packed tick initialized boolean values. See TickBitmap for more information
positions
Returns the information about a position by the position's key
Parameters
Return Values
observations
Returns data about a specific observation index
You most likely want to use #observe() instead of this method to get an observation as of some amount of time ago, rather than at a specific index in the array.
Parameters
Return Values
lmPool
SetLmPoolEvent
lock
Mutually exclusive reentrancy protection into the pool to/from a method. This method also prevents entrance to a function before the pool is initialized. The reentrancy guard is required throughout the contract because we use balance checks to determine the payment status of interactions such as mint, swap and flash.
onlyFactoryOwner
Prevents calling a function from anyone except the address returned by IPancakeV3Factory#owner()
constructor
_blockTimestamp
Returns the block timestamp truncated to 32 bits, i.e. mod 2**32. This method is overridden in tests.
snapshotCumulativesInside
Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside a tick range
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.
Parameters
Return Values
observe
Returns the cumulative tick and liquidity as of each timestamp secondsAgo
from the current block timestamp
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.
Parameters
Return Values
increaseObservationCardinalityNext
Increase the maximum number of price and liquidity observations that this pool will store
This method is no-op if the pool already has an observationCardinalityNext greater than or equal to the input observationCardinalityNext.
Parameters
initialize
Sets the initial price for the pool
not locked because it initializes unlocked
Parameters
ModifyPositionParams
mint
Adds liquidity for the given recipient/tickLower/tickUpper position
_noDelegateCall is applied indirectly via modifyPosition
Parameters
Return Values
collect
Collects tokens owed to a position
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.
Parameters
Return Values
burn
Burn liquidity from the sender and account tokens owed for the liquidity to the position
_noDelegateCall is applied indirectly via modifyPosition
Parameters
Return Values
SwapCache
SwapState
StepComputations
swap
Swap token0 for token1, or token1 for token0
The caller of this method receives a callback in the form of IPancakeV3SwapCallback#pancakeV3SwapCallback
Parameters
Return Values
flash
Receive token0 and/or token1 and pay it back, plus a fee, in the callback
The caller of this method receives a callback in the form of IPancakeV3FlashCallback#pancakeV3FlashCallback Can be used to donate underlying tokens pro-rata to currently in-range liquidity providers by calling with 0 amount{0,1} and sending the donation amount(s) from the callback
Parameters
setFeeProtocol
Set the denominator of the protocol's % share of the fees
Parameters
collectProtocol
Collect the protocol fee accrued to the pool
Parameters
Return Values
setLmPool
Last updated