Base

Ensure the deadline of a liquidity modification request is not expired.

Set the pool PoolManager address.

To cover all possible scenarios, msg.sender should have already given the hook an allowance of at least amount0Desired/amount1Desired on token0/token1. Always adds assets at the ideal ratio, according to the price when the transaction is executed.

Calls the PoolManager to unlock and call back the hook’s unlockCallback function.

Callback from the PoolManager when liquidity is modified, either adding or removing.

Handle any fees accrued in a liquidity position. By default, this function transfers the tokens to the owner of the liquidity position. However, this function can be overriden to take fees accrued in the position, or any other desired logic.

Initialize the hook’s pool key. The stored key should act immutably so that it can safely be used across the hook’s functions.

Revert when liquidity is attempted to be added via the PoolManager.

Revert when liquidity is attempted to be removed via the PoolManager.

Get the liquidity modification to apply for a given liquidity addition, and the amount of liquidity shares would be minted to the sender.

Get the liquidity modification to apply for a given liquidity removal, and the amount of liquidity shares would be burned from the sender.

Mint liquidity shares to the sender.

Burn liquidity shares from the sender.

Set the hook permissions, specifically beforeInitialize, beforeAddLiquidity and beforeRemoveLiquidity.

A liquidity modification order was attempted to be executed after the deadline.

Pool was not initialized.

Principal delta of liquidity modification resulted in too much slippage.

Liquidity was attempted to be added or removed via the PoolManager instead of the hook.

Native currency was not sent with the correct amount.

Hook was already initialized.

Set the pool PoolManager address.

Defines how the liquidity modification data is encoded and returned for an add liquidity request.

Defines how the liquidity modification data is encoded and returned for a remove liquidity request.

Overides the default swap logic of the PoolManager and calls the _getUnspecifiedAmount to get the amount of tokens to be sent to the receiver.

Overides the custom accounting logic to support the custom curve integer amounts.

Decodes the callback data and applies the liquidity modifications, overriding the custom accounting logic to mint and burn ERC-6909 claim tokens which are used in swaps.

Calculate the amount of the unspecified currency to be taken or settled from the swapper, depending on the swap direction and the fee amount to be paid to LPs.

Calculate the amount of fees to be paid to LPs in a swap.

Calculate the amount of tokens to use and liquidity shares to burn for a remove liquidity request.

Calculate the amount of tokens to use and liquidity shares to mint for an add liquidity request.

Set the hook permissions, specifically beforeInitialize, beforeAddLiquidity, beforeRemoveLiquidity, beforeSwap, and beforeSwapReturnDelta

Restrict the function to only be callable by the hook itself.

Restrict the function to only be called for a valid pool.

Set the pool manager and check that the hook address matches the expected permissions and flags.

Get the hook permissions to signal which hook functions are to be implemented.

Used at deployment to validate the address correctly represents the expected permissions.

Validate the hook address against the expected permissions.

Hook implementation for beforeInitialize, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for afterInitialize, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for beforeAddLiquidity, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for beforeRemoveLiquidity, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for afterAddLiquidity, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for afterRemoveLiquidity, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for beforeSwap, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for afterSwap, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for beforeDonate, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

Hook implementation for afterDonate, to be overriden by the inheriting hook. The flag must be set to true in the getHookPermissions function.

The hook is not the caller.

The pool is not authorized to use this hook.

The hook function is not implemented.

Set the PoolManager address.

Skip the v3-like swap implementation of the PoolManager by returning a delta that nets out the specified amount to 0 to enable asynchronous swaps.

Calculate the fee amount for the swap.

Set the hook permissions, specifically beforeSwap and beforeSwapReturnDelta.