@satora/swap 1.6.1 → 1.7.0

package/dist/index.d.cts

@@ -639,6 +639,8 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     getChainConfig(...args: Parameters<Client$1["getChainConfig"]>): ReturnType<Client$1["getChainConfig"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    getRifRelay(...args: Parameters<Client$1["getRifRelay"]>): ReturnType<Client$1["getRifRelay"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     getReferralFee(...args: Parameters<Client$1["getReferralFee"]>): ReturnType<Client$1["getReferralFee"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     getNetworkFees(...args: Parameters<Client$1["getNetworkFees"]>): ReturnType<Client$1["getNetworkFees"]>;
@@ -703,6 +705,10 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     createArkadeToLightningSwap(...args: Parameters<Client$1["createArkadeToLightningSwap"]>): ReturnType<Client$1["createArkadeToLightningSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    createLightningToBitcoinSwap(...args: Parameters<Client$1["createLightningToBitcoinSwap"]>): ReturnType<Client$1["createLightningToBitcoinSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
+    createBitcoinToLightningSwap(...args: Parameters<Client$1["createBitcoinToLightningSwap"]>): ReturnType<Client$1["createBitcoinToLightningSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     createEvmToLightningSwap(...args: Parameters<Client$1["createEvmToLightningSwap"]>): ReturnType<Client$1["createEvmToLightningSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     createEvmToArkadeSwapGeneric(...args: Parameters<Client$1["createEvmToArkadeSwapGeneric"]>): ReturnType<Client$1["createEvmToArkadeSwapGeneric"]>;
@@ -715,8 +721,14 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     fundSwap(...args: Parameters<Client$1["fundSwap"]>): ReturnType<Client$1["fundSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    fundSwapFromSolana(...args: Parameters<Client$1["fundSwapFromSolana"]>): ReturnType<Client$1["fundSwapFromSolana"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
+    getSolanaUsdcBalance(...args: Parameters<Client$1["getSolanaUsdcBalance"]>): ReturnType<Client$1["getSolanaUsdcBalance"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     refundEvmWithSigner(...args: Parameters<Client$1["refundEvmWithSigner"]>): ReturnType<Client$1["refundEvmWithSigner"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    refundEvmSponsored(...args: Parameters<Client$1["refundEvmSponsored"]>): ReturnType<Client$1["refundEvmSponsored"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     collabRefundEvmWithSigner(...args: Parameters<Client$1["collabRefundEvmWithSigner"]>): ReturnType<Client$1["collabRefundEvmWithSigner"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     fundSwapGasless(...args: Parameters<Client$1["fundSwapGasless"]>): ReturnType<Client$1["fundSwapGasless"]>;
@@ -729,6 +741,8 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     continueRefundedEvmSwap(...args: Parameters<Client$1["continueRefundedEvmSwap"]>): ReturnType<Client$1["continueRefundedEvmSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    recoverCctpInboundSwap(...args: Parameters<Client$1["recoverCctpInboundSwap"]>): ReturnType<Client$1["recoverCctpInboundSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     recoverGaslessFunds(...args: Parameters<Client$1["recoverGaslessFunds"]>): ReturnType<Client$1["recoverGaslessFunds"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     hasReceivedVtxo(...args: Parameters<Client$1["hasReceivedVtxo"]>): ReturnType<Client$1["hasReceivedVtxo"]>;
@@ -847,6 +861,7 @@ declare class ClientBuilder {
     withMnemonic(...args: Parameters<ClientBuilder$1["withMnemonic"]>): this;
     withXprv(...args: Parameters<ClientBuilder$1["withXprv"]>): this;
     withAa(...args: Parameters<ClientBuilder$1["withAa"]>): this;
+    withSolanaRpcUrl(...args: Parameters<ClientBuilder$1["withSolanaRpcUrl"]>): this;
     withLogger(...args: Parameters<ClientBuilder$1["withLogger"]>): this;
     withLogLevel(...args: Parameters<ClientBuilder$1["withLogLevel"]>): this;
     build(): Promise<Client>;

package/dist/index.d.ts

@@ -639,6 +639,8 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     getChainConfig(...args: Parameters<Client$1["getChainConfig"]>): ReturnType<Client$1["getChainConfig"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    getRifRelay(...args: Parameters<Client$1["getRifRelay"]>): ReturnType<Client$1["getRifRelay"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     getReferralFee(...args: Parameters<Client$1["getReferralFee"]>): ReturnType<Client$1["getReferralFee"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     getNetworkFees(...args: Parameters<Client$1["getNetworkFees"]>): ReturnType<Client$1["getNetworkFees"]>;
@@ -703,6 +705,10 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     createArkadeToLightningSwap(...args: Parameters<Client$1["createArkadeToLightningSwap"]>): ReturnType<Client$1["createArkadeToLightningSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    createLightningToBitcoinSwap(...args: Parameters<Client$1["createLightningToBitcoinSwap"]>): ReturnType<Client$1["createLightningToBitcoinSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
+    createBitcoinToLightningSwap(...args: Parameters<Client$1["createBitcoinToLightningSwap"]>): ReturnType<Client$1["createBitcoinToLightningSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     createEvmToLightningSwap(...args: Parameters<Client$1["createEvmToLightningSwap"]>): ReturnType<Client$1["createEvmToLightningSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     createEvmToArkadeSwapGeneric(...args: Parameters<Client$1["createEvmToArkadeSwapGeneric"]>): ReturnType<Client$1["createEvmToArkadeSwapGeneric"]>;
@@ -715,8 +721,14 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     fundSwap(...args: Parameters<Client$1["fundSwap"]>): ReturnType<Client$1["fundSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    fundSwapFromSolana(...args: Parameters<Client$1["fundSwapFromSolana"]>): ReturnType<Client$1["fundSwapFromSolana"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
+    getSolanaUsdcBalance(...args: Parameters<Client$1["getSolanaUsdcBalance"]>): ReturnType<Client$1["getSolanaUsdcBalance"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     refundEvmWithSigner(...args: Parameters<Client$1["refundEvmWithSigner"]>): ReturnType<Client$1["refundEvmWithSigner"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    refundEvmSponsored(...args: Parameters<Client$1["refundEvmSponsored"]>): ReturnType<Client$1["refundEvmSponsored"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     collabRefundEvmWithSigner(...args: Parameters<Client$1["collabRefundEvmWithSigner"]>): ReturnType<Client$1["collabRefundEvmWithSigner"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     fundSwapGasless(...args: Parameters<Client$1["fundSwapGasless"]>): ReturnType<Client$1["fundSwapGasless"]>;
@@ -729,6 +741,8 @@ declare class Client {
     /** Delegated to the legacy client (migration checkpoint). */
     continueRefundedEvmSwap(...args: Parameters<Client$1["continueRefundedEvmSwap"]>): ReturnType<Client$1["continueRefundedEvmSwap"]>;
     /** Delegated to the legacy client (migration checkpoint). */
+    recoverCctpInboundSwap(...args: Parameters<Client$1["recoverCctpInboundSwap"]>): ReturnType<Client$1["recoverCctpInboundSwap"]>;
+    /** Delegated to the legacy client (migration checkpoint). */
     recoverGaslessFunds(...args: Parameters<Client$1["recoverGaslessFunds"]>): ReturnType<Client$1["recoverGaslessFunds"]>;
     /** Delegated to the legacy client (migration checkpoint). */
     hasReceivedVtxo(...args: Parameters<Client$1["hasReceivedVtxo"]>): ReturnType<Client$1["hasReceivedVtxo"]>;
@@ -847,6 +861,7 @@ declare class ClientBuilder {
     withMnemonic(...args: Parameters<ClientBuilder$1["withMnemonic"]>): this;
     withXprv(...args: Parameters<ClientBuilder$1["withXprv"]>): this;
     withAa(...args: Parameters<ClientBuilder$1["withAa"]>): this;
+    withSolanaRpcUrl(...args: Parameters<ClientBuilder$1["withSolanaRpcUrl"]>): this;
     withLogger(...args: Parameters<ClientBuilder$1["withLogger"]>): this;
     withLogLevel(...args: Parameters<ClientBuilder$1["withLogLevel"]>): this;
     build(): Promise<Client>;

package/dist/index.js

@@ -1439,6 +1439,11 @@ var SwapWorker = class {
   #executing = /* @__PURE__ */ new Set();
   /** Swaps with a scheduled auto-claim retry (backoff timer + attempt count). */
   #retries = /* @__PURE__ */ new Map();
+  /**
+   * Swaps whose claim needs the user's wallet (RIF Relay): handed to
+   * `onActionRequired` once and not auto-run while the claim is recommended.
+   */
+  #needsUser = /* @__PURE__ */ new Set();
   #unsubs = [];
   #started = false;
   constructor(options) {
@@ -1481,6 +1486,7 @@ var SwapWorker = class {
     this.#hintSource.stop();
     for (const { timer } of this.#retries.values()) clearTimeout(timer);
     this.#retries.clear();
+    this.#needsUser.clear();
     this.#executing.clear();
   }
   /** Chain-reconcile every tracked swap (the post-outage catch-up sweep). */
@@ -1503,9 +1509,11 @@ var SwapWorker = class {
     }
     this.#hintSource.subscribe([swapId]);
     if (recommended && AUTO_EXECUTABLE.has(recommended) && this.#execute) {
+      if (this.#needsUser.has(swapId)) return;
       this.#autoExecute(swapId, actions);
       return;
     }
+    this.#needsUser.delete(swapId);
     this.#cancelRetry(swapId);
     if (!recommended) return;
     const automation = actions.actions.find(
@@ -1522,6 +1530,12 @@ var SwapWorker = class {
     if (!actionId) return;
     this.#executing.add(swapId);
     void execute(swapId, actionId).then(() => this.#cancelRetry(swapId)).catch((error) => {
+      if (needsWallet(error)) {
+        this.#cancelRetry(swapId);
+        this.#needsUser.add(swapId);
+        this.#onActionRequired?.(swapId, actions);
+        return;
+      }
       console.warn(`SwapWorker: ${actionId}(${swapId}) failed:`, error);
       this.#scheduleRetry(swapId, actions);
     }).finally(() => this.#executing.delete(swapId));
@@ -1569,6 +1583,9 @@ var SwapWorker = class {
     if (existing) clearTimeout(existing.timer);
   }
 };
+function needsWallet(error) {
+  return error instanceof Error && error.name === "WalletClaimRequiredError";
+}
 
 // src/hints/ws-status-source.ts
 var MAX_ARGS_PER_FRAME = 64;
@@ -1819,6 +1836,12 @@ function buildArkadeVhtlcRef(input) {
 
 // src/tracker/from-swap.ts
 var ms = (seconds2) => seconds2 * 1e3;
+var ONCHAIN_CLAIM_MARGIN_SECONDS = 30 * 60;
+function onchainClaimDeadline(refundLocktime, network) {
+  const net = network?.toLowerCase();
+  const mainnet = net === "bitcoin" || net === "mainnet";
+  return ms(refundLocktime - (mainnet ? ONCHAIN_CLAIM_MARGIN_SECONDS : 0));
+}
 var MAINNET_LOCKED_TOKEN = {
   1: "0x18084fba666a33d37592fa2633fd49a74dd93a88",
   // tBTC
@@ -2093,6 +2116,37 @@ function swapToTracked(stored) {
         serverRefundLocktime: 0
         // no on-chain server leg
       };
+    // The user's payment is held off-chain; the server funds the BTC HTLC
+    // the client claims.
+    case "lightning_to_bitcoin":
+      return {
+        swapId: r.id,
+        serverHtlc: bitcoinLeg(
+          r.btc_htlc_address,
+          r.hash_lock,
+          Number(r.target_amount)
+        ),
+        clientRefundLocktime: 0,
+        // no on-chain client leg
+        serverRefundLocktime: onchainClaimDeadline(
+          r.btc_refund_locktime,
+          r.network
+        )
+      };
+    // Client funds the BTC HTLC; the server pays the invoice and sweeps it.
+    case "bitcoin_to_lightning":
+      return {
+        swapId: r.id,
+        clientHtlc: bitcoinLeg(
+          r.btc_htlc_address,
+          r.hash_lock,
+          Number(r.source_amount),
+          CLIENT_FUNDING_MIN_CONFIRMATIONS
+        ),
+        clientRefundLocktime: ms(r.btc_refund_locktime),
+        serverRefundLocktime: 0
+        // no on-chain server leg
+      };
     default:
       return void 0;
   }
@@ -2588,6 +2642,10 @@ var Client = class {
     return this.#legacy.getChainConfig(...args);
   }
   /** Delegated to the legacy client (migration checkpoint). */
+  getRifRelay(...args) {
+    return this.#legacy.getRifRelay(...args);
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
   getReferralFee(...args) {
     return this.#legacy.getReferralFee(...args);
   }
@@ -2724,6 +2782,18 @@ var Client = class {
     );
   }
   /** Delegated to the legacy client (migration checkpoint). */
+  createLightningToBitcoinSwap(...args) {
+    return this.#trackAfterCreate(
+      this.#legacy.createLightningToBitcoinSwap(...args)
+    );
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
+  createBitcoinToLightningSwap(...args) {
+    return this.#trackAfterCreate(
+      this.#legacy.createBitcoinToLightningSwap(...args)
+    );
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
   createEvmToLightningSwap(...args) {
     return this.#trackAfterCreate(
       this.#legacy.createEvmToLightningSwap(...args)
@@ -2752,10 +2822,22 @@ var Client = class {
     return this.#legacy.fundSwap(...args);
   }
   /** Delegated to the legacy client (migration checkpoint). */
+  fundSwapFromSolana(...args) {
+    return this.#legacy.fundSwapFromSolana(...args);
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
+  getSolanaUsdcBalance(...args) {
+    return this.#legacy.getSolanaUsdcBalance(...args);
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
   refundEvmWithSigner(...args) {
     return this.#legacy.refundEvmWithSigner(...args);
   }
   /** Delegated to the legacy client (migration checkpoint). */
+  refundEvmSponsored(...args) {
+    return this.#legacy.refundEvmSponsored(...args);
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
   collabRefundEvmWithSigner(...args) {
     return this.#legacy.collabRefundEvmWithSigner(...args);
   }
@@ -2780,6 +2862,10 @@ var Client = class {
     return this.#trackAfterRetry(this.#legacy.continueRefundedEvmSwap(...args));
   }
   /** Delegated to the legacy client (migration checkpoint). */
+  recoverCctpInboundSwap(...args) {
+    return this.#legacy.recoverCctpInboundSwap(...args);
+  }
+  /** Delegated to the legacy client (migration checkpoint). */
   recoverGaslessFunds(...args) {
     return this.#legacy.recoverGaslessFunds(...args);
   }
@@ -3208,6 +3294,10 @@ var ClientBuilder = class {
     this.#inner.withAa(...args);
     return this;
   }
+  withSolanaRpcUrl(...args) {
+    this.#inner.withSolanaRpcUrl(...args);
+    return this;
+  }
   withLogger(...args) {
     this.#inner.withLogger(...args);
     return this;