@logswap/sdk 0.5.54 → 0.5.56

package/src/liquidity.ts

@@ -2,7 +2,7 @@
  * liquidity.ts — providing, editing and exiting a C position.
  *
  * A class is (ξ, μ, L): floor, cap, exposure. One primitive sets all three — `update` — and every
- * edit is a constraint on it. The vocabulary follows the geometry (decisions 009): **the verb
+ * edit is a constraint on it. The vocabulary follows the geometry: **the verb
  * names the axis, the direction is a signed rung count**, and only two direction-words survive,
  * because each names a wallet flow the user must see.
  *
@@ -15,7 +15,7 @@
  *   └─ reprice(ξ')         R pinned: L' = L·e^{ξ' − ξ}, dormant only
  *   mint · burn · claim
  *
- * Every edit is ONE action of the router's batch (decisions 010, `actions.ts`), which is what
+ * Every edit is ONE action of the router's batch (`actions.ts`), which is what
  * lets it settle in kind, or in base, or in quote: `settleIn` appends the one swap that nets the
  * other side, and the batch moves a single token. `previewEdit` is the lens's `previewUpdate` —
  * the exact flows, mint fee and swept fees included — and is what an editor shows before its one
@@ -99,7 +99,7 @@ export async function mint(c: LogswapClient, a: MintArgs): Promise<Hash> {
 
 export interface CreateMarketArgs extends WriteOptions {
   key: PoolKey;
-  /** Launch log-price. Bounded by the manager to ±46 (the price domain, decisions 012). */
+  /** Launch log-price. Bounded by the manager to ±46 (the price domain). */
   x0: bigint;
   /** The backstop's floor — the first mint's rung, permanent for the pool's life. */
   targetFloor: bigint;
@@ -112,7 +112,7 @@ export interface CreateMarketArgs extends WriteOptions {
 
 /**
  * Create a market ATOMICALLY: `initialize` at `x0` plus the backstop-establishing first mint in
- * one transaction — the canonical creation path (decisions 013, security-review H-02). The
+ * one transaction — the canonical creation path. The
  * two-step path let an attacker seat the PERMANENT backstop at a hostile rung between an honest
  * `initialize` and its first mint; here either both land or neither, and a front-run of the whole
  * call reverts it without moving a wei. No cap: the first mint IS the backstop and must be
@@ -140,7 +140,7 @@ export interface ZapArgs extends WriteOptions {
   /** Fund entirely from base (true) or entirely from quote (false). */
   fundWithBase: boolean;
   amountIn: bigint;
-  /** The least the swap leg may return (contracts 7c82eed, decisions 043): the zap's own slippage bound, as `swapExactIn`'s. Required. */
+  /** The least the swap leg may return: the zap's own slippage bound, as `swapExactIn`'s. Required. */
   minSwapOut: bigint;
   targetFloor: bigint;
   cap?: bigint;
@@ -155,7 +155,7 @@ export interface ZapArgs extends WriteOptions {
  *
  * Routing the imbalanced part through the CURVE is the point, not an implementation detail. A
  * pro-rata deposit of one asset would be a zero-slippage, zero-fee swap at stale spot — a subsidy
- * paid by the incumbent LPs (`logswap-docs` §*Quote-only capital*). Paying the curve removes it.
+ * paid by the incumbent LPs. Paying the curve removes it.
  */
 export async function zapIn(c: LogswapClient, a: ZapArgs): Promise<Hash> {
   return sendRouterWriteWithPermits(c, {
@@ -226,7 +226,7 @@ export interface MoveArgs extends WriteOptions {
  * Reposition at constant exposure — the L-pinned parent of `floor`, `cap` and `shift`; in kind.
  *
  * **Bound it.** The router used to settle this entry with no limit, which meant a reposition that
- * priced differently by inclusion time could pull the whole allowance (security-review2 M-01).
+ * priced differently by inclusion time could pull the whole allowance.
  * The bounds are required; {@link UNBOUNDED} is an explicit, visible opt-out.
  */
 export async function move(c: LogswapClient, a: MoveArgs): Promise<Hash> {
@@ -325,7 +325,7 @@ export async function edit(c: LogswapClient, a: EditArgs & { toFloor: bigint; to
   if (settleIn === "kind") {
     settle = settleInKind(key, recipient, { ...boundsFromFlows(p.dBase, p.dQuote, a.slippageBps), ...defined(a) });
   } else {
-    // the swept fees ride INSIDE dQuote (the manager burns by owner and nets them; decisions 018),
+    // the swept fees ride INSIDE dQuote (the manager burns by owner and nets them),
     // so quote's open delta after the update is dQuote itself — `fees` is reported for display only
     const otherFlow = settleIn === "base" ? p.dQuote : p.dBase; // + = owed, − = released
     const otherIsBase = settleIn === "quote";

package/src/pools.ts

@@ -31,7 +31,7 @@ export interface PoolState {
   reserveQuote: bigint;
   /** Fee-per-unit-L accumulator: $\phi \cdot \mathrm{TV}(\log p)$. */
   F: bigint;
-  /** Quadratic variation of log-price, $\Sigma = \sum_{\text{swaps}} (\Delta x_{\text{swap}})^2$ — one term per swap (decisions 042). */
+  /** Quadratic variation of log-price, $\Sigma = \sum_{\text{swaps}} (\Delta x_{\text{swap}})^2$ — one term per swap. */
   bigSigma: bigint;
   currentK: bigint;
   protocolOwed: bigint;
@@ -52,7 +52,7 @@ export async function getPool(c: LogswapClient, key: PoolKey): Promise<PoolState
 
 /**
  * The market's fee: the key's `phi` with `0n` resolved to `DEFAULT_FEE`. Constant for the market's
- * life (C version 4, decisions 042 — `phiEff` and the variance kernel before). Reverts for a key
+ * life (C version 4, — `phiEff` and the variance kernel before). Reverts for a key
  * nobody initialized, which `discoverMarkets` relies on to drop a stale indexer's rows.
  */
 export async function phiOf(c: LogswapClient, key: PoolKey): Promise<bigint> {