IBonsaiswapV3PoolImmutables

These parameters are fixed for a pool forever, i.e., the methods will always return the same values

Functions​

factory​

  function factory(
  ) external view returns (address)

The contract that deployed the pool, which must adhere to the IBonsaisV3Factory interface

Return Values:​

Type	Description
address	contract address

token0​

  function token0(
  ) external view returns (address)

The first of the two tokens of the pool, sorted by address

Return Values:​

Type	Description
address	token contract address

token1​

  function token1(
  ) external view returns (address)

The second of the two tokens of the pool, sorted by address

Return Values:​

Type	Description
address	token contract address

fee​

  function fee(
  ) external view returns (uint24)

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

Return Values:​

Type	Description
uint24	fee

tickSpacing​

  function tickSpacing(
  ) external view returns (int24)

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

Type	Description
int24	tick spacing

maxLiquidityPerTick​

  function maxLiquidityPerTick(
  ) external view returns (uint128)

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

Type	Description
uint128	max amount of liquidity per tick