StoryHuntV3Pool

Variables

address factory

Description: The contract that deployed the pool, which must adhere to the IStoryHuntV3Factory interface.

address token0

Description: The first of the two tokens of the pool, sorted by address.

address token1

Description: The second of the two tokens of the pool, sorted by address.

uint24 fee

Description: The pool's fee in hundredths of a bip, i.e., 1e-6.

int24 tickSpacing

Description: The pool tick spacing. Ticks can only be used at multiples of this value, minimum of 1 and always positive. For example, a tickSpacing of 3 means ticks can be initialized every 3rd tick, i.e., ..., -6, -3, 0, 3, 6, ...

uint128 maxLiquidityPerTick

Description: 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.

Slot0 slot0

Description: The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas when accessed externally. Struct Definition:

struct Slot0 {
    uint160 sqrtPriceX96;
    int24 tick;
    uint16 observationIndex;
    uint16 observationCardinality;
    uint16 observationCardinalityNext;
    uint8 feeProtocol;
    bool unlocked;
}
uint256 feeGrowthGlobal0X128

Description: The fee growth as a Q128.128, representing fees of token0 collected per unit of liquidity for the entire life of the pool. This value can overflow the uint256.

uint256 feeGrowthGlobal1X128

Description: The fee growth as a Q128.128, representing fees of token1 collected per unit of liquidity for the entire life of the pool. This value can overflow the uint256.

ProtocolFees protocolFees

Description: The amounts of token0 and token1 that are owed to the protocol. Struct Definition:

struct ProtocolFees {
    uint128 token0;
    uint128 token1;
}

Protocol fees will never exceed uint128 max in either token.

uint128 liquidity

Description: The currently in-range liquidity available to the pool. This value has no relationship to the total liquidity across all ticks.

mapping(int24 => Tick.Info) ticks

Description: Look up information about a specific tick in the pool.

mapping(int16 => uint256) tickBitmap

Description: Returns 256 packed tick initialized boolean values. See TickBitmap for more information.

mapping(bytes32 => Position.Info) positions

Description: Returns the information about a position by the position's key.

Oracle.Observation[65535] observations

Description: 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.

Functions

function snapshotCumulativesInside(int24 tickLower, int24 tickUpper) external view returns (int56 tickCumulativeInside, uint160 secondsPerLiquidityInsideX128, uint32 secondsInside)

Description: 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

Name
Type
Description

tickLower

int24

The lower tick of the range

tickUpper

int24

The upper tick of the range

Return Values

Name
Type
Description

tickCumulativeInside

int56

The snapshot of the tick accumulator for the range

secondsPerLiquidityInsideX128

uint160

The snapshot of seconds per liquidity for the range

secondsInside

uint32

The snapshot of seconds inside the range

function observe(uint32[] secondsAgos) external view returns (int56[] tickCumulatives, uint160[] secondsPerLiquidityCumulativeX128s)

Description: 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

Name
Type
Description

secondsAgos

uint32[]

From how long ago each cumulative tick and liquidity value should be returned

Return Values

Name
Type
Description

tickCumulatives

int56[]

Cumulative tick values as of each secondsAgo from the current block timestamp

secondsPerLiquidityCumulativeX128s

uint160[]

Cumulative seconds per liquidity-in-range value as of each secondsAgo from the current block timestamp

function increaseObservationCardinalityNext(uint16 observationCardinalityNext) external

Description: Increase the maximum number of price and liquidity observations that this pool will store. This method is a no-op if the pool already has an observationCardinalityNext greater than or equal to the input observationCardinalityNext.

Parameters

Name
Type
Description

observationCardinalityNext

uint16

The desired minimum number of observations for the pool to store

function initialize(uint160 sqrtPriceX96) external

Description: Sets the initial price for the pool. Note: Not locked because it initializes unlocked.

Parameters

Name
Type
Description

sqrtPriceX96

uint160

The initial sqrt price of the pool as a Q64.96

function mint(address recipient, int24 tickLower, int24 tickUpper, uint128 amount, bytes data) external returns (uint256 amount0, uint256 amount1)

Description: Adds liquidity for the given recipient/tickLower/tickUpper position. Note: noDelegateCall is applied indirectly via _modifyPosition.

Parameters

Name
Type
Description

recipient

address

The address for which the liquidity will be created

tickLower

int24

The lower tick of the position in which to add liquidity

tickUpper

int24

The upper tick of the position in which to add liquidity

amount

uint128

The amount of liquidity to mint

data

bytes

Any data that should be passed through to the callback

Return Values

Name
Type
Description

amount0

uint256

The amount of token0 that was paid to mint the given amount of liquidity. Matches the value in the callback

amount1

uint256

The amount of token1 that was paid to mint the given amount of liquidity. Matches the value in the callback

function collect(address recipient, int24 tickLower, int24 tickUpper, uint128 amount0Requested, uint128 amount1Requested) external returns (uint128 amount0, uint128 amount1)

Description: 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, the 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

Name
Type
Description

recipient

address

The address which should receive the fees collected

tickLower

int24

The lower tick of the position for which to collect fees

tickUpper

int24

The upper tick of the position for which to collect fees

amount0Requested

uint128

How much token0 should be withdrawn from the fees owed

amount1Requested

uint128

How much token1 should be withdrawn from the fees owed

Return Values

Name
Type
Description

amount0

uint128

The amount of fees collected in token0

amount1

uint128

The amount of fees collected in token1

function burn(int24 tickLower, int24 tickUpper, uint128 amount) external returns (uint256 amount0, uint256 amount1)

Description: Burns liquidity from the sender and accounts tokens owed for the liquidity to the position. Note: noDelegateCall is applied indirectly via _modifyPosition.

Parameters

Name
Type
Description

tickLower

int24

The lower tick of the position for which to burn liquidity

tickUpper

int24

The upper tick of the position for which to burn liquidity

amount

uint128

How much liquidity to burn

Return Values

Name
Type
Description

amount0

uint256

The amount of token0 sent to the recipient

amount1

uint256

The amount of token1 sent to the recipient

function swap(address recipient, bool zeroForOne, int256 amountSpecified, uint160 sqrtPriceLimitX96, bytes data) external returns (int256 amount0, int256 amount1)

Description: Swaps token0 for token1, or token1 for token0. The caller of this method receives a callback in the form of IStoryHuntV3SwapCallback#storyHuntV3SwapCallback.

Parameters

Name
Type
Description

recipient

address

The address to receive the output of the swap

zeroForOne

bool

The direction of the swap, true for token0 to token1, false for token1 to token0

amountSpecified

int256

The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)

sqrtPriceLimitX96

uint160

The Q64.96 sqrt price limit. If zeroForOne, the price cannot be less than this value after the swap. If oneForZero, the price cannot be greater than this value after the swap

data

bytes

Any data that should be passed through to the callback

Return Values

Name
Type
Description

amount0

int256

The delta of the balance of token0 of the pool, exact when negative, minimum when positive

amount1

int256

The delta of the balance of token1 of the pool, exact when negative, minimum when positive

function flash(address recipient, uint256 amount0, uint256 amount1, bytes data) external

Description: Receives token0 and/or token1 and pays it back, plus a fee, in the callback. The caller of this method receives a callback in the form of IStoryHuntV3FlashCallback#storyHuntV3FlashCallback. Can be used to donate underlying tokens pro-rata to currently in-range liquidity providers by calling with 0 amount0 and/or amount1 and sending the donation amount(s) from the callback.

Parameters

Name
Type
Description

recipient

address

The address which will receive the token0 and token1 amounts

amount0

uint256

The amount of token0 to send

amount1

uint256

The amount of token1 to send

data

bytes

Any data that should be passed through to the callback

function setFeeProtocol(uint8 feeProtocol0, uint8 feeProtocol1) external

Description: Sets the denominator of the protocol's percentage share of the fees. Only callable by the factory owner.

Parameters

Name
Type
Description

feeProtocol0

uint8

New protocol fee denominator for token0 of the pool

feeProtocol1

uint8

New protocol fee denominator for token1 of the pool

function collectProtocol(address recipient, uint128 amount0Requested, uint128 amount1Requested) external returns (uint128 amount0, uint128 amount1)

Description: Collects the protocol fee accrued to the pool. Only callable by the factory owner.

Parameters

Name
Type
Description

recipient

address

The address to which collected protocol fees should be sent

amount0Requested

uint128

The maximum amount of token0 to send, can be 0 to collect fees in only token1

amount1Requested

uint128

The maximum amount of token1 to send, can be 0 to collect fees in only token0

Return Values

Name
Type
Description

amount0

uint128

The protocol fee collected in token0

amount1

uint128

The protocol fee collected in token1

Modifiers

modifier lock()

Description: Mutually exclusive reentrancy protection into the pool to/from a method. This modifier also prevents entrance to a function before the pool is initialized. The reentrancy guard is required throughout the contract because balance checks are used to determine the payment status of interactions such as mint, swap, and flash.

modifier onlyFactoryOwner()

Description: Prevents calling a function from anyone except the address returned by IStoryHuntV3Factory#owner().

Events

event Initialize(uint160 sqrtPriceX96, int24 tick)

Description: Emitted when the pool is initialized with the initial price and tick.

event IncreaseObservationCardinalityNext(uint16 observationCardinalityNextOld, uint16 observationCardinalityNextNew)

Description: Emitted when the observation cardinality is increased.

event Mint(address sender, address recipient, int24 tickLower, int24 tickUpper, uint128 amount, uint256 amount0, uint256 amount1)

Description: Emitted when liquidity is minted for a given position.

event Collect(address sender, address recipient, int24 tickLower, int24 tickUpper, uint128 amount0, uint128 amount1)

Description: Emitted when fees are collected from a position.

event Burn(address sender, int24 tickLower, int24 tickUpper, uint128 amount, uint256 amount0, uint256 amount1)

Description: Emitted when liquidity is burned from a position.

event Swap(address sender, address recipient, int256 amount0, int256 amount1, uint160 sqrtPriceX96, uint128 liquidity, int24 tick)

Description: Emitted for any swaps between token0 and token1.

event Flash(address sender, address recipient, uint256 amount0, uint256 amount1, uint256 paid0, uint256 paid1)

Description: Emitted for any flash taken from the pool.

event SetFeeProtocol(uint8 feeProtocol0Old, uint8 feeProtocol1Old, uint8 feeProtocol0New, uint8 feeProtocol1New)

Description: Emitted when the protocol fee denominators are updated.

event CollectProtocol(address sender, address recipient, uint128 amount0, uint128 amount1)

Description: Emitted when protocol fees are collected.

Usage Notes

  1. Initialization

    • The pool must be initialized by calling initialize(sqrtPriceX96) before performing any swaps or adding liquidity.

  2. Adding Liquidity

    • Use mint() to add liquidity to a specific position defined by tickLower and tickUpper.

  3. Removing Liquidity

    • Use burn() to remove liquidity from a specific position. To collect the owed tokens, follow up with collect().

  4. Swapping Tokens

    • Use swap() to trade between token0 and token1. Ensure that the recipient can handle the callback.

PreviousStoryHuntV3FactoryNextNonfungiblePositionManager