hookr-sdk 0.1.0

package/README.md

@@ -0,0 +1,70 @@
+# hookr-sdk
+
+Build a market on Hookr's live root hook with a custom rule configuration, quote and swap
+through Hookr's router, read markets, and claim payouts. There is exactly one root today:
+`HookrModularHookV6` on Robinhood Chain (id 4663), `ADDRESSES.root`.
+
+## Install
+
+```
+npm install hookr-sdk viem
+```
+
+## List and validate rules
+
+```ts
+import { RULES, PARAMS, defaultBlock, validateStack } from "hookr-sdk";
+
+console.log(RULES.map((r) => r.key)); // ["snipe", "fee", "burn", "lp", "pot"]
+
+const stack = [defaultBlock("fee"), defaultBlock("lp")];
+const { ok, errors } = validateStack(stack);
+```
+
+## Build and send a create-market call
+
+```ts
+import { createWalletClient, http } from "viem";
+import { CHAIN_ID, RPC_URL, buildExistingTokenMarketCall } from "hookr-sdk";
+
+const call = buildExistingTokenMarketCall({
+  subject: token, quote: usdcAddress, tickSpacing: 60, sqrtPriceX96,
+  rules: { baseFeePips: 3_000, blocks: stack },
+  protocolRecipient, protocolShareBps, caps, // read from the coordinator and native block first
+});
+const hash = await walletClient.writeContract(call);
+```
+
+`caps` comes from `nativeMechanicsBlock.validateStack(...)`; `protocolShareBps` from
+`marketCoordinator.protocolShareBps(creator)`. See `market.ts`'s module doc for what this
+package computes and what it takes as an already-resolved input.
+
+## Read a market, quote, and swap
+
+```ts
+import { createPublicClient, http } from "viem";
+import { readMarket, poolKeyFor, quoteExactInput, buildExactInputSwapCall } from "hookr-sdk";
+
+const client = createPublicClient({ transport: http(RPC_URL) });
+const market = await readMarket(client, poolId);
+const key = poolKeyFor({ subject: market.subject, quote: market.quote, tickSpacing: market.tickSpacing });
+const { amountOut } = await quoteExactInput(client, { key, user, currencyIn: market.quote, amountIn });
+const swapCall = buildExactInputSwapCall({ key, currencyIn: market.quote, amountIn, amountOutMinimum, recipient: user, deadline });
+```
+
+## Claim
+
+```ts
+import { claimableCall, claimCall } from "hookr-sdk";
+
+const owed = await client.readContract(claimableCall(quoteAddress, account));
+if (owed > 0n) await walletClient.writeContract(claimCall(quoteAddress));
+```
+
+## Rule catalog
+
+`RULES` and `PARAMS` are this package's own machine-readable list of the five public rules and
+their bounds, and the same list is served live at https://hookr.fun/api/hooks/catalog together
+with the root and contract addresses, the fee model, the composition limits and prefilled
+builder links for example configurations. Both come from the same source in the Hookr app, and a
+parity test in that repository keeps the package and the app in step.