Documentation · Reference

Errors

Every custom error GENE contracts can raise, with its selector and the exact condition that throws it.

Selectors were produced by forge inspect at commit aca5fcd3bbc9ecb1026de58bea431d406d8ecfff (see Selectors). GeneLens defines no custom errors. Errors raised inside the PoolManager or inside OpenZeppelin ERC20 during a GENE call carry their own selectors.

#GeneHook errors

#NotPoolManager

error NotPoolManager(), selector 0xae18210a. Thrown when msg.sender is not the PoolManager in beforeSwap (GeneHook.sol:359), afterSwap (GeneHook.sol:372) or unlockCallback (GeneHook.sol:396).

#NotLauncher

error NotLauncher(), selector 0x9e6ff739. Thrown by launch() when msg.sender != launcher (GeneHook.sol:253).

#AlreadyLaunched

error AlreadyLaunched(), selector 0xcfa6d878. Thrown by launch() when launched is already true, so a second launch always reverts (GeneHook.sol:254).

#NotLaunched

error NotLaunched(), selector 0x8dda39df. Thrown by _requireLaunched() (GeneHook.sol:999-1001), which metabolize(), regenerate() and evolve() call first (GeneHook.sol:282, GeneHook.sol:297, GeneHook.sol:313).

#Forbidden

error Forbidden(), selector 0xee90c468. beforeInitialize, beforeAddLiquidity and beforeRemoveLiquidity always throw it (GeneHook.sol:332-352). The PoolManager calls them for every initialize or liquidity change on a pool naming this hook, except when the hook itself is the caller.

A caller sees it wrapped: v4's callHook reverts with WrappedError(address target, bytes4 selector, bytes reason, bytes details) (selector 0x90bfb865), where target is the hook, selector is the callback's selector, reason holds Forbidden() and details holds HookCallFailed() (selector 0xa9e35b2f) (v4 Hooks.sol:74, Hooks.sol:131-137, CustomRevert.sol:11, CustomRevert.sol:83-115).

#WrongPool

error WrongPool(), selector 0xd3c913ea. Thrown by beforeSwap when the key passed by the PoolManager differs from the canonical key in currency0, currency1, fee or tickSpacing (GeneHook.sol:360-363). afterSwap has no key check.

#UnexpectedCallback

error UnexpectedCallback(), selector 0xdab1e993. Thrown by unlockCallback when the transient ACTION_SLOT is zero or differs from the action decoded from the callback data (GeneHook.sol:397-403). The slot is set only by the hook's own _unlock (GeneHook.sol:409-418).

#HookAddressInvalid

error HookAddressInvalid(), selector 0xf0dd0d55. Thrown by the constructor when:

1. the low 14 bits of the hook address are not exactly REQUIRED_FLAGS (0x2AC0) (GeneHook.sol:226);
2. the top byte of the address is 0x91 (GeneHook.sol:228);
3. the PoolManager address has no code, or the launcher is address(0) (GeneHook.sol:229).

#GeneNotExpressed

error GeneNotExpressed(uint8 gene), selector 0x2abc0a56. Thrown with gene = 1 by metabolize() while METABOLISM is not EXPRESSED (GeneHook.sol:283), and with gene = 2 by regenerate() while REGENERATION is not EXPRESSED (GeneHook.sol:298). After launch the first metabolize() therefore needs METABOLISM to have been expressed by an earlier evolve().

#Cooldown

error Cooldown(uint256 readyAtBlock), selector 0xff658a1c. Thrown when the stored last block is non-zero and block.number < last + COOLDOWN_BLOCKS (COOLDOWN_BLOCKS); readyAtBlock is last + COOLDOWN_BLOCKS.

#InvariantBroken

error InvariantBroken(), selector 0xb2151907. Thrown when a liquidity operation returns a principal that the code does not allow:

A revert rolls back the whole call, including its harvest and its cooldown write (GeneHook.sol:284-286). An ETH placement requires GENE when the pool price is at or beyond the band's lower tick. Audit scope note: metabolize() reverting InvariantBroken while the price sits at or beyond the METABOLISM or churn bid band (see Security).

#GeneLens revert

positionAt(hook, i) reverts with the string "index" (Error(string)) when i >= positionCount(hook) (GeneLens.sol:93-94). GeneLens has no other revert of its own.

#GeneToken errors

GeneToken defines no custom errors. It raises the OpenZeppelin ERC-6093 errors below (declared in draft-IERC6093.sol). OZ is lib/v4-core/lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol.