@blazephoenix/sdk 1.2.1 → 1.3.0

package/dist/index.d.cts

@@ -201,6 +201,13 @@ interface SwapRequest extends QuoteRequest {
     recipient: Address;
     /** The account that will send the swap — enables the allowance check and simulation. */
     from?: Address;
+    /** With `from`: eth_call the built swap from that account before returning it, and fail closed
+     *  (`not_executable`, no plan) on a revert. The Quoter's `canExecute` is swap math; whether these
+     *  bytes settle for the payer is answered only by that call.
+     *  Exception: while the Router still needs its approval, no eth_call is made. The plan comes back
+     *  with `simulation: { ok: false, error.name: 'allowance' }`; send the approval, then `simulate()`
+     *  again from the payer before sending the swap (`execute()` does this). */
+    simulate?: boolean;
     /** Default 50 (0.5%). minOut = netOut − slippage, never below the on-chain floor. */
     slippageBps?: number;
     /** Seconds from now (default 120, 10–3600) — or pass an absolute `deadline`. */
@@ -234,6 +241,11 @@ interface ApprovalStep {
 }
 interface SwapPlan {
     quote: Quote;
+    /** Present when built with `simulate: true`. Either the Router's eth_call from `from` settled
+     *  (`ok: true`, `amountOut`), or no eth_call was made because the approval is still missing
+     *  (`ok: false`, `error.name: 'allowance'`): approve, then `simulate()` again. A revert never
+     *  reaches here; it is thrown as `not_executable`. */
+    simulation?: SimulationResult;
     entry: 'swapExactIn' | 'swapExactInNative' | 'swapBestExactIn';
     /** 'quoter': the bytes are the Quoter's own previewAndEncode output (2.x),
      *  verified field-by-field against what you asked; 'sdk': encoded locally. */
@@ -249,7 +261,7 @@ interface SwapPlan {
     unwrapAfter: boolean;
     /** Ordered transactions to send: [approval?, swap]. */
     steps: TxRequest[];
-    /** With `exact: true`: the previewPlanExact output minOut was derived from. */
+    /** With `exact: true`: the NET previewPlanExact output used to derive `minOut`. */
     exactOut?: bigint;
 }
 interface SimulationResult {

package/dist/index.d.ts

@@ -201,6 +201,13 @@ interface SwapRequest extends QuoteRequest {
     recipient: Address;
     /** The account that will send the swap — enables the allowance check and simulation. */
     from?: Address;
+    /** With `from`: eth_call the built swap from that account before returning it, and fail closed
+     *  (`not_executable`, no plan) on a revert. The Quoter's `canExecute` is swap math; whether these
+     *  bytes settle for the payer is answered only by that call.
+     *  Exception: while the Router still needs its approval, no eth_call is made. The plan comes back
+     *  with `simulation: { ok: false, error.name: 'allowance' }`; send the approval, then `simulate()`
+     *  again from the payer before sending the swap (`execute()` does this). */
+    simulate?: boolean;
     /** Default 50 (0.5%). minOut = netOut − slippage, never below the on-chain floor. */
     slippageBps?: number;
     /** Seconds from now (default 120, 10–3600) — or pass an absolute `deadline`. */
@@ -234,6 +241,11 @@ interface ApprovalStep {
 }
 interface SwapPlan {
     quote: Quote;
+    /** Present when built with `simulate: true`. Either the Router's eth_call from `from` settled
+     *  (`ok: true`, `amountOut`), or no eth_call was made because the approval is still missing
+     *  (`ok: false`, `error.name: 'allowance'`): approve, then `simulate()` again. A revert never
+     *  reaches here; it is thrown as `not_executable`. */
+    simulation?: SimulationResult;
     entry: 'swapExactIn' | 'swapExactInNative' | 'swapBestExactIn';
     /** 'quoter': the bytes are the Quoter's own previewAndEncode output (2.x),
      *  verified field-by-field against what you asked; 'sdk': encoded locally. */
@@ -249,7 +261,7 @@ interface SwapPlan {
     unwrapAfter: boolean;
     /** Ordered transactions to send: [approval?, swap]. */
     steps: TxRequest[];
-    /** With `exact: true`: the previewPlanExact output minOut was derived from. */
+    /** With `exact: true`: the NET previewPlanExact output used to derive `minOut`. */
     exactOut?: bigint;
 }
 interface SimulationResult {

package/dist/index.js

@@ -5161,9 +5161,9 @@ var EMBEDDED_DEPLOYMENTS = {
     {
       version: "2.0.0",
       status: "pending",
-      source: "blazephoenixxyz-crypto/Blaze-Phoenix-Dex@07c8563",
+      source: "blazephoenixxyz-crypto/Blaze-Phoenix-Dex@f746a48",
       notes: "Final generation (Core/Hub/Solver/Quoter/Router). Addresses arrive through the registry the day they are deployed.",
-      chains: { 8453: pending(), 1: pending(), 10: pending(), 42161: pending(), 4663: pending() }
+      chains: { 8453: pending(), 10: pending(), 42161: pending(), 4663: pending() }
     },
     {
       version: "1.0.0",
@@ -5656,6 +5656,9 @@ function fromBaseUnits(v, decimals, maxDp) {
 var HEX_ADDR2 = /^0x[0-9a-fA-F]{40}$/;
 var INT = /^\d{1,78}$/;
 var UINT128_MAX = (1n << 128n) - 1n;
+function netExactOutput(version, exactOut) {
+  return featuresOf(version).previewAndEncode ? exactOut : exactOut - (exactOut * BigInt(FEE_BPS) + 9999n) / 10000n;
+}
 var BlazePhoenix = class {
   registry;
   rpc;
@@ -5935,7 +5938,7 @@ var BlazePhoenix = class {
         args: [tIn.address, tOut.address, amountIn],
         ...req.blockNumber !== void 0 ? { blockNumber: req.blockNumber } : {}
       });
-      const net = featuresOf(ctx.dep.version).previewAndEncode ? exactOut : exactOut - (exactOut * BigInt(FEE_BPS) + 9999n) / 10000n;
+      const net = netExactOutput(ctx.dep.version, exactOut);
       return {
         chainId: ctx.chainId,
         version: ctx.dep.version,
@@ -6078,8 +6081,8 @@ var BlazePhoenix = class {
       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];
+      exactOut = netExactOutput(ctx.dep.version, ex[1]);
+      return exactOut;
     };
     const settleMin = async (p) => {
       let floor = minOutFor(p.netOut, slippageBps, p.ironFloor);
@@ -6179,7 +6182,7 @@ var BlazePhoenix = class {
       }
     }
     const quote = this.buildQuote(ctx, tIn, tOut, amountIn, pv, fb);
-    return {
+    const plan = {
       quote,
       entry,
       encodedBy,
@@ -6193,6 +6196,18 @@ var BlazePhoenix = class {
       steps: approval ? [approval.tx, tx] : [tx],
       ...exactOut !== void 0 ? { exactOut } : {}
     };
+    if (!req.simulate) return plan;
+    if (!from) throw new BlazeError("bad_request", "simulate: true needs `from` (the account that will send the swap)");
+    const simulation = await this.simulate(plan, from);
+    if (!simulation.ok && simulation.error?.name !== "allowance") {
+      const err = simulation.error;
+      throw new BlazeError(
+        "not_executable",
+        `the Router refuses these bytes from ${from}: ${err?.name ?? "revert"}${err?.code !== void 0 ? `(${err.code})` : ""} \u2014 ${err?.reason ?? "execution reverted"}`,
+        { details: { from, error: err } }
+      );
+    }
+    return { ...plan, simulation };
   }
   /** eth_call the swap from `from` on your RPC: the realised amountOut if it
    *  would settle now, or the decoded reason it would revert. */