IMaverickV2BoostedPosition

Inherits: IBoostedPositionBase

Functions

mint

Mints BP LP position to recipient. User has to add liquidity to BP contract before making this call as this mint function simply assigns any new liquidity that this BP possesses in the pool to the recipient. Accordingly, this function should only be called in the same transaction where liquidity has been added to a pool as part of a multicall or through a router/manager contract.

function mint(address recipient) external returns (uint256 deltaSupply);

burn

Burns BP LP positions and redeems the underlying A/B token to the recipient.

function burn(address recipient, uint256 amount) external returns (uint256 tokenAOut, uint256 tokenBOut);

migrateBinLiquidityToRoot

Migrates all underlying movement-mode liquidity from a merged bin to the active parent of the merged bin. For Static BPs, this function is a no-op and never needs to be called.

function migrateBinLiquidityToRoot() external;

getTicks

Array of ticks where the underlying BP liquidity exists.

function getTicks() external view returns (int32[] memory ticks);

getRatios

Array of relative pool bin LP balance of the bins in the BP.

function getRatios() external view returns (uint128[] memory ratios_);

getBinIds

Array of BP binIds.

function getBinIds() external view returns (uint32[] memory binIds_);

Events

BoostedPositionMigrateBinLiquidity

event BoostedPositionMigrateBinLiquidity(uint32 currentBinId, uint32 newBinId, uint128 newBinBalance);

Errors

BoostedPositionTooLittleLiquidityAdded

error BoostedPositionTooLittleLiquidityAdded(uint256 binIdIndex, uint32 binId, uint128 required, uint128 available);

BoostedPositionMovementBinNotMigrated

error BoostedPositionMovementBinNotMigrated();