HookrNativeMechanicsCoordinatorLibV2

Deployed at 0xafC0a7656DF8B1aA5A173d04612a9661C4b9c7E2, compiled from src/libraries/HookrNativeMechanicsCoordinatorLibV2.sol at source commit 8db7fc940938f811f508ba9cb0c8f2d3f24c9a25. Its source is verified on the explorer; see Verification.

Coordinator-side admission and fee routing for the native mechanics module

A linked library, executed by DELEGATECALL, so its storage writes and its transfers happen in the coordinator's context.

Constants

Both version bounds are 2, so only HookrNativeMechanicsBlockV2 admits through this library. A module at any other version fails closed.

Functions

validateOrigin

Resolves the one canonical native module in the selections and proves every admission fact. Returns zero for both values when no native module is selected, which is how the coordinator detects a stack that would have no rules.

function validateOrigin(
    IHookrNativeMechanicsCatalogReadV1 registry,
    uint8 origin,
    uint24 baseLpFeePips,
    HookrModuleTypesV1.ModuleSelection[] calldata selections,
    address treasuryReader,
    address creator
) public view returns (address module, bytes32 codeHash);

Parameters

Returns

Every external read here, except the coordinator's own treasuryBeneficiary(), is a gas-bounded staticcall that requires a full 32-byte return word. A target that reverts, runs long, or returns a short word fails admission rather than being treated as absent.

validateAndRecordMarket

Runs validateOrigin and records the module binding for the pool atomically.

function validateAndRecordMarket(
    IHookrNativeMechanicsCatalogReadV1 registry,
    uint8 origin,
    uint24 baseLpFeePips,
    HookrModuleTypesV1.ModuleSelection[] calldata selections,
    bytes32 poolId,
    address treasuryReader,
    address creator
) public returns (address module);

Returns

recordMarket

Writes the module and its code hash into the pool's guard-accounting record. Reverts InvalidGuardAccounting if a record already exists for that pool, and InvalidNativeMechanicsModule when exactly one of the module address and its code hash is zero.

function recordMarket(bytes32 poolId, address module, bytes32 moduleCodeHash) public;

guardLpEarned

Reads the module's cumulative guard-window quote earnings, but only from the exact implementation recorded at market creation and only while its runtime code hash is unchanged. Reverts InvalidNativeMechanicsModule on drift.

function guardLpEarned(address module, bytes32 expectedCodeHash, bytes32 poolId)
    public
    view
    returns (uint256 earned);

guardAccounting

Per-pool guard-window view for interfaces: the module recorded for the pool and its cumulative guard-window earnings. Nothing is withheld and nothing is pending, so there is nothing else to report.

function guardAccounting(bytes32 poolId) public view returns (address module, uint256 cumulativeEarned);

Returns

routeFoundingPositionFees

Sends both collected currencies to lpFeeRecipient and emits LpFeesCollected. Executed by DELEGATECALL, so the transfers originate from the coordinator.

function routeFoundingPositionFees(FeeRouteInput memory input) public {
    if (input.amount0 != 0) _refund(input.currency0, input.lpFeeRecipient, input.amount0);
    if (input.amount1 != 0) _refund(input.currency1, input.lpFeeRecipient, input.amount1);
    emit LpFeesCollected(input.poolId, input.lpFeeRecipient, input.amount0, input.amount1);
}

That is the whole body. There is no withholding branch and no treasury read.

ERC-20 transfers inside _refund are balance-checked on both sides and revert TaxedTransfer if either party's balance moves by anything other than the exact amount.

Structs

FeeRouteInput

struct FeeRouteInput {
    bytes32 poolId;
    address currency0;
    address currency1;
    address lpFeeRecipient;
    uint256 amount0;
    uint256 amount1;
}

GuardAccounting

struct GuardAccounting {
    address module;
    bytes32 moduleCodeHash;
}

Events

LpFeesCollected(bytes32 indexed poolId, address indexed recipient, uint256 amount0, uint256 amount1); the library declares poolId as bytes32, the coordinator as PoolId, and the topic is the same.

Errors

InvalidNativeMechanicsModule, ProtocolShareTierMismatch(expected, actual), GuardRequiresLockedFoundingPosition, InvalidGuardAccounting, TransferFailed, TaxedTransfer, NativeTransferFailed.