@pickhooks/sdk 0.4.0 → 0.5.0

package/dist/abis/sticky3.js

@@ -0,0 +1,8 @@
+// Generated from out-sticky3 (src/sticky3: the coin with a mode, its factory, lens, drand beacon and the modes). Do not edit by hand: node scripts/gen-abis.mjs
+export const sticky3FactoryAbi = [{ "type": "function", "name": "FEE", "inputs": [], "outputs": [{ "name": "", "type": "uint24" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_ALLOCATION_BPS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_OUT_BPS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "NPM", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "ROUTER", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "V2", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "WBNB", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "coinCount", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "coins", "inputs": [{ "name": "", "type": "uint256" }], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "creatorBps", "inputs": [], "outputs": [{ "name": "", "type": "uint16" }], "stateMutability": "view" }, { "type": "function", "name": "custom", "inputs": [], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "deployer", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "isCoin", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "launch", "inputs": [{ "name": "a", "type": "tuple", "components": [{ "name": "name", "type": "string" }, { "name": "symbol", "type": "string" }, { "name": "metadata", "type": "string" }, { "name": "rows", "type": "uint256[]" }, { "name": "release", "type": "uint32" }, { "name": "salt", "type": "bytes32" }, { "name": "keepBps", "type": "uint16" }, { "name": "minCreatorBps", "type": "uint16" }, { "name": "switcher", "type": "address" }, { "name": "switchMask", "type": "uint8" }, { "name": "mode", "type": "address" }, { "name": "modeData", "type": "bytes" }] }], "outputs": [{ "name": "token", "type": "address" }], "stateMutability": "payable" }, { "type": "function", "name": "launchAt", "inputs": [{ "name": "creator", "type": "address" }, { "name": "a", "type": "tuple", "components": [{ "name": "name", "type": "string" }, { "name": "symbol", "type": "string" }, { "name": "metadata", "type": "string" }, { "name": "rows", "type": "uint256[]" }, { "name": "release", "type": "uint32" }, { "name": "salt", "type": "bytes32" }, { "name": "keepBps", "type": "uint16" }, { "name": "minCreatorBps", "type": "uint16" }, { "name": "switcher", "type": "address" }, { "name": "switchMask", "type": "uint8" }, { "name": "mode", "type": "address" }, { "name": "modeData", "type": "bytes" }] }, { "name": "tick", "type": "int24" }, { "name": "allocation", "type": "uint256" }], "outputs": [{ "name": "token", "type": "address" }], "stateMutability": "payable" }, { "type": "function", "name": "launchFor", "inputs": [{ "name": "creator", "type": "address" }, { "name": "a", "type": "tuple", "components": [{ "name": "name", "type": "string" }, { "name": "symbol", "type": "string" }, { "name": "metadata", "type": "string" }, { "name": "rows", "type": "uint256[]" }, { "name": "release", "type": "uint32" }, { "name": "salt", "type": "bytes32" }, { "name": "keepBps", "type": "uint16" }, { "name": "minCreatorBps", "type": "uint16" }, { "name": "switcher", "type": "address" }, { "name": "switchMask", "type": "uint8" }, { "name": "mode", "type": "address" }, { "name": "modeData", "type": "bytes" }] }], "outputs": [{ "name": "token", "type": "address" }], "stateMutability": "payable" }, { "type": "function", "name": "launchers", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "locker", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "modes", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "owner", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "platformWallet", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "seedBnb", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "setCustom", "inputs": [{ "name": "on", "type": "bool" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setLauncher", "inputs": [{ "name": "who", "type": "address" }, { "name": "on", "type": "bool" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setMode", "inputs": [{ "name": "m", "type": "address" }, { "name": "on", "type": "bool" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setOwner", "inputs": [{ "name": "o", "type": "address" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setPlatform", "inputs": [{ "name": "wallet", "type": "address" }, { "name": "creatorBps_", "type": "uint16" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setSeed", "inputs": [{ "name": "seedBnb_", "type": "uint256" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setStartPrice", "inputs": [{ "name": "sp0", "type": "uint160" }, { "name": "tl0", "type": "int24" }, { "name": "sp1", "type": "uint160" }, { "name": "tu1", "type": "int24" }, { "name": "startFdv_", "type": "uint256" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "setSwitcher", "inputs": [{ "name": "who", "type": "address" }, { "name": "on", "type": "bool" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "sqrtPrice0", "inputs": [], "outputs": [{ "name": "", "type": "uint160" }], "stateMutability": "view" }, { "type": "function", "name": "sqrtPrice1", "inputs": [], "outputs": [{ "name": "", "type": "uint160" }], "stateMutability": "view" }, { "type": "function", "name": "startFdv", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "switchers", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "tickLower0", "inputs": [], "outputs": [{ "name": "", "type": "int24" }], "stateMutability": "view" }, { "type": "function", "name": "tickUpper1", "inputs": [], "outputs": [{ "name": "", "type": "int24" }], "stateMutability": "view" }, { "type": "function", "name": "validator", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "event", "name": "Launched", "inputs": [{ "name": "token", "type": "address", "indexed": true }, { "name": "creator", "type": "address", "indexed": true }, { "name": "pool", "type": "address", "indexed": false }, { "name": "pair", "type": "address", "indexed": false }, { "name": "tokenId", "type": "uint256", "indexed": false }, { "name": "mask", "type": "uint64", "indexed": false }], "anonymous": false }, { "type": "event", "name": "LaunchedBy", "inputs": [{ "name": "token", "type": "address", "indexed": true }, { "name": "launcher", "type": "address", "indexed": true }, { "name": "switcher", "type": "address", "indexed": false }, { "name": "switchMask", "type": "uint8", "indexed": false }, { "name": "tick", "type": "int24", "indexed": false }, { "name": "allocation", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "LauncherSet", "inputs": [{ "name": "launcher", "type": "address", "indexed": true }, { "name": "on", "type": "bool", "indexed": false }], "anonymous": false }, { "type": "event", "name": "ModeLaunched", "inputs": [{ "name": "token", "type": "address", "indexed": true }, { "name": "mode", "type": "address", "indexed": true }, { "name": "gameBps", "type": "uint16", "indexed": false }, { "name": "data", "type": "bytes", "indexed": false }], "anonymous": false }, { "type": "event", "name": "ModeSet", "inputs": [{ "name": "mode", "type": "address", "indexed": true }, { "name": "on", "type": "bool", "indexed": false }], "anonymous": false }, { "type": "event", "name": "Script", "inputs": [{ "name": "token", "type": "address", "indexed": true }, { "name": "rows", "type": "uint256[]", "indexed": false }, { "name": "release", "type": "uint32", "indexed": false }], "anonymous": false }, { "type": "event", "name": "SwitcherSet", "inputs": [{ "name": "switcher", "type": "address", "indexed": true }, { "name": "on", "type": "bool", "indexed": false }], "anonymous": false }, { "type": "error", "name": "Bad", "inputs": [{ "name": "what", "type": "string" }] }, { "type": "error", "name": "InvalidTick", "inputs": [{ "name": "tick", "type": "int24" }] }, { "type": "error", "name": "NotLauncher", "inputs": [] }, { "type": "error", "name": "NotOwner", "inputs": [] }, { "type": "error", "name": "PoolPrice", "inputs": [] }];
+export const sticky3TokenAbi = [{ "type": "function", "name": "EXIT", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_HOLD", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_LAUNCH_HOLD", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MODE_GAS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "activate", "inputs": [{ "name": "pool_", "type": "address" }, { "name": "pool2_", "type": "address" }, { "name": "locker_", "type": "address" }, { "name": "curveSupply_", "type": "uint256" }, { "name": "alloc", "type": "address" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "active", "inputs": [], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "aged", "inputs": [{ "name": "who", "type": "address" }, { "name": "before", "type": "uint256" }, { "name": "skip", "type": "uint8" }], "outputs": [{ "name": "total", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "allowance", "inputs": [{ "name": "", "type": "address" }, { "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "approve", "inputs": [{ "name": "spender", "type": "address" }, { "name": "amount", "type": "uint256" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "balanceOf", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "check", "inputs": [{ "name": "kind", "type": "uint8" }, { "name": "from", "type": "address" }, { "name": "to", "type": "address" }, { "name": "amount", "type": "uint256" }], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "creator", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "curveSupply", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "custody", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "until", "type": "uint40" }, { "name": "since", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "decimals", "inputs": [], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "dev", "inputs": [], "outputs": [{ "name": "bought", "type": "uint128" }, { "name": "sold", "type": "uint128" }, { "name": "sniperSold", "type": "uint96" }, { "name": "at10", "type": "uint40" }, { "name": "at25", "type": "uint40" }, { "name": "at50", "type": "uint40" }, { "name": "at100", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "factory", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "gameBps", "inputs": [], "outputs": [{ "name": "", "type": "uint16" }], "stateMutability": "view" }, { "type": "function", "name": "gamePot", "inputs": [], "outputs": [{ "name": "", "type": "uint128" }], "stateMutability": "view" }, { "type": "function", "name": "heldOf", "inputs": [{ "name": "who", "type": "address" }], "outputs": [{ "name": "amount", "type": "uint256" }, { "name": "devAmount", "type": "uint256" }, { "name": "until", "type": "uint40" }, { "name": "since", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "lift", "inputs": [{ "name": "i", "type": "uint8" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "locker", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "lotCount", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "lotsRaw", "inputs": [{ "name": "a", "type": "address" }], "outputs": [{ "name": "ls", "type": "uint256[]" }], "stateMutability": "view" }, { "type": "function", "name": "metadata", "inputs": [], "outputs": [{ "name": "", "type": "string" }], "stateMutability": "view" }, { "type": "function", "name": "mode", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "name", "inputs": [], "outputs": [{ "name": "", "type": "string" }], "stateMutability": "view" }, { "type": "function", "name": "off", "inputs": [], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "play", "inputs": [{ "name": "data", "type": "bytes" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "poke", "inputs": [{ "name": "data", "type": "bytes" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "pool", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "pool2", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "pot", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "release", "inputs": [], "outputs": [{ "name": "", "type": "uint32" }], "stateMutability": "view" }, { "type": "function", "name": "releaseHeld", "inputs": [{ "name": "who", "type": "address" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "rowCount", "inputs": [], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "script", "inputs": [], "outputs": [{ "name": "rows", "type": "uint256[]" }, { "name": "release_", "type": "uint32" }, { "name": "off_", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "setSwitch", "inputs": [{ "name": "i", "type": "uint8" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "shadow", "inputs": [{ "name": "who", "type": "address" }], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "pure" }, { "type": "function", "name": "start", "inputs": [], "outputs": [{ "name": "", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "startBlock", "inputs": [], "outputs": [{ "name": "", "type": "uint64" }], "stateMutability": "view" }, { "type": "function", "name": "stats", "inputs": [], "outputs": [{ "name": "holders", "type": "uint32" }, { "name": "buys", "type": "uint32" }, { "name": "sells", "type": "uint32" }, { "name": "highAt", "type": "uint40" }, { "name": "lastBuy", "type": "uint40" }, { "name": "volume", "type": "uint128" }, { "name": "net", "type": "uint128" }, { "name": "peak", "type": "uint128" }, { "name": "high", "type": "uint128" }], "stateMutability": "view" }, { "type": "function", "name": "switchMask", "inputs": [], "outputs": [{ "name": "", "type": "uint8" }], "stateMutability": "view" }, { "type": "function", "name": "switcher", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "symbol", "inputs": [], "outputs": [{ "name": "", "type": "string" }], "stateMutability": "view" }, { "type": "function", "name": "totalSupply", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "transfer", "inputs": [{ "name": "to", "type": "address" }, { "name": "amount", "type": "uint256" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "transferFrom", "inputs": [{ "name": "from", "type": "address" }, { "name": "to", "type": "address" }, { "name": "amount", "type": "uint256" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "nonpayable" }, { "type": "event", "name": "Activated", "inputs": [{ "name": "pool", "type": "address", "indexed": false }, { "name": "pool2", "type": "address", "indexed": false }, { "name": "locker", "type": "address", "indexed": false }, { "name": "curveSupply", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "Approval", "inputs": [{ "name": "owner", "type": "address", "indexed": true }, { "name": "spender", "type": "address", "indexed": true }, { "name": "value", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "DevSold", "inputs": [{ "name": "pct", "type": "uint8", "indexed": true }, { "name": "sold", "type": "uint256", "indexed": false }, { "name": "bought", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "Held", "inputs": [{ "name": "who", "type": "address", "indexed": true }, { "name": "amount", "type": "uint256", "indexed": false }, { "name": "until", "type": "uint40", "indexed": false }], "anonymous": false }, { "type": "event", "name": "ModeSkipped", "inputs": [{ "name": "kind", "type": "uint8", "indexed": false }], "anonymous": false }, { "type": "event", "name": "RowLifted", "inputs": [{ "name": "row", "type": "uint8", "indexed": true }], "anonymous": false }, { "type": "event", "name": "Switched", "inputs": [{ "name": "row", "type": "uint8", "indexed": true }], "anonymous": false }, { "type": "event", "name": "Transfer", "inputs": [{ "name": "from", "type": "address", "indexed": true }, { "name": "to", "type": "address", "indexed": true }, { "name": "value", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "error", "name": "BadOrder", "inputs": [{ "name": "i", "type": "uint256" }] }, { "type": "error", "name": "Blocked", "inputs": [{ "name": "row", "type": "uint8" }] }, { "type": "error", "name": "Busy", "inputs": [] }, { "type": "error", "name": "LowGas", "inputs": [] }, { "type": "error", "name": "NoMode", "inputs": [] }, { "type": "error", "name": "Nope", "inputs": [] }, { "type": "error", "name": "NotCreator", "inputs": [] }, { "type": "error", "name": "NotFactory", "inputs": [] }, { "type": "error", "name": "NotSwitcher", "inputs": [] }];
+export const sticky3ValidatorAbi = [{ "type": "function", "name": "MAX_AGE", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_BLOCKS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_EVERY", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_HOLD_BLOCKS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_PERIOD", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MAX_SWITCH_ROWS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MIN_OPEN", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MIN_RELEASE", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "MIN_SELL_CAP", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "game", "inputs": [{ "name": "rows", "type": "uint256[]" }, { "name": "gameBps", "type": "uint16" }], "outputs": [], "stateMutability": "pure" }, { "type": "function", "name": "isTemplate", "inputs": [{ "name": "", "type": "uint256" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "function", "name": "switchRows", "inputs": [{ "name": "rows", "type": "uint256[]" }, { "name": "mask", "type": "uint8" }], "outputs": [], "stateMutability": "pure" }, { "type": "function", "name": "templates", "inputs": [], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "view" }, { "type": "function", "name": "validate", "inputs": [{ "name": "rows", "type": "uint256[]" }, { "name": "release", "type": "uint32" }, { "name": "custom", "type": "bool" }], "outputs": [], "stateMutability": "view" }, { "type": "error", "name": "Bad", "inputs": [{ "name": "what", "type": "string" }] }];
+export const sticky3LensAbi = [{ "type": "function", "name": "custodyOf", "inputs": [{ "name": "coin", "type": "address" }, { "name": "holder", "type": "address" }], "outputs": [{ "name": "amount", "type": "uint256" }, { "name": "devAmount", "type": "uint256" }, { "name": "until", "type": "uint40" }, { "name": "since", "type": "uint40" }, { "name": "at", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "devSold", "inputs": [{ "name": "coin", "type": "address" }], "outputs": [{ "name": "bps", "type": "uint256" }, { "name": "at10", "type": "uint40" }, { "name": "at25", "type": "uint40" }, { "name": "at50", "type": "uint40" }, { "name": "at100", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "game", "inputs": [{ "name": "coin", "type": "address" }], "outputs": [{ "name": "mode", "type": "address" }, { "name": "gameBps", "type": "uint16" }, { "name": "gamePot", "type": "uint256" }, { "name": "rowPot", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "lotsOf", "inputs": [{ "name": "coin", "type": "address" }, { "name": "holder", "type": "address" }], "outputs": [{ "name": "r", "type": "tuple", "components": [{ "name": "amount", "type": "uint256[]" }, { "name": "locked", "type": "uint256[]" }, { "name": "since", "type": "uint40[]" }, { "name": "flags", "type": "uint8[]" }, { "name": "open", "type": "bool[]" }] }], "stateMutability": "view" }, { "type": "function", "name": "sellable", "inputs": [{ "name": "coin", "type": "address" }, { "name": "holder", "type": "address" }], "outputs": [{ "name": "total", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "soldBps", "inputs": [{ "name": "coin", "type": "address" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }];
+export const drandBeaconAbi = [{ "type": "function", "name": "CHAIN_HASH", "inputs": [], "outputs": [{ "name": "", "type": "bytes32" }], "stateMutability": "view" }, { "type": "function", "name": "GENESIS", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "PERIOD", "inputs": [], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "view" }, { "type": "function", "name": "hashToPoint", "inputs": [{ "name": "round", "type": "uint64" }], "outputs": [{ "name": "", "type": "bytes" }], "stateMutability": "view" }, { "type": "function", "name": "randomness", "inputs": [{ "name": "", "type": "uint64" }], "outputs": [{ "name": "", "type": "bytes32" }], "stateMutability": "view" }, { "type": "function", "name": "roundAt", "inputs": [{ "name": "t", "type": "uint256" }], "outputs": [{ "name": "", "type": "uint64" }], "stateMutability": "pure" }, { "type": "function", "name": "submit", "inputs": [{ "name": "round", "type": "uint64" }, { "name": "sig", "type": "bytes" }], "outputs": [{ "name": "r", "type": "bytes32" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "timeOf", "inputs": [{ "name": "round", "type": "uint64" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "pure" }, { "type": "function", "name": "verify", "inputs": [{ "name": "round", "type": "uint64" }, { "name": "sig", "type": "bytes" }], "outputs": [{ "name": "", "type": "bool" }], "stateMutability": "view" }, { "type": "event", "name": "Beacon", "inputs": [{ "name": "round", "type": "uint64", "indexed": true }, { "name": "randomness", "type": "bytes32", "indexed": false }], "anonymous": false }, { "type": "error", "name": "BadSignature", "inputs": [] }, { "type": "error", "name": "Precompile", "inputs": [] }];
+export const comboModeAbi = [{ "type": "function", "name": "creatorOf", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "factory", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "games", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "combo", "type": "uint32" }, { "name": "best", "type": "uint32" }, { "name": "hits", "type": "uint32" }, { "name": "bps", "type": "uint16" }, { "name": "minPpm", "type": "uint32" }, { "name": "breaker", "type": "address" }, { "name": "brokeAt", "type": "uint40" }], "stateMutability": "view" }, { "type": "function", "name": "name", "inputs": [], "outputs": [{ "name": "", "type": "string" }], "stateMutability": "pure" }, { "type": "function", "name": "nextAt", "inputs": [{ "name": "c", "type": "uint256" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "pure" }, { "type": "function", "name": "onPlay", "inputs": [{ "name": "player", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "onPoke", "inputs": [{ "name": "caller", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "onTrade", "inputs": [{ "name": "t", "type": "tuple", "components": [{ "name": "kind", "type": "uint8" }, { "name": "from", "type": "address" }, { "name": "to", "type": "address" }, { "name": "who", "type": "address" }, { "name": "amount", "type": "uint256" }, { "name": "got", "type": "uint256" }, { "name": "dev", "type": "uint256" }, { "name": "sniper", "type": "uint256" }, { "name": "pot", "type": "uint256" }, { "name": "buys", "type": "uint256" }] }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "quote", "inputs": [{ "name": "", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint16" }], "stateMutability": "pure" }, { "type": "function", "name": "register", "inputs": [{ "name": "coin", "type": "address" }, { "name": "creator", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "function", "name": "shareAt", "inputs": [{ "name": "c", "type": "uint256" }], "outputs": [{ "name": "", "type": "uint256" }], "stateMutability": "pure" }, { "type": "event", "name": "ComboBroken", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "seller", "type": "address", "indexed": true }, { "name": "combo", "type": "uint32", "indexed": false }], "anonymous": false }, { "type": "event", "name": "ComboHit", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "buyer", "type": "address", "indexed": true }, { "name": "combo", "type": "uint32", "indexed": false }, { "name": "paid", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "ComboUp", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "buyer", "type": "address", "indexed": true }, { "name": "combo", "type": "uint32", "indexed": false }], "anonymous": false }, { "type": "event", "name": "Registered", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "creator", "type": "address", "indexed": true }, { "name": "data", "type": "bytes", "indexed": false }], "anonymous": false }, { "type": "error", "name": "Bad", "inputs": [{ "name": "what", "type": "string" }] }, { "type": "error", "name": "NotCoin", "inputs": [] }, { "type": "error", "name": "NotFactory", "inputs": [] }];
+export const forwardModeAbi = [{ "type": "function", "name": "creatorOf", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "factory", "inputs": [], "outputs": [{ "name": "", "type": "address" }], "stateMutability": "view" }, { "type": "function", "name": "games", "inputs": [{ "name": "", "type": "address" }], "outputs": [{ "name": "last", "type": "address" }, { "name": "lastGot", "type": "uint96" }, { "name": "bps", "type": "uint16" }, { "name": "minPpm", "type": "uint32" }, { "name": "forwards", "type": "uint32" }], "stateMutability": "view" }, { "type": "function", "name": "name", "inputs": [], "outputs": [{ "name": "", "type": "string" }], "stateMutability": "pure" }, { "type": "function", "name": "onPlay", "inputs": [{ "name": "player", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "onPoke", "inputs": [{ "name": "caller", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "onTrade", "inputs": [{ "name": "t", "type": "tuple", "components": [{ "name": "kind", "type": "uint8" }, { "name": "from", "type": "address" }, { "name": "to", "type": "address" }, { "name": "who", "type": "address" }, { "name": "amount", "type": "uint256" }, { "name": "got", "type": "uint256" }, { "name": "dev", "type": "uint256" }, { "name": "sniper", "type": "uint256" }, { "name": "pot", "type": "uint256" }, { "name": "buys", "type": "uint256" }] }], "outputs": [{ "name": "", "type": "uint256[]" }], "stateMutability": "nonpayable" }, { "type": "function", "name": "quote", "inputs": [{ "name": "", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [{ "name": "", "type": "uint16" }], "stateMutability": "pure" }, { "type": "function", "name": "register", "inputs": [{ "name": "coin", "type": "address" }, { "name": "creator", "type": "address" }, { "name": "data", "type": "bytes" }], "outputs": [], "stateMutability": "nonpayable" }, { "type": "event", "name": "Forwarded", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "buyer", "type": "address", "indexed": true }, { "name": "paid", "type": "address", "indexed": true }, { "name": "amount", "type": "uint256", "indexed": false }, { "name": "burned", "type": "uint256", "indexed": false }], "anonymous": false }, { "type": "event", "name": "Registered", "inputs": [{ "name": "coin", "type": "address", "indexed": true }, { "name": "creator", "type": "address", "indexed": true }, { "name": "data", "type": "bytes", "indexed": false }], "anonymous": false }, { "type": "error", "name": "Bad", "inputs": [{ "name": "what", "type": "string" }] }, { "type": "error", "name": "NotCoin", "inputs": [] }, { "type": "error", "name": "NotFactory", "inputs": [] }];

package/dist/addresses.d.ts

@@ -1,4 +1,7 @@
 import type { Address } from "viem";
+/** The modes of sticky 3, by the name the SDK and the site use. */
+export type ModeName = "combo" | "forward";
+export declare const MODE_NAMES: readonly ModeName[];
 /**
  * The contracts on BNB Chain (chain id 56). pickhooks' own contracts are verified on BscScan; the PancakeSwap ones are
  * PancakeSwap's. Pass `addresses` to createPickhooks to point the SDK at another deployment (a fork, a new factory).
@@ -42,6 +45,14 @@ export type Addresses = {
     ruleAuction: Address;
     darkRound: Address;
     launchDesk: Address;
+    /** sticky 3: coins with a mode (a game), fixed at launch; the lens reads what the coin leaves out; the drand beacon checks
+     *  drand signatures for the modes that draw. Not on mainnet yet: the zero address switches each off */
+    sticky3Factory: Address;
+    sticky3Lens: Address;
+    sticky3StartBlock: bigint;
+    drandBeacon: Address;
+    /** the modes of sticky 3 by name (the zero address: not deployed) */
+    modes: Record<ModeName, Address>;
     /** find the dev and CZ mode: v2 coins launched through these boxes (their coins trade like any v2 coin) */
     hideBox: Address;
     czBox: Address;

package/dist/addresses.js

@@ -1,3 +1,7 @@
+export const MODE_NAMES = [
+    "combo",
+    "forward",
+];
 export const BSC_MAINNET = {
     anyFactory: "0x1662668Ab8FaA612A7F615F1AccB90ceC20be117",
     anyHook: "0x49892253A5E71f5DF0Fbc118bd7c15acAF55F767",
@@ -24,6 +28,14 @@ export const BSC_MAINNET = {
     ruleAuction: "0x874CA64571774f2ae0A3fFa0A578B046910aDb35",
     darkRound: "0x304c6604e96627FDdc7a94b7a691A0673A80F765",
     launchDesk: "0x81508f3fCc535c29a49226E61D39188b6D479d61",
+    sticky3Factory: "0x4b41a3Ee8C80C568aE6Da7C5572867D5640C0574",
+    sticky3Lens: "0x7cc832E9EBd25fAC2852587935B6BbF06814B9e0",
+    sticky3StartBlock: 127371715n,
+    drandBeacon: "0x9c264D2934B2027Bad622417b6747E558EC465CC",
+    modes: {
+        combo: "0xEC0b3180c6D76F250Fa1d0155d03e2494F9ea03F",
+        forward: "0x09b8D80bC6c48387C7b7302AE85eDa46b713603d",
+    },
     hideBox: "0x5d540b727E28D00E1F627305739E8Fcdda4450C5",
     czBox: "0x9EDA1d134CE325001FB65381d80B85822D1DAe13",
     agentsFactory: "0x5965e2D2128248ac2CB4FFf312CFB098a1eDA232",

package/dist/errors.js

@@ -11,6 +11,7 @@ import { lever2EngineAbi, lever2FactoryAbi, lever2HookAbi } from "./abis/lever2.
 import { poolsFactoryAbi, poolsHookAbi } from "./abis/pools.js";
 import { stickyFactoryAbi, stickyTokenAbi, stickyValidatorAbi } from "./abis/sticky.js";
 import { coverDeskAbi, darkRoundAbi, launchDeskAbi, ruleAuctionAbi, sticky2FactoryAbi, sticky2TokenAbi, sticky2ValidatorAbi } from "./abis/sticky2.js";
+import { comboModeAbi, drandBeaconAbi, forwardModeAbi, sticky3FactoryAbi, sticky3TokenAbi, sticky3ValidatorAbi, } from "./abis/sticky3.js";
 import { v1FactoryAbi, v1TokenAbi } from "./abis/v1.js";
 import { arenaAbi, floorVaultAbi, payrollBoxAbi, v2FactoryAbi, v2TokenAbi, voteBoxAbi } from "./abis/v2.js";
 /** sticky: what token.check() answers when no row stops a trade but the coins are not unlocked yet */
@@ -83,6 +84,21 @@ const BAD = {
     "pot needs a drop": "A pot needs a drop row that pays it out.",
     every: "Every n-th buy: n from 2 to 1,000,000.",
     idle: "Time since the last buy: at most 30 days.",
+    // sticky 3: the factory, the validator, the modes
+    mode: "That mode is not open for launches (or it launches another way).",
+    "mode data": "Settings for a mode, but no mode.",
+    "game take": "The rows' burns and pots and the mode's share are over 10 % of a buy together.",
+    bps: "The mode's share of buys is outside its bounds.",
+    min: "The mode's minimum size is outside its bounds (0.001 to 0.1 % of the supply).",
+    registered: "This coin is registered with the mode already.",
+    "no play": "This mode has nothing to play.",
+    "no poke": "This mode has nothing to nudge.",
+    "no action": "Say what to do (the action first).",
+    action: "This mode does not know that action.",
+    player: "The creator (and the coin's pools) cannot play this.",
+    "too small": "Too small: below the mode's minimum.",
+    size: "A size is out of its bounds.",
+    "not yet": "Not yet: the reveal round is not out.",
 };
 /** every other error of the pickhooks contracts, by name */
 const BY_NAME = {
@@ -233,6 +249,12 @@ const BY_NAME = {
     NothingToProtect: "No coins arrived to protect.",
     Swap: "The swap through PancakeSwap failed.",
     Target: "The executor only calls PancakeSwap's own routers.",
+    // sticky 3: the coin
+    Busy: "The coin is busy with its mode. Try again.",
+    NoMode: "This coin has no mode.",
+    LowGas: "Too little gas for the coin's mode: send it with more gas (estimate again).",
+    BadOrder: "The mode answered with an order the coin refuses.",
+    BadSignature: "That is not drand's signature on this round.",
 };
 /** PancakeSwap's own errors that a trade can run into */
 const PANCAKE = [
@@ -285,6 +307,12 @@ const ABIS = [
     agentsFactoryAbi,
     agentsHookAbi,
     agentsDeskAbi,
+    sticky3FactoryAbi,
+    sticky3ValidatorAbi,
+    sticky3TokenAbi,
+    drandBeaconAbi,
+    comboModeAbi,
+    forwardModeAbi,
 ];
 /** every error selector the pickhooks ABIs know, for errors that PancakeSwap wraps (WrappedError, the quoter's revert) */
 const SELECTORS = ABIS.flatMap((abi) => abi.filter((x) => x.type === "error").map((x) => ({ sel: toFunctionSelector(formatAbiItem(x)).slice(2).toLowerCase(), abi })));

package/dist/index.d.ts

@@ -10,7 +10,10 @@ import { type DipsModule } from "./dips.js";
 import { type InfraModule } from "./infra.js";
 import { type Lever2Module, type LeverModule } from "./lever.js";
 import { type CallsModule, type PoolsModule } from "./pools.js";
-import { type StickyModule } from "./sticky.js";
+import { type StickyModule, type StickyLaunch } from "./sticky.js";
+import { type ModesModule } from "./modes.js";
+import { type SimulateModule } from "./simulate.js";
+import { type TextRead, understandLaunch } from "./text-launch.js";
 import { type PickhooksOptions, type SendOptions, type Sent, type TxRequest } from "./tx.js";
 import { type WalletModule } from "./wallet.js";
 import { type WatchModule } from "./watch.js";
@@ -23,6 +26,23 @@ export type Pickhooks = {
     sticky: StickyModule;
     /** sticky 2: the same coins from the second factory, plus what the creator sold and the switch rows (off until it is on mainnet) */
     sticky2: StickyModule & Pick<DesksModule, "devCounters" | "switches">;
+    /**
+     * sticky 3: the sticky 2 coin with a mode (a game, like combo), fixed at launch: launch with `mode` and
+     * `modeSettings`; fromText reads a sentence into a launch. Off until the factory is on mainnet (the zero address).
+     */
+    sticky3: StickyModule & {
+        fromText: (text: string, o?: {
+            reader?: Parameters<typeof understandLaunch>[1];
+            metadata?: string;
+        }) => Promise<TextRead & {
+            by: "parser" | "reader" | null;
+            launch: StickyLaunch | null;
+        }>;
+    };
+    /** the games of sticky 3 coins: each mode's state and actions, custody, the catalog */
+    modes: ModesModule;
+    /** every buy, sell, send or play tried first against the chain as it is (eth_simulateV1): what arrives, burns, pays, or which rule stops it */
+    simulate: SimulateModule;
     /** dev cover and dev bond: cover against the creator selling, paid out of the desk when the creator's sold share reaches the mark */
     cover: DesksModule["cover"];
     /** the rule auction: holders burn coins to pick the game of the next round */
@@ -79,7 +99,7 @@ export type Pickhooks = {
  *   const r = await ph.any.buy({ pool, bnbIn: parseEther("0.05") });
  */
 export declare function createPickhooks(options?: PickhooksOptions): Pickhooks;
-export { BSC_MAINNET, LIMITS, NATIVE, ZERO_ADDRESS, type Addresses } from "./addresses.js";
+export { BSC_MAINNET, LIMITS, MODE_NAMES, NATIVE, ZERO_ADDRESS, type Addresses, type ModeName } from "./addresses.js";
 export { CHECK_TEXT, PickhooksError, decodeRevert, errorText, explain, findRevertData } from "./errors.js";
 export { DEFAULT_RPC, deadlineIn, minusBps, type PickhooksOptions, type SendOptions, type Sent, type TxRequest } from "./tx.js";
 export { blockedKind, buildInfiSwap, infiPriceBnb, infiQuote, infiSwapInput, permit2Approvals, poolIdOf, toKey, type PoolKey } from "./infinity.js";
@@ -88,6 +108,10 @@ export { type Venue, bestVenue, buildV2Buy, buildV2Sell, v2Quote, v2RouterAbi }
 export { MAX_TICK, MIN_TICK, TAX_QUOTE_MARK, afterTax, depthNeeds, fitLadder, partnerLink, rangeFor, tickOf, type AnyLine, type AnyModule, type AnyPool, type AnyQuote, type CoinCheck, type Earnings, type OpenOptions, type OpenParams, type PoolConfig, type PoolPosition, type PoolRef, type RangeKind, type Recapture, type TaxLive, type TradeResult, } from "./any.js";
 export { describeRows, stickyTable, stickyTestRun, testRunText, type StickyTestRun, type StickyCheck, type StickyCoin, type StickyLaunch, type StickyLot, type StickyModule, type StickyRow, type StickyTerms, } from "./sticky.js";
 export { CURVE, SUPPLY, simulate, type SimReport } from "./sticky-sim.js";
+export { MODES, MODE_LIST, encodeModeData, modeBps, type ModeAction, type ModeInfo, type ModeSettings } from "./modes-catalog.js";
+export { type Custody, type ModesModule } from "./modes.js";
+export { eventText, shadowOf, type SimResult, type SimulateModule } from "./simulate.js";
+export { NOT_POSSIBLE, readLaunch, understandLaunch, type TextDraft, type TextPick, type TextRead } from "./text-launch.js";
 export { ruleText, type CoinRule, type CoinsModule, type RuleCheck, type RuleCoin, type RuleCoinVersion, type RuleLaunch } from "./coins.js";
 export { type CallRow, type CallStep, type CallsModule, type HookCoin, type HookLaunch, type PoolsModule } from "./pools.js";
 export { LEVER2_REASON, type Lever2CloseQuote, type Lever2Module, type Lever2OpenQuote, type Lever2Row, type Lever2State, type LeverCoin, type LeverMarket, type LeverModule, type LeverPosition, } from "./lever.js";

package/dist/index.js

@@ -9,6 +9,10 @@ import { infraModule } from "./infra.js";
 import { lever2Module, leverModule } from "./lever.js";
 import { callsModule, poolsModule } from "./pools.js";
 import { stickyModule } from "./sticky.js";
+import { modesModule } from "./modes.js";
+import { simulateModule } from "./simulate.js";
+import { understandLaunch } from "./text-launch.js";
+import { PickhooksError } from "./errors.js";
 import { makeCtx, sendAll, sendTx } from "./tx.js";
 import { walletModule } from "./wallet.js";
 import { watchModule } from "./watch.js";
@@ -33,6 +37,7 @@ export function createPickhooks(options = {}) {
     const d = desksModule(ctx);
     const sticky = stickyModule(ctx);
     const sticky2 = stickyModule(ctx, true);
+    const sticky3 = stickyModule(ctx, 3);
     const coins = coinsModule(ctx);
     const pools = poolsModule(ctx);
     const calls = callsModule(ctx);
@@ -46,6 +51,41 @@ export function createPickhooks(options = {}) {
         any,
         sticky,
         sticky2: { ...sticky2, devCounters: d.devCounters, switches: d.switches },
+        sticky3: {
+            ...sticky3,
+            /**
+             * A sentence ("CAT Cat, combo, dev lock 7 days, sniper jail, dev buy 0.05") read into a sticky 3 launch. `launch` is
+             * ready for ph.sticky3.launch once there are no unknown clauses (add `metadata`); the factory and the mode check it
+             * again on chain. Pass a reader (your model, your key) for what the parser does not understand.
+             */
+            fromText: async (text, o = {}) => {
+                const r = await understandLaunch(text, o.reader);
+                const d = r.draft;
+                if (!d || r.unknown.length || r.refusals.length)
+                    return { ...r, launch: null };
+                const launch = {
+                    name: d.name,
+                    symbol: d.symbol,
+                    metadata: o.metadata ?? "",
+                    picks: d.picks,
+                    devBuy: BigInt(Math.round(d.devBuyBnb * 1e6)) * 10n ** 12n,
+                    ...(d.mode ? { mode: d.mode, modeSettings: d.modeSettings } : {}),
+                };
+                const table = (() => {
+                    try {
+                        return sticky3.table(launch);
+                    }
+                    catch (e) {
+                        return e instanceof PickhooksError ? e.message : String(e);
+                    }
+                })();
+                if (typeof table === "string")
+                    return { ...r, notes: [...r.notes, table], launch: null };
+                return { ...r, launch };
+            },
+        },
+        modes: modesModule(ctx),
+        simulate: simulateModule(ctx),
         cover: d.cover,
         auction: d.auction,
         dark: d.dark,
@@ -66,7 +106,7 @@ export function createPickhooks(options = {}) {
         sendAll: (txs, o) => sendAll(ctx, txs, o),
     };
 }
-export { BSC_MAINNET, LIMITS, NATIVE, ZERO_ADDRESS } from "./addresses.js";
+export { BSC_MAINNET, LIMITS, MODE_NAMES, NATIVE, ZERO_ADDRESS } from "./addresses.js";
 export { CHECK_TEXT, PickhooksError, decodeRevert, errorText, explain, findRevertData } from "./errors.js";
 export { DEFAULT_RPC, deadlineIn, minusBps } from "./tx.js";
 export { blockedKind, buildInfiSwap, infiPriceBnb, infiQuote, infiSwapInput, permit2Approvals, poolIdOf, toKey } from "./infinity.js";
@@ -75,6 +115,10 @@ export { bestVenue, buildV2Buy, buildV2Sell, v2Quote, v2RouterAbi } from "./v2.j
 export { MAX_TICK, MIN_TICK, TAX_QUOTE_MARK, afterTax, depthNeeds, fitLadder, partnerLink, rangeFor, tickOf, } from "./any.js";
 export { describeRows, stickyTable, stickyTestRun, testRunText, } from "./sticky.js";
 export { CURVE, SUPPLY, simulate } from "./sticky-sim.js";
+export { MODES, MODE_LIST, encodeModeData, modeBps } from "./modes-catalog.js";
+export {} from "./modes.js";
+export { eventText, shadowOf } from "./simulate.js";
+export { NOT_POSSIBLE, readLaunch, understandLaunch } from "./text-launch.js";
 export { ruleText } from "./coins.js";
 export {} from "./pools.js";
 export { LEVER2_REASON, } from "./lever.js";

package/dist/modes-catalog.d.ts

@@ -0,0 +1,59 @@
+import { type Hex } from "viem";
+import type { ModeName } from "./addresses.js";
+/**
+ * The modes of sticky 3, offline: what each one is, its line, its share of buys and the bounds of its settings, the
+ * actions holders play, and whether it draws with drand. The chain is the truth: a mode's own quote() refuses settings
+ * outside its bounds, and the coin's guardrails hold whatever a mode does.
+ */
+export type ModeSettings = {
+    /** the mode's share of every buy into the game pot, basis points */
+    bps?: number;
+    /** the smallest trade (or bid, try, join) that counts, millionths of the supply */
+    minPpm?: number;
+};
+export type ModeAction = {
+    name: string;
+    who: "holder" | "creator" | "anyone" | "dev";
+    text: string;
+};
+export type ModeInfo = {
+    name: ModeName;
+    title: string;
+    /** the line as the launcher and the posts say it */
+    line: string;
+    /** how it plays, sentence by sentence */
+    how: string[];
+    /** the share of every buy into the game pot, basis points: default and bounds (0: the mode takes nothing) */
+    bps: {
+        default: number;
+        min: number;
+        max: number;
+    };
+    /** the smallest trade that counts, millionths of the supply (null: the mode has no minimum setting) */
+    minPpm: {
+        default: number;
+        min: number;
+        max: number;
+    } | null;
+    /** the settings the launcher offers */
+    settings: (keyof ModeSettings)[];
+    actions: ModeAction[];
+    /** it waits for drand rounds (the keeper hands them in) */
+    drand: boolean;
+    /** coins can sit in custody in this mode (never more than 7 days; 14 for a dev bag locked at the launch) */
+    custody: boolean;
+    /** the keeper's part: what it settles, opens or drops */
+    keeper: string | null;
+    /** said plainly: what can look odd or be gamed, and the cap that holds it */
+    notes: string[];
+};
+export declare const MODES: Record<ModeName, ModeInfo>;
+/** The modes in the launcher's order. */
+export declare const MODE_LIST: ModeInfo[];
+/**
+ * A mode's settings as the factory passes them on (abi encoded; zeros mean the defaults, empty means all defaults). Throws
+ * for settings the mode does not have, or outside its bounds.
+ */
+export declare function encodeModeData(name: ModeName, s?: ModeSettings): Hex;
+/** The share of buys a mode takes with these settings (offline; the mode's quote() on chain is the truth). */
+export declare function modeBps(name: ModeName, s?: ModeSettings): number;

package/dist/modes-catalog.js

@@ -0,0 +1,77 @@
+import { encodeAbiParameters } from "viem";
+import { PickhooksError } from "./errors.js";
+const MIN = { default: 100, min: 10, max: 1000 };
+export const MODES = {
+    combo: {
+        name: "combo",
+        title: "combo",
+        line: "Buys build the combo. One sell breaks it.",
+        how: [
+            "Every buy of at least the minimum size adds one to the combo; every sell of that size breaks it to zero.",
+            "The buy that brings the combo to 10, 25 or 50 wins 10, 25 or 50 % of the pot, then every 25 more win 25 %.",
+            "A win is never more coins than the winning buy itself brings, and never goes to the creator.",
+        ],
+        bps: { default: 200, min: 100, max: 300 },
+        minPpm: MIN,
+        settings: ["bps", "minPpm"],
+        actions: [],
+        drand: false,
+        custody: false,
+        keeper: null,
+        notes: ["A bot can aim for the 10th buy: it buys, and the win stops at its own buy."],
+    },
+    forward: {
+        name: "forward",
+        title: "pay it forward",
+        line: "Your buy pays the last buyer. The next buy pays you.",
+        how: [
+            "A share of every buy (3 % by default) goes straight to the wallet that bought before, as fresh coins.",
+            "Never the same wallet twice in a row, never the creator, never more than that wallet's own buy brought.",
+            "What is not forwarded is burned: the mode keeps no pot.",
+        ],
+        bps: { default: 300, min: 100, max: 500 },
+        minPpm: MIN,
+        settings: ["bps", "minPpm"],
+        actions: [],
+        drand: false,
+        custody: false,
+        keeper: null,
+        notes: ["A game with a fixed share, not a return: two own wallets pay each other and lose the price and the fees."],
+    },
+};
+/** The modes in the launcher's order. */
+export const MODE_LIST = [
+    MODES.combo,
+    MODES.forward,
+];
+const u = (x) => BigInt(typeof x === "boolean" ? (x ? 1 : 0) : Math.round(x ?? 0));
+/**
+ * A mode's settings as the factory passes them on (abi encoded; zeros mean the defaults, empty means all defaults). Throws
+ * for settings the mode does not have, or outside its bounds.
+ */
+export function encodeModeData(name, s) {
+    const info = MODES[name];
+    if (!info)
+        throw new PickhooksError(`There is no mode "${name}".`, { code: "input" });
+    if (!s || Object.values(s).every((x) => x === undefined))
+        return "0x";
+    for (const k of Object.keys(s)) {
+        if (s[k] !== undefined && !info.settings.includes(k))
+            throw new PickhooksError(`${info.title} has no setting "${k}".`, { code: "input" });
+    }
+    if (s.bps !== undefined && (s.bps < info.bps.min || s.bps > info.bps.max)) {
+        throw new PickhooksError(`${info.title}: the share of buys is ${info.bps.min / 100} to ${info.bps.max / 100} %.`, { code: "input" });
+    }
+    if (s.minPpm !== undefined && info.minPpm && (s.minPpm < info.minPpm.min || s.minPpm > info.minPpm.max)) {
+        throw new PickhooksError(`${info.title}: the minimum size is ${info.minPpm.min / 1e4} to ${info.minPpm.max / 1e4} % of the supply.`, { code: "input" });
+    }
+    const two = [{ type: "uint256" }, { type: "uint256" }];
+    switch (name) {
+        default:
+            return encodeAbiParameters(two, [u(s.bps), u(s.minPpm)]);
+    }
+}
+/** The share of buys a mode takes with these settings (offline; the mode's quote() on chain is the truth). */
+export function modeBps(name, s) {
+    return s?.bps ?? MODES[name].bps.default;
+}

package/dist/modes.d.ts

@@ -0,0 +1,71 @@
+import { type Address, type Hex } from "viem";
+import { type ModeName } from "./addresses.js";
+import { type ModeInfo, encodeModeData, modeBps } from "./modes-catalog.js";
+import { type Ctx, type SendOptions, type TxRequest } from "./tx.js";
+/**
+ * ph.modes: the games of sticky 3 coins. Every coin has one mode, fixed at launch; holders play it through the coin
+ * (`coin.play`), anyone nudges it (`coin.poke`), and the coin carries out what the mode answers inside its guardrails.
+ * Each mode here has its state (what the page shows) and its actions (build: the TxRequest; the plain name sends it).
+ * The modes that draw fetch drand's signature themselves (@pickhooks/sdk/tlock is loaded only then).
+ */
+export type Custody = {
+    amount: bigint;
+    dev: bigint;
+    until: number;
+    since: number;
+    shadow: Address;
+    releasable: boolean;
+};
+export declare function modesModule(ctx: Ctx): {
+    /** the modes: line, how they play, share of buys and bounds, actions (offline) */
+    catalog: Record<ModeName, ModeInfo>;
+    list: ModeInfo[];
+    info: (n: ModeName) => ModeInfo;
+    /** a mode's settings encoded for the launch (zeros: defaults) */
+    encode: typeof encodeModeData;
+    /** the share of buys a mode takes with these settings */
+    bps: typeof modeBps;
+    /** is the mode open for launches on the factory now */
+    listed: (n: ModeName) => Promise<boolean>;
+    of: (coin: Address) => Promise<{
+        name: ModeName | "other" | null;
+        address: Address;
+        gameBps: number;
+        gamePot: bigint;
+        info: ModeInfo | null;
+    }>;
+    custody: (coin: Address, who: Address) => Promise<Custody>;
+    build: {
+        release: (coin: Address, who: Address) => TxRequest;
+        play: (coin: Address, data: Hex, label: string) => TxRequest;
+        poke: (coin: Address, data: Hex, label: string) => TxRequest;
+    };
+    /** anyone: a holder's custody back to the wallet once its time is up */
+    release: (coin: Address, who: Address, s?: SendOptions) => Promise<import("./tx.js").Sent>;
+    /** a raw play or poke (data: abi.encode(action, ...)) for modes the SDK does not know */
+    play: (coin: Address, data: Hex, s?: SendOptions) => Promise<import("./tx.js").Sent>;
+    poke: (coin: Address, data: Hex, s?: SendOptions) => Promise<import("./tx.js").Sent>;
+    combo: {
+        state(coin: Address): Promise<{
+            combo: number;
+            best: number;
+            hits: number;
+            bps: number;
+            minPpm: number;
+            breaker: `0x${string}`;
+            brokeAt: number;
+            next: number;
+            nextSharePct: number;
+        }>;
+    };
+    forward: {
+        state(coin: Address): Promise<{
+            last: `0x${string}`;
+            lastGot: bigint;
+            bps: number;
+            minPpm: number;
+            forwards: number;
+        }>;
+    };
+};
+export type ModesModule = ReturnType<typeof modesModule>;