hookr-sdk 0.2.1 → 1.0.0

package/dist/index.d.ts

@@ -1,18 +1,9 @@
 /**
- * `hookr-sdk` — build a market on Hookr's live root hooks with a custom rule configuration,
- * quote and swap through Hookr's router, read markets, and claim payouts.
+ * hookr-sdk: build on Hookr 1, Hookr's Uniswap v4 hook on Robinhood Chain.
  *
- * Two roots are live on Robinhood Chain (id 4663): the default root `HookrModularHookV6`
- * (`ADDRESSES.root`) and the arbitrage-recapture root `HookrModularHookV6WthV5`
- * (`ADDRESSES.recaptureRoot`); `ROOTS` in `chain.ts` pairs each with its kernel id. See the
- * README for a quickstart.
+ * `./core` is the release SDK of the release commit, copied byte for byte (`provenance.json` names the commit and
+ * every file's hash). `./releases` adds the addresses and deployment of the production release and its canary, the
+ * chain for viem, and builds the DeploymentManifest the core builders take.
  */
-export * from "./chain.js";
-export * from "./abi.js";
-export * from "./rules.js";
-export * from "./fees.js";
-export * from "./market.js";
-export * from "./swap.js";
-export * from "./reads.js";
-export * from "./claims.js";
-export * from "./links.js";
+export * from "./core/index.js";
+export * from "./releases.js";

package/dist/index.js

@@ -1,18 +1,9 @@
 /**
- * `hookr-sdk` — build a market on Hookr's live root hooks with a custom rule configuration,
- * quote and swap through Hookr's router, read markets, and claim payouts.
+ * hookr-sdk: build on Hookr 1, Hookr's Uniswap v4 hook on Robinhood Chain.
  *
- * Two roots are live on Robinhood Chain (id 4663): the default root `HookrModularHookV6`
- * (`ADDRESSES.root`) and the arbitrage-recapture root `HookrModularHookV6WthV5`
- * (`ADDRESSES.recaptureRoot`); `ROOTS` in `chain.ts` pairs each with its kernel id. See the
- * README for a quickstart.
+ * `./core` is the release SDK of the release commit, copied byte for byte (`provenance.json` names the commit and
+ * every file's hash). `./releases` adds the addresses and deployment of the production release and its canary, the
+ * chain for viem, and builds the DeploymentManifest the core builders take.
  */
-export * from "./chain.js";
-export * from "./abi.js";
-export * from "./rules.js";
-export * from "./fees.js";
-export * from "./market.js";
-export * from "./swap.js";
-export * from "./reads.js";
-export * from "./claims.js";
-export * from "./links.js";
+export * from "./core/index.js";
+export * from "./releases.js";

package/dist/releases.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Hookr 1 on Robinhood Chain: the production release `hookr-1`, its canary `canary-hookr-1-a`, each release's
+ * deployment, and the deployment manifest the builders take.
+ *
+ * Every address is fixed by CREATE3 from the release deployer, the release id and the contract's name, so it is known
+ * before the contract is deployed and is the same on every machine. `test/releases.test.ts` derives each one again
+ * from those inputs. The canary runs the same code at its own addresses and exists to prove a release before
+ * production; build on `HOOKR_1`.
+ */
+import { type Chain } from "viem";
+import { type Address, type ContractRole, type DeploymentManifest, type Hash } from "./core/index.js";
+/** Robinhood Chain's id. */
+export declare const CHAIN_ID = 4663;
+/**
+ * The chain's public, keyless RPC endpoint. Fine for a few reads. Under load it rate limits, and a wide `eth_getLogs`
+ * can come back as an empty array instead of an error, so anything that must not miss data should use a provider
+ * endpoint of its own.
+ */
+export declare const RPC_URL = "https://rpc.mainnet.chain.robinhood.com";
+/** The block explorer people open: RobinScan, where every contract's source is verified. No trailing slash. */
+export declare const EXPLORER_URL = "https://robin.etherscan.io";
+/**
+ * Robinhood Chain for viem, on any viem 2, with RobinScan as its explorer. viem 2.55 and later also ship it as
+ * `robinhood` from `viem/chains`, with the same id and RPC endpoint and Blockscout as its explorer.
+ */
+export declare const ROBINHOOD_CHAIN: Chain;
+/** An address's page on the explorer. */
+export declare function explorerAddressUrl(address: Address): string;
+/** A transaction's page on the explorer. */
+export declare function explorerTxUrl(hash: Hash): string;
+/** Uniswap v4's dynamic-fee flag. Every Hookr pool's `PoolKey.fee` is this: the hook sets the LP fee on each swap. */
+export declare const DYNAMIC_FEE = 8388608;
+/** The price limit for a `zeroForOne` swap that may fill in full: TickMath's MIN_SQRT_PRICE + 1. */
+export declare const MIN_SQRT_PRICE_LIMIT = 4295128740n;
+/** The price limit for a `oneForZero` swap that may fill in full: TickMath's MAX_SQRT_PRICE - 1. */
+export declare const MAX_SQRT_PRICE_LIMIT = 1461446703485210103287273052203988822378723970341n;
+/** Uniswap v4's PoolManager on Robinhood Chain. Every Hookr pool lives in it. */
+export declare const POOL_MANAGER: Address;
+/** The account that deploys both releases. CREATE3 addresses depend on it, never on a nonce. */
+export declare const RELEASE_DEPLOYER: Address;
+/** The CREATE3 factory both releases deploy through. */
+export declare const CREATE3_FACTORY: Address;
+/** The source commit both releases are built from. */
+export declare const RELEASE_SOURCE_COMMIT = "412960b37a631ce145d49fb4a1887f04a4d1fa74";
+/** The release digest: the hash of the build both releases deploy from. */
+export declare const RELEASE_PACKET_DIGEST = "83962c12ff55df431612ffae8bfc66a30041eb310035cfc30eab1bb9bdc0e031";
+/** Every contract of a release, by contract name. */
+export interface ReleaseContracts {
+    HookrRegistryChecks: Address;
+    HookrRegistryAdmin: Address;
+    HookrRegistry: Address;
+    HookrTreasury: Address;
+    HookrForwarder: Address;
+    HookrRouter: Address;
+    HookrQuoter: Address;
+    HookrLaunchChecks: Address;
+    HookrTokenDeployer: Address;
+    HookrLauncher: Address;
+    HookrReferralRegistry: Address;
+    HookrProgramsAdmin: Address;
+    HookrPrograms: Address;
+    /** Created by HookrPrograms. */
+    HookrMilestoneNFTFactory: Address;
+    /** Created by HookrPrograms. */
+    HookrProgramValidator: Address;
+    HookrReferralDistributor: Address;
+    /** The hook every pool of the release names in `PoolKey.hooks`. */
+    HookrRoot: Address;
+    /** Created by HookrRoot: the arb recapture lane. */
+    HookrLane: Address;
+    HookrRules: Address;
+    /** Created by HookrRules: the arb recapture split. */
+    HookrRecapture: Address;
+    HookrFamilyRouter: Address;
+    HookrFamilyLock: Address;
+    HookrCompliance: Address;
+    HookrComplianceGuard: Address;
+    HookrAccountCalls: Address;
+    HookrPaymasterAdmin: Address;
+    HookrPaymaster: Address;
+    HookrRootFactory: Address;
+    HookrSessionAdvisory: Address;
+    HookrFeeAdvisory: Address;
+    HookrLiquidityVault: Address;
+    HookrOwnedProfiles: Address;
+    HookrOwnedRootsLens: Address;
+    HookrOwnedRootFactory: Address;
+    HookrLpBoost: Address;
+}
+export type ReleaseContractName = keyof ReleaseContracts;
+/** The id each contract's salt is derived from. */
+export type HookrReleaseId = "hookr-1" | "canary-hookr-1-a";
+export interface HookrRelease {
+    /** The release id each contract's salt is derived from. */
+    releaseId: HookrReleaseId;
+    /** True for the canary: the same code at its own addresses, run before production. */
+    canary: boolean;
+    chainId: typeof CHAIN_ID;
+    contracts: Readonly<ReleaseContracts>;
+    /**
+     * The deployment as the release's verified app manifest records it, or null in a version of this package made
+     * before the release was deployed and verified. `releaseManifest` and `readReleaseManifest` use it by default.
+     */
+    deployment: Readonly<ReleaseDeployment> | null;
+}
+/** The production release. Build on this one. */
+export declare const HOOKR_1: HookrRelease;
+/** The canary: the same contracts at their own addresses, deployed and proven before production. Not for users. */
+export declare const CANARY_HOOKR_1_A: HookrRelease;
+/** Both releases by release id. */
+export declare const RELEASES: Readonly<Record<HookrReleaseId, HookrRelease>>;
+/** The contract each manifest role pins, in the order the manifest lists them. */
+export declare const MANIFEST_ROLES: Readonly<Partial<Record<ContractRole, ReleaseContractName | "PoolManager">>>;
+/** The address a manifest role pins in a release. */
+export declare function releaseAddress(release: HookrRelease, role: keyof typeof MANIFEST_ROLES): Address;
+/** What a manifest needs beyond the addresses: the deployment as the chain has it and its source verification. */
+export interface ReleaseDeployment {
+    /** The block the manifest starts from, as a decimal string: the block the release's app manifest was read at. */
+    startBlock: string;
+    /** That block's hash. The manifest calls it `parentHash`. */
+    parentHash: Hash;
+    /** keccak256 of each role's runtime code. Every role of `MANIFEST_ROLES` needs one. */
+    runtimeHashes: Readonly<Partial<Record<ContractRole, Hash>>>;
+    /**
+     * The hash of the release's source verification records on Blockscout. The manifest carries it to say the release
+     * is verified; the builders check its form, not its content.
+     */
+    evidenceHash: Hash;
+}
+/**
+ * The DeploymentManifest the builders take for a release: every role at its fixed address with its runtime hash, from
+ * the release's own deployment unless one is given. It makes no reads. Refuses a role without a runtime hash, and
+ * anything `deployment()` refuses.
+ *
+ * It is the builders' manifest. Its release id is the release's, `hookr-1`, so it is not the manifest a Hookr service
+ * publishes: `HookrClient` takes the release id and manifest hash the service names.
+ */
+export declare function releaseManifest(release: HookrRelease, d?: Readonly<ReleaseDeployment> | null): DeploymentManifest;
+/** The two reads `readReleaseManifest` makes. A viem PublicClient has both. */
+export interface ReleaseReader {
+    getCode(args: {
+        address: Address;
+        blockNumber?: bigint;
+    }): Promise<`0x${string}` | undefined>;
+    getBlock(args: {
+        blockNumber: bigint;
+    }): Promise<{
+        hash: Hash | null;
+    }>;
+}
+/** Overrides for `readReleaseManifest`. With none, it reads the release's own deployment. */
+export interface ReadReleaseOptions {
+    /** The block the manifest starts from. Defaults to the release's. */
+    startBlock?: bigint;
+    /** The release's source verification hash. Defaults to the release's. */
+    evidenceHash?: Hash;
+    /** The block the code is read at. Defaults to the latest. */
+    blockNumber?: bigint;
+}
+/**
+ * `releaseManifest` with each role's runtime hash and the start block's hash read from chain. Refuses a role with no
+ * code: the release is not deployed, or not on this chain. Where the release carries its deployment, it also refuses
+ * a role whose code is not the release's, and a start block whose hash is not the release's.
+ */
+export declare function readReleaseManifest(client: ReleaseReader, release: HookrRelease, options?: ReadReleaseOptions): Promise<DeploymentManifest>;
+/**
+ * The gas floor a swap on an arb recapture pool must carry while its lane is on: `2 × gasCap + gasCap / 63 + 755,000`
+ * (HookrLane), the `gasFloor` `laneOf(id)` returns. At the 3,000,000 cap the lane opens with it is 6,802,619. A swap
+ * sent with less reverts `InsufficientLaneGas`. The swap's own gas comes on top: the release rehearsal's lane swap
+ * needed a gas limit of 7,419,835, so a fixed limit on such a pool should be at least 7,500,000.
+ */
+export declare function laneGasFloor(gasCap: number | bigint): bigint;

package/dist/releases.js

@@ -0,0 +1,268 @@
+/**
+ * Hookr 1 on Robinhood Chain: the production release `hookr-1`, its canary `canary-hookr-1-a`, each release's
+ * deployment, and the deployment manifest the builders take.
+ *
+ * Every address is fixed by CREATE3 from the release deployer, the release id and the contract's name, so it is known
+ * before the contract is deployed and is the same on every machine. `test/releases.test.ts` derives each one again
+ * from those inputs. The canary runs the same code at its own addresses and exists to prove a release before
+ * production; build on `HOOKR_1`.
+ */
+import { defineChain, keccak256 } from "viem";
+import { deployment } from "./core/index.js";
+import { DEPLOYMENTS } from "./deployments.js";
+/** Robinhood Chain's id. */
+export const CHAIN_ID = 4663;
+/**
+ * The chain's public, keyless RPC endpoint. Fine for a few reads. Under load it rate limits, and a wide `eth_getLogs`
+ * can come back as an empty array instead of an error, so anything that must not miss data should use a provider
+ * endpoint of its own.
+ */
+export const RPC_URL = "https://rpc.mainnet.chain.robinhood.com";
+/** The block explorer people open: RobinScan, where every contract's source is verified. No trailing slash. */
+export const EXPLORER_URL = "https://robin.etherscan.io";
+/**
+ * Robinhood Chain for viem, on any viem 2, with RobinScan as its explorer. viem 2.55 and later also ship it as
+ * `robinhood` from `viem/chains`, with the same id and RPC endpoint and Blockscout as its explorer.
+ */
+export const ROBINHOOD_CHAIN = defineChain({
+    id: CHAIN_ID,
+    name: "Robinhood Chain",
+    nativeCurrency: { name: "Ether", symbol: "ETH", decimals: 18 },
+    rpcUrls: { default: { http: [RPC_URL] } },
+    blockExplorers: { default: { name: "RobinScan", url: EXPLORER_URL } },
+    contracts: { multicall3: { address: "0xca11bde05977b3631167028862be2a173976ca11" } },
+});
+/** An address's page on the explorer. */
+export function explorerAddressUrl(address) {
+    return `${EXPLORER_URL}/address/${address}`;
+}
+/** A transaction's page on the explorer. */
+export function explorerTxUrl(hash) {
+    return `${EXPLORER_URL}/tx/${hash}`;
+}
+/** Uniswap v4's dynamic-fee flag. Every Hookr pool's `PoolKey.fee` is this: the hook sets the LP fee on each swap. */
+export const DYNAMIC_FEE = 0x800000;
+/** The price limit for a `zeroForOne` swap that may fill in full: TickMath's MIN_SQRT_PRICE + 1. */
+export const MIN_SQRT_PRICE_LIMIT = 4295128740n;
+/** The price limit for a `oneForZero` swap that may fill in full: TickMath's MAX_SQRT_PRICE - 1. */
+export const MAX_SQRT_PRICE_LIMIT = 1461446703485210103287273052203988822378723970341n;
+/** Uniswap v4's PoolManager on Robinhood Chain. Every Hookr pool lives in it. */
+export const POOL_MANAGER = "0x8366a39CC670B4001A1121B8F6A443A643e40951";
+/** The account that deploys both releases. CREATE3 addresses depend on it, never on a nonce. */
+export const RELEASE_DEPLOYER = "0x0c0967485A25F18E70262a2Ee80c7595CC64a5fC";
+/** The CREATE3 factory both releases deploy through. */
+export const CREATE3_FACTORY = "0xc7c662Fc760FE1d5cB97fd8A68cb43A046da3F7d";
+/** The source commit both releases are built from. */
+export const RELEASE_SOURCE_COMMIT = "412960b37a631ce145d49fb4a1887f04a4d1fa74";
+/** The release digest: the hash of the build both releases deploy from. */
+export const RELEASE_PACKET_DIGEST = "83962c12ff55df431612ffae8bfc66a30041eb310035cfc30eab1bb9bdc0e031";
+/** A deployment, frozen, so no caller can change the facts a release carries. */
+function frozen(d) {
+    return d && Object.freeze({ ...d, runtimeHashes: Object.freeze({ ...d.runtimeHashes }) });
+}
+/** The production release. Build on this one. */
+export const HOOKR_1 = Object.freeze({
+    releaseId: "hookr-1",
+    canary: false,
+    chainId: CHAIN_ID,
+    deployment: frozen(DEPLOYMENTS["hookr-1"]),
+    contracts: Object.freeze({
+        HookrRegistryChecks: "0xB9F5c54E5Cc7ac6c7a96335E5A334Cf4eA496E98",
+        HookrRegistryAdmin: "0x675ac2102E8c69E2467F64656E3c235AF3901Ac1",
+        HookrRegistry: "0x463c82beA1a52F4Cc05ca0741a24F0AD24bA4602",
+        HookrTreasury: "0x2242F7FC75606500503075f29ea8cDA684EfB4a9",
+        HookrForwarder: "0xe7863CC0E2Fb783b44c279aB159bcD812c2ceA1c",
+        HookrRouter: "0xC2Bc9a3fe6c4Ce8C2F7EB4655b0869b01D8c93C9",
+        HookrQuoter: "0x445D7891381Aa7F91F5048EdBC6a611ccBDe7865",
+        HookrLaunchChecks: "0x8567369a70100828611BB6F44ec051B48F10fb59",
+        HookrTokenDeployer: "0x1B23D6d7beBcB61E39317E9F0Bc02AEB91aFCcAe",
+        HookrLauncher: "0x1cf2748A6670572425eAbf9Ab9e5BC4eb2eB8Ef4",
+        HookrReferralRegistry: "0xefD1DfBA80c06E72F793601706c3a1c71aab3057",
+        HookrProgramsAdmin: "0x40B40D65543E70a9C757eda1A2208517a8BC7292",
+        HookrPrograms: "0x9fA204AC99176782Fd20615b2b2A516D1F8C328F",
+        HookrMilestoneNFTFactory: "0xa340F964F1E685c681dC3ABB5B0405E608914d00",
+        HookrProgramValidator: "0x33e0249083Be7Cd8bD2fe175E0671AcfD0516850",
+        HookrReferralDistributor: "0x690539c53212899A9c6AEEE3b4B6737A5c4851d9",
+        HookrRoot: "0x89c9FB50d1f03192230FFB1c279BB6E7d3Fe6aCc",
+        HookrLane: "0x9A8a1006469BA196f8FEfc017a53505C83A060BB",
+        HookrRules: "0x4a71c270b1520F94064268102AebD744b0DE7942",
+        HookrRecapture: "0xF83569E564d70daebc35950f66a73f2e2B915583",
+        HookrFamilyRouter: "0x854f3Fa7AC342B244DF0d9A8c8F597b051aAE559",
+        HookrFamilyLock: "0xfAFEcE64099C1E791C4B46189c277f00c0c7e00b",
+        HookrCompliance: "0x9D205e8a68464761A9d84bdeCcEa0C3CB1e7B1EC",
+        HookrComplianceGuard: "0x6CD70db1ac99344416a6fD7184e23FA8f09f313A",
+        HookrAccountCalls: "0x0579a95A7760070E2d6D34e5beCe571e5F1c4818",
+        HookrPaymasterAdmin: "0x1d81F4B131832f741392edf7B91b4CF099FbB008",
+        HookrPaymaster: "0x1c4682915092E742231ea038C4fcA61e96a83c99",
+        HookrRootFactory: "0x21E438FaBE10770afb4407cF6b09d32369CBdCE4",
+        HookrSessionAdvisory: "0x78Bc6b7302Dda8632e661c8d74966bdBea1c66b1",
+        HookrFeeAdvisory: "0x3B6b3f00684987B831fcF9EB5f0d5B806afF7306",
+        HookrLiquidityVault: "0xA408923EF811945Ef119Bc700B1950Dab65467Fc",
+        HookrOwnedProfiles: "0xb46c318B6AEA2d6274f5566da414b09fDa6CC325",
+        HookrOwnedRootsLens: "0x6Bb5c9d21dD095F788cb8373d0143429ad277366",
+        HookrOwnedRootFactory: "0xA6c2a401597301dFf57A59bC8F70a9622499f3ec",
+        HookrLpBoost: "0x52536F5F4E5BC7cEA2197c8F1BB49bf2B133E7f1",
+    }),
+});
+/** The canary: the same contracts at their own addresses, deployed and proven before production. Not for users. */
+export const CANARY_HOOKR_1_A = Object.freeze({
+    releaseId: "canary-hookr-1-a",
+    canary: true,
+    chainId: CHAIN_ID,
+    deployment: frozen(DEPLOYMENTS["canary-hookr-1-a"]),
+    contracts: Object.freeze({
+        HookrRegistryChecks: "0x4598d64B6c5730813a469e4B36cf379DbfB24118",
+        HookrRegistryAdmin: "0x57252DB7C9ed51213a324A2160934Ee2f840d6E8",
+        HookrRegistry: "0x91eDc45319B66dc4f168BcF7B957e8f753771834",
+        HookrTreasury: "0x3cA2926E5971Cda3E3667e9A6835b2cDfF8DD836",
+        HookrForwarder: "0xDd3407eB6DbFF4a3Cb6258923C35F3e306C86320",
+        HookrRouter: "0x3b6848A557F5Aedc18EbE5f3E5b6EafB4F46f6F9",
+        HookrQuoter: "0xc324D74339763E8b12709092a2c9d8f04CD02c88",
+        HookrLaunchChecks: "0xa22BF1F6a8709441Fc7af410891204454Ed24026",
+        HookrTokenDeployer: "0x85b6B07688Da8089F4191439dbFC315a4757DB0F",
+        HookrLauncher: "0x064a2b59f7c3d70ECdC0009be30Eb464110Ae787",
+        HookrReferralRegistry: "0x8EC0AE84b21BF2dD187ED390dbDA7A967ECfC5dD",
+        HookrProgramsAdmin: "0x2Bec6C3bEB51c062C0Ef59ddC67237354E86BeF1",
+        HookrPrograms: "0x3A11ea03e1B6c6750dEF8A5fBb41bd4c3d0C3d97",
+        HookrMilestoneNFTFactory: "0xFeE0AbA75f9C0A23bB5AB686314a5112dfe3f0b2",
+        HookrProgramValidator: "0xA6883F0424FA4Ec11E0591Aa14A26be957EE863A",
+        HookrReferralDistributor: "0x9ab480d01e89F9d9A1D1e3cd8433DCbC825BA4cC",
+        HookrRoot: "0x4C0904bfbdaEC6AA847C36BBf395E5f61325eacc",
+        HookrLane: "0x3ba186E41b83ABd4E91a2a72c2fF3BAF8f88003C",
+        HookrRules: "0x8Ef8869CD47d9928d563001F1d38D65c3c3e01Ab",
+        HookrRecapture: "0xe7035c0d8523a5eE9Fc5Ba5Ec97a4f1D771a6F87",
+        HookrFamilyRouter: "0xD6F31D46D06d4Aa91e937407369a369D1DB9C684",
+        HookrFamilyLock: "0xC39144589aC7336eFC9baB9d7608c7B014Fe757e",
+        HookrCompliance: "0xed326114d79b8bf64f00585fF3Ca1D5C01693649",
+        HookrComplianceGuard: "0xB6a3d34513020458fBC80D71F5753fC41a863CE5",
+        HookrAccountCalls: "0xdd706C93179730cFE73b8c1627bEc6103e51E3a3",
+        HookrPaymasterAdmin: "0x7a44B8E11097c4B801bcf195EF09295882538bF3",
+        HookrPaymaster: "0x1Bf7C2e0755b8776C04f21208Ea4CF29A0942866",
+        HookrRootFactory: "0x2B2fF011b4A3854b7796e86307736AEB558C80C7",
+        HookrSessionAdvisory: "0x6fE7e2244257664e4658FEcB308Cf374e6c83Af1",
+        HookrFeeAdvisory: "0x02B13627a634dfebBb864389cDb3E4D6945e80Ac",
+        HookrLiquidityVault: "0x67E93f59E3fD78e7976960aBce835E27c63Aa8c9",
+        HookrOwnedProfiles: "0xeCeD7a6D923Dc5C0c49B0a8c5089f372C6c40244",
+        HookrOwnedRootsLens: "0x76f0F2a48C154c8261110a4c13cdc5d4437A0631",
+        HookrOwnedRootFactory: "0xEFD7bE480bbA7e3b14dbA0878F34AB436bC08ff8",
+        HookrLpBoost: "0xe06dac9dea02424fAd01CEE10feA0ce5517765A9",
+    }),
+});
+/** Both releases by release id. */
+export const RELEASES = Object.freeze({
+    "hookr-1": HOOKR_1,
+    "canary-hookr-1-a": CANARY_HOOKR_1_A,
+});
+/** The contract each manifest role pins, in the order the manifest lists them. */
+export const MANIFEST_ROLES = Object.freeze({
+    poolManager: "PoolManager",
+    registry: "HookrRegistry",
+    root: "HookrRoot",
+    rules: "HookrRules",
+    router: "HookrRouter",
+    quoter: "HookrQuoter",
+    launcher: "HookrLauncher",
+    treasury: "HookrTreasury",
+    programs: "HookrPrograms",
+    referrals: "HookrReferralRegistry",
+    commissions: "HookrReferralDistributor",
+    forwarder: "HookrForwarder",
+    rootFactory: "HookrRootFactory",
+    feeAdvisory: "HookrFeeAdvisory",
+    sessionAdvisory: "HookrSessionAdvisory",
+    liquidityVault: "HookrLiquidityVault",
+});
+/** The address a manifest role pins in a release. */
+export function releaseAddress(release, role) {
+    const name = MANIFEST_ROLES[role];
+    if (!name)
+        throw new Error(`No ${role} in ${release.releaseId}`);
+    return name === "PoolManager" ? POOL_MANAGER : release.contracts[name];
+}
+/** What a version of this package made before the release was verified tells a caller. */
+function noDeployment(release) {
+    return new Error(`This version of hookr-sdk has no deployment for ${release.releaseId}: pass its startBlock and evidenceHash`);
+}
+/**
+ * The DeploymentManifest the builders take for a release: every role at its fixed address with its runtime hash, from
+ * the release's own deployment unless one is given. It makes no reads. Refuses a role without a runtime hash, and
+ * anything `deployment()` refuses.
+ *
+ * It is the builders' manifest. Its release id is the release's, `hookr-1`, so it is not the manifest a Hookr service
+ * publishes: `HookrClient` takes the release id and manifest hash the service names.
+ */
+export function releaseManifest(release, d = release.deployment) {
+    if (!d)
+        throw noDeployment(release);
+    const contracts = Object.keys(MANIFEST_ROLES).map((role) => {
+        const runtimeHash = d.runtimeHashes[role];
+        if (!runtimeHash)
+            throw new Error(`No runtime hash for ${role}`);
+        return {
+            role,
+            address: releaseAddress(release, role).toLowerCase(),
+            runtimeHash,
+            startBlock: d.startBlock,
+        };
+    });
+    return deployment({
+        schema: "hookr.engagement.sources.v1",
+        releaseId: release.releaseId,
+        chainId: String(release.chainId),
+        startBlock: d.startBlock,
+        parentHash: d.parentHash,
+        contracts,
+        qualification: { status: "verified", evidenceHash: d.evidenceHash, sourceCommit: RELEASE_SOURCE_COMMIT },
+    });
+}
+/**
+ * `releaseManifest` with each role's runtime hash and the start block's hash read from chain. Refuses a role with no
+ * code: the release is not deployed, or not on this chain. Where the release carries its deployment, it also refuses
+ * a role whose code is not the release's, and a start block whose hash is not the release's.
+ */
+export async function readReleaseManifest(client, release, options = {}) {
+    const pinned = release.deployment;
+    const startBlock = options.startBlock ?? (pinned ? BigInt(pinned.startBlock) : undefined);
+    const evidenceHash = options.evidenceHash ?? pinned?.evidenceHash;
+    if (startBlock === undefined || evidenceHash === undefined)
+        throw noDeployment(release);
+    const roles = Object.keys(MANIFEST_ROLES);
+    const [block, codes] = await Promise.all([
+        client.getBlock({ blockNumber: startBlock }),
+        Promise.all(roles.map((role) => client.getCode({ address: releaseAddress(release, role), blockNumber: options.blockNumber }))),
+    ]);
+    if (!block.hash)
+        throw new Error(`Block ${startBlock} has no hash yet`);
+    const pinnedStart = pinned && startBlock === BigInt(pinned.startBlock);
+    if (pinnedStart && block.hash.toLowerCase() !== pinned.parentHash.toLowerCase())
+        throw new Error(`Block ${startBlock} is not ${release.releaseId}'s start block on this chain`);
+    const runtimeHashes = {};
+    roles.forEach((role, i) => {
+        const code = codes[i];
+        if (!code || code === "0x")
+            throw new Error(`No code at ${role} ${releaseAddress(release, role)}`);
+        const runtimeHash = keccak256(code);
+        const expected = pinned?.runtimeHashes[role];
+        if (expected && runtimeHash !== expected.toLowerCase())
+            throw new Error(`${role} ${releaseAddress(release, role)} does not run ${release.releaseId}'s code`);
+        runtimeHashes[role] = runtimeHash;
+    });
+    return releaseManifest(release, {
+        startBlock: startBlock.toString(),
+        parentHash: block.hash,
+        runtimeHashes,
+        evidenceHash,
+    });
+}
+/**
+ * The gas floor a swap on an arb recapture pool must carry while its lane is on: `2 × gasCap + gasCap / 63 + 755,000`
+ * (HookrLane), the `gasFloor` `laneOf(id)` returns. At the 3,000,000 cap the lane opens with it is 6,802,619. A swap
+ * sent with less reverts `InsufficientLaneGas`. The swap's own gas comes on top: the release rehearsal's lane swap
+ * needed a gas limit of 7,419,835, so a fixed limit on such a pool should be at least 7,500,000.
+ */
+export function laneGasFloor(gasCap) {
+    const cap = BigInt(gasCap);
+    if (cap <= 0n)
+        return 0n;
+    return 2n * cap + cap / 63n + 755000n;
+}

package/package.json

@@ -1,29 +1,65 @@
 {
   "name": "hookr-sdk",
-  "version": "0.2.1",
-  "description": "Build a market on Hookr's live root hooks, quote and swap through its router, read markets, and claim payouts.",
+  "version": "1.0.0",
+  "description": "Build on Hookr 1: launch tokens with Hook Blocks, open pools, quote, swap and claim on Robinhood Chain.",
   "type": "module",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Hookr-fun/hookr"
-  },
+  "homepage": "https://hookr.fun/docs",
+  "keywords": [
+    "hookr",
+    "uniswap",
+    "uniswap-v4",
+    "v4-hooks",
+    "hooks",
+    "hook-blocks",
+    "launchpad",
+    "robinhood-chain",
+    "viem",
+    "sdk"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "provenance.json",
+    "README.md",
+    "CHANGELOG.md",
+    "MIGRATING.md",
+    "LICENSE"
   ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18.16"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": ">=22.18",
+      "onFail": "error"
+    }
+  },
   "peerDependencies": {
-    "viem": "^2"
+    "viem": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "24.3.0",
+    "typescript": "5.9.3",
+    "viem": "2.55.10"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json"
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && node scripts/declarations.mjs",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "node --test test/*.test.ts",
+    "sync": "node scripts/sync-core.mjs",
+    "deployment": "node scripts/release-deployment.mjs",
+    "prepack": "npm run build",
+    "prepublishOnly": "node scripts/release-deployment.mjs --require hookr-1"
   }
 }

package/provenance.json

@@ -0,0 +1,31 @@
+{
+  "schema": "hookr-sdk.provenance.v1",
+  "algorithm": "sha256",
+  "source": {
+    "commit": "412960b37a631ce145d49fb4a1887f04a4d1fa74",
+    "path": "labs/hooks/hookr-phase-one/sdk/src",
+    "package": "@hookr/phase-one-sdk@0.1.0"
+  },
+  "packetDigest": "83962c12ff55df431612ffae8bfc66a30041eb310035cfc30eab1bb9bdc0e031",
+  "contractSources": "Verified on RobinScan at each contract's address: https://robin.etherscan.io",
+  "files": {
+    "abi.ts": "615359c9865eaa8b12ddde68f3e115bcf4cc922c2ba9578cd4c4ba9c0836d416",
+    "advisories.ts": "2fd12057ddb8c8527c19438574366ca9b15a48183b841d56d44e38506b823ded",
+    "client.ts": "78c386458e747e9c520926e3c22c33292a4ef0ae26dfcf4b671ccd7302e19328",
+    "generated.ts": "2fa220f53b64b85cb8fd7b34e06dd3a346027b6d8aa4e93835f69f92697a0fe7",
+    "index.ts": "5789edae589547442a6529111dd8c2e02d6a8791784f6da45c96e189567b3059",
+    "launch.ts": "dffb0d1321a30f68d4510dc30523599ae28b9a30f6df9880366e149974555268",
+    "pair.ts": "1b3f3f2d3dbf6a3e69655c9d35324e5f656ab64b2d7b846c7621dd6a4ca4e43d",
+    "params.ts": "5fa75b9ede3bbb20d4b48f2b907220f9b832b05977c3aeefa5b69d0169f85521",
+    "policies.ts": "07411d29d46f7175ff77624242cabcf4d3a235a287507f3d83a0df4a06985410",
+    "proofs.ts": "81f1f4a0f2c267b8a2b7897ecd4847fb8791f512f8babc51f1c8976d9d047bb8",
+    "quotes.ts": "c3483a97ca247533cc5ef9d5648b43df591d47db3c434e8f8ff6b634b44359c3",
+    "referrals.ts": "9426b5a128ddff1c9f7b54e483a81a30458dea04c7d40adff8d1e4084f048987",
+    "registry.ts": "fec429bc5b7bd91a83124d46055171269ded20678c185ad3e40d7d5e1153cee8",
+    "rules.ts": "d34b23187424756293b06815c6ee31dc772c87f2ae1cbba63f966148ece64543",
+    "schema.ts": "caa6caa9f15ae9a597bf8b2a2d098ef40780b8b6410a3a72a4f2be62b84c98e5",
+    "stocks.generated.ts": "8809cd3b82612bbc6e96bca23b756ee0bb7b99d391d991415f6ffb9d2aa705fd",
+    "vault.ts": "e01d26ed5517547bfc29dc89ca58836c762d665e88a5db58523475248f5de387",
+    "wallet.ts": "25fd97be3dde9755414f0eeacae2a9cfc14358951f98d6573af1025403895dba"
+  }
+}