{ "$schema": "https://hookforge.pages.dev/schema/hook-manifest.json", "slug": "liquidity-floor", "name": "LiquidityFloor", "contract": "LiquidityFloorHook", "version": "1.0.0", "family": "Liquidity provider economics", "summary": "A liquidity commitment enforced per position: a fraction of what you add cannot leave until the pool's unlock date, and every provider is held to that fraction of their own stake rather than to a shared pool total.", "description": "A new pool has a bootstrapping problem that is really a credibility problem. Swappers cannot tell the difference between liquidity that intends to stay and liquidity that will leave the moment the pool is quoted by an aggregator, and the second kind is indistinguishable from the first right up until it is gone. The published answers lock whole positions for a term. That works and it is also badly mispriced: a provider who would happily commit a third of their capital for six months has to choose between committing all of it and committing none. Term locks therefore select for the providers least sensitive to the lock, which is not the same set as the providers most useful to the pool. This hook takes the commitment as a *fraction*. Configure `floorBps` and `unlockTimestamp`, and thereafter each position may freely withdraw down to `floorBps` of everything it has ever added, with the remainder released at the unlock. Adding more liquidity raises your own floor proportionally, so topping up is never a trap: you keep the same ratio of free to committed capital that you signed up for. The design is deliberately race-free, which is the property that distinguishes it from a pool-wide minimum. A floor expressed as \"total pool liquidity must stay above X\" is a bank run waiting to happen: it is satisfiable by whoever withdraws first and binding only on whoever is last, so rational providers race for the exit precisely when the pool most needs them. Holding each position to its own commitment removes the race entirely. Nothing another provider does can change what you are allowed to withdraw. The hook takes no fee, holds no funds and has no privileged role. It cannot stop a provider from ceasing to quote, only from removing committed liquidity, and it does not restrict swaps at all. Position identity is the v4 position key: the address that called `modifyLiquidity` on the `PoolManager` (in practice a position manager or a router), the tick range, and the caller's salt. Two providers sharing one position manager therefore share a commitment only if they also share a salt, which position managers do not do. Prior art: `LiquidityLock`, `Timelock Addition` and `LockingLiquidity` all lock positions wholesale for a term. Fractional, per-position, top-up-safe commitments are the contribution here.", "priorArt": "LiquidityLock, Timelock Addition and LockingLiquidity all lock positions wholesale for a term. Fractional, per-position, top-up-safe commitments are the contribution here, along with the observation that a pool-wide minimum is a bank run rather than a floor.", "limitation": "The commitment binds the v4 position key, which is the address that called modifyLiquidity. A provider who routes through a position manager that pools many users under one key would share a commitment with them; every mainstream position manager gives each position its own key, but a custom router need not.", "tags": [ "lp-economics", "commitment", "launch", "rug-resistance" ], "recommendedChains": [ "base", "arbitrum", "unichain", "robinhood", "ethereum", "optimism", "polygon", "bnb" ], "source": "contracts/src/hooks/LiquidityFloorHook.sol", "docs": "https://hookforge.pages.dev/hooks/liquidity-floor", "repo": "https://github.com/nirholas/liquidity-floor", "site": "https://liquidity-floor.pages.dev", "permissions": { "afterRemoveLiquidityReturnsDelta": false, "afterAddLiquidityReturnsDelta": false, "afterSwapReturnsDelta": false, "beforeSwapReturnsDelta": false, "afterDonate": false, "beforeDonate": false, "afterSwap": false, "beforeSwap": false, "afterRemoveLiquidity": false, "beforeRemoveLiquidity": true, "afterAddLiquidity": true, "beforeAddLiquidity": false, "afterInitialize": true, "beforeInitialize": false }, "permissionsSource": "address", "properties": { "dynamicFee": false, "upgradeable": false, "requiresCustomSwapData": false, "vanillaSwap": true, "swapAccess": "none" }, "configure": { "signature": "configure((address,address,uint24,int24,address),(uint16,uint64))", "fields": [ { "name": "floorBps", "type": "uint16" }, { "name": "unlockTimestamp", "type": "uint64" } ] }, "errors": [ { "signature": "CommitmentBreached(uint256,uint256)", "notice": "The withdrawal would take the position below its commitment." }, { "signature": "HookNotImplemented()", "notice": "The hook function is not implemented." }, { "signature": "InvalidFloor()", "notice": "`floorBps` was zero (no commitment) or above 100%." }, { "signature": "InvalidPool()", "notice": "The pool is not configured to use this hook." }, { "signature": "PoolAlreadyInitialized()", "notice": "The pool already exists, so its configuration is final." }, { "signature": "PoolNotConfigured()", "notice": "The pool was initialized without a configuration for this hook." }, { "signature": "UnlockInThePast()", "notice": "The unlock must be in the future at configuration time, or the commitment means nothing." } ], "deployments": [ { "chain": "unichain", "chainId": 130, "address": "0xFeCAf8bb3DD7fBE0Df1b6eFa0E865ef598535600", "status": "deterministic" }, { "chain": "robinhood", "chainId": 4663, "address": "0x3041fD311d0f39428655f45ce4501DEC7BfAD600", "status": "deterministic" }, { "chain": "base", "chainId": 8453, "address": "0x375ae2136a29aaA49E5f17c2Fc2A6A4832385600", "status": "deterministic" }, { "chain": "arbitrum", "chainId": 42161, "address": "0x1b142F790e2FfEb875a36FAED37Bbf8cE1Cf9600", "status": "deterministic" } ], "abi": [ { "type": "constructor", "inputs": [ { "name": "_poolManager", "type": "address", "internalType": "contract IPoolManager" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "addedLiquidity", "inputs": [ { "name": "", "type": "bytes32", "internalType": "PoolId" }, { "name": "", "type": "bytes32", "internalType": "bytes32" } ], "outputs": [ { "name": "", "type": "uint256", "internalType": "uint256" } ], "stateMutability": "view" }, { "type": "function", "name": "afterAddLiquidity", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct ModifyLiquidityParams", "components": [ { "name": "tickLower", "type": "int24", "internalType": "int24" }, { "name": "tickUpper", "type": "int24", "internalType": "int24" }, { "name": "liquidityDelta", "type": "int256", "internalType": "int256" }, { "name": "salt", "type": "bytes32", "internalType": "bytes32" } ] }, { "name": "delta0", "type": "int256", "internalType": "BalanceDelta" }, { "name": "delta1", "type": "int256", "internalType": "BalanceDelta" }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" }, { "name": "", "type": "int256", "internalType": "BalanceDelta" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "afterDonate", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "amount0", "type": "uint256", "internalType": "uint256" }, { "name": "amount1", "type": "uint256", "internalType": "uint256" }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "afterInitialize", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "sqrtPriceX96", "type": "uint160", "internalType": "uint160" }, { "name": "tick", "type": "int24", "internalType": "int24" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "afterRemoveLiquidity", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct ModifyLiquidityParams", "components": [ { "name": "tickLower", "type": "int24", "internalType": "int24" }, { "name": "tickUpper", "type": "int24", "internalType": "int24" }, { "name": "liquidityDelta", "type": "int256", "internalType": "int256" }, { "name": "salt", "type": "bytes32", "internalType": "bytes32" } ] }, { "name": "delta0", "type": "int256", "internalType": "BalanceDelta" }, { "name": "delta1", "type": "int256", "internalType": "BalanceDelta" }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" }, { "name": "", "type": "int256", "internalType": "BalanceDelta" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "afterSwap", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct SwapParams", "components": [ { "name": "zeroForOne", "type": "bool", "internalType": "bool" }, { "name": "amountSpecified", "type": "int256", "internalType": "int256" }, { "name": "sqrtPriceLimitX96", "type": "uint160", "internalType": "uint160" } ] }, { "name": "delta", "type": "int256", "internalType": "BalanceDelta" }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" }, { "name": "", "type": "int128", "internalType": "int128" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "beforeAddLiquidity", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct ModifyLiquidityParams", "components": [ { "name": "tickLower", "type": "int24", "internalType": "int24" }, { "name": "tickUpper", "type": "int24", "internalType": "int24" }, { "name": "liquidityDelta", "type": "int256", "internalType": "int256" }, { "name": "salt", "type": "bytes32", "internalType": "bytes32" } ] }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "beforeDonate", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "amount0", "type": "uint256", "internalType": "uint256" }, { "name": "amount1", "type": "uint256", "internalType": "uint256" }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "beforeInitialize", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "sqrtPriceX96", "type": "uint160", "internalType": "uint160" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "beforeRemoveLiquidity", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct ModifyLiquidityParams", "components": [ { "name": "tickLower", "type": "int24", "internalType": "int24" }, { "name": "tickUpper", "type": "int24", "internalType": "int24" }, { "name": "liquidityDelta", "type": "int256", "internalType": "int256" }, { "name": "salt", "type": "bytes32", "internalType": "bytes32" } ] }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "beforeSwap", "inputs": [ { "name": "sender", "type": "address", "internalType": "address" }, { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "params", "type": "tuple", "internalType": "struct SwapParams", "components": [ { "name": "zeroForOne", "type": "bool", "internalType": "bool" }, { "name": "amountSpecified", "type": "int256", "internalType": "int256" }, { "name": "sqrtPriceLimitX96", "type": "uint160", "internalType": "uint160" } ] }, { "name": "hookData", "type": "bytes", "internalType": "bytes" } ], "outputs": [ { "name": "", "type": "bytes4", "internalType": "bytes4" }, { "name": "", "type": "int256", "internalType": "BeforeSwapDelta" }, { "name": "", "type": "uint24", "internalType": "uint24" } ], "stateMutability": "nonpayable" }, { "type": "function", "name": "committedLiquidity", "inputs": [ { "name": "id", "type": "bytes32", "internalType": "PoolId" }, { "name": "position", "type": "bytes32", "internalType": "bytes32" } ], "outputs": [ { "name": "", "type": "uint256", "internalType": "uint256" } ], "stateMutability": "view" }, { "type": "function", "name": "configOf", "inputs": [ { "name": "", "type": "bytes32", "internalType": "PoolId" } ], "outputs": [ { "name": "floorBps", "type": "uint16", "internalType": "uint16" }, { "name": "unlockTimestamp", "type": "uint64", "internalType": "uint64" } ], "stateMutability": "view" }, { "type": "function", "name": "configure", "inputs": [ { "name": "key", "type": "tuple", "internalType": "struct PoolKey", "components": [ { "name": "currency0", "type": "address", "internalType": "Currency" }, { "name": "currency1", "type": "address", "internalType": "Currency" }, { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "tickSpacing", "type": "int24", "internalType": "int24" }, { "name": "hooks", "type": "address", "internalType": "contract IHooks" } ] }, { "name": "cfg", "type": "tuple", "internalType": "struct LiquidityFloorHook.Config", "components": [ { "name": "floorBps", "type": "uint16", "internalType": "uint16" }, { "name": "unlockTimestamp", "type": "uint64", "internalType": "uint64" } ] } ], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "getHookPermissions", "inputs": [], "outputs": [ { "name": "", "type": "tuple", "internalType": "struct Hooks.Permissions", "components": [ { "name": "beforeInitialize", "type": "bool", "internalType": "bool" }, { "name": "afterInitialize", "type": "bool", "internalType": "bool" }, { "name": "beforeAddLiquidity", "type": "bool", "internalType": "bool" }, { "name": "afterAddLiquidity", "type": "bool", "internalType": "bool" }, { "name": "beforeRemoveLiquidity", "type": "bool", "internalType": "bool" }, { "name": "afterRemoveLiquidity", "type": "bool", "internalType": "bool" }, { "name": "beforeSwap", "type": "bool", "internalType": "bool" }, { "name": "afterSwap", "type": "bool", "internalType": "bool" }, { "name": "beforeDonate", "type": "bool", "internalType": "bool" }, { "name": "afterDonate", "type": "bool", "internalType": "bool" }, { "name": "beforeSwapReturnDelta", "type": "bool", "internalType": "bool" }, { "name": "afterSwapReturnDelta", "type": "bool", "internalType": "bool" }, { "name": "afterAddLiquidityReturnDelta", "type": "bool", "internalType": "bool" }, { "name": "afterRemoveLiquidityReturnDelta", "type": "bool", "internalType": "bool" } ] } ], "stateMutability": "pure" }, { "type": "function", "name": "hookName", "inputs": [], "outputs": [ { "name": "", "type": "string", "internalType": "string" } ], "stateMutability": "pure" }, { "type": "function", "name": "hookTags", "inputs": [], "outputs": [ { "name": "tags", "type": "string[]", "internalType": "string[]" } ], "stateMutability": "pure" }, { "type": "function", "name": "hookVersion", "inputs": [], "outputs": [ { "name": "", "type": "string", "internalType": "string" } ], "stateMutability": "view" }, { "type": "function", "name": "isPoolInitialized", "inputs": [ { "name": "id", "type": "bytes32", "internalType": "PoolId" } ], "outputs": [ { "name": "", "type": "bool", "internalType": "bool" } ], "stateMutability": "view" }, { "type": "function", "name": "poolManager", "inputs": [], "outputs": [ { "name": "", "type": "address", "internalType": "contract IPoolManager" } ], "stateMutability": "view" }, { "type": "function", "name": "positionKey", "inputs": [ { "name": "owner", "type": "address", "internalType": "address" }, { "name": "tickLower", "type": "int24", "internalType": "int24" }, { "name": "tickUpper", "type": "int24", "internalType": "int24" }, { "name": "salt", "type": "bytes32", "internalType": "bytes32" } ], "outputs": [ { "name": "", "type": "bytes32", "internalType": "bytes32" } ], "stateMutability": "pure" }, { "type": "function", "name": "removedLiquidity", "inputs": [ { "name": "", "type": "bytes32", "internalType": "PoolId" }, { "name": "", "type": "bytes32", "internalType": "bytes32" } ], "outputs": [ { "name": "", "type": "uint256", "internalType": "uint256" } ], "stateMutability": "view" }, { "type": "function", "name": "specURI", "inputs": [], "outputs": [ { "name": "", "type": "string", "internalType": "string" } ], "stateMutability": "pure" }, { "type": "function", "name": "supportsInterface", "inputs": [ { "name": "interfaceId", "type": "bytes4", "internalType": "bytes4" } ], "outputs": [ { "name": "", "type": "bool", "internalType": "bool" } ], "stateMutability": "view" }, { "type": "function", "name": "withdrawableLiquidity", "inputs": [ { "name": "id", "type": "bytes32", "internalType": "PoolId" }, { "name": "position", "type": "bytes32", "internalType": "bytes32" } ], "outputs": [ { "name": "", "type": "uint256", "internalType": "uint256" } ], "stateMutability": "view" }, { "type": "event", "name": "CommitmentIncreased", "inputs": [ { "name": "id", "type": "bytes32", "indexed": true, "internalType": "PoolId" }, { "name": "position", "type": "bytes32", "indexed": true, "internalType": "bytes32" }, { "name": "added", "type": "uint256", "indexed": false, "internalType": "uint256" }, { "name": "committed", "type": "uint256", "indexed": false, "internalType": "uint256" } ], "anonymous": false }, { "type": "event", "name": "PoolConfigured", "inputs": [ { "name": "id", "type": "bytes32", "indexed": true, "internalType": "PoolId" }, { "name": "floorBps", "type": "uint16", "indexed": false, "internalType": "uint16" }, { "name": "unlockTimestamp", "type": "uint64", "indexed": false, "internalType": "uint64" } ], "anonymous": false }, { "type": "error", "name": "CommitmentBreached", "inputs": [ { "name": "committed", "type": "uint256", "internalType": "uint256" }, { "name": "remaining", "type": "uint256", "internalType": "uint256" } ] }, { "type": "error", "name": "HookNotImplemented", "inputs": [] }, { "type": "error", "name": "InvalidFloor", "inputs": [] }, { "type": "error", "name": "InvalidPool", "inputs": [] }, { "type": "error", "name": "NotPoolManager", "inputs": [] }, { "type": "error", "name": "PoolAlreadyInitialized", "inputs": [] }, { "type": "error", "name": "PoolNotConfigured", "inputs": [] }, { "type": "error", "name": "UnlockInThePast", "inputs": [] } ] }