hookr-sdk 0.1.0

package/dist/swap.js

@@ -0,0 +1,111 @@
+import { hookrKernelQuoterV1Abi, hookrKernelRouterV3Abi } from "./abi.js";
+import { ADDRESSES, NATIVE_ADDRESS } from "./chain.js";
+/** Router / block `MIN_SQRT_PRICE_LIMIT`: the full-fill limit for a `zeroForOne` swap. */
+export const MIN_SQRT_PRICE_LIMIT = 4295128740n;
+/** Router / block `MAX_SQRT_PRICE_LIMIT`: the full-fill limit for a `oneForZero` swap. */
+export const MAX_SQRT_PRICE_LIMIT = 1461446703485210103287273052203988822378723970341n;
+/** `type(int128).max`: the router's and the quoter's ceiling on every amount and bound. */
+export const INT128_MAX = (1n << 127n) - 1n;
+/** The bound an exact-input quote carries: the smallest value the quoter admits. */
+export const QUOTE_MIN_OUT_BOUND = 1n;
+/** The router's `moduleData` for a plain swap: the native block reads none. */
+export const EMPTY_MODULE_DATA = "0x";
+/** The full-fill `sqrtPriceLimitX96`: `MIN` when selling currency0, `MAX` otherwise. Any pool
+ *  with an input cut rejects every other limit on an exact-input buy. */
+export function fullFillLimit(zeroForOne) {
+    return zeroForOne ? MIN_SQRT_PRICE_LIMIT : MAX_SQRT_PRICE_LIMIT;
+}
+/** `zeroForOne = currencyIn == key.currency0`. Throws when `currencyIn` is not in the pool. */
+export function swapDirection(key, currencyIn) {
+    const same = (a, b) => a.toLowerCase() === b.toLowerCase();
+    if (same(currencyIn, key.currency0))
+        return true;
+    if (same(currencyIn, key.currency1))
+        return false;
+    throw new Error("That currency is not in this pool.");
+}
+/**
+ * `exactInput` through the Hookr router. `value` is `amountIn` when `currencyIn` is native ETH,
+ * else 0 (the router pulls the ERC-20 by `transferFrom`; approve it first).
+ */
+export function buildExactInputSwapCall(input) {
+    const zeroForOne = swapDirection(input.key, input.currencyIn);
+    const native = input.currencyIn.toLowerCase() === NATIVE_ADDRESS.toLowerCase();
+    return Object.freeze({
+        address: ADDRESSES.router,
+        abi: hookrKernelRouterV3Abi,
+        functionName: "exactInput",
+        args: [
+            {
+                key: input.key,
+                zeroForOne,
+                amountIn: input.amountIn,
+                amountOutMinimum: input.amountOutMinimum,
+                sqrtPriceLimitX96: fullFillLimit(zeroForOne),
+                recipient: input.recipient,
+                deadline: input.deadline,
+            },
+            EMPTY_MODULE_DATA,
+        ],
+        value: native ? input.amountIn : 0n,
+    });
+}
+/**
+ * `exactOutput` through the Hookr router. `value` is `amountInMaximum` when `currencyIn` is
+ * native ETH — the router refunds what the swap does not use.
+ */
+export function buildExactOutputSwapCall(input) {
+    const zeroForOne = swapDirection(input.key, input.currencyIn);
+    const native = input.currencyIn.toLowerCase() === NATIVE_ADDRESS.toLowerCase();
+    return Object.freeze({
+        address: ADDRESSES.router,
+        abi: hookrKernelRouterV3Abi,
+        functionName: "exactOutput",
+        args: [
+            {
+                key: input.key,
+                zeroForOne,
+                amountOut: input.amountOut,
+                amountInMaximum: input.amountInMaximum,
+                sqrtPriceLimitX96: fullFillLimit(zeroForOne),
+                recipient: input.recipient,
+                deadline: input.deadline,
+            },
+            EMPTY_MODULE_DATA,
+        ],
+        value: native ? input.amountInMaximum : 0n,
+    });
+}
+/**
+ * Quote through `kernelQuoter.quote`. Run as a simulated call from `account` rather than an
+ * ordinary read: the function is declared `nonpayable` (it runs the full module loop, including
+ * the pot leg, which is recipient-specific), which is also why the app's own equivalent
+ * (`quoteV2` in `src/lib/v2-swap.ts`) calls `simulateContract` rather than `readContract` — the
+ * same `eth_call` either way, just the viem entry point whose types match a nonpayable function.
+ * `amountSpecified` is negative for an exact-input quote, bound at 1 wei/unit — the least the
+ * quoter admits; pass `amountBound` to override it (an exact-output quote wants `INT128_MAX` or
+ * your own maximum).
+ */
+export async function quoteExactInput(client, input) {
+    const zeroForOne = swapDirection(input.key, input.currencyIn);
+    const { result } = await client.simulateContract({
+        address: ADDRESSES.quoter,
+        abi: hookrKernelQuoterV1Abi,
+        functionName: "quote",
+        account: input.user,
+        args: [
+            {
+                key: input.key,
+                payer: input.user,
+                recipient: input.user,
+                zeroForOne,
+                amountSpecified: -input.amountIn,
+                amountBound: input.amountBound ?? QUOTE_MIN_OUT_BOUND,
+                sqrtPriceLimitX96: fullFillLimit(zeroForOne),
+            },
+            EMPTY_MODULE_DATA,
+        ],
+    });
+    const [amountIn, amountOut] = result;
+    return Object.freeze({ amountIn, amountOut });
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "hookr-sdk",
+  "version": "0.1.0",
+  "description": "Build a market on Hookr's live root hook, quote and swap through its router, read markets, and claim payouts.",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Hookr-fun/hookr"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "viem": "^2"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}