General

Set the PoolManager address and the block number offset.

Hooks into the afterAddLiquidity hook to record the block number when the liquidity was added to track JIT liquidity positions.

Hooks into the afterRemoveLiquidity hook to donate accumulated fees for a JIT liquidity position created.

Calculates the fee donation when a liquidity position is removed before the block number offset.

Hook was attempted to be deployed with a block number offset that is too low.

Handles the before swap hook, setting up checkpoints at the beginning of blocks and calculating target outputs for subsequent swaps.

For the first swap in a block: - Saves the current pool state as a checkpoint

For subsequent swaps in the same block: - Calculates a target output based on the beginning-of-block state - Sets the inherited _targetOutput and _applyTargetOutput variables to enforce price limits

Handles the after swap hook, initializing the full pool state checkpoint for the first swap in a block and updating the target output if needed.

For the first swap in a block: - Saves a detailed checkpoint of the pool state including liquidity and tick information - This checkpoint will be used for subsequent swaps to calculate fair execution prices

For all swaps: - Caps the target output to the actual swap amount to prevent excessive fee collection

Calculates the fair output amount based on the pool state at the beginning of the block. This prevents sandwich attacks by ensuring trades can’t get better prices than what was available at the start of the block.

The anti-sandwich mechanism works by: * For currency0 to currency1 swaps (zeroForOne = true): The pool behaves normally with xy=k curve * For currency1 to currency0 swaps (zeroForOne = false): The price is fixed at the beginning-of-block price, which prevents attackers from manipulating the price within a block

Handles the excess tokens collected during the swap due to the anti-sandwich mechanism. When a swap executes at a worse price than what’s currently available in the pool (due to enforcing the beginning-of-block price), the excess tokens are donated back to the pool to benefit all liquidity providers.

Set the hook permissions, specifically beforeSwap, afterSwap, and afterSwapReturnDelta.

Set the PoolManager address.

Hooks into the afterInitialize hook to set the last tick lower for the pool.

Hooks into the afterSwap hook to get the ticks crossed by the swap and fill the orders that are crossed, filling them.

Places a limit order by adding liquidity out of range at a specific tick. The order will be filled when the pool price crosses the specified tick. Takes a PoolKey key, target tick, direction zeroForOne indicating whether to buy currency0 or currency1, and amount of liquidity to place. The interaction with the poolManager is done via the unlock function, which will trigger the unlockCallback function.

Cancels a limit order by removing liquidity from the pool. Takes a PoolKey key, tickLower of the order, direction zeroForOne indicating whether it was buying currency0 or currency1, and recipient address to for the removed liquidity. Note that partial cancellation is not supported - the entire liquidity added by the msg.sender will be removed. Note also that cancelling an order will cancel the order placed by the msg.sender, not orders placed by other users in the same tick range. The interaction with the poolManager is done via the unlock function, which will trigger the unlockCallback function.

Withdraws liquidity from a filled order, sending it to address to. Takes an OrderId orderId of the filled order to withdraw from. Returns the withdrawn amounts as (amount0, amount1). Can only be called after the order is filled - use cancelOrder to remove liquidity from unfilled orders. The interaction with the poolManager is done via the unlock function, which will trigger the unlockCallback function.

Handles callbacks from the PoolManager for order operations. Takes encoded rawData containing the callback type and operation-specific data. Returns encoded data containing fees accrued for cancel operations, or empty bytes otherwise. Only callable by the PoolManager.

Internal handler for place order callbacks. Takes placeData containing the order details and adds the specified liquidity to the pool out of range. Reverts if the order would be placed in range or on the wrong side of the range.

Internal handler for cancel order callbacks. Takes cancelData containing the cancellation details and removes liquidity from the pool. Returns accrued fees (amount0Fee, amount1Fee) which are allocated to remaining limit order placers, or to the cancelling user if they’re removing all liquidity.

Internal handler for withdraw callbacks. Takes withdrawData containing withdrawal amounts and recipient, burns the specified currency amounts from the hook, and transfers them to the recipient address.

Internal handler for filling limit orders when price crosses a tick. Takes a PoolKey key, target tickLower, and direction zeroForOne. Removes liquidity from filled orders, mints the received currencies to the hook, and updates order state to track filled amounts.

Internal helper that calculates the range of ticks crossed during a price change. Takes a PoolId poolId and tickSpacing, returns the current tickLower and the range of ticks crossed (lower, upper) that need to be checked for limit orders.

Returns the last recorded lower tick for a given pool. Takes a PoolId poolId and returns the stored tickLowerLast value.

Retrieves the order id for a given pool position. Takes a PoolKey key, target tickLower, and direction zeroForOne indicating whether it’s buying currency0 or currency1. Returns the {OrderId} associated with this position, or the default order id if no order exists.

Get the liquidity of an order for a given order id and owner. Takes an {OrderId} orderId and owner address and returns the amount of liquidity the owner has contributed to the order.

Get the hook permissions for this contract. Returns a Hooks.Permissions struct configured to enable afterInitialize and afterSwap hooks while disabling all other hooks.

The next order id to be used.

The last tick lower for each pool.

Tracks each order id for a given identifier, defined by keccak256 of the key, tick lower, and zero for one.

Tracks the order info for each order id.

Event emitted when a limit order is placed.

Event emitted when a limit order is filled.

Event emitted when a limit order is canceled.

Event emitted when a limit order is withdrawn.

Zero liquidity was attempted to be added or removed.

Limit order was placed in range.

Limit order placed on the wrong side of the range.

Hook was already initialized.

Limit order was already filled.

Limit order is not filled.

The zero bytes.