@logswap/sdk 0.5.37 → 0.5.39

package/dist/fpool.js

@@ -67,7 +67,7 @@ export async function getFPool(c, poolId) {
     const weights = legs.map((l) => l[1]);
     const x = legs.map((l) => l[2]); // derived by the manager: x_j = ln(w_j·L / R_j) (decisions 026)
     const reserves = legs.map((l) => l[3]); // the state
-    const { quote, Q, L, phi, theta0, bigSigma, authority, pendingAuthority, operator, minBuffer, gateMint, gateSwap, restructureBlock, lockStrike, seeded, dissolved, successor } = p;
+    const { quote, Q, L, phi, theta0, bigSigma, authority, pendingAuthority, operator, minBuffer, gateMint, gateSwap, restructureBlock, lockStrike, seeded, gen } = p;
     const totalSupply = p.shares;
     return {
         poolId,
@@ -92,8 +92,7 @@ export async function getFPool(c, poolId) {
         restructureBlock: Number(restructureBlock),
         lockStrike,
         seeded,
-        dissolved,
-        successor,
+        gen: Number(gen),
         totalSupply,
         reserves,
     };
@@ -208,31 +207,33 @@ export async function fPoolZapOut(c, a) {
     return writeRouter(c, "zapOut", [a.poolId, a.shares, a.tokenOut, a.minOut ?? 0n, to, a.deadline ?? defaultDeadline()], a.account);
 }
 /**
- * Roll a dissolved pool's bundle into its successor (decisions 025), on the router under one
- * lock: burn `shares` of `fromPool` in place — the legs, the quote and any unpulled dividend come
- * back — buy through `toPool`'s own curve only what its ratio lacks, mint `dL` of it to `to`, and
- * refund the rest in kind. Quote the bundle does not cover is pulled from the payer, at most
- * `maxQuoteIn`; surplus base is refunded, never sold. Size `dL` with {@link fPoolPreviewRollIn}.
- * The router must be the caller's ERC-6909 operator ({@link approveRouterForFPool}).
+ * Roll a retired generation's bundle into the pool's live one (decisions 025, 032), on the
+ * router under one lock: redeem `shares` of generation `gen` in place — the legs, the quote and
+ * any unpulled dividend come back — buy through the pool's own curve only what the live
+ * generation's ratio lacks, mint `dL` of it to `to`, and refund the rest in kind. Quote the
+ * bundle does not cover is pulled from the payer, at most `maxQuoteIn`; surplus base is
+ * refunded, never sold. Size `dL` with {@link fPoolPreviewRollIn}. The router must be the
+ * caller's ERC-6909 operator ({@link approveRouterForFPool}).
  */
 export async function fPoolRollIn(c, a) {
     const to = a.to ?? a.account;
-    return writeRouter(c, "rollIn", [a.fromPool, a.toPool, a.shares, a.dL, a.maxQuoteIn ?? 0n, a.minShares ?? 0n, to, a.deadline ?? defaultDeadline()], a.account);
+    return writeRouter(c, "rollIn", [a.poolId, BigInt(a.gen), a.shares, a.dL, a.maxQuoteIn ?? 0n, a.minShares ?? 0n, to, a.deadline ?? defaultDeadline()], a.account);
 }
 /**
- * The roll `holder`'s `shares` of `fromPool` fund into `toPool` WITHOUT a trade: the largest `dL`
- * the bundle's base covers on every successor leg, and the quote the bundle is short of (pass it
- * as `maxQuoteIn`) or over (refunded — the up direction's distribution) at that `dL`. A
- * successor leg the bundle does not hold makes `dL` zero: such a roll must buy, so size it below
- * with `previewZapIn` in mind.
+ * The roll `holder`'s `shares` of retired generation `gen` fund into the live one WITHOUT a
+ * trade: the largest `dL` the bundle's base covers on every leg, and the quote the bundle is
+ * short of (pass it as `maxQuoteIn`) or over (refunded — the up direction's distribution) at
+ * that `dL`. A leg the live generation admitted since makes `dL` zero: such a roll must buy, so
+ * size it below with `previewZapIn` in mind. Zero for the live generation, or before the next
+ * seed.
  */
-export async function fPoolPreviewRollIn(c, fromPool, toPool, holder, shares) {
+export async function fPoolPreviewRollIn(c, poolId, gen, holder, shares) {
     const { logswapLensAbi } = await import("./generated.js");
     const [dL, quoteShort, quoteExcess] = (await c.public.readContract({
         address: c.addresses.lens,
         abi: logswapLensAbi,
         functionName: "previewRollIn",
-        args: [fromPool, toPool, holder, shares],
+        args: [poolId, BigInt(gen), holder, shares],
     }));
     return { dL, quoteShort, quoteExcess };
 }
@@ -247,17 +248,23 @@ export async function fPoolPreviewRollIn(c, fromPool, toPool, holder, shares) {
 export async function fPoolHarvest(c, a) {
     return writeFPool(c, a.poolId, "harvest", [a.amount, a.to ?? a.account], a.account);
 }
-/** Pull one's settled dividend (decisions 028) without moving shares; anyone with shares. */
+/**
+ * Pull one's settled dividend (decisions 028) on a generation's shares without moving them;
+ * anyone with shares. `gen` defaults to the live generation; a retired generation's harvests
+ * stay claimable under its own id (decisions 032).
+ */
 export async function fPoolClaim(c, a) {
-    return writeFPool(c, a.poolId, "claim", [a.to ?? a.account], a.account);
+    const gen = a.gen ?? (await fPoolGen(c, a.poolId));
+    return writeFPool(c, a.poolId, "claim", [BigInt(gen), a.to ?? a.account], a.account);
 }
-/** A holder's dividend as of now — banked plus pending on the current balance (decisions 028). */
-export async function fPoolDividendOf(c, poolId, holder) {
+/** A holder's dividend as of now on generation `gen` (the live one by default) — banked plus pending on the current balance (decisions 028). */
+export async function fPoolDividendOf(c, poolId, holder, gen) {
+    const g = gen ?? (await fPoolGen(c, poolId));
     return c.public.readContract({
         address: c.addresses.fPoolManager,
         abi: fPoolManagerAbi,
         functionName: "dividendOf",
-        args: [poolId, holder],
+        args: [poolId, BigInt(g), holder],
     });
 }
 /** The lever's floor: `harvest` may not take Q/L under ln 1.25 — the floor stays ≥ 20% below the mark (decisions 025). */
@@ -386,22 +393,71 @@ export async function approveRouterForFPool(c, account) {
 // One ERC-6909 space, split structurally on bit 255 — the C manager's scheme. Derived here rather
 // than read from the chain: it is pure, and a client that has to call to learn an id cannot build
 // a multicall that uses it.
-/** The ERC-6909 id carrying a pool's shares. Bit 255 set. */
-export function fPoolShareId(poolId) {
-    return (1n << 255n) | (BigInt(poolId) >> 1n);
+/**
+ * The ERC-6909 id carrying generation `gen` of a pool's shares (decisions 032): bit 255 set (the
+ * share flag), the pool id's top 239 bits, the generation in the low 16. Each generation's shares
+ * are their own asset — a retired one is a claim on its bundle, the live one on the pool.
+ */
+export function fPoolShareId(poolId, gen = 0n) {
+    return (1n << 255n) | ((BigInt(poolId) >> 17n) << 16n) | BigInt(gen);
+}
+/** The generation a share id carries — its low 16 bits. */
+export function fPoolGenOfShareId(id) {
+    return Number(id & 0xffffn);
+}
+/** The pool's live generation, one read. */
+export async function fPoolGen(c, poolId) {
+    const p = (await c.public.readContract({
+        address: c.addresses.fPoolManager,
+        abi: fPoolManagerAbi,
+        functionName: "getPool",
+        args: [poolId],
+    }));
+    return Number(p.gen);
 }
 /** The ERC-6909 id carrying claims on a token. Bit 255 clear, so it can never meet a share id. */
 export function fPoolClaimId(token) {
     return BigInt(token);
 }
-export async function fPoolShareBalance(c, poolId, owner) {
+/** A holder's shares of generation `gen` — the live one by default. */
+export async function fPoolShareBalance(c, poolId, owner, gen) {
+    const g = gen ?? (await fPoolGen(c, poolId));
     return c.public.readContract({
         address: c.addresses.fPoolManager,
         abi: fPoolManagerAbi,
         functionName: "balanceOf",
-        args: [owner, fPoolShareId(poolId)],
+        args: [owner, fPoolShareId(poolId, g)],
     });
 }
+/** A retired generation's bundle (decisions 032): what is left to redeem — supply, quote, base per leg index. */
+export async function fPoolBundleOf(c, poolId, gen) {
+    const [supply, quote, base] = (await c.public.readContract({
+        address: c.addresses.fPoolManager,
+        abi: fPoolManagerAbi,
+        functionName: "bundleOf",
+        args: [poolId, BigInt(gen)],
+    }));
+    return { supply, quote, base: [...base] };
+}
+/** A holder's claims on a pool's retired generations — one row per generation still held (decisions 032). */
+export async function fPoolClaimsOf(c, poolId, owner) {
+    const { logswapLensAbi } = await import("./generated.js");
+    const rows = (await c.public.readContract({
+        address: c.addresses.lens,
+        abi: logswapLensAbi,
+        functionName: "fClaimsOf",
+        args: [poolId, owner],
+    }));
+    return rows.map((r) => ({ gen: Number(r.gen), shares: r.shares, base: [...r.base], quote: r.quote, dividend: r.dividend }));
+}
+/**
+ * Redeem `shares` of a RETIRED generation (decisions 032): its bundle, pro rata — the base per
+ * leg and the quote — plus the owner's settled dividend. Not `burn`: nothing can move a bundle's
+ * ratio, so there is no slippage to bound. The owner, or an operator of theirs.
+ */
+export async function fPoolRedeem(c, a) {
+    return writeFPool(c, a.poolId, "redeem", [BigInt(a.gen), a.owner ?? a.account, a.shares], a.account);
+}
 export async function fPoolClaimBalance(c, token, owner) {
     return c.public.readContract({
         address: c.addresses.fPoolManager,
@@ -544,40 +600,100 @@ export async function fPoolSeed(c, a) {
     return writeFPool(c, a.poolId, "seed", [a.L0, r0, a.Q0], a.account);
 }
 /**
- * End of life (decisions 025). Allowed at Q ≤ L/1e9 on every pool — the market filled the ask —
- * and on a pool that is not strike-locked at any Q, provided `successor` names an initialized
- * pool of the same authority and quote: the relaunch. After it every share is a frozen in-kind
- * claim redeemed by `burn` (or rolled with {@link fPoolRollIn}), forever; the pool's `successor`
- * carries the lineage. Never a second dissolve on one pool: the successor is a NEW pool.
+ * Retire the live generation (decisions 025, 032). Allowed at Q ≤ L/1e9 on every pool — the
+ * market filled the ask — and on a pool that is not strike-locked at any Q. The live (S, Q, R_j)
+ * become a frozen bundle every share of this generation redeems ({@link fPoolRedeem}) or rolls
+ * ({@link fPoolRollIn}), forever; the pool is unseeded until the next {@link fPoolSeed}, which
+ * opens generation `gen + 1` under the same id, gates, lists and promises.
  */
 export async function fPoolDissolve(c, a) {
-    return writeFPool(c, a.poolId, "dissolve", [a.successor ?? ZERO_SALT], a.account);
+    return writeFPool(c, a.poolId, "dissolve", [], a.account);
 }
 /**
- * The sponsor's relaunch as ONE transaction (decisions 025): `initialize` the successor key,
- * `dissolve` the old pool into it, `burn` the sponsor's own shares, `seed` the successor with what
- * came back — the manager's `multicall`, the sponsor as sender throughout. Gates, allowlist,
- * operator, floor guard and name are re-applied afterwards, or appended to `extra` pre-encoded
- * against {@link fPoolManagerAbi}. Returns the tx hash; the successor's id is {@link fPoolIdOf}
- * of `nextKey`.
+ * The sponsor's relaunch as ONE transaction (decisions 025, 032): `dissolve` the live generation,
+ * `redeem` the sponsor's own shares of it (when `shares` > 0), `seed` the next generation with
+ * what came back — the manager's `multicall`, the sponsor as sender throughout, the same pool.
+ * Gates, allowlist, operator, `minBuffer` and names carry over; anything else goes in `extra`,
+ * pre-encoded against {@link fPoolManagerAbi}. The seed names reserves (decisions 029): `r0`
+ * outright, or `x0` marks against the key's `weights`.
  */
 export async function fPoolRelaunch(c, a) {
-    const { bases, companions } = sortFPoolLegs(a.nextKey.bases, a.nextKey.weights);
-    const key = {
-        quote: a.nextKey.quote, bases, weights: companions[0], phi: a.nextKey.phi, lockStrike: a.nextKey.lockStrike,
-        authority: a.nextKey.authority, salt: a.nextKey.salt ?? ZERO_SALT,
-    };
-    const next = await fPoolIdOf(c, a.nextKey);
+    const gen = await fPoolGen(c, a.poolId);
+    const r0 = "r0" in a ? a.r0 : a.x0.map((x, j) => fPoolReserveAt((a.weights[j] * a.L0) / WAD, x));
     const enc = (functionName, args) => encodeFunctionData({ abi: fPoolManagerAbi, functionName, args });
     const calls = [
-        enc("initialize", [key]),
-        enc("dissolve", [a.poolId, next]),
-        enc("burn", [a.poolId, a.account, a.shares, 0n]),
-        enc("seed", [next, a.L0, a.r0, a.Q0]),
+        enc("dissolve", [a.poolId]),
+        ...(a.shares > 0n ? [enc("redeem", [a.poolId, BigInt(gen), a.account, a.shares])] : []),
+        enc("seed", [a.poolId, a.L0, r0, a.Q0]),
         ...(a.extra ?? []),
     ];
     return writeFPool0(c, "multicall", [calls], a.account);
 }
+/** ERC-6909 shares sent here are locked for good — the seed's custody (custody.md §4(b)). */
+export const DEAD_ADDRESS = "0x000000000000000000000000000000000000dEaD";
+/** The manager's `MIN_SHARES`: the seed mints this much to 0xdead itself, the rest to the seeder. */
+export const F_MIN_SHARES = 1000n;
+/**
+ * The launch's calls, in order — the batch {@link fPoolLaunch} sends. Pure, so a form can show
+ * what it is about to send, and a test can decode it. Legs are sorted here with their weights and
+ * reserves (the key's canonical order; `openBuy.j` is re-indexed to match), and the weights are
+ * checked here, where the message is readable.
+ */
+export function fPoolLaunchCalls(poolId, a) {
+    const sum = a.weights.reduce((x, y) => x + y, 0n);
+    if (sum !== WAD)
+        throw new Error(`logswap: weights sum to ${sum}, expected 1e18`);
+    const given = "r0" in a ? a.r0 : a.x0.map((x, j) => fPoolReserveAt((a.weights[j] * a.L0) / WAD, x));
+    if (given.length !== a.bases.length)
+        throw new Error(`logswap: ${given.length} reserves for ${a.bases.length} legs`);
+    const { bases, companions } = sortFPoolLegs(a.bases, a.weights, given);
+    const key = { quote: a.quote, bases, weights: companions[0], phi: a.phi, lockStrike: a.lockStrike, authority: a.authority, salt: a.salt ?? ZERO_SALT };
+    const enc = (functionName, args) => encodeFunctionData({ abi: fPoolManagerAbi, functionName, args });
+    const calls = [];
+    if (!a.initialized)
+        calls.push(enc("initialize", [key]));
+    calls.push(enc("seed", [poolId, a.L0, companions[1], a.Q0]));
+    // gen 0 by construction: a launch is the pool's FIRST seed — a relaunch is `fPoolRelaunch`
+    if (a.lockSeed)
+        calls.push(enc("transfer", [DEAD_ADDRESS, fPoolShareId(poolId, 0), a.L0 - F_MIN_SHARES]));
+    if (a.openBuy) {
+        const j = bases.indexOf(a.bases[a.openBuy.j]);
+        if (j < 0)
+            throw new Error(`logswap: openBuy.j = ${a.openBuy.j} is not a leg`);
+        calls.push(enc("swapQuoteIn", [poolId, BigInt(j), a.openBuy.amountIn, a.openBuy.minOut ?? 0n, a.account]));
+    }
+    if (a.name)
+        calls.push(enc("setName", [poolId, textToBytes32(a.name)]));
+    if (a.privatePool) {
+        calls.push(enc("setGates", [poolId, true, false]));
+        calls.push(enc("setAllowed", [poolId, [a.account], true]));
+        calls.push(enc("appointOperator", [poolId, a.account]));
+    }
+    calls.push(...(a.extra ?? []));
+    return calls;
+}
+/**
+ * Create a pool as ONE transaction: `initialize`, `seed`, the seed lock, the opening buy, the
+ * name, the private-pool gates — the manager's `multicall`, the creator as sender throughout.
+ * Either every call lands or none does; there is no half-built pool to resume.
+ *
+ * Why the manager and not the router: every one of these entries authenticates by `msg.sender`
+ * (`seed` is authority-only, so is everything after it). Routed, the router would be the sender
+ * — the authority, the holder of the seed shares — and the handover back is two-step, so it
+ * could not even close in the same transaction. `multicall` is delegatecall-to-self, so the
+ * sender survives, which is what the manager's own doc says a router cannot do.
+ *
+ * What the batch PULLS, by plain allowance to the manager (never Permit2): `r0[j]` of each base,
+ * `Q0` of quote, plus `openBuy.amountIn` of quote. Grant those first — one `approve` per token,
+ * once ever ({@link approveTokenForFPoolManager}, {@link fPoolManagerAllowanceOk}).
+ *
+ * Returns the hash and the pool's id (the key's hash, {@link fPoolIdOf}).
+ */
+export async function fPoolLaunch(c, a) {
+    const poolId = await fPoolIdOf(c, a);
+    const hash = await writeFPool0(c, "multicall", [fPoolLaunchCalls(poolId, a)], a.account);
+    return { hash, poolId };
+}
 /**
  * Propose the next authority — step one of two (contracts `2aa6b7b`, decisions 020). Nothing moves
  * until `next` accepts; proposing again (the zero address included) cancels a pending proposal.
@@ -669,11 +785,12 @@ export async function fPoolAdmitLeg(c, a) {
  */
 export async function fPoolTransferShares(c, a) {
     const wallet = requireWallet(c);
+    const gen = a.gen ?? (await fPoolGen(c, a.poolId));
     const { request } = await c.public.simulateContract({
         address: c.addresses.fPoolManager,
         abi: fPoolManagerAbi,
         functionName: "transfer",
-        args: [a.to, fPoolShareId(a.poolId), a.shares],
+        args: [a.to, fPoolShareId(a.poolId, gen), a.shares],
         account: a.account,
     });
     return wallet.writeContract(request);
@@ -731,7 +848,7 @@ export async function fPoolShareHolders(c, poolIdHex, opts = {}) {
     const ev = fPoolManagerAbi.find((x) => x.type === "event" && x.name === "Transfer");
     if (!ev)
         throw new Error("logswap: 6909 Transfer event missing from the generated ABI");
-    const id = fPoolShareId(poolIdHex);
+    const id = fPoolShareId(poolIdHex, opts.gen ?? (await fPoolGen(c, poolIdHex)));
     const logs = await c.public.getLogs({
         address: c.addresses.fPoolManager,
         event: ev,
@@ -752,7 +869,7 @@ export async function fPoolShareHolders(c, poolIdHex, opts = {}) {
         .map(([holder, shares]) => ({ holder: holder, shares }))
         .sort((a, b) => (b.shares > a.shares ? 1 : -1));
 }
-/** Every F pool's state in one lens call (the raw manager struct: quote, phi, authority, lockStrike, seeded, dissolved, successor, n, Q, L, shares, theta0, bigSigma, leverTheta). */
+/** Every F pool's state in one lens call (the raw manager struct: quote, phi, authority, lockStrike, seeded, gen, n, Q, L, shares, theta0, bigSigma, leverTheta). */
 export async function getFPoolsRaw(c, poolIds) {
     const { logswapLensAbi } = await import("./generated.js");
     return (await c.public.readContract({ address: c.addresses.lens, abi: logswapLensAbi, functionName: "getFPools", args: [poolIds] }));