HookrKernelRouterV3

Deployed at 0xf0E528c39f33F565876cbaa7e0DFaCa38Df966E9, compiled from src/HookrKernelRouterV3.sol at source commit 8db7fc940938f811f508ba9cb0c8f2d3f24c9a25. Its source is verified on the explorer; see Verification. ABI: /api/v2-abi/HookrKernelRouterV3.

Implements: IUnlockCallback, IHookrKernelIntegrationV1, IHookrKernelRouterV2

The trusted router. Settles swaps against a frozen stack and carries an authenticated payer and recipient

Being the pool's registered router is what makes the pot leg work: the accounting kernel decodes hookData only from the pool's limits.trustedRouter or limits.trustedQuoter, at its registered runtime code hash.

Identity

Two pure getters every contract in the graph carries, so an integrator can confirm what it is holding without a bytecode comparison.

function contractName() external pure returns (string memory);   // "HookrKernelRouterV3"
function contractVersion() external pure returns (string memory); // "3.0.0"

Constants

Integration Identity

The registry round-trips a registration through these three getters and reverts IntegrationMetadataMismatch if the values it was handed disagree with what the implementation answers, so a router cannot be registered under a family or version it does not serve.

function integrationKind() external pure returns (bytes32);      // ROUTER_INTEGRATION_KIND
function integrationFamilyId() external pure returns (bytes32);  // KERNEL_FAMILY_ID
function integrationVersion() external pure returns (uint32);    // 3

HookrMarketCoordinatorInitialBuyLibV4 requires integration version 3 of the pool's registered router before it will run a creator buy through it.

State Variables

Functions

constructor

Reverts InvalidWiring unless the registry's PoolManager matches, the registry's coordinator() already equals this argument, and the coordinator's own poolManager() and stackRegistry() round-trip to the same addresses. Deploy it after setCoordinatorOnce.

constructor(IPoolManager poolManager_, IHookrStackRegistryV1 stackRegistry_, address coordinator_);

exactInput

Swaps up to a maximum input. Native input requires msg.value == amountIn and refunds the remainder; ERC-20 input requires msg.value == 0 and an allowance to this router. A price limit may cause a partial fill, and the minimum-output bound still applies.

function exactInput(ExactInputParams calldata params, bytes calldata moduleData)
    external
    payable
    returns (uint256 amountOut);

Parameters

Returns

Set sqrtPriceLimitX96 to MIN_SQRT_PRICE_LIMIT for zeroForOne or MAX_SQRT_PRICE_LIMIT otherwise on any pool with input cuts, or the swap reverts PartialFillUnsupportedWithInputCuts (the hook's error, bubbled up through the router).

exactOutput

Swaps for a fixed output. Native input requires msg.value == amountInMaximum and refunds the remainder.

function exactOutput(ExactOutputParams calldata params, bytes calldata moduleData)
    external
    payable
    returns (uint256 amountIn);

Returns

exactInputInitialBuy

The coordinator's same-transaction creator buy. Callable only by the coordinator, and only while the coordinator's runtime code hash still matches the one pinned at construction.

function exactInputInitialBuy(IHookrKernelRouterV2.InitialBuyParams calldata params, bytes calldata moduleData)
    external
    payable
    returns (uint256 quoteAmountIn, uint256 subjectAmountOut);

Parameters

Returns

The input currency is the pool's own quote, which may sort into currency1. The router sets zeroForOne from whether the quote is currency0, validates msg.value against the quote currency, and pulls an ERC-20 quote from the creator through the same settle path the generic exact-input lane uses. The creator approves the router for the quote token before launching.

requireFullInput stays true: the buy must consume its whole input or revert.

integrationKind, integrationFamilyId, integrationVersion

The identity triple the stack registry round-trips against the values passed to registerIntegration. A mismatch reverts IntegrationMetadataMismatch at registration. integrationVersion() returns 3, so the registration must pass 3 and HookrMarketCoordinatorInitialBuyLibV4 requires exactly that value before it will run a creator buy.

function integrationKind() external pure returns (bytes32);
function integrationFamilyId() external pure returns (bytes32);
function integrationVersion() external pure returns (uint32);

unlockCallback

PoolManager unlock callback. Reverts NotPoolManager, CallbackNotActive, CallbackNotCompleted.

function unlockCallback(bytes calldata rawData) external returns (bytes memory);

Structs

ExactInputParams

struct ExactInputParams {
    PoolKey key;
    bool zeroForOne;
    uint128 amountIn;
    uint128 amountOutMinimum;
    uint160 sqrtPriceLimitX96;
    address recipient;
    uint256 deadline;
}

ExactOutputParams

struct ExactOutputParams {
    PoolKey key;
    bool zeroForOne;
    uint128 amountOut;
    uint128 amountInMaximum;
    uint160 sqrtPriceLimitX96;
    address recipient;
    uint256 deadline;
}

Events

SwapExecuted

Emitted after a swap settles and output is delivered

event SwapExecuted(
    PoolId indexed poolId,
    bytes32 indexed stackHash,
    address indexed payer,
    address recipient,
    address kernel,
    address currencyIn,
    address currencyOut,
    bool exactInput,
    uint256 amountIn,
    uint256 amountOut,
    bytes32 moduleDataHash
);

Errors

InvalidWiring, NotCoordinator(expected, actual), CoordinatorCodeHashMismatch(expected, actual), Reentrancy, NotPoolManager, CallbackNotActive, CallbackNotCompleted, DeadlineExpired(deadline, timestamp), InvalidStack, StackNotInitialized, UntrustedStackRouter(expected, actual), InvalidRecipient, InvalidAmount, InvalidSqrtPriceLimit, ModuleDataTooLarge, InvalidNativeValue(expected, received), TooLittleReceived(minimum, received), TooMuchRequested(maximum, requested), PartialFill(expected, actual), UnexpectedDelta, TransferFailed, BalanceQueryFailed, InputDebitMismatch(expected, debited), SettlementMismatch(expected, settled), OutputCustodyMismatch(expected, received), OutputDeliveryMismatch(expected, received), RetainedBalance(currency, expected, actual), UnexpectedNativeSender.

Delivery Guarantees

Output is taken into the router first and delivered after the PoolManager relocks, which keeps a recipient callback outside the unlock. ERC-20 paths compare router and recipient balance deltas; native paths require a successful transfer and no retained router balance. Any mismatch reverts rather than settling short.