{ "$schema": "https://hookforge.pages.dev/schema/hook-manifest.json", "slug": "depeg-shield", "name": "DepegShield", "contract": "DepegShieldHook", "version": "1.0.0", "family": "Risk", "summary": "Makes leaving a peg expensive and returning to it cheap, in proportion to how far the pool has already strayed.", "description": "A pegged pool fails in a specific way. Something spooks the market, the first sellers cross, the price slips, and the slip is itself the signal that brings the next sellers. Liquidity providers are filled the whole way down at a fee that was set for a pool sitting at par. By the time anyone reacts, the pool is one-sided and the providers own the asset that broke. This hook makes the fee a function of two things: how far the pool is from the peg, and which way the swap pushes it. A swap that widens the gap pays `baseFee` plus a surcharge that grows with the existing deviation. A swap that closes the gap pays less than `baseFee`, down to a floor, with the discount growing the same way. The result is a spread that opens as the pool strays and pays anyone willing to push it back. widening: fee = baseFee + maxSurcharge * deviation / (deviation + halfDeviation) restoring: fee = baseFee - (baseFee - minFee) * deviation / (deviation + halfDeviation) Both are LP fees, so the surcharge is paid to liquidity and the discount is given up by liquidity. That is the right trade for a provider in a pegged pool: paying for the flow that repairs the pool is cheaper than being filled on the way out. The peg is a tick, not an oracle. `pegTick = 0` is a one-to-one pool; a pair whose par is not one-to-one sets the tick that corresponds to par. Since it is fixed at initialization, there is nothing to manipulate and no feed to go stale, and a pool whose peg genuinely re-bases has to be re-created, which for a pegged pair is the honest outcome. Deviation is measured in ticks. One tick is one basis point to within rounding, so `halfDeviationTicks = 50` means half the surcharge applies once the pool is fifty basis points off par. Prior art: stable-swap curves flatten the price impact near par, and dynamic-fee hooks keyed on volatility exist. Neither is directional. A curve treats a swap toward the peg and a swap away from it identically, and a volatility fee charges the repairing flow exactly as much as the flow that broke the pool. Charging asymmetrically by direction of travel is what is new here.", "priorArt": "Stable-swap curves flatten price impact near par, and dynamic-fee hooks keyed on volatility exist. Neither is directional: a curve prices a swap toward the peg and one away from it identically, and a volatility fee charges the repairing flow exactly as much as the flow that broke the pool. Charging asymmetrically by direction of travel is what is new.", "limitation": "The peg is fixed at initialization, so a pair whose par genuinely re-bases has to be re-created. For a pegged pair that is the honest outcome, but it does mean this is the wrong hook for a drifting reference such as a yield-bearing wrapper.", "tags": [ "risk", "stablecoin", "dynamic-fee", "oracle-free" ], "recommendedChains": [ "base", "arbitrum", "unichain", "robinhood", "ethereum", "optimism", "polygon", "bnb" ], "source": "contracts/src/hooks/DepegShieldHook.sol", "docs": "https://hookforge.pages.dev/hooks/depeg-shield", "repo": "https://github.com/nirholas/depeg-shield", "site": "https://depeg-shield.pages.dev", "permissions": { "afterRemoveLiquidityReturnsDelta": false, "afterAddLiquidityReturnsDelta": false, "afterSwapReturnsDelta": false, "beforeSwapReturnsDelta": false, "afterDonate": false, "beforeDonate": false, "afterSwap": false, "beforeSwap": true, "afterRemoveLiquidity": false, "beforeRemoveLiquidity": false, "afterAddLiquidity": false, "beforeAddLiquidity": false, "afterInitialize": true, "beforeInitialize": false }, "permissionsSource": "address", "properties": { "dynamicFee": true, "upgradeable": false, "requiresCustomSwapData": false, "vanillaSwap": true, "swapAccess": "none" }, "configure": { "signature": "configure((address,address,uint24,int24,address),(int24,uint24,uint24,uint24,uint24))", "fields": [ { "name": "pegTick", "type": "int24" }, { "name": "baseFee", "type": "uint24" }, { "name": "minFee", "type": "uint24" }, { "name": "maxSurcharge", "type": "uint24" }, { "name": "halfDeviationTicks", "type": "uint24" } ] }, "errors": [ { "signature": "FeeTooLarge(uint24)", "notice": "A fee was configured above the protocol maximum of 100%." }, { "signature": "HookNotImplemented()", "notice": "The hook function is not implemented." }, { "signature": "InvalidConfig()", "notice": "`halfDeviationTicks` was zero, or `minFee` exceeded `baseFee`." }, { "signature": "InvalidPool()", "notice": "The pool is not configured to use this hook." }, { "signature": "NotDynamicFee()", "notice": "The hook was attempted to be initialized with a non-dynamic fee." }, { "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": "SurchargeTooLarge()", "notice": "`baseFee + maxSurcharge` must leave room under the 100% protocol maximum." } ], "deployments": [ { "chain": "unichain", "chainId": 130, "address": "0x6536608422113CFF4cbDb9c413E447EEd1fF1080", "status": "deterministic" }, { "chain": "robinhood", "chainId": 4663, "address": "0x6D7B49F497e6Dec999147dF461038AE312609080", "status": "deterministic" }, { "chain": "base", "chainId": 8453, "address": "0xFe88b1eECB9AeFF393f4E7a7fFBB1f80392D9080", "status": "deterministic" }, { "chain": "arbitrum", "chainId": 42161, "address": "0xb888b2e1886d4C703c53C2a1650ced1262bCd080", "status": "deterministic" } ], "abi": [ { "type": "constructor", "inputs": [ { "name": "_poolManager", "type": "address", "internalType": "contract IPoolManager" } ], "stateMutability": "nonpayable" }, { "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": "configOf", "inputs": [ { "name": "", "type": "bytes32", "internalType": "PoolId" } ], "outputs": [ { "name": "pegTick", "type": "int24", "internalType": "int24" }, { "name": "baseFee", "type": "uint24", "internalType": "uint24" }, { "name": "minFee", "type": "uint24", "internalType": "uint24" }, { "name": "maxSurcharge", "type": "uint24", "internalType": "uint24" }, { "name": "halfDeviationTicks", "type": "uint24", "internalType": "uint24" } ], "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 DepegShieldHook.Config", "components": [ { "name": "pegTick", "type": "int24", "internalType": "int24" }, { "name": "baseFee", "type": "uint24", "internalType": "uint24" }, { "name": "minFee", "type": "uint24", "internalType": "uint24" }, { "name": "maxSurcharge", "type": "uint24", "internalType": "uint24" }, { "name": "halfDeviationTicks", "type": "uint24", "internalType": "uint24" } ] } ], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "getHookPermissions", "inputs": [], "outputs": [ { "name": "permissions", "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": "previewFee", "inputs": [ { "name": "cfg", "type": "tuple", "internalType": "struct DepegShieldHook.Config", "components": [ { "name": "pegTick", "type": "int24", "internalType": "int24" }, { "name": "baseFee", "type": "uint24", "internalType": "uint24" }, { "name": "minFee", "type": "uint24", "internalType": "uint24" }, { "name": "maxSurcharge", "type": "uint24", "internalType": "uint24" }, { "name": "halfDeviationTicks", "type": "uint24", "internalType": "uint24" } ] }, { "name": "tick", "type": "int24", "internalType": "int24" }, { "name": "zeroForOne", "type": "bool", "internalType": "bool" } ], "outputs": [ { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "deviationTicks", "type": "uint256", "internalType": "uint256" }, { "name": "restoring", "type": "bool", "internalType": "bool" } ], "stateMutability": "pure" }, { "type": "function", "name": "quoteFee", "inputs": [ { "name": "id", "type": "bytes32", "internalType": "PoolId" }, { "name": "zeroForOne", "type": "bool", "internalType": "bool" } ], "outputs": [ { "name": "fee", "type": "uint24", "internalType": "uint24" }, { "name": "deviationTicks", "type": "uint256", "internalType": "uint256" }, { "name": "restoring", "type": "bool", "internalType": "bool" } ], "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": "event", "name": "DeviationPriced", "inputs": [ { "name": "id", "type": "bytes32", "indexed": true, "internalType": "PoolId" }, { "name": "deviationTicks", "type": "uint256", "indexed": false, "internalType": "uint256" }, { "name": "restoring", "type": "bool", "indexed": false, "internalType": "bool" }, { "name": "fee", "type": "uint24", "indexed": false, "internalType": "uint24" } ], "anonymous": false }, { "type": "event", "name": "PoolConfigured", "inputs": [ { "name": "id", "type": "bytes32", "indexed": true, "internalType": "PoolId" }, { "name": "pegTick", "type": "int24", "indexed": false, "internalType": "int24" }, { "name": "baseFee", "type": "uint24", "indexed": false, "internalType": "uint24" }, { "name": "minFee", "type": "uint24", "indexed": false, "internalType": "uint24" }, { "name": "maxSurcharge", "type": "uint24", "indexed": false, "internalType": "uint24" } ], "anonymous": false }, { "type": "error", "name": "FeeTooLarge", "inputs": [ { "name": "fee", "type": "uint24", "internalType": "uint24" } ] }, { "type": "error", "name": "HookNotImplemented", "inputs": [] }, { "type": "error", "name": "InvalidConfig", "inputs": [] }, { "type": "error", "name": "InvalidPool", "inputs": [] }, { "type": "error", "name": "NotDynamicFee", "inputs": [] }, { "type": "error", "name": "NotPoolManager", "inputs": [] }, { "type": "error", "name": "PoolAlreadyInitialized", "inputs": [] }, { "type": "error", "name": "PoolNotConfigured", "inputs": [] }, { "type": "error", "name": "SurchargeTooLarge", "inputs": [] } ] }