BaseHook

Git Source

Inherits: IHooks

State Variables

POOL_MANAGER

IPoolManager public immutable POOL_MANAGER = IPoolManager(UNIV4_POOL_MANAGER)

Functions

poolManagerOnly

Only the pool manager may call this function

modifier poolManagerOnly() ;

_poolManagerOnly

function _poolManagerOnly() internal view;

selfOnly

Only this address may call this function

modifier selfOnly() ;

_selfOnly

function _selfOnly() internal view;

onlyValidPools

Only pools with hooks set to this contract may call this function

modifier onlyValidPools(IHooks hooks) ;

_onlyValidPools

function _onlyValidPools(IHooks hooks) internal view;

getHookPermissions

function getHookPermissions() public pure virtual returns (Hooks.Permissions memory);

validateHookAddress

function validateHookAddress() public view virtual;

lockAcquired

function lockAcquired(bytes calldata data) external virtual poolManagerOnly returns (bytes memory);

beforeInitialize

function beforeInitialize(address, PoolKey calldata, uint160) external virtual returns (bytes4);

afterInitialize

function afterInitialize(address, PoolKey calldata, uint160, int24) external virtual returns (bytes4);

beforeAddLiquidity

function beforeAddLiquidity(
    address,
    PoolKey calldata,
    IPoolManager.ModifyLiquidityParams calldata,
    bytes calldata
) external virtual returns (bytes4);

beforeRemoveLiquidity

function beforeRemoveLiquidity(
    address,
    PoolKey calldata,
    IPoolManager.ModifyLiquidityParams calldata,
    bytes calldata
) external virtual returns (bytes4);

afterAddLiquidity

function afterAddLiquidity(
    address, /* sender **/
    PoolKey calldata, /* key **/
    IPoolManager.ModifyLiquidityParams calldata, /* params **/
    BalanceDelta, /* delta **/
    BalanceDelta, /* feeDelta **/
    bytes calldata /* hookData **/
) external virtual returns (bytes4, BalanceDelta);

afterRemoveLiquidity

function afterRemoveLiquidity(
    address,
    PoolKey calldata,
    IPoolManager.ModifyLiquidityParams calldata,
    BalanceDelta,
    BalanceDelta,
    bytes calldata
) external virtual returns (bytes4, BalanceDelta);

beforeSwap

function beforeSwap(
    address,
    PoolKey calldata,
    IPoolManager.SwapParams calldata,
    bytes calldata
) external virtual returns (bytes4, BeforeSwapDelta, uint24);

afterSwap

function afterSwap(
    address,
    PoolKey calldata,
    IPoolManager.SwapParams calldata,
    BalanceDelta,
    bytes calldata
) external virtual returns (bytes4, int128);

beforeDonate

function beforeDonate(
    address,
    PoolKey calldata,
    uint256,
    uint256,
    bytes calldata
) external virtual returns (bytes4);

afterDonate

function afterDonate(
    address,
    PoolKey calldata,
    uint256,
    uint256,
    bytes calldata
) external virtual returns (bytes4);

Errors

NotPoolManager

error NotPoolManager();

NotSelf

error NotSelf();

InvalidPool

error InvalidPool();

LockFailure

error LockFailure();

HookNotImplemented

error HookNotImplemented();