@logswap/sdk 0.5.51 → 0.5.52

package/dist/fees.d.ts

@@ -0,0 +1,52 @@
+/**
+ * fees.ts — swap fees over a window, from `Swap` logs.
+ *
+ * `F` cannot answer "what did takers pay this week": it is per unit of L, it carries the mint-fee
+ * credits as well as swap fees, and it has no window. Each `Swap` event carries the quote leg and
+ * φ, and the fee is a fixed fraction of that leg, so the sum over a window is exact up to rounding:
+ *
+ *   quote in  (price up):   the curve takes q/(1+φ), the fee is q·φ/(1+φ)
+ *   quote out (price down): the curve releases q/(1−φ), the fee is q·φ/(1−φ)
+ *
+ * Both equal φ·L·|Δx| summed over the swap's segments — the same φ·|dx| per unit L that `F` books.
+ */
+import type { LogswapClient } from "./client.js";
+import type { DiscoveredMarket } from "./pools.js";
+/** The fee one swap paid, in quote, from its `Swap` event's fields. */
+export declare function swapFeeOf(e: {
+    baseIn: boolean;
+    amountIn: bigint;
+    amountOut: bigint;
+}, phi: bigint): bigint;
+/** Swap fees paid over a window, in the market's quote units. */
+export interface SwapFeeWindow {
+    fromBlock: bigint;
+    toBlock: bigint;
+    /** Window start, unix seconds — `since`, or the first block's timestamp, never before the market opened. */
+    from: bigint;
+    /** Window end, unix seconds — the last block's timestamp. */
+    to: bigint;
+    seconds: bigint;
+    swapFees: bigint;
+    swaps: number;
+}
+/** The first block with timestamp ≥ `t`, by bisection over `[lo, hi]`; `hi` when none is earlier. */
+export declare function blockAtOrAfter(c: LogswapClient, t: bigint, lo: bigint, hi: bigint): Promise<bigint>;
+/**
+ * Sum the swap fees of market `m` over a window: from `since` (unix seconds) or `fromBlock`, to
+ * `toBlock` (default latest). Either start is clamped to the market's opening, so a period longer
+ * than the market's life measures its whole life and `seconds` says how long that was.
+ */
+export declare function swapFees(c: LogswapClient, m: DiscoveredMarket, opts?: {
+    since?: bigint;
+    fromBlock?: bigint;
+    toBlock?: bigint;
+}): Promise<SwapFeeWindow>;
+/**
+ * The window's swap fees over the market's CURRENT active L, annualised linearly over the window.
+ * A fraction: 0.12 is 12%. Linear: fees are paid out, so none compound.
+ *
+ * Per unit of L. An uncapped position is worth L·(x − ξ + 1), so its return on capital is this
+ * divided by (x − ξ + 1).
+ */
+export declare function swapFeeApy(w: Pick<SwapFeeWindow, "swapFees" | "seconds">, lActive: bigint): number;

package/dist/fees.js

@@ -0,0 +1,79 @@
+/**
+ * fees.ts — swap fees over a window, from `Swap` logs.
+ *
+ * `F` cannot answer "what did takers pay this week": it is per unit of L, it carries the mint-fee
+ * credits as well as swap fees, and it has no window. Each `Swap` event carries the quote leg and
+ * φ, and the fee is a fixed fraction of that leg, so the sum over a window is exact up to rounding:
+ *
+ *   quote in  (price up):   the curve takes q/(1+φ), the fee is q·φ/(1+φ)
+ *   quote out (price down): the curve releases q/(1−φ), the fee is q·φ/(1−φ)
+ *
+ * Both equal φ·L·|Δx| summed over the swap's segments — the same φ·|dx| per unit L that `F` books.
+ */
+import { cPoolManagerAbi } from "./generated.js";
+const WAD = 10n ** 18n;
+const YEAR_SECONDS = 31_536_000;
+/** The fee one swap paid, in quote, from its `Swap` event's fields. */
+export function swapFeeOf(e, phi) {
+    return e.baseIn ? (e.amountOut * phi) / (WAD - phi) : (e.amountIn * phi) / (WAD + phi);
+}
+/** The first block with timestamp ≥ `t`, by bisection over `[lo, hi]`; `hi` when none is earlier. */
+export async function blockAtOrAfter(c, t, lo, hi) {
+    while (lo < hi) {
+        const mid = (lo + hi) / 2n;
+        if ((await c.public.getBlock({ blockNumber: mid })).timestamp < t)
+            lo = mid + 1n;
+        else
+            hi = mid;
+    }
+    return lo;
+}
+/**
+ * Sum the swap fees of market `m` over a window: from `since` (unix seconds) or `fromBlock`, to
+ * `toBlock` (default latest). Either start is clamped to the market's opening, so a period longer
+ * than the market's life measures its whole life and `seconds` says how long that was.
+ */
+export async function swapFees(c, m, opts = {}) {
+    const toBlock = opts.toBlock ?? (await c.public.getBlockNumber());
+    const [opened, last] = await Promise.all([
+        c.public.getBlock({ blockNumber: m.blockNumber }),
+        c.public.getBlock({ blockNumber: toBlock }),
+    ]);
+    let fromBlock;
+    let from;
+    if (opts.since !== undefined && opts.since > opened.timestamp) {
+        fromBlock = await blockAtOrAfter(c, opts.since, m.blockNumber, toBlock);
+        from = opts.since;
+    }
+    else if (opts.fromBlock !== undefined && opts.fromBlock > m.blockNumber) {
+        fromBlock = opts.fromBlock;
+        from = (await c.public.getBlock({ blockNumber: fromBlock })).timestamp;
+    }
+    else {
+        fromBlock = m.blockNumber;
+        from = opened.timestamp;
+    }
+    const ev = cPoolManagerAbi.find((x) => x.type === "event" && x.name === "Swap");
+    if (!ev)
+        throw new Error("logswap: Swap event missing from the generated ABI");
+    const logs = fromBlock > toBlock
+        ? []
+        : await c.public.getLogs({ address: c.addresses.cPoolManager, event: ev, args: { poolId: m.poolId }, fromBlock, toBlock });
+    let fees = 0n;
+    for (const l of logs)
+        fees += swapFeeOf({ baseIn: l.args.baseIn, amountIn: l.args.amountIn, amountOut: l.args.amountOut }, l.args.phi);
+    const to = last.timestamp;
+    return { fromBlock, toBlock, from, to, seconds: to > from ? to - from : 0n, swapFees: fees, swaps: logs.length };
+}
+/**
+ * The window's swap fees over the market's CURRENT active L, annualised linearly over the window.
+ * A fraction: 0.12 is 12%. Linear: fees are paid out, so none compound.
+ *
+ * Per unit of L. An uncapped position is worth L·(x − ξ + 1), so its return on capital is this
+ * divided by (x − ξ + 1).
+ */
+export function swapFeeApy(w, lActive) {
+    if (w.seconds <= 0n || lActive <= 0n)
+        return 0;
+    return (Number(w.swapFees) / Number(lActive)) * (YEAR_SECONDS / Number(w.seconds));
+}

package/dist/index.d.ts

@@ -19,5 +19,6 @@ export * from "./onboard.js";
 export * from "./indexer.js";
 export * from "./tokencache.js";
 export * from "./fpool.js";
+export * from "./fees.js";
 export { cPoolManagerAbi, fPoolManagerAbi, logswapLensAbi, logswapRouterAbi, padPolicyAbi, polPolicyAbi, policyRegistryAbi, privatePolicyAbi, publicPolicyAbi } from "./generated.js";
 export * from "./admin.js";

package/dist/index.js

@@ -19,5 +19,6 @@ export * from "./onboard.js";
 export * from "./indexer.js";
 export * from "./tokencache.js";
 export * from "./fpool.js";
+export * from "./fees.js";
 export { cPoolManagerAbi, fPoolManagerAbi, logswapLensAbi, logswapRouterAbi, padPolicyAbi, polPolicyAbi, policyRegistryAbi, privatePolicyAbi, publicPolicyAbi } from "./generated.js";
 export * from "./admin.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logswap/sdk",
-  "version": "0.5.51",
+  "version": "0.5.52",
   "description": "TypeScript SDK for Logswap, the liquidity primitive introducing the logarithmic invariant — typed wrappers over the CPoolManager / FPoolManager / Router / Lens surface.",
   "license": "GPL-2.0-or-later",
   "type": "module",
@@ -25,6 +25,7 @@
     "typecheck": "tsc --noEmit",
     "clean": "rm -rf dist src/generated.ts",
     "test": "vitest run",
+    "test:isolated": "bash scripts/test-isolated.sh",
     "test:watch": "vitest",
     "prepublishOnly": "npm run codegen && npm run build"
   },

package/src/fees.ts

@@ -0,0 +1,103 @@
+/**
+ * fees.ts — swap fees over a window, from `Swap` logs.
+ *
+ * `F` cannot answer "what did takers pay this week": it is per unit of L, it carries the mint-fee
+ * credits as well as swap fees, and it has no window. Each `Swap` event carries the quote leg and
+ * φ, and the fee is a fixed fraction of that leg, so the sum over a window is exact up to rounding:
+ *
+ *   quote in  (price up):   the curve takes q/(1+φ), the fee is q·φ/(1+φ)
+ *   quote out (price down): the curve releases q/(1−φ), the fee is q·φ/(1−φ)
+ *
+ * Both equal φ·L·|Δx| summed over the swap's segments — the same φ·|dx| per unit L that `F` books.
+ */
+
+import type { LogswapClient } from "./client.js";
+import { cPoolManagerAbi } from "./generated.js";
+import type { DiscoveredMarket } from "./pools.js";
+
+const WAD = 10n ** 18n;
+const YEAR_SECONDS = 31_536_000;
+
+/** The fee one swap paid, in quote, from its `Swap` event's fields. */
+export function swapFeeOf(e: { baseIn: boolean; amountIn: bigint; amountOut: bigint }, phi: bigint): bigint {
+  return e.baseIn ? (e.amountOut * phi) / (WAD - phi) : (e.amountIn * phi) / (WAD + phi);
+}
+
+/** Swap fees paid over a window, in the market's quote units. */
+export interface SwapFeeWindow {
+  fromBlock: bigint;
+  toBlock: bigint;
+  /** Window start, unix seconds — `since`, or the first block's timestamp, never before the market opened. */
+  from: bigint;
+  /** Window end, unix seconds — the last block's timestamp. */
+  to: bigint;
+  seconds: bigint;
+  swapFees: bigint;
+  swaps: number;
+}
+
+/** The first block with timestamp ≥ `t`, by bisection over `[lo, hi]`; `hi` when none is earlier. */
+export async function blockAtOrAfter(c: LogswapClient, t: bigint, lo: bigint, hi: bigint): Promise<bigint> {
+  while (lo < hi) {
+    const mid = (lo + hi) / 2n;
+    if ((await c.public.getBlock({ blockNumber: mid })).timestamp < t) lo = mid + 1n;
+    else hi = mid;
+  }
+  return lo;
+}
+
+/**
+ * Sum the swap fees of market `m` over a window: from `since` (unix seconds) or `fromBlock`, to
+ * `toBlock` (default latest). Either start is clamped to the market's opening, so a period longer
+ * than the market's life measures its whole life and `seconds` says how long that was.
+ */
+export async function swapFees(
+  c: LogswapClient,
+  m: DiscoveredMarket,
+  opts: { since?: bigint; fromBlock?: bigint; toBlock?: bigint } = {},
+): Promise<SwapFeeWindow> {
+  const toBlock = opts.toBlock ?? (await c.public.getBlockNumber());
+  const [opened, last] = await Promise.all([
+    c.public.getBlock({ blockNumber: m.blockNumber }),
+    c.public.getBlock({ blockNumber: toBlock }),
+  ]);
+
+  let fromBlock: bigint;
+  let from: bigint;
+  if (opts.since !== undefined && opts.since > opened.timestamp) {
+    fromBlock = await blockAtOrAfter(c, opts.since, m.blockNumber, toBlock);
+    from = opts.since;
+  } else if (opts.fromBlock !== undefined && opts.fromBlock > m.blockNumber) {
+    fromBlock = opts.fromBlock;
+    from = (await c.public.getBlock({ blockNumber: fromBlock })).timestamp;
+  } else {
+    fromBlock = m.blockNumber;
+    from = opened.timestamp;
+  }
+
+  type Ev = Extract<(typeof cPoolManagerAbi)[number], { type: "event"; name: "Swap" }>;
+  const ev = cPoolManagerAbi.find((x): x is Ev => x.type === "event" && x.name === "Swap");
+  if (!ev) throw new Error("logswap: Swap event missing from the generated ABI");
+
+  const logs = fromBlock > toBlock
+    ? []
+    : await c.public.getLogs({ address: c.addresses.cPoolManager, event: ev, args: { poolId: m.poolId }, fromBlock, toBlock });
+
+  let fees = 0n;
+  for (const l of logs) fees += swapFeeOf({ baseIn: l.args.baseIn!, amountIn: l.args.amountIn!, amountOut: l.args.amountOut! }, l.args.phi!);
+
+  const to = last.timestamp;
+  return { fromBlock, toBlock, from, to, seconds: to > from ? to - from : 0n, swapFees: fees, swaps: logs.length };
+}
+
+/**
+ * The window's swap fees over the market's CURRENT active L, annualised linearly over the window.
+ * A fraction: 0.12 is 12%. Linear: fees are paid out, so none compound.
+ *
+ * Per unit of L. An uncapped position is worth L·(x − ξ + 1), so its return on capital is this
+ * divided by (x − ξ + 1).
+ */
+export function swapFeeApy(w: Pick<SwapFeeWindow, "swapFees" | "seconds">, lActive: bigint): number {
+  if (w.seconds <= 0n || lActive <= 0n) return 0;
+  return (Number(w.swapFees) / Number(lActive)) * (YEAR_SECONDS / Number(w.seconds));
+}

package/src/index.ts

@@ -19,5 +19,6 @@ export * from "./onboard.js";
 export * from "./indexer.js";
 export * from "./tokencache.js";
 export * from "./fpool.js";
+export * from "./fees.js";
 export { cPoolManagerAbi, fPoolManagerAbi, logswapLensAbi, logswapRouterAbi, padPolicyAbi, polPolicyAbi, policyRegistryAbi, privatePolicyAbi, publicPolicyAbi } from "./generated.js";
 export * from "./admin.js";