@anywalletkit/protocol-swap2-core 0.4.1 → 0.6.0

package/dist/swap2/base.d.cts

@@ -1,4 +1,5 @@
 import { Swap2Protocol, Swap2ProtocolConfig, Swap2Options, Swap2Fee, Swap2Quote, Swap2Result, Swap2StatusOptions, Swap2StatusResult, BridgeOptions, BridgeResult, SwapOptions, SwapResult, Swap2SupportedChain, Swap2SupportedTokensOptions, Swap2SupportedToken } from '@anywalletkit/core';
+import { CcAsset } from '@anywalletkit/swap2-assets';
 import { QuoteParams, Quote, CrossChainProvider } from '../types.cjs';
 
 /**
@@ -89,6 +90,15 @@ interface Swap2EngineConfig extends Swap2ProtocolConfig {
      * called again with `requoted: true`, and throwing then revokes the allowance.
      */
     reviewExecution?: (plan: Swap2ExecutionPlan) => Promise<void> | void;
+    /**
+     * Accept tokens the swap catalog does not list, named by their contract (EVM) or mint (Solana):
+     * tokens the user added at their own risk. Off by default. The source token's decimals are read
+     * with the account's `getTokenInfo` (a `fromTokenDecimals` that disagrees is refused); an account
+     * without it must be given `fromTokenDecimals`. Only providers that trade any token (LI.FI,
+     * Uniswap, Balancer, Fynd, Jupiter) quote them, and they have no USD value: the router cannot
+     * judge their price, so show the user the amounts.
+     */
+    allowUnlistedTokens?: boolean;
 }
 /** What `swap2()` is about to sign, handed to {@link Swap2EngineConfig.reviewExecution}. */
 interface Swap2ExecutionPlan {
@@ -202,8 +212,18 @@ declare abstract class BaseSwap2Protocol extends Swap2Protocol {
     protected protocolEnabled(): boolean;
     /** Pair-level capability used when discovery specifies both endpoints. */
     protected pairSupported(fromChain: string, toChain: string): boolean;
+    private unlistedAllowed;
+    /** The source asset the options name: the catalog's, or (allowUnlistedTokens) an unlisted one with its decimals. */
+    protected sourceAsset(options: Swap2Options): CcAsset | undefined;
+    private readonly unlistedDecimals;
+    /**
+     * 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.
+     */
+    protected prepareOptions(options: Swap2Options): Promise<Swap2Options>;
     /** Swap2Options → the engine's QuoteParams (exact-in only). */
-    protected toParams(options: Swap2Options, dry: boolean): QuoteParams;
+    protected toParams(given: Swap2Options, dry: boolean): QuoteParams;
     private assertAccountChain;
     protected assertFeeConfig(config?: Swap2ProtocolConfig): void;
     protected assertFeeCaps(fees: readonly Swap2Fee[] | undefined, sourceAmount: bigint, sourceToken: string, config?: Swap2ProtocolConfig): void;

package/dist/swap2/base.d.ts

@@ -1,4 +1,5 @@
 import { Swap2Protocol, Swap2ProtocolConfig, Swap2Options, Swap2Fee, Swap2Quote, Swap2Result, Swap2StatusOptions, Swap2StatusResult, BridgeOptions, BridgeResult, SwapOptions, SwapResult, Swap2SupportedChain, Swap2SupportedTokensOptions, Swap2SupportedToken } from '@anywalletkit/core';
+import { CcAsset } from '@anywalletkit/swap2-assets';
 import { QuoteParams, Quote, CrossChainProvider } from '../types.js';
 
 /**
@@ -89,6 +90,15 @@ interface Swap2EngineConfig extends Swap2ProtocolConfig {
      * called again with `requoted: true`, and throwing then revokes the allowance.
      */
     reviewExecution?: (plan: Swap2ExecutionPlan) => Promise<void> | void;
+    /**
+     * Accept tokens the swap catalog does not list, named by their contract (EVM) or mint (Solana):
+     * tokens the user added at their own risk. Off by default. The source token's decimals are read
+     * with the account's `getTokenInfo` (a `fromTokenDecimals` that disagrees is refused); an account
+     * without it must be given `fromTokenDecimals`. Only providers that trade any token (LI.FI,
+     * Uniswap, Balancer, Fynd, Jupiter) quote them, and they have no USD value: the router cannot
+     * judge their price, so show the user the amounts.
+     */
+    allowUnlistedTokens?: boolean;
 }
 /** What `swap2()` is about to sign, handed to {@link Swap2EngineConfig.reviewExecution}. */
 interface Swap2ExecutionPlan {
@@ -202,8 +212,18 @@ declare abstract class BaseSwap2Protocol extends Swap2Protocol {
     protected protocolEnabled(): boolean;
     /** Pair-level capability used when discovery specifies both endpoints. */
     protected pairSupported(fromChain: string, toChain: string): boolean;
+    private unlistedAllowed;
+    /** The source asset the options name: the catalog's, or (allowUnlistedTokens) an unlisted one with its decimals. */
+    protected sourceAsset(options: Swap2Options): CcAsset | undefined;
+    private readonly unlistedDecimals;
+    /**
+     * 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.
+     */
+    protected prepareOptions(options: Swap2Options): Promise<Swap2Options>;
     /** Swap2Options → the engine's QuoteParams (exact-in only). */
-    protected toParams(options: Swap2Options, dry: boolean): QuoteParams;
+    protected toParams(given: Swap2Options, dry: boolean): QuoteParams;
     private assertAccountChain;
     protected assertFeeConfig(config?: Swap2ProtocolConfig): void;
     protected assertFeeCaps(fees: readonly Swap2Fee[] | undefined, sourceAmount: bigint, sourceToken: string, config?: Swap2ProtocolConfig): void;

package/dist/swap2/base.js

@@ -7,7 +7,7 @@ import {
   nativeUnits,
   normalizeTypedDomain,
   swap2ChainId
-} from "../chunk-Y3VUEWYI.js";
+} from "../chunk-IGTMUTNJ.js";
 import "../chunk-IVR3SREQ.js";
 export {
   BaseSwap2Protocol,

package/dist/swap2/single.cjs

@@ -111,12 +111,14 @@ var inFlightKey = (fromChain, o) => JSON.stringify(
   [fromChain, o.fromToken, o.toToken, o.toChain, o.recipient, o.refundAddress, o.fromTokenAmount, o.toTokenAmount, o.minAmountOut, o.slippage],
   (_k, v) => typeof v === "bigint" ? v.toString() : v
 );
+var LOST_ANSWER = /socket hang up|ECONNRESET|ECONNABORTED|ETIMEDOUT|EPIPE|ENETUNREACH|EHOSTUNREACH|EAI_AGAIN|UND_ERR_[A-Z_]+|timed? ?out|TimeoutError|request aborted|AbortError|connection (?:closed|reset)|fetch failed|failed to fetch|network request failed|other side closed/i;
 function maybeSent(error) {
-  for (let e = error, i = 0; e && typeof e === "object" && i < 5; e = e.cause, i++) {
-    if (e.maybeSent === true) return typeof e.hash === "string" && e.hash ? { hash: e.hash } : {};
-  }
-  const text = error instanceof Error ? error.message : String(error);
-  return /socket hang up|ECONNRESET|ETIMEDOUT|EPIPE|timed? ?out|request aborted|connection (?:closed|reset)/i.test(text) ? {} : null;
+  const chain = [];
+  for (let e = error, i = 0; e && typeof e === "object" && i < 6; e = e.cause, i++) chain.push(e);
+  for (const e of chain) if (e.maybeSent === true) return typeof e.hash === "string" && e.hash ? { hash: e.hash } : {};
+  if (chain.some((e) => e.answered === true)) return null;
+  const texts = chain.length ? chain.map((e) => [e.message, e.code, e.name].filter((x) => typeof x === "string").join(" ")) : [String(error)];
+  return texts.some((t) => LOST_ANSWER.test(t)) ? {} : null;
 }
 var NATIVE_DECIMALS = Object.freeze({
   "eip155:5042": 18
@@ -200,22 +202,24 @@ function reviewedIdentity(plan) {
   return JSON.stringify(pinned, (_k, v) => typeof v === "bigint" ? v.toString() : v);
 }
 var SWAP2_ID_PREFIX = "awk1";
-function encodeId(provider, intentId, sourceTxHash) {
+function encodeId(provider, intentId, sourceTxHash, destTxHash) {
   const enc = (v) => encodeURIComponent(v).replace(/\./g, "%2E");
-  return `${SWAP2_ID_PREFIX}.${[provider, intentId, sourceTxHash].filter((v) => v != null).map(enc).join(".")}`;
+  const parts = [provider, intentId, ...sourceTxHash != null ? [sourceTxHash, ...destTxHash != null ? [destTxHash] : []] : []];
+  return `${SWAP2_ID_PREFIX}.${parts.map(enc).join(".")}`;
 }
 function decodeId(id) {
   try {
     if (!id.startsWith(`${SWAP2_ID_PREFIX}.`)) throw new Error("unsupported id version");
     const parts = id.slice(SWAP2_ID_PREFIX.length + 1).split(".");
-    if (parts.length < 2 || parts.length > 3 || !parts[0] || !parts[1]) throw new Error("invalid id shape");
+    if (parts.length < 2 || parts.length > 4 || !parts[0] || !parts[1]) throw new Error("invalid id shape");
     const provider = decodeURIComponent(parts[0]);
     const intentId = decodeURIComponent(parts[1]);
     const sourceTxHash = parts[2] ? decodeURIComponent(parts[2]) : void 0;
-    if (!/^[A-Za-z0-9_-]+$/.test(provider) || !intentId || parts[2] !== void 0 && !sourceTxHash) {
+    const destTxHash = parts[3] ? decodeURIComponent(parts[3]) : void 0;
+    if (!/^[A-Za-z0-9_-]+$/.test(provider) || !intentId || parts[2] !== void 0 && !sourceTxHash || parts[3] !== void 0 && !destTxHash) {
       throw new Error("invalid id contents");
     }
-    return { provider, intentId, ...sourceTxHash ? { sourceTxHash } : {} };
+    return { provider, intentId, ...sourceTxHash ? { sourceTxHash } : {}, ...destTxHash ? { destTxHash } : {} };
   } catch {
     throw new Swap2ValidationError("swap2: malformed swap2 status id");
   }
@@ -267,16 +271,23 @@ function toCaip2(chain, fallback) {
   }
   return swap2ChainId(chain);
 }
+function nonEmptyRef(ref, side) {
+  if (typeof ref !== "string" || ref.trim() === "") throw new Swap2ValidationError(`swap2: ${side} token must not be empty (pass the symbol or the contract address)`);
+  return ref;
+}
 function toSymbol(caip2, ref) {
+  nonEmptyRef(ref, "source");
   const byToken = ref.startsWith("0x") || ref.length > 20 ? (0, import_swap2_assets.ccAssetByToken)(caip2, ref) : void 0;
   if (byToken) return byToken.symbol;
   if ((0, import_swap2_assets.ccAsset)(caip2, ref)) return ref;
   return ref;
 }
-function toDestAddress(caip2, ref) {
+function toDestAddress(caip2, ref, allowUnlisted = false) {
+  nonEmptyRef(ref, "destination");
   if (ref.startsWith("0x")) return ref;
   const asset = (0, import_swap2_assets.ccAssetByToken)(caip2, ref) ?? (0, import_swap2_assets.ccAsset)(caip2, ref);
   if (!asset) {
+    if (allowUnlisted && (0, import_swap2_assets.isTokenAddress)(caip2, ref)) return ref;
     throw new Error(`swap2: unknown destination token '${ref}' on ${caip2}`);
   }
   return asset.contract ?? ZERO;
@@ -358,6 +369,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) {
@@ -390,19 +410,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_assets.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_assets.resolveAsset)(this.fromChain, ref) || !(0, import_swap2_assets.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_assets.isUnlisted)(source) ? source.contract : toSymbol(this.fromChain, options.fromToken),
+      ...(0, import_swap2_assets.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,
@@ -458,7 +520,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) }));
@@ -503,7 +565,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();
@@ -545,9 +607,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) {
@@ -589,7 +651,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
         throw new Error("swap2: provider build does not match the validated quote transaction");
       }
     } else if (!unsigned.bodyBoc && !unsigned.typedData) {
-      if (!q.depositAddress || unsigned.to !== q.depositAddress || (unsigned.memo ?? null) !== q.depositMemo) {
+      if (!q.depositAddress || unsigned.to !== q.depositAddress || (unsigned.memo ?? null) !== q.depositMemo || unsigned.data !== void 0 || unsigned.approvalAddress !== void 0 || unsigned.serializedTx !== void 0) {
         throw new Error("swap2: provider build does not match the validated quote deposit");
       }
     }
@@ -628,7 +690,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 = {
@@ -654,7 +716,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) {
@@ -944,10 +1006,10 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
   }
   /** Status of a swap by the id `swap2()` returned, asked from the provider that executed it. */
   async getSwap2Status(id, _options) {
-    const { provider: name, intentId, sourceTxHash } = decodeId(id);
+    const { provider: name, intentId, sourceTxHash, destTxHash } = decodeId(id);
     const provider = this.providerFor(name);
     if (!provider) throw new Error(`swap2: no swap2 found for id '${id}'`);
-    return mapStatus(await provider.trackIntent(sourceTxHash == null ? { intentId } : { intentId, sourceTxHash }));
+    return mapStatus(await provider.trackIntent({ intentId, ...sourceTxHash != null ? { sourceTxHash } : {}, ...destTxHash != null ? { destTxHash } : {} }));
   }
   /**
    * Two-phase routes (CCTP-style burn-and-mint): once `getSwap2Status` reports
@@ -993,6 +1055,17 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     if (unsigned.chainId !== void 0 && String(unsigned.chainId) !== expectedId) {
       throw new Error(`swap2: claim chainId ${unsigned.chainId} does not match ${unsigned.chain}`);
     }
+    if (typeof provider.claimTargets !== "function") {
+      throw new Swap2UnsupportedOperationError(`swap2: provider '${name}' declares no claimTargets \u2014 a claim may only call contracts the provider names for its chain`);
+    }
+    const targets = provider.claimTargets(unsigned.chain).map((a) => a.toLowerCase());
+    if (!targets.includes(unsigned.to.toLowerCase())) {
+      throw new Swap2ValidationError(`swap2: claim target ${unsigned.to} is not a contract '${name}' declares for ${unsigned.chain} \u2014 refused`);
+    }
+    const claimCall = (0, import_tx_preview_evm.decodeCall)({ to: unsigned.to, data: unsigned.data, value: 0n });
+    if (claimCall.transfer || claimCall.approval) {
+      throw new Swap2ValidationError(`swap2: claim calldata (${claimCall.method}) moves tokens or grants an allowance \u2014 refused`);
+    }
     const actual = await readAccountChain(signer);
     if (actual == null) throw new Error(`swap2: destination account chain identity is unavailable for ${unsigned.chain}`);
     const actualText = typeof actual === "string" ? actual : String(actual);
@@ -1008,7 +1081,7 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
     });
     if (!sent.hash) throw new Swap2ExecutionError("swap2: account did not return a claim transaction hash");
     this.emitPhase("broadcast", { hash: sent.hash });
-    return { hash: sent.hash, chain: unsigned.chain, id };
+    return { hash: sent.hash, chain: unsigned.chain, id: encodeId(name, intentId, sourceTxHash, sent.hash) };
   }
   /** The inherited bridge() has no floor field: quote first, then bind execution
    * to that quote's minimum so the inherited convenience API stays safe. */
@@ -1068,7 +1141,9 @@ var BaseSwap2Protocol = class extends import_core.Swap2Protocol {
       if ((wantFrom || wantTo) && c.caip2 !== wantFrom && c.caip2 !== wantTo) continue;
       for (const a of c.assets) {
         out.push({
-          token: a.assetId,
+          // What quoteSwap2 takes back: the contract, or the symbol of the native coin — never the
+          // provider-specific assetId, which is "" for most catalog entries (round 3, M25).
+          token: a.contract ?? a.symbol,
           chain: c.caip2,
           symbol: a.symbol,
           decimals: a.decimals,