@anywalletkit/protocol-swap2-core 0.4.0 → 0.5.0

package/dist/index.cjs

@@ -54,6 +54,7 @@ __export(src_exports, {
   remoteProvider: () => remoteProvider,
   shortAddress: () => shortAddress,
   slippageClassOf: () => slippageClassOf,
+  sourceAssetOf: () => sourceAssetOf,
   suggestSlippage: () => suggestSlippage,
   swap2ChainId: () => swap2ChainId,
   validQuote: () => validQuote
@@ -158,6 +159,7 @@ function validQuote(q, params, provider) {
 }
 
 // src/util.ts
+var import_swap2_assets = require("@anywalletkit/swap2-assets");
 function namespace(chain) {
   return chain.split(":")[0] ?? "";
 }
@@ -190,6 +192,10 @@ function anySignal(signals) {
 function redactUrls(text) {
   return text.replace(/\b[a-z][a-z0-9+.-]*:\/\/[^\s"'<>]+/gi, "<url>");
 }
+function sourceAssetOf(params) {
+  const decimals = params.sourceDecimals;
+  return (0, import_swap2_assets.resolveAsset)(params.sourceChain, params.sourceToken, decimals === void 0 ? {} : { allowUnlisted: true, decimals });
+}
 
 // src/remote.ts
 function remoteProvider(opts) {
@@ -268,7 +274,7 @@ function remoteProvider(opts) {
 var import_core = require("@anywalletkit/core");
 var import_viem = require("viem");
 var import_tx_preview_evm = require("@anywalletkit/tx-preview-evm");
-var import_swap2_assets = require("@anywalletkit/swap2-assets");
+var import_swap2_assets2 = require("@anywalletkit/swap2-assets");
 var ZERO = "0x0000000000000000000000000000000000000000";
 var ERC20_TRANSFER_ABI = [
   {
@@ -375,6 +381,10 @@ function normalizeTypedDomain(domain) {
   return chainId === void 0 || !Number.isSafeInteger(chainId) ? domain : { ...domain, chainId };
 }
 var DEFAULT_SERIALIZED_NATIVE_ALLOWANCE = 20000000n;
+function reviewedIdentity(plan) {
+  const { feeUsd: _fee, etaSeconds: _eta, validUntilMs: _valid, approvals: _approvals, destAmount: _dest, requoted: _requoted, ...pinned } = plan;
+  return JSON.stringify(pinned, (_k, v) => typeof v === "bigint" ? v.toString() : v);
+}
 var SWAP2_ID_PREFIX = "awk1";
 function encodeId(provider, intentId, sourceTxHash) {
   const enc = (v) => encodeURIComponent(v).replace(/\./g, "%2E");
@@ -444,15 +454,16 @@ function toCaip2(chain, fallback) {
   return swap2ChainId(chain);
 }
 function toSymbol(caip2, ref) {
-  const byToken = ref.startsWith("0x") || ref.length > 20 ? (0, import_swap2_assets.ccAssetByToken)(caip2, ref) : void 0;
+  const byToken = ref.startsWith("0x") || ref.length > 20 ? (0, import_swap2_assets2.ccAssetByToken)(caip2, ref) : void 0;
   if (byToken) return byToken.symbol;
-  if ((0, import_swap2_assets.ccAsset)(caip2, ref)) return ref;
+  if ((0, import_swap2_assets2.ccAsset)(caip2, ref)) return ref;
   return ref;
 }
-function toDestAddress(caip2, ref) {
+function toDestAddress(caip2, ref, allowUnlisted = false) {
   if (ref.startsWith("0x")) return ref;
-  const asset = (0, import_swap2_assets.ccAssetByToken)(caip2, ref) ?? (0, import_swap2_assets.ccAsset)(caip2, ref);
+  const asset = (0, import_swap2_assets2.ccAssetByToken)(caip2, ref) ?? (0, import_swap2_assets2.ccAsset)(caip2, ref);
   if (!asset) {
+    if (allowUnlisted && (0, import_swap2_assets2.isTokenAddress)(caip2, ref)) return ref;
     throw new Error(`swap2: unknown destination token '${ref}' on ${caip2}`);
   }
   return asset.contract ?? ZERO;
@@ -534,6 +545,15 @@ function mapStatus(s) {
   const status = s.state === "completed" ? "completed" : s.state === "action-required" ? "action-required" : s.state === "refund-pending" ? "refund-pending" : s.state === "partial" ? "partial" : s.state === "failed" ? "failed" : s.state === "refunded" ? "refunded" : s.state === "cancelled" ? "cancelled" : s.state === "expired" ? "expired" : "pending";
   return s.destTxHash ? { status, transactions: [{ hash: s.destTxHash, type: "destination" }] } : { status };
 }
+function blankToUndefined(v) {
+  return typeof v === "string" && v.trim() === "" ? void 0 : v;
+}
+function withoutBlankAddresses(o) {
+  const { recipient, refundAddress, ...rest } = o;
+  const r = blankToUndefined(recipient);
+  const f = blankToUndefined(refundAddress);
+  return { ...rest, ...r !== void 0 ? { recipient: r } : {}, ...f !== void 0 ? { refundAddress: f } : {} };
+}
 var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
   fromChain;
   constructor(account, config) {
@@ -566,19 +586,61 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
   pairSupported(fromChain, toChain) {
     return this.chainSupported(fromChain) && this.chainSupported(toChain);
   }
+  unlistedAllowed() {
+    return this._config.allowUnlistedTokens === true;
+  }
+  /** The source asset the options name: the catalog's, or (allowUnlistedTokens) an unlisted one with its decimals. */
+  sourceAsset(options) {
+    const decimals = options.fromTokenDecimals;
+    return (0, import_swap2_assets2.resolveAsset)(this.fromChain, toSymbol(this.fromChain, options.fromToken), {
+      allowUnlisted: this.unlistedAllowed(),
+      ...decimals !== void 0 ? { decimals } : {}
+    });
+  }
+  unlistedDecimals = /* @__PURE__ */ new Map();
+  /**
+   * Options ready to quote: with `allowUnlistedTokens`, an unlisted source token gets its decimals,
+   * read from the chain through the account (cached per token) — a caller's `fromTokenDecimals` that
+   * disagrees is refused. Listed tokens and every option otherwise pass through unchanged.
+   */
+  async prepareOptions(options) {
+    if (!this.unlistedAllowed()) return options;
+    const ref = toSymbol(this.fromChain, options.fromToken);
+    if ((0, import_swap2_assets2.resolveAsset)(this.fromChain, ref) || !(0, import_swap2_assets2.isTokenAddress)(this.fromChain, ref)) return options;
+    const key = ref.startsWith("0x") ? ref.toLowerCase() : ref;
+    let decimals = this.unlistedDecimals.get(key);
+    if (decimals === void 0) {
+      const reader = this._account;
+      if (typeof reader?.getTokenInfo !== "function") {
+        if (options.fromTokenDecimals === void 0) {
+          throw new Swap2ValidationError(`swap2: '${ref}' is not in the catalog \u2014 pass fromTokenDecimals, or use an account that can read token info`);
+        }
+        return options;
+      }
+      decimals = (await reader.getTokenInfo(ref)).decimals;
+      this.unlistedDecimals.set(key, decimals);
+    }
+    if (options.fromTokenDecimals !== void 0 && options.fromTokenDecimals !== decimals) {
+      throw new Swap2ValidationError(`swap2: fromTokenDecimals ${options.fromTokenDecimals} does not match the token's ${decimals}`);
+    }
+    return snapshotOptions({ ...options, fromTokenDecimals: decimals });
+  }
   /** Swap2Options → the engine's QuoteParams (exact-in only). */
-  toParams(options, dry) {
+  toParams(given, dry) {
+    const options = withoutBlankAddresses(given);
     if (options.fromTokenAmount == null) {
       throw new Swap2UnsupportedOperationError("swap2: exact-out swap2 is not supported by the engine");
     }
     const destChain = toCaip2(options.toChain, this.fromChain);
     const constraints = callerConstraints(options);
     const amountIn = exactPositiveAmount(options.fromTokenAmount, "fromTokenAmount");
+    const source = this.sourceAsset(options);
     const params = {
       sourceChain: this.fromChain,
-      sourceToken: toSymbol(this.fromChain, options.fromToken),
+      sourceToken: (0, import_swap2_assets2.isUnlisted)(source) ? source.contract : toSymbol(this.fromChain, options.fromToken),
+      ...(0, import_swap2_assets2.isUnlisted)(source) ? { sourceDecimals: source.decimals } : {},
       destChain,
-      destToken: toDestAddress(destChain, options.toToken),
+      destToken: toDestAddress(destChain, options.toToken, this.unlistedAllowed()),
       amountIn: amountIn.toString(),
       destAddress: options.recipient ?? "",
       dry,
@@ -634,7 +696,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     }
   }
   assertQuoteFeeCaps(q, options, config) {
-    const source = (0, import_swap2_assets.ccAsset)(this.fromChain, toSymbol(this.fromChain, options.fromToken));
+    const source = this.sourceAsset(options);
     if (!source) throw new Error(`swap2: unknown source token '${options.fromToken}' on ${this.fromChain}`);
     const token = source.contract ?? source.assetId;
     const fees = q.fees?.map((fee) => ({ ...fee, amount: BigInt(fee.amount) }));
@@ -679,7 +741,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
    * gave one.
    */
   async quoteSwap2(options) {
-    const snapshot = snapshotOptions(options);
+    const snapshot = await this.prepareOptions(snapshotOptions(options));
     const q = await this.resolveQuote(this.toParams(snapshot, true));
     if (!q) {
       const detail = this.noRouteDetail();
@@ -721,9 +783,9 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     this.assertFeeConfig(configSnapshot);
     await this.assertAccountChain(signer);
     const selfAddress = await signer.getAddress();
-    const recipient = snapshot.recipient ?? selfAddress;
-    const refundAddress = snapshot.refundAddress ?? selfAddress;
-    const executionOptions = snapshotOptions({ ...snapshot, recipient, refundAddress });
+    const recipient = blankToUndefined(snapshot.recipient) ?? selfAddress;
+    const refundAddress = blankToUndefined(snapshot.refundAddress) ?? selfAddress;
+    const executionOptions = await this.prepareOptions(snapshotOptions({ ...snapshot, recipient, refundAddress }));
     const params = this.toParams(executionOptions, false);
     const resolved = await this.resolveQuote(params);
     if (!resolved) {
@@ -804,7 +866,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     }
     let tokenId;
     if (!unsigned.data && !unsigned.bodyBoc && !unsigned.typedData && !serialized) {
-      const src = (0, import_swap2_assets.ccAsset)(this.fromChain, toSymbol(this.fromChain, executionOptions.fromToken));
+      const src = this.sourceAsset(executionOptions);
       if (src?.contract) {
         if (this.fromChain.startsWith("eip155:")) {
           unsigned = {
@@ -830,7 +892,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     if (tokenId && (cellBody !== void 0 || unsigned.memo !== void 0 && !tronSource && !nearSource && !tonSource)) {
       throw new Error("swap2: token deposit with memo/cell payload is not implemented");
     }
-    const source = (0, import_swap2_assets.ccAsset)(this.fromChain, toSymbol(this.fromChain, executionOptions.fromToken));
+    const source = this.sourceAsset(executionOptions);
     if (!source) throw new Error(`swap2: unknown source token '${executionOptions.fromToken}' on ${this.fromChain}`);
     const executionValue = BigInt(unsigned.value);
     if (serialized) {
@@ -886,7 +948,8 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
       approvalAmounts = current === approvalAmount ? [] : [...usdtMainnet && current !== 0n ? [0n] : [], approvalAmount];
     }
     const review = this._config.reviewExecution;
-    if (review && !carried) {
+    let reviewed;
+    if (review && (!carried || carried.reviewed)) {
       const chainId = unsigned.chainId !== void 0 ? { chainId: unsigned.chainId } : {};
       const approvals = approvalAmounts.map((amount) => ({ token: source.contract, spender: unsigned.approvalAddress, amount, ...chainId }));
       const plan = {
@@ -914,12 +977,28 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
           ...cellBody !== void 0 ? { cellBody: true } : {}
         }
       };
-      await review(deepFreeze(structuredCloneSafe(plan)));
-      if (q.validUntilMs > 0 && q.validUntilMs <= Date.now()) {
-        throw new Swap2QuoteError("swap2: quote expired during review \u2014 nothing was signed");
+      const previous = carried?.reviewed;
+      if (!previous || reviewedIdentity(previous) !== reviewedIdentity(plan) || plan.destAmount < previous.destAmount) {
+        try {
+          reviewed = deepFreeze(structuredCloneSafe(previous ? { ...plan, requoted: true } : plan));
+          await review(reviewed);
+          if (q.validUntilMs > 0 && q.validUntilMs <= Date.now()) {
+            throw new Swap2QuoteError(`swap2: quote expired during review \u2014 ${previous ? "the allowance was revoked" : "nothing was signed"}`);
+          }
+        } catch (error) {
+          if (previous) await revokeApproval?.().catch(() => {
+          });
+          throw error;
+        }
       }
     }
-    await this.assertNativeGas(signer, unsigned, approvalAmounts, source.contract ?? void 0, !!unsigned.typedData || serialized || !!tokenId);
+    try {
+      await this.assertNativeGas(signer, unsigned, approvalAmounts, source.contract ?? void 0, !!unsigned.typedData || serialized || !!tokenId);
+    } catch (error) {
+      if (carried) await revokeApproval?.().catch(() => {
+      });
+      throw error;
+    }
     if (approvalAmounts.length) {
       const approve = async (amount) => {
         const sent2 = await signer.sendTransaction({
@@ -948,7 +1027,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     if (q.validUntilMs > 0 && q.validUntilMs <= Date.now()) {
       if (!carried && approvalAmounts.length && revokeApproval) {
         this.emitPhase("requoting");
-        const handoff = { token: source.contract, spender: unsigned.approvalAddress, amount: approvalAmount, revoke: revokeApproval, adopted: false };
+        const handoff = { token: source.contract, spender: unsigned.approvalAddress, amount: approvalAmount, revoke: revokeApproval, adopted: false, ...reviewed ? { reviewed } : {} };
         try {
           return await this.executeSwap2(signer, snapshot, config, handoff);
         } catch (error) {
@@ -1209,7 +1288,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
   /** Source chains this protocol can swap from. */
   async getSupportedChains() {
     if (!this.protocolEnabled()) return [];
-    return import_swap2_assets.CC_SOURCE_CHAINS.filter((c) => this.chainSupported(c.caip2)).map((c) => ({
+    return import_swap2_assets2.CC_SOURCE_CHAINS.filter((c) => this.chainSupported(c.caip2)).map((c) => ({
       id: c.caip2,
       name: c.label,
       type: chainType(c.caip2),
@@ -1222,7 +1301,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     const wantTo = options?.toChain != null ? toCaip2(options.toChain, "") : void 0;
     if (!this.protocolEnabled() || wantFrom && wantTo && !this.pairSupported(wantFrom, wantTo)) return [];
     const out = [];
-    for (const c of import_swap2_assets.CC_SOURCE_CHAINS) {
+    for (const c of import_swap2_assets2.CC_SOURCE_CHAINS) {
       if (!this.chainSupported(c.caip2)) continue;
       if ((wantFrom || wantTo) && c.caip2 !== wantFrom && c.caip2 !== wantTo) continue;
       for (const a of c.assets) {
@@ -1309,7 +1388,7 @@ var SingleProviderSwap2 = class extends BaseSwap2Protocol {
 
 // src/activity.ts
 var import_core2 = require("@anywalletkit/core");
-var import_swap2_assets2 = require("@anywalletkit/swap2-assets");
+var import_swap2_assets3 = require("@anywalletkit/swap2-assets");
 function calledContract(tx) {
   const to = tx.call?.to ?? tx.to;
   if (!to) return null;
@@ -1346,7 +1425,7 @@ function matchesCall(tx, contracts, selectors) {
   return sel !== void 0 && want.has(sel);
 }
 function chainLabel(caip2) {
-  return (0, import_swap2_assets2.ccChain)(caip2)?.label ?? caip2;
+  return (0, import_swap2_assets3.ccChain)(caip2)?.label ?? caip2;
 }
 function shortAddress(a) {
   return a.length > 14 ? `${a.slice(0, 6)}\u2026${a.slice(-4)}` : a;
@@ -1365,7 +1444,7 @@ function assetMetaFor(tx) {
     const key = token === null ? null : token.startsWith("0x") ? token.toLowerCase() : token;
     const known = fromTransfers.get(key);
     if (known?.symbol !== void 0 && known.decimals !== void 0) return known;
-    const cat = (0, import_swap2_assets2.ccAssetByToken)(tx.chain, token ?? "");
+    const cat = (0, import_swap2_assets3.ccAssetByToken)(tx.chain, token ?? "");
     if (!cat) return known;
     const meta = { symbol: known?.symbol ?? cat.symbol, decimals: known?.decimals ?? cat.decimals };
     return meta;
@@ -1373,7 +1452,7 @@ function assetMetaFor(tx) {
 }
 function assetLabel(tx, a) {
   if (a.symbol) return a.symbol;
-  if (a.token === null) return (0, import_swap2_assets2.ccAssetByToken)(tx.chain, "")?.symbol ?? "native";
+  if (a.token === null) return (0, import_swap2_assets3.ccAssetByToken)(tx.chain, "")?.symbol ?? "native";
   return shortAddress(a.token);
 }
 function ownerAssets(tx, ctx) {