@blazephoenix/sdk 1.0.1 → 1.1.0

package/README.md

@@ -13,6 +13,31 @@ npm i @blazephoenix/sdk viem
 # or straight from GitHub (builds on install):  npm i github:blazephoenixxyz-crypto/SDK viem
 ```
 
+## BlazePhoenix in one sentence
+
+BlazePhoenix is the fully on-chain DEX aggregator — the route is computed inside the transaction that executes it — paired with an oracle-free staking engine that proves its own solvency on every transaction. It runs on Base, Ethereum, Optimism, Arbitrum and Robinhood Chain.
+
+**Swap** in the [app](https://blazephoenix.xyz/?tab=swap) · **integrate** with the [SDK](https://github.com/blazephoenixxyz-crypto/SDK) (`npm i @blazephoenix/sdk`) · **connect an agent** to the [MCP server](https://github.com/blazephoenixxyz-crypto/blazephoenix-mcp) (`https://blazephoenix.xyz/mcp`, no key)
+
+## Reading guide by level
+
+- **New to DeFi:** [BlazePhoenix in five minutes](https://blazephoenix.xyz/learn/blazephoenix-in-five-minutes), then [What is a DEX aggregator](https://blazephoenix.xyz/learn/what-is-a-dex-aggregator) and [How to swap tokens safely](https://blazephoenix.xyz/learn/how-to-swap-safely).
+- **Comfortable with swaps:** [Anatomy of a DEX aggregator](https://blazephoenix.xyz/learn/anatomy-of-an-aggregator) and [BlazePhoenix vs the established aggregators](https://blazephoenix.xyz/learn/how-we-compare).
+- **Engineers and researchers:** the [Technical Whitepaper v2.3](https://blazephoenix.xyz/whitepaper.md) (DOI [10.5281/zenodo.23084091](https://doi.org/10.5281/zenodo.23084091)), the contract source in [Blaze-Phoenix-Dex](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex) and [Blaze-Phoenix-Staking](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Staking), and [On-chain quoting](https://blazephoenix.xyz/learn/on-chain-quoting).
+- **Models and agents:** [https://blazephoenix.xyz/llms.txt](https://blazephoenix.xyz/llms.txt) and the [reading guide](https://blazephoenix.xyz/reading-guide.md).
+
+## Trust and verification
+
+Each item links to the place where it can be checked. The full list is at [https://blazephoenix.xyz/trust](https://blazephoenix.xyz/trust).
+
+- **Verified contracts:** source-verified on Sourcify and the chain explorers; every address per chain at [/api/deployments](https://blazephoenix.xyz/api/deployments).
+- **Source available:** the contract source is public under the [Business Source License 1.1](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex/blob/main/LICENSE), converting to GPL-2.0-or-later on 2030-06-01.
+- **Public CI:** [GitHub Actions](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex/actions) on every push, including the Certora Prover and Halmos.
+- **Bug bounty:** a [public programme](https://blazephoenix.xyz/bounty) with [credited researchers](https://blazephoenix.xyz/security/researchers) and [published advisories](https://blazephoenix.xyz/security/advisories).
+- **Whitepaper DOI:** [10.5281/zenodo.23084091](https://doi.org/10.5281/zenodo.23084091); papers timestamped with [OpenTimestamps](https://blazephoenix.xyz/provenance/provenance.json).
+- **Contact:** contact@blazephoenix.xyz ([security.txt](https://blazephoenix.xyz/.well-known/security.txt)); official channels at [/official](https://blazephoenix.xyz/official).
+- **Audit status:** an independent external audit is scheduled before launch.
+
 ## Quote → build → execute
 
 ```ts
@@ -91,17 +116,20 @@ The SDK adapts to what each version can do (`featuresOf(version)`):
 | on-chain `batchQuote` | parallel previews | ✅ chunked |
 | `ExecutionProof` on every fill (quoted vs realised vs floor) | — | ✅ |
 
-### New deployments reach you without a new SDK release
+### Only pinned addresses are routed to by default
 
 The registry has three layers:
 
 1. **Embedded** — shipped in the package. Non-zero addresses are **pins**: nothing fetched
-   at runtime can move them.
+   at runtime can move them, and by default they are the only Router and Quoter addresses
+   a quote or a swap uses. A new deployment reaches you with a new SDK release.
 2. **Remote** — `GET https://blazephoenix.xyz/api/deployments` (static JSON, refreshed every
    10 min in the background; the first lookup waits at most 3 s). It can only fill what the
    snapshot doesn't know — e.g. the 2.0.0 addresses the day they are deployed — and only for
-   versions that can be verified on-chain (2.x+). Every remote-sourced set is **verified on
-   your RPC before first use**:
+   versions that can be verified on-chain (2.x+). Those versions are listed, but routed to
+   only with `registry: { remoteVersions: true }`: the on-chain check reads the entry's own
+   contracts, so it cannot tell a real deployment from a look-alike. With the opt-in, every
+   remote-sourced set is still **verified on your RPC before first use**:
    code at every address, `VERSION()` matches, and the Quoter, Router and Solver all point at
    the same Hub and Solver. Anything else fails closed (`deployment_unverified`).
 3. **Your overrides** — always win:

package/dist/index.cjs

@@ -5356,6 +5356,7 @@ var Registry = class {
   fetchedAt = 0;
   lastError;
   mode;
+  remoteVersions;
   url;
   ttlMs;
   fetchFn;
@@ -5364,6 +5365,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;
@@ -5495,7 +5497,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] } : {
@@ -5515,9 +5517,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 } }
       );
     }
@@ -5526,6 +5529,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;
@@ -5773,16 +5781,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) {
@@ -6172,6 +6183,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);