@blazephoenix/sdk 1.0.1 → 1.2.0

package/dist/index.d.cts

@@ -145,7 +145,8 @@ interface QuoteRequest {
     amountIn?: bigint | string;
     /** Input in HUMAN units ("1.5"); decimals are read from the token on your RPC. */
     amount?: string;
-    /** Tighten the on-chain floor with your own minimum (base units of tokenOut). */
+    /** Your own minimum (base units of tokenOut). In buildSwap it is the signed minimum as given,
+     *  and it is refused (`min_implausible`) below the quote net of slippageBps or the on-chain floor. */
     userMinOut?: bigint | string;
     /** Protocol version for this call (default: the client's, itself 'latest'). */
     version?: string;
@@ -211,6 +212,15 @@ interface SwapRequest extends QuoteRequest {
     mode?: 'route' | 'best';
     /** Allowance to request when approval is needed: 'exact' (default) or 'max'. */
     approve?: 'exact' | 'max';
+    /**
+     * true — also read previewPlanExact (every concentrated leg dry-run) in the same block and
+     * derive minOut from its exactOut: a fixed 50 bps safety margin first, then slippageBps off
+     * that, never below the default minimum. The calldata still executes the route of the default
+     * path; the exact read must price that same route, or buildSwap refuses. A userMinOut above
+     * exactOut less the margin is refused (`min_above_exact`). One more eth_call; the swap reverts
+     * instead of filling short when the pool moves past the tolerance.
+     */
+    exact?: boolean;
 }
 interface ApprovalStep {
     token: Address;
@@ -237,6 +247,8 @@ interface SwapPlan {
     unwrapAfter: boolean;
     /** Ordered transactions to send: [approval?, swap]. */
     steps: TxRequest[];
+    /** With `exact: true`: the previewPlanExact output minOut was derived from. */
+    exactOut?: bigint;
 }
 interface SimulationResult {
     ok: boolean;
@@ -385,6 +397,12 @@ interface RegistryOptions {
      *  delay a call, and by at most this much; later refreshes run in the
      *  background (stale-while-revalidate). */
     timeoutMs?: number;
+    /** Route to addresses that only the fetched document supplies (a version
+     *  released after this SDK). Default false: the document can list them, but
+     *  resolve() only returns Router/Quoter addresses pinned in this package —
+     *  the on-chain check of a remote entry reads the entry's own contracts, so
+     *  it cannot tell a real deployment from a look-alike. */
+    remoteVersions?: boolean;
     /** Called for every pin conflict or rejected document — never silently. */
     onWarning?: (msg: string) => void;
 }
@@ -394,6 +412,7 @@ declare class Registry {
     private fetchedAt;
     private lastError?;
     private readonly mode;
+    private readonly remoteVersions;
     private readonly url;
     private readonly ttlMs;
     private readonly fetchFn?;
@@ -422,6 +441,8 @@ declare class Registry {
     /** Every deployed version on a chain, newest first. */
     versionsOn(chainId: SupportedChainId): string[];
     resolve(chainId: SupportedChainId, selector?: VersionSelector): ResolvedDeployment;
+    /** Router and Quoter both pinned in this package (not filled by a fetched document). */
+    private isPinned;
     private latestKnownVersion;
     /** chains × versions table (for dashboards, the MCP, debugging). */
     table(): {
@@ -4240,7 +4261,7 @@ declare const CAUTION_IMPACT_BPS = 200;
 declare function routeIsConsistent(route: Route, tokenIn: Address, tokenOut: Address): boolean;
 declare function phoenixCheck(pv: Preview, tokenIn: Address, tokenOut: Address): QuoteChecks;
 
-type BlazeErrorCode = 'rpc_required' | 'rpc_chain_mismatch' | 'rpc_error' | 'bad_request' | 'not_deployed' | 'unsupported_by_version' | 'no_route' | 'not_executable' | 'calldata_mismatch' | 'deployment_unverified' | 'reverted' | 'wallet_chain_mismatch';
+type BlazeErrorCode = 'rpc_required' | 'rpc_chain_mismatch' | 'rpc_error' | 'bad_request' | 'not_deployed' | 'unsupported_by_version' | 'no_route' | 'not_executable' | 'calldata_mismatch' | 'min_implausible' | 'min_above_exact' | 'deployment_unverified' | 'reverted' | 'wallet_chain_mismatch';
 declare class BlazeError extends Error {
     readonly code: BlazeErrorCode;
     readonly details?: Record<string, unknown>;

package/dist/index.d.ts

@@ -145,7 +145,8 @@ interface QuoteRequest {
     amountIn?: bigint | string;
     /** Input in HUMAN units ("1.5"); decimals are read from the token on your RPC. */
     amount?: string;
-    /** Tighten the on-chain floor with your own minimum (base units of tokenOut). */
+    /** Your own minimum (base units of tokenOut). In buildSwap it is the signed minimum as given,
+     *  and it is refused (`min_implausible`) below the quote net of slippageBps or the on-chain floor. */
     userMinOut?: bigint | string;
     /** Protocol version for this call (default: the client's, itself 'latest'). */
     version?: string;
@@ -211,6 +212,15 @@ interface SwapRequest extends QuoteRequest {
     mode?: 'route' | 'best';
     /** Allowance to request when approval is needed: 'exact' (default) or 'max'. */
     approve?: 'exact' | 'max';
+    /**
+     * true — also read previewPlanExact (every concentrated leg dry-run) in the same block and
+     * derive minOut from its exactOut: a fixed 50 bps safety margin first, then slippageBps off
+     * that, never below the default minimum. The calldata still executes the route of the default
+     * path; the exact read must price that same route, or buildSwap refuses. A userMinOut above
+     * exactOut less the margin is refused (`min_above_exact`). One more eth_call; the swap reverts
+     * instead of filling short when the pool moves past the tolerance.
+     */
+    exact?: boolean;
 }
 interface ApprovalStep {
     token: Address;
@@ -237,6 +247,8 @@ interface SwapPlan {
     unwrapAfter: boolean;
     /** Ordered transactions to send: [approval?, swap]. */
     steps: TxRequest[];
+    /** With `exact: true`: the previewPlanExact output minOut was derived from. */
+    exactOut?: bigint;
 }
 interface SimulationResult {
     ok: boolean;
@@ -385,6 +397,12 @@ interface RegistryOptions {
      *  delay a call, and by at most this much; later refreshes run in the
      *  background (stale-while-revalidate). */
     timeoutMs?: number;
+    /** Route to addresses that only the fetched document supplies (a version
+     *  released after this SDK). Default false: the document can list them, but
+     *  resolve() only returns Router/Quoter addresses pinned in this package —
+     *  the on-chain check of a remote entry reads the entry's own contracts, so
+     *  it cannot tell a real deployment from a look-alike. */
+    remoteVersions?: boolean;
     /** Called for every pin conflict or rejected document — never silently. */
     onWarning?: (msg: string) => void;
 }
@@ -394,6 +412,7 @@ declare class Registry {
     private fetchedAt;
     private lastError?;
     private readonly mode;
+    private readonly remoteVersions;
     private readonly url;
     private readonly ttlMs;
     private readonly fetchFn?;
@@ -422,6 +441,8 @@ declare class Registry {
     /** Every deployed version on a chain, newest first. */
     versionsOn(chainId: SupportedChainId): string[];
     resolve(chainId: SupportedChainId, selector?: VersionSelector): ResolvedDeployment;
+    /** Router and Quoter both pinned in this package (not filled by a fetched document). */
+    private isPinned;
     private latestKnownVersion;
     /** chains × versions table (for dashboards, the MCP, debugging). */
     table(): {
@@ -4240,7 +4261,7 @@ declare const CAUTION_IMPACT_BPS = 200;
 declare function routeIsConsistent(route: Route, tokenIn: Address, tokenOut: Address): boolean;
 declare function phoenixCheck(pv: Preview, tokenIn: Address, tokenOut: Address): QuoteChecks;
 
-type BlazeErrorCode = 'rpc_required' | 'rpc_chain_mismatch' | 'rpc_error' | 'bad_request' | 'not_deployed' | 'unsupported_by_version' | 'no_route' | 'not_executable' | 'calldata_mismatch' | 'deployment_unverified' | 'reverted' | 'wallet_chain_mismatch';
+type BlazeErrorCode = 'rpc_required' | 'rpc_chain_mismatch' | 'rpc_error' | 'bad_request' | 'not_deployed' | 'unsupported_by_version' | 'no_route' | 'not_executable' | 'calldata_mismatch' | 'min_implausible' | 'min_above_exact' | 'deployment_unverified' | 'reverted' | 'wallet_chain_mismatch';
 declare class BlazeError extends Error {
     readonly code: BlazeErrorCode;
     readonly details?: Record<string, unknown>;

package/dist/index.js

@@ -4736,8 +4736,7 @@ var CHAINS = {
     explorer: "https://basescan.org",
     weth: "0x4200000000000000000000000000000000000006",
     usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
-    bzpx: "0x23113e72165a034265Ab8Bf2277CCB7a85Cb7483",
-    staking: "0x3f60C7aa0c36a78D200405feBE143d2Cf3fA0c77",
+    bzpx: "0x053D75c00FdD571538492e3B1686Bd963a0911A7",
     blockTime: 2
   },
   10: {
@@ -5354,6 +5353,7 @@ var Registry = class {
   fetchedAt = 0;
   lastError;
   mode;
+  remoteVersions;
   url;
   ttlMs;
   fetchFn;
@@ -5362,6 +5362,7 @@ var Registry = class {
   overrides = /* @__PURE__ */ new Map();
   constructor(opts = {}, overrides) {
     this.mode = opts.mode ?? "auto";
+    this.remoteVersions = opts.remoteVersions ?? false;
     this.url = opts.url ?? DEPLOYMENTS_URL;
     this.ttlMs = opts.ttlMs ?? 10 * 6e4;
     this.fetchFn = opts.fetchFn ?? globalThis.fetch;
@@ -5493,7 +5494,7 @@ var Registry = class {
     if (!isValidSelector(selector)) throw new BlazeError("bad_request", `bad version selector "${selector}"`);
     const ov = this.overrides.get(chainId);
     const sel = ov?.version && selector === "latest" ? ov.version : selector;
-    const candidates = this.doc.versions.filter((v) => matchesSelector(v.version, sel) && isDeployed(v.chains[chainId])).sort((a, b) => compareVersions(b.version, a.version));
+    const candidates = this.doc.versions.filter((v) => matchesSelector(v.version, sel) && isDeployed(v.chains[chainId])).filter((v) => this.remoteVersions || this.isPinned(v.version, chainId)).sort((a, b) => compareVersions(b.version, a.version));
     const pick = candidates[0];
     if (ov && (ov.router || ov.quoter)) {
       const base = pick ? { ...pick.chains[chainId] } : {
@@ -5513,9 +5514,10 @@ var Registry = class {
     }
     if (!pick) {
       const deployed = this.versionsOn(chainId);
+      const remoteOnly = this.remoteVersions ? [] : deployed.filter((v) => matchesSelector(v, sel) && !this.isPinned(v, chainId));
       throw new BlazeError(
         "not_deployed",
-        `no BlazePhoenix deployment matching version "${selector}" on chain ${chainId}` + (deployed.length ? ` (deployed: ${deployed.join(", ")})` : ""),
+        `no BlazePhoenix deployment matching version "${selector}" on chain ${chainId}` + (deployed.length ? ` (deployed: ${deployed.join(", ")})` : "") + (remoteOnly.length ? ` \u2014 ${remoteOnly.join(", ")} is known only from the fetched registry; update the SDK, or set registry.remoteVersions after checking the addresses yourself` : ""),
         { details: { chainId, selector, deployed } }
       );
     }
@@ -5524,6 +5526,11 @@ var Registry = class {
     const source = src("router") === "remote" || src("quoter") === "remote" ? "remote" : "embedded";
     return { chainId, version: pick.version, status: pick.status, contracts: { ...set }, source };
   }
+  /** Router and Quoter both pinned in this package (not filled by a fetched document). */
+  isPinned(version, chainId) {
+    const src = (k) => this.fieldSource[`${version}|${chainId}|${k}`];
+    return src("router") === "embedded" && src("quoter") === "embedded";
+  }
   latestKnownVersion(selector) {
     const all = this.doc.versions.map((v) => v.version).sort((a, b) => compareVersions(b, a));
     const m = selector ? all.find((v) => matchesSelector(v, selector)) : void 0;
@@ -5771,16 +5778,19 @@ var BlazePhoenix = class {
         return { address: c.weth, native: true };
       case "WETH":
         return { address: c.weth, native: false };
+      // `usdc` holds each chain's one dollar asset: USDG on Robinhood Chain, USDC
+      // elsewhere. The other symbol names a different token there, so it is refused.
       case "USDC":
       case "USDG":
-        return { address: c.usdc, native: false };
+        if (s.toUpperCase() === (chainId === 4663 ? "USDG" : "USDC")) return { address: c.usdc, native: false };
+        break;
       case "BZPX":
         if (c.bzpx) return { address: c.bzpx, native: false };
         break;
     }
     throw new BlazeError(
       "bad_request",
-      `${side}: "${ref}" is not a 0x address or a built-in symbol (ETH, WETH, USDC, BZPX) on ${c.name} \u2014 pass the token address`
+      `${side}: "${ref}" is not a 0x address or a built-in symbol (ETH, WETH, ${chainId === 4663 ? "USDG" : "USDC"}, BZPX) on ${c.name} \u2014 pass the token address`
     );
   }
   async decimalsOf(client, chainId, t) {
@@ -6022,6 +6032,60 @@ var BlazePhoenix = class {
     let encodedBy = "sdk";
     let entry;
     let minOut;
+    let at;
+    if (req.exact) {
+      try {
+        at = await ctx.client.getBlockNumber();
+      } catch (e) {
+        this.wrapReadError(e, "block number");
+      }
+    }
+    const pin = at !== void 0 ? { blockNumber: at } : {};
+    let exactOut;
+    const exactRead = async (route) => {
+      let ex;
+      try {
+        ex = await ctx.client.readContract({
+          address: ctx.dep.contracts.quoter,
+          abi: QUOTER_ABI,
+          functionName: "previewPlanExact",
+          args: [tIn.address, tOut.address, amountIn],
+          ...pin
+        });
+      } catch (e) {
+        this.wrapReadError(e, "exact quote");
+      }
+      if (!samePath(ex[0], route)) {
+        throw new BlazeError("calldata_mismatch", "previewPlanExact priced a different route than the one to execute");
+      }
+      exactOut = ex[1];
+      return ex[1];
+    };
+    const settleMin = async (p) => {
+      let floor = minOutFor(p.netOut, slippageBps, p.ironFloor);
+      let ceil;
+      if (req.exact) {
+        const ex = await exactRead(p.route);
+        ceil = minOutFor(ex, EXACT_MARGIN_BPS, 0n);
+        floor = maxBig(floor, minOutFor(ceil, slippageBps, 0n));
+      }
+      if (userMinOut === 0n) return floor;
+      if (userMinOut < floor) {
+        throw new BlazeError(
+          "min_implausible",
+          `userMinOut is below ${floor} (this quote net of slippageBps): set it from a price you trust, or raise slippageBps if a lower minimum is intended`,
+          { details: { userMinOut: userMinOut.toString(), floor: floor.toString() } }
+        );
+      }
+      if (ceil !== void 0 && userMinOut > ceil && userMinOut > floor) {
+        throw new BlazeError(
+          "min_above_exact",
+          `userMinOut is above ${ceil} (exactOut less ${EXACT_MARGIN_BPS} bps): an honest swap at this minimum may revert`,
+          { details: { userMinOut: userMinOut.toString(), ceiling: ceil.toString() } }
+        );
+      }
+      return userMinOut;
+    };
     if (features.previewAndEncode && !tIn.native && mode === "route") {
       let call;
       try {
@@ -6029,19 +6093,21 @@ var BlazePhoenix = class {
           address: ctx.dep.contracts.quoter,
           abi: QUOTER_ABI,
           functionName: "previewAndEncodeWithMinOut",
-          args: [tIn.address, tOut.address, amountIn, userMinOut, recipient, deadline]
+          args: [tIn.address, tOut.address, amountIn, userMinOut, recipient, deadline],
+          ...pin
         }) : await ctx.client.readContract({
           address: ctx.dep.contracts.quoter,
           abi: QUOTER_ABI,
           functionName: "previewAndEncode",
-          args: [tIn.address, tOut.address, amountIn, recipient, deadline]
+          args: [tIn.address, tOut.address, amountIn, recipient, deadline],
+          ...pin
         });
         [pv, call] = r;
       } catch (e) {
         this.wrapReadError(e, "previewAndEncode");
       }
       assertExecutable(pv, tIn.address, tOut.address, call);
-      minOut = maxBig(minOutFor(pv.netOut, slippageBps, pv.effectiveMinOut), userMinOut);
+      minOut = await settleMin(pv);
       verifySwapExactIn(call, {
         tokenIn: tIn.address,
         tokenOut: tOut.address,
@@ -6055,9 +6121,9 @@ var BlazePhoenix = class {
       encodedBy = "quoter";
       entry = "swapExactIn";
     } else {
-      ({ pv, fb } = await this.readPreview(ctx, tIn.address, tOut.address, amountIn, userMinOut));
+      ({ pv, fb } = await this.readPreview(ctx, tIn.address, tOut.address, amountIn, userMinOut, at));
       assertExecutable(pv, tIn.address, tOut.address);
-      minOut = maxBig(minOutFor(pv.netOut, slippageBps, pv.effectiveMinOut), userMinOut);
+      minOut = await settleMin(pv);
       if (mode === "best") {
         entry = "swapBestExactIn";
         data = encodeSwapBestExactIn(tIn.address, tOut.address, amountIn, minOut, recipient, deadline);
@@ -6104,7 +6170,8 @@ var BlazePhoenix = class {
       slippageBps,
       approval,
       unwrapAfter: tOut.native,
-      steps: approval ? [approval.tx, tx] : [tx]
+      steps: approval ? [approval.tx, tx] : [tx],
+      ...exactOut !== void 0 ? { exactOut } : {}
     };
   }
   /** eth_call the swap from `from` on your RPC: the realised amountOut if it
@@ -6170,6 +6237,12 @@ var BlazePhoenix = class {
         if (r.status !== "success") throw new BlazeError("reverted", `approval transaction reverted (${approvalHash})`);
       }
       plan = { ...plan, approval: { ...plan.approval, current: plan.approval.amount } };
+      if (Date.now() - plan.quote.quotedAt > maxAge) {
+        if (!req) {
+          throw new BlazeError("bad_request", `plan went older than ${maxAge}ms while the approval confirmed${approvalHash ? ` (${approvalHash})` : ""} \u2014 the swap was NOT sent; rebuild the plan, or pass \`request\` so it can be rebuilt`);
+        }
+        plan = await this.buildSwap({ ...req, from: req.from ?? account.address });
+      }
     }
     if (opts.simulate ?? true) {
       const sim = await this.simulate(plan, account.address);
@@ -6339,6 +6412,17 @@ function checkDeadlineSec(n) {
   return n;
 }
 var maxBig = (a, b) => a > b ? a : b;
+var EXACT_MARGIN_BPS = 50;
+function samePath(a, b) {
+  const eqA = (x, y) => x.toLowerCase() === y.toLowerCase();
+  return a.hops.length === b.hops.length && a.hops.every((h, i) => {
+    const g = b.hops[i];
+    return eqA(h.tokenIn, g.tokenIn) && eqA(h.tokenOut, g.tokenOut) && h.legs.length === g.legs.length && h.legs.every((l, j) => {
+      const m = g.legs[j];
+      return eqA(l.pool, m.pool) && eqA(l.hooks, m.hooks) && l.kind === m.kind && l.fee === m.fee && l.tickSpacing === m.tickSpacing && l.zeroForOne === m.zeroForOne && l.stable === m.stable;
+    });
+  });
+}
 function deepLink(opts = {}) {
   const base = (opts.baseUrl ?? "https://blazephoenix.xyz").replace(/\/+$/, "");
   const sp = new URLSearchParams();