PoolsharkRangePair

Functions¶

snapshotLiquidityInside¶

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

Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside the specified tick range.

This informs the caller of

1) The tick * time elapsed since the pool was first initialized
2) Seconds per liquidity for the range
3) The number of seconds inside the range

Parameters:

Return Values:

observe¶

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

Returns an array of sample cumulative tick (tick * seconds) and liquidity (in liquidity units) as of each timestamp secondsAgo from the current block.

To get a time weighted average tick or liquidity-in-range, you must pass two time values:

1) the beginning time 
2) the end time 

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 of the two tokens in the pool.

Parameters:

Return Values:

timestamp

increaseObservationLength¶

  function increaseObservationLength(
    uint16 observationLengthNext
  ) external override lock noDelegateCall

Increase the maximum number of price and liquidity observations that can be stored by the pool.

This method will not modify state if the pool already has an observationLengthNext greater than or equal to the input observationLengthNext.

Parameters:

initialize¶

  function initialize(
    uint160 sqrtPriceX96
  ) external override

Sets the initial price for the pool.

Initializes unlocked.

Parameters:

mint¶

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

Adds liquidity for the given recipient.

tickLower will be the lower tick for the position.

tickUpper will be the upper tick for the position.

If the tick is outside of this range, this Position will not collect fees.

Parameters:

Return Values:

collect¶

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

Collects fees owed to a position.

Does not recompute fees earned, which must be done either via mint or burn.

Collect must be called by the Position NFT 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¶

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

Burn liquidity from the sender. collect must be called after burn to receive liquidity removed from the Position NFT.

noDelegateCall is applied indirectly via _modifyPosition

Parameters:

Return Values:

swap¶

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

Swap token0 for token1, or token1 for token0

The caller of this method receives a callback in the form of IOceanbookV1SwapCallback. This will ensure that the user interacted with a genuine Oceanbook v1 pool.

Parameters:

Return Values:

flash¶

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

Receive token0 and/or token1 and pay it back plus a fee of 0.1% (changeable by governance) in the callback.

The caller of this method receives a callback in the form of IPoolsharkV1FlashCallback.

Parameters:

setFeeProtocol¶

  function setFeeProtocol(
    uint8 feeProtocol0,
    uint8 feeProtocol1
  ) external override lock onlyFactoryOwner

Set the denominator of the protocol's % share of the fees

Parameters:

collectProtocol¶

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

Collect the protocol fee accrued to the pool

Parameters:

Return Values: