@piprail/sdk 1.3.1 → 1.5.0

package/dist/index.js

@@ -20,7 +20,7 @@ import {
   parseUnits,
   rejectForeignToken,
   toInsufficientFundsError
-} from "./chunk-AGKC3C7Y.js";
+} from "./chunk-QDS6FBZP.js";
 
 // src/drivers/registry.ts
 var byFamily = /* @__PURE__ */ new Map();
@@ -40,6 +40,7 @@ function familyForChain(chain) {
     if (chain.startsWith("sui")) return "sui";
     if (chain.startsWith("near")) return "near";
     if (chain.startsWith("aptos")) return "aptos";
+    if (chain.startsWith("algorand")) return "algorand";
     return "evm";
   }
   return "evm";
@@ -62,7 +63,7 @@ function resolveNetwork(opts) {
 }
 
 // src/drivers/evm/index.ts
-import { BaseError, createPublicClient, getAddress as getAddress2, http as http2, isAddress } from "viem";
+import { BaseError, createPublicClient, erc20Abi as erc20Abi3, getAddress as getAddress2, http as http2, isAddress } from "viem";
 
 // src/drivers/evm/chains.ts
 import { defineChain } from "viem";
@@ -715,6 +716,27 @@ function makeEvmNetwork(resolved) {
         });
       }
     },
+    async balanceOf(wallet, asset) {
+      const owner = wallet._native.account.address;
+      const native = await publicClient.getBalance({ address: owner }).catch(() => null);
+      if (asset === "native") return { token: native, native };
+      let token = null;
+      try {
+        token = await publicClient.readContract({
+          address: getAddress2(asset),
+          abi: erc20Abi3,
+          functionName: "balanceOf",
+          args: [owner]
+        });
+      } catch {
+        token = null;
+      }
+      return { token, native };
+    },
+    // EVM has no receive prerequisite — any 0x address receives native or ERC-20 immediately.
+    async recipientReady() {
+      return { ready: "n/a" };
+    },
     async verify(ref, accept) {
       return verifyEvm({
         publicClient,
@@ -738,7 +760,7 @@ var loaders = {
   solana: async () => {
     let mod;
     try {
-      mod = await import("./solana-37F2PR5H.js");
+      mod = await import("./solana-7WJVZGDW.js");
     } catch (cause) {
       throw new MissingDriverError(
         `Solana selected, but its packages aren't installed. Run: npm install @solana/web3.js @solana/spl-token bs58`,
@@ -750,7 +772,7 @@ var loaders = {
   ton: async () => {
     let mod;
     try {
-      mod = await import("./ton-NIDWF77T.js");
+      mod = await import("./ton-DGZB7W4U.js");
     } catch (cause) {
       throw new MissingDriverError(
         `TON selected, but its packages aren't installed. Run: npm install @ton/ton @ton/core @ton/crypto`,
@@ -762,7 +784,7 @@ var loaders = {
   stellar: async () => {
     let mod;
     try {
-      mod = await import("./stellar-ALOVOMFD.js");
+      mod = await import("./stellar-HV6VGZX3.js");
     } catch (cause) {
       throw new MissingDriverError(
         `Stellar selected, but its package isn't installed. Run: npm install @stellar/stellar-sdk`,
@@ -774,7 +796,7 @@ var loaders = {
   xrpl: async () => {
     let mod;
     try {
-      mod = await import("./xrpl-6ODQS7JR.js");
+      mod = await import("./xrpl-UEC2GYVV.js");
     } catch (cause) {
       throw new MissingDriverError(
         `XRPL selected, but its package isn't installed. Run: npm install xrpl`,
@@ -786,7 +808,7 @@ var loaders = {
   tron: async () => {
     let mod;
     try {
-      mod = await import("./tron-LPMK57H7.js");
+      mod = await import("./tron-RLIL2FDI.js");
     } catch (cause) {
       throw new MissingDriverError(
         `Tron selected, but its package isn't installed. Run: npm install tronweb`,
@@ -798,7 +820,7 @@ var loaders = {
   sui: async () => {
     let mod;
     try {
-      mod = await import("./sui-OLC5ID4X.js");
+      mod = await import("./sui-2WFWVFJX.js");
     } catch (cause) {
       throw new MissingDriverError(
         `Sui selected, but its package isn't installed. Run: npm install @mysten/sui`,
@@ -810,7 +832,7 @@ var loaders = {
   near: async () => {
     let mod;
     try {
-      mod = await import("./near-YX3XOASO.js");
+      mod = await import("./near-7MBBCDUE.js");
     } catch (cause) {
       throw new MissingDriverError(
         `NEAR selected, but its package isn't installed. Run: npm install near-api-js`,
@@ -822,7 +844,7 @@ var loaders = {
   aptos: async () => {
     let mod;
     try {
-      mod = await import("./aptos-DTAONNMM.js");
+      mod = await import("./aptos-YQWTGFRZ.js");
     } catch (cause) {
       throw new MissingDriverError(
         `Aptos selected, but its package isn't installed. Run: npm install @aptos-labs/ts-sdk`,
@@ -830,6 +852,18 @@ var loaders = {
       );
     }
     registerDriver(mod.aptosDriver);
+  },
+  algorand: async () => {
+    let mod;
+    try {
+      mod = await import("./algorand-B67G4335.js");
+    } catch (cause) {
+      throw new MissingDriverError(
+        `Algorand selected, but its package isn't installed. Run: npm install algosdk`,
+        { cause }
+      );
+    }
+    registerDriver(mod.algorandDriver);
   }
 };
 var inFlight = /* @__PURE__ */ new Map();
@@ -963,6 +997,12 @@ var SpendLedger = class {
 };
 
 // src/client.ts
+var RECIPIENT_FIX = {
+  NO_TRUSTLINE: "the recipient needs a one-time trustline for this asset before it can receive",
+  NOT_REGISTERED: "the recipient must be storage_deposit-registered on this token (NEP-145, one-time)",
+  NOT_OPTED_IN: "the recipient must opt into this asset once (a 0-amount self-transfer)",
+  INACTIVE: "the recipient account doesn't exist yet \u2014 fund it with the chain's base reserve to activate it"
+};
 var PipRailClient = class {
   opts;
   maxRetries;
@@ -1071,6 +1111,44 @@ var PipRailClient = class {
   spent() {
     return this.ledger.summary();
   }
+  /**
+   * Plan a payment for a gated URL — WITHOUT paying. The read-only completion of
+   * the `quote()` → `estimateCost()` → **`planPayment()`** trio: it surveys every
+   * rail the 402 offers on this client's chain against the wallet's OWN holdings —
+   * token balance, native-coin gas, and recipient-readiness (trustline / ATA /
+   * storage_deposit / ASA opt-in) — and returns, crystal-clear:
+   *   - `payable` + `best`   — the cheapest rail the wallet can actually settle
+   *   - `options[]`          — every rail with typed `blockers` + soft `warnings`
+   *   - `fundingHint`        — one human sentence on exactly what to top up
+   *
+   * NEVER throws for a read problem (a transient/RPC failure surfaces as a rail in
+   * `state: 'unknown'` + a warning, never a false "unaffordable"); returns `null`
+   * when the URL isn't payment-gated (no 402); and when the 402 offers no rail on
+   * this client's chain it EXPLAINS that (status `blocked` + a hint), rather than
+   * throwing. Throws `InvalidEnvelopeError` only on an unparseable challenge.
+   *
+   * Then pay the chosen rail with `fetch(url, { autoRoute: true })`, or branch on
+   * the plan yourself. No funds move.
+   */
+  async planPayment(url, init) {
+    const res = await fetch(url, { ...init ?? {}, method: init?.method ?? "GET" });
+    if (res.status !== 402) return null;
+    const challenge = await parseChallenge(res);
+    if (!challenge) {
+      throw new InvalidEnvelopeError("402 response did not include a parseable x402 challenge.");
+    }
+    const { net, wallet } = await this.ensure();
+    return this.planFromChallenge(net, wallet, challenge, url);
+  }
+  /**
+   * Convenience over {@link planPayment}: can the wallet settle this URL right now?
+   * `true` when at least one rail is payable — or when the URL isn't gated (a free
+   * resource is trivially "affordable"). No funds move.
+   */
+  async canAfford(url, init) {
+    const plan = await this.planPayment(url, init);
+    return plan == null ? true : plan.payable;
+  }
   /**
    * Lower-level: drive any HTTP method through the 402 flow.
    *
@@ -1087,10 +1165,19 @@ var PipRailClient = class {
     }
     const firstResponse = await fetch(url, init);
     if (firstResponse.status !== 402) return firstResponse;
-    const { net, wallet, accept, challenge, quote } = await this.resolveChallenge(
-      url,
-      firstResponse
-    );
+    const resolved = await this.resolveChallenge(url, firstResponse);
+    const { net, wallet, challenge } = resolved;
+    let accept = resolved.accept;
+    let quote = resolved.quote;
+    const autoRoute = init?.autoRoute ?? this.opts.autoRoute ?? false;
+    if (autoRoute) {
+      const plan = await this.planFromChallenge(net, wallet, challenge, url);
+      if (!plan.best) {
+        throw new PaymentDeclinedError(plan.fundingHint ?? "No rail is settleable for this payment.");
+      }
+      accept = plan.best.accept;
+      quote = plan.best.quote;
+    }
     this.safeEmit({ kind: "payment-required", challenge, accept });
     await this.authorize(quote);
     const { ref, confirmed } = await this.payAndConfirm(net, wallet, accept);
@@ -1112,9 +1199,7 @@ var PipRailClient = class {
       );
     }
     const { net, wallet } = await this.ensure();
-    const candidates = challenge.accepts.filter(
-      (a) => a.scheme === "onchain-proof" && net.supports(a.network)
-    );
+    const candidates = this.gatherCandidates(net, challenge);
     if (candidates.length === 0) {
       const networks = challenge.accepts.map((a) => a.network).join(", ");
       throw new NoCompatibleAcceptError(
@@ -1128,6 +1213,111 @@ var PipRailClient = class {
     const chosen = priced.find((p) => p.quote.withinPolicy) ?? priced[0];
     return { net, wallet, accept: chosen.accept, challenge, quote: chosen.quote };
   }
+  /** The candidate accepts this client could pay: our scheme, on the bound network. */
+  gatherCandidates(net, challenge) {
+    return challenge.accepts.filter(
+      (a) => a.scheme === "onchain-proof" && net.supports(a.network)
+    );
+  }
+  /** Build the full {@link PaymentPlan} from an already-parsed challenge + bound
+   *  net/wallet. Shared by `planPayment` (read-only) and `fetch`'s autoRoute. */
+  async planFromChallenge(net, wallet, challenge, url) {
+    const chainLabel = typeof this.opts.chain === "string" ? this.opts.chain : net.network;
+    const candidates = this.gatherCandidates(net, challenge);
+    if (candidates.length === 0) {
+      const offered = [...new Set(challenge.accepts.map((a) => a.network))].join(", ") || "none";
+      return {
+        url,
+        network: net.network,
+        status: "blocked",
+        payable: false,
+        best: null,
+        options: [],
+        fundingHint: `This 402 isn't offered on your chain (${chainLabel}); it's payable on: ${offered}.`
+      };
+    }
+    const analysed = await Promise.all(
+      candidates.map(
+        (accept) => this.analyzeRail(net, wallet, accept, url, challenge.resource.description)
+      )
+    );
+    const options = rankOptions(analysed);
+    const best = options.find((o) => o.state === "payable") ?? null;
+    const status = best ? "ready" : options.some((o) => o.state === "unknown") ? "unknown" : "blocked";
+    return {
+      url,
+      network: net.network,
+      status,
+      payable: best !== null,
+      best,
+      options,
+      fundingHint: best ? null : buildFundingHint(options, chainLabel)
+    };
+  }
+  /** Analyse ONE rail against the wallet's holdings — quote (existing) + gas
+   *  (estimateCost, existing) + balanceOf + recipientReady → a {@link PayOption}. */
+  async analyzeRail(net, wallet, accept, url, description) {
+    const quote = this.buildQuote(net, accept, url, description);
+    const cost = await net.estimateCost(accept);
+    const bal = await net.balanceOf(wallet, accept.asset).catch(() => ({ token: null, native: null }));
+    const rr = await net.recipientReady(accept.payTo, accept.asset).catch(() => ({ ready: "unknown" }));
+    const amount = BigInt(accept.amount);
+    const fee = safeBig(cost.fee);
+    const isNative = accept.asset === "native";
+    const blockers = [];
+    const warnings = [];
+    const shortfall = {};
+    if (!quote.withinPolicy) blockers.push("OUTSIDE_POLICY");
+    if (quote.symbolMismatch) warnings.push("SYMBOL_MISMATCH");
+    if (cost.basis === "heuristic") warnings.push("GAS_HEURISTIC");
+    const tokenKnown = bal.token != null;
+    const nativeKnown = bal.native != null;
+    if (!tokenKnown || !nativeKnown) warnings.push("BALANCE_UNREADABLE");
+    if (isNative) {
+      if (nativeKnown && bal.native < amount + fee) {
+        blockers.push("INSUFFICIENT_TOKEN");
+        shortfall.token = formatUnits(amount + fee - bal.native, quote.decimals);
+      }
+    } else {
+      if (tokenKnown && bal.token < amount) {
+        blockers.push("INSUFFICIENT_TOKEN");
+        shortfall.token = formatUnits(amount - bal.token, quote.decimals);
+      }
+      if (nativeKnown && bal.native < fee) {
+        blockers.push("INSUFFICIENT_GAS");
+        shortfall.native = formatUnits(fee - bal.native, cost.feeDecimals);
+      } else if (nativeKnown && fee > 0n && bal.native < fee * 3n / 2n) {
+        warnings.push("THIN_GAS_MARGIN");
+      }
+    }
+    let recipient;
+    if (rr.ready === false) {
+      blockers.push("RECIPIENT_NOT_READY");
+      recipient = rr.reason ? { ready: false, reason: rr.reason, fix: RECIPIENT_FIX[rr.reason] } : { ready: false };
+    } else if (rr.ready === "unknown") {
+      warnings.push("RECIPIENT_READINESS_UNKNOWN");
+      recipient = { ready: "unknown" };
+    } else {
+      recipient = { ready: rr.ready };
+    }
+    const unreadable = isNative ? !nativeKnown : !tokenKnown || !nativeKnown;
+    const state = blockers.length ? "blocked" : unreadable || rr.ready === "unknown" ? "unknown" : "payable";
+    return {
+      accept,
+      quote,
+      cost,
+      state,
+      blockers,
+      warnings,
+      balance: {
+        token: bal.token != null ? formatUnits(bal.token, quote.decimals) : null,
+        native: bal.native != null ? formatUnits(bal.native, cost.feeDecimals) : null
+      },
+      need: { token: quote.amountFormatted, native: cost.feeFormatted },
+      ...shortfall.token || shortfall.native ? { shortfall } : {},
+      recipient
+    };
+  }
   /** Build the agent-facing quote for an accept: TRUE decimals/symbol (via the
    *  driver's describeAsset) + the policy verdict + a symbol-mismatch flag. */
   buildQuote(net, accept, url, description) {
@@ -1300,6 +1490,68 @@ var PipRailClient = class {
     );
   }
 };
+function safeBig(s) {
+  try {
+    return BigInt(s);
+  } catch {
+    return 0n;
+  }
+}
+function shortAddr(a) {
+  return a.length > 14 ? `${a.slice(0, 8)}\u2026${a.slice(-4)}` : a;
+}
+function rankOptions(options) {
+  const rank = { payable: 0, unknown: 1, blocked: 2 };
+  return [...options].sort((a, b) => {
+    if (rank[a.state] !== rank[b.state]) return rank[a.state] - rank[b.state];
+    if (a.state === "payable") {
+      const fa = safeBig(a.cost.fee);
+      const fb = safeBig(b.cost.fee);
+      if (fa !== fb) return fa < fb ? -1 : 1;
+    }
+    return 0;
+  });
+}
+function buildFundingHint(options, chainLabel) {
+  if (options.length === 0) return null;
+  const target = [...options].sort((a, b) => a.blockers.length - b.blockers.length)[0];
+  const sym = target.quote.symbol ?? "the token";
+  if (target.blockers.includes("RECIPIENT_NOT_READY")) {
+    return `Recipient ${shortAddr(target.accept.payTo)} can't receive on ${chainLabel} yet \u2014 ${target.recipient.fix ?? "recipient not ready"}.`;
+  }
+  if (target.blockers.includes("OUTSIDE_POLICY")) {
+    return `Refused by spend policy: ${target.quote.policyReason ?? "not allowed"}.`;
+  }
+  if (target.state === "unknown") {
+    return `Couldn't fully read your wallet on ${chainLabel} (RPC throttled) \u2014 retry; you may already be able to pay ${target.quote.amountFormatted} ${sym}.`;
+  }
+  const parts = [];
+  if (target.blockers.includes("INSUFFICIENT_TOKEN") && target.shortfall?.token) {
+    parts.push(`top up ${target.shortfall.token} ${sym}`);
+  }
+  if (target.blockers.includes("INSUFFICIENT_GAS") && target.shortfall?.native) {
+    parts.push(`add ~${target.shortfall.native} ${target.cost.feeSymbol} for gas`);
+  }
+  return parts.length ? `Can't settle on ${chainLabel}: ${parts.join(" and ")} (to pay ${target.quote.amountFormatted} ${sym}).` : `Can't settle on ${chainLabel} for ${target.quote.amountFormatted} ${sym}.`;
+}
+async function planAcross(clients, url, init) {
+  const plans = await Promise.all(clients.map((c) => c.planPayment(url, init).catch(() => null)));
+  const live = plans.filter((p) => p != null);
+  if (live.length === 0) return null;
+  const options = rankOptions(live.flatMap((p) => p.options));
+  const best = options.find((o) => o.state === "payable") ?? null;
+  const status = best ? "ready" : options.some((o) => o.state === "unknown") ? "unknown" : "blocked";
+  return {
+    url,
+    network: best?.accept.network ?? live[0].network,
+    status,
+    payable: best !== null,
+    best,
+    options,
+    // First non-null hint across clients — each already names its chain.
+    fundingHint: best ? null : live.map((p) => p.fundingHint).find(Boolean) ?? null
+  };
+}
 function hostOf(url) {
   try {
     return new URL(url).hostname;
@@ -1359,6 +1611,44 @@ function paymentTools(client) {
         return quote ? { gated: true, ...quote } : { gated: false, url: String(args.url) };
       }
     },
+    {
+      name: "piprail_plan_payment",
+      description: "Check whether you CAN pay an x402-gated URL before paying. Reads your wallet balance, native gas, and whether the recipient can receive \u2014 across every rail the URL offers on your chain \u2014 and returns { gated, payable, best, options, fundingHint }. payable:false means do NOT attempt the payment; fundingHint says exactly what to top up. Call this before piprail_pay_request so you never commit to a payment you cannot finish. Returns { gated: false } when no payment is needed.",
+      parameters: {
+        type: "object",
+        properties: {
+          url: { type: "string", description: "Full URL of the gated resource." }
+        },
+        required: ["url"],
+        additionalProperties: false
+      },
+      invoke: async (args) => {
+        const plan = await client.planPayment(String(args.url));
+        if (plan == null) return { gated: false, url: String(args.url) };
+        return {
+          gated: true,
+          payable: plan.payable,
+          status: plan.status,
+          fundingHint: plan.fundingHint,
+          best: plan.best ? {
+            network: plan.best.accept.network,
+            symbol: plan.best.quote.symbol,
+            amount: plan.best.quote.amountFormatted,
+            gasCoin: plan.best.cost.feeSymbol,
+            gas: plan.best.cost.feeFormatted
+          } : null,
+          options: plan.options.map((o) => ({
+            network: o.accept.network,
+            symbol: o.quote.symbol,
+            amount: o.quote.amountFormatted,
+            state: o.state,
+            blockers: o.blockers,
+            warnings: o.warnings,
+            recipientReady: o.recipient.ready
+          }))
+        };
+      }
+    },
     {
       name: "piprail_pay_request",
       description: "Fetch an x402 payment-gated URL, automatically paying the required on-chain payment if needed (subject to the spend policy + approval hook). Returns the HTTP status, the response body, and a payment receipt if one settled. If the payment is refused by policy or the approval hook, returns { declined: true, reason } \u2014 no funds moved.",
@@ -1725,6 +2015,7 @@ export {
   parseSignatureHeader,
   paymentTools,
   pickAccept,
+  planAcross,
   registerDriver,
   requirePayment,
   resolveChain,

package/dist/{near-YX3XOASO.js → near-7MBBCDUE.js}

@@ -7,7 +7,7 @@ import {
   nativeCost,
   rejectForeignToken,
   toInsufficientFundsError
-} from "./chunk-AGKC3C7Y.js";
+} from "./chunk-QDS6FBZP.js";
 
 // src/drivers/near/index.ts
 import { JsonRpcProvider, Account, actions } from "near-api-js";
@@ -400,6 +400,56 @@ function makeNearNetwork(preset, rpcUrl) {
         detail: "~14 TGas for ft_transfer (\u22480.0015 NEAR) + 1 yoctoNEAR deposit"
       });
     },
+    async balanceOf(wallet, asset) {
+      let accountId;
+      try {
+        accountId = resolveNearWallet(wallet._native).accountId;
+      } catch {
+        return { token: null, native: null };
+      }
+      let native = null;
+      try {
+        const r = await provider.query({
+          request_type: "view_account",
+          finality: "final",
+          account_id: accountId
+        });
+        native = r.amount != null ? BigInt(r.amount) : null;
+      } catch (e) {
+        native = /does not exist|UNKNOWN_ACCOUNT/i.test(String(e?.message ?? e)) ? 0n : null;
+      }
+      if (asset === "native") return { token: native, native };
+      let token = null;
+      try {
+        const r = await provider.query({
+          request_type: "call_function",
+          finality: "final",
+          account_id: asset,
+          method_name: "ft_balance_of",
+          args_base64: Buffer.from(JSON.stringify({ account_id: accountId })).toString("base64")
+        });
+        token = r.result ? BigInt(JSON.parse(Buffer.from(r.result).toString())) : null;
+      } catch (e) {
+        token = /does not exist|not registered|UNKNOWN_ACCOUNT/i.test(String(e?.message ?? e)) ? 0n : null;
+      }
+      return { token, native };
+    },
+    async recipientReady(payTo, asset) {
+      if (asset === "native") return { ready: "n/a" };
+      try {
+        const r = await provider.query({
+          request_type: "call_function",
+          finality: "final",
+          account_id: asset,
+          method_name: "storage_balance_of",
+          args_base64: Buffer.from(JSON.stringify({ account_id: payTo })).toString("base64")
+        });
+        const parsed = r.result ? JSON.parse(Buffer.from(r.result).toString()) : null;
+        return parsed == null ? { ready: false, reason: "NOT_REGISTERED" } : { ready: true };
+      } catch {
+        return { ready: "unknown" };
+      }
+    },
     async verify(ref, accept) {
       const { senderId, hash } = decodeRef(ref);
       return verifyNear({ reader, hash, senderId, accept });