@arkade-os/swap 0.0.10 → 0.0.12

package/README.md

@@ -759,6 +759,23 @@ through their stored `preimageHex` or their HD descriptor, and `DB_VERSION` is u
 
 Notes from before 0.0.1, kept for consumers who tracked the branch.
 
+- **`refundIfUnresolved` reports an exited lockup, and its input gained `paymentHash`.**
+  `RefundOutcome` has a new `{ outcome: "exited"; outpoints; status }` variant: a lockup whose
+  outputs were unilaterally exited lives onchain under the VHTLC script, where no offchain refund
+  reaches it. It used to come back as `nothing_to_refund`, which reads as "already resolved" over
+  money still sitting at the script — the swept case gets `needs_recovery` for the same reason, and
+  this is deliberately **not** that variant: recovery into a fresh batch is a spend no batch can
+  make for an onchain output. Complete the unroll and spend the outputs onchain instead.
+
+  Two required changes for direct callers. The input gains **`paymentHash`** (`sha256(P)` hex — the
+  quote's `payment_hash`, which callers already hold): the exit is read through `readLockupFate`,
+  and the VHTLC script cannot supply it, since its `preimageHash` is a `hash160` of the same secret.
+  And the `indexer` parameter widened from `RefundIndexer` to **`LockupSpendIndexer`**, so it must
+  now carry `getVirtualTxs` as well as `getVtxos` — a real `RestIndexerProvider` already does.
+
+  A lockup funded in two sends of which only one exited reports `exited` for the whole thing and
+  leaves the live half unrefunded. That matches `RfqSwapManager`, which reports the same lockup
+  `exited` on the same any-output rule; the two must not disagree.
 - **`RfqSwapManager` can own its own persistence.** New optional
   `RfqSwapManagerDeps.repository`, new `restoreFromRepository()` and `pruneRetiredSwaps()`, and
   `addSwap(swap, origin?)` gains an optional second argument. Nothing narrows and nothing is

package/dist/{chunk-5NPYNQ5V.js → chunk-XXWOODUE.js}

@@ -17,6 +17,7 @@ var L1_NETWORKS = {
   testnet: btc.TEST_NETWORK,
   regtest: { ...btc.TEST_NETWORK, bech32: "bcrt" }
 };
+var l1ScriptForAddress = (address, network) => btc.OutScript.encode(btc.Address(L1_NETWORKS[network]).decode(address));
 function onchainHtlcScript(params, network) {
   if (params.claimKey.length !== 32 || params.refundKey.length !== 32) {
     throw new Error("claimKey and refundKey must be 32-byte x-only keys");
@@ -199,7 +200,11 @@ async function classifyOnchainHtlc(chain, input) {
   const best = utxos.sort((a, b) => b.amount > a.amount ? 1 : -1)[0];
   if (!best) {
     if (!input.funding) return { phase: "unfunded" };
-    const spend = await chain.getSpendingTx(input.funding.txid, input.funding.vout);
+    const spend = await chain.getSpendingTx(
+      input.funding.txid,
+      input.funding.vout,
+      input.htlc.pkScript
+    );
     if (!spend) return { phase: "unfunded" };
     const preimage = extractPreimage(spend.txHex, input.htlc.paymentHash);
     const txid = btc.Transaction.fromRaw(hex.decode(spend.txHex), {
@@ -422,8 +427,22 @@ var assertPairLength = (pair) => {
 };
 var verifyLockupAddress = (quote, derivedAddress) => {
   const quoted = quote.profile?.lockup_address;
-  if (derivedAddress !== quoted) throw new AddressMismatch(derivedAddress, quoted);
-  return derivedAddress;
+  const candidates = Array.isArray(derivedAddress) ? derivedAddress : [derivedAddress];
+  const matched = candidates.find((address) => address === quoted);
+  if (matched === void 0) throw new AddressMismatch(candidates, quoted);
+  return matched;
+};
+var LOCKUP_SHAPE_VARIANTS = [void 0, "preTimelockedRefund"];
+var matchQuotedLockup = (quote, hrp, serverPubkey, build) => {
+  const candidates = LOCKUP_SHAPE_VARIANTS.map((legacy) => {
+    const script = build(legacy);
+    return { script, address: script.address(hrp, serverPubkey).encode(), legacy };
+  });
+  const matchedAddress = verifyLockupAddress(
+    quote,
+    candidates.map((candidate) => candidate.address)
+  );
+  return candidates.find((candidate) => candidate.address === matchedAddress);
 };
 var assertFundable = (input) => {
   const fail = (reason, message) => {
@@ -437,6 +456,43 @@ var assertFundable = (input) => {
   if (input.quote.refund_locktime !== void 0 && input.quote.refund_locktime - input.now < MIN_HEADROOM_SECONDS) {
     fail("insufficient_headroom", "refund deadline headroom below 90 minutes");
   }
+  if (input.maxFee) {
+    const { bps, sats, referenceRate } = input.maxFee;
+    if (bps === void 0 && sats === void 0) {
+      fail("max_fee_unbounded", "maxFee names neither bps nor sats");
+    }
+    if (bps !== void 0 && (!Number.isInteger(bps) || bps < 0 || bps > 1e4)) {
+      fail("max_fee_out_of_range", `maxFee.bps must be an integer in 0..10000, got ${bps}`);
+    }
+    if (sats !== void 0 && (!Number.isInteger(sats) || sats < 0)) {
+      fail("max_fee_out_of_range", `maxFee.sats must be a non-negative integer, got ${sats}`);
+    }
+    const legs = input.quote.pair.split("->");
+    const assetOf = (leg) => leg.slice(leg.indexOf(":") + 1);
+    const sameAsset = legs.length === 2 && assetOf(legs[0]) === assetOf(legs[1]);
+    if (!sameAsset && referenceRate === void 0) {
+      fail(
+        "fee_gate_unavailable",
+        `maxFee cannot gate ${input.quote.pair}: its legs name different assets, so from_amount - to_amount is not a fee. Supply maxFee.referenceRate (to-units per from-unit) from a source of your OWN \u2014 reading it off the solver's published feed would check the solver against its own number`
+      );
+    }
+    if (!sameAsset && (!Number.isFinite(referenceRate) || referenceRate <= 0)) {
+      fail(
+        "max_fee_out_of_range",
+        `maxFee.referenceRate must be a positive finite number, got ${referenceRate}`
+      );
+    }
+    const fee = sameAsset ? input.quote.from_amount - input.quote.to_amount : Math.ceil(
+      (input.quote.from_amount * referenceRate - input.quote.to_amount) / referenceRate
+    );
+    const allowed = Math.max(
+      sats ?? 0,
+      Math.floor(input.quote.from_amount * (bps ?? 0) / 1e4)
+    );
+    if (fee > allowed) {
+      fail("fee_too_high", `fee ${fee} exceeds the ${allowed} this client allows`);
+    }
+  }
   if (input.onchain) {
     const { htlcLocktime, minConfirmations, direction } = input.onchain;
     if (!Number.isInteger(minConfirmations) || minConfirmations < 1 || minConfirmations > MAX_MIN_CONFIRMATIONS) {
@@ -625,13 +681,11 @@ function lightningSendVtxoScript(params) {
     unilateralRefundWithoutReceiverDelay: seconds(
       unilateralRefundWithoutReceiverDelay(params.claimDelay)
     ),
-    nonInteractiveClaim: {
+    nonInteractiveParameters: {
       receiverPkScript: params.receiverPkScript,
-      emulatorPubkey: params.emulatorPubkey
-    },
-    nonInteractiveRefund: {
       senderPkScript: params.refundPkScript,
-      emulatorPubkey: params.emulatorPubkey
+      emulatorPubkey: params.emulatorPubkey,
+      ...params.legacy !== void 0 && { legacy: params.legacy }
     }
   });
 }
@@ -677,9 +731,18 @@ async function requestLightningSend(wallet, arkServerUrl, transport, params) {
     receiverPkScript: solverHex(receiverPkScriptHex, "profile.receiver_pk_script"),
     refundPkScript: secrets.pkScript
   };
-  const script = lightningSendVtxoScript(treeParams);
-  const address = script.address(network.hrp, serverPubkey).encode();
-  verifyLockupAddress(quote, address);
+  const matched = matchQuotedLockup(
+    quote,
+    network.hrp,
+    serverPubkey,
+    (legacy) => lightningSendVtxoScript({ ...treeParams, ...legacy !== void 0 && { legacy } })
+  );
+  const script = matched.script;
+  const address = matched.address;
+  const matchedTreeParams = {
+    ...treeParams,
+    ...matched.legacy !== void 0 && { legacy: matched.legacy }
+  };
   assertFundable({
     quote,
     invoiceExpiresAt: params.invoice.expiresAt,
@@ -698,7 +761,7 @@ async function requestLightningSend(wallet, arkServerUrl, transport, params) {
     refundAddress,
     senderPubkey,
     secrets,
-    treeParams
+    treeParams: matchedTreeParams
   };
 }
 var offerTermsFromQuote = (quote, assets) => {
@@ -763,7 +826,7 @@ function deriveOnchainSend(input) {
   if (refundLocktime === void 0 || htlcPubkey === void 0 || htlcLocktime === void 0 || minConfirmations === void 0 || receiverPkScriptHex === void 0) {
     throw new Error("onchain-send quote is missing a binding field");
   }
-  const script = lightningSendVtxoScript({
+  const treeParams = {
     solverPubkey: toXOnly(hex3.decode(quote.solver_pubkey), "solver key"),
     refundLocktime,
     serverPubkey: input.serverPubkey,
@@ -773,9 +836,13 @@ function deriveOnchainSend(input) {
     senderPubkey: input.senderPubkey,
     receiverPkScript: solverHex(receiverPkScriptHex, "profile.receiver_pk_script"),
     refundPkScript: ArkAddress2.decode(input.refundAddress).pkScript
-  });
-  const address = script.address(input.hrp, input.serverPubkey).encode();
-  verifyLockupAddress(quote, address);
+  };
+  const { script, address } = matchQuotedLockup(
+    quote,
+    input.hrp,
+    input.serverPubkey,
+    (legacy) => lightningSendVtxoScript({ ...treeParams, ...legacy !== void 0 && { legacy } })
+  );
   const htlcParams = {
     paymentHash: input.paymentHash,
     claimKey: input.payoutPubkey,
@@ -821,6 +888,7 @@ async function requestOnchainSend(wallet, arkServerUrl, transport, params) {
       amountSide: params.amountSide
     })
   );
+  assertQuotedAmount(quote, params.amountSide, params.amount);
   const network = getNetwork(info.network);
   const derived = deriveOnchainSend({
     quote,
@@ -950,13 +1018,11 @@ function receiveVtxoScript(params) {
     unilateralRefundWithoutReceiverDelay: seconds(
       unilateralRefundWithoutReceiverDelay(params.claimDelay)
     ),
-    nonInteractiveClaim: {
+    nonInteractiveParameters: {
       receiverPkScript: params.payoutPkScript,
-      emulatorPubkey: params.emulatorPubkey
-    },
-    nonInteractiveRefund: {
       senderPkScript: params.solverRefundPkScript,
-      emulatorPubkey: params.emulatorPubkey
+      emulatorPubkey: params.emulatorPubkey,
+      ...params.legacy !== void 0 && { legacy: params.legacy }
     }
   });
 }
@@ -980,10 +1046,23 @@ function deriveLightningReceive(input) {
     payoutPubkey: input.payoutPubkey,
     payoutPkScript: ArkAddress2.decode(input.payoutAddress).pkScript
   };
-  const script = receiveVtxoScript(treeParams);
-  const address = script.address(input.hrp, input.serverPubkey).encode();
-  verifyLockupAddress(quote, address);
-  return { address, swapPkScript: script.pkScript, script, invoice, refundLocktime, treeParams };
+  const matched = matchQuotedLockup(
+    quote,
+    input.hrp,
+    input.serverPubkey,
+    (legacy) => receiveVtxoScript({ ...treeParams, ...legacy !== void 0 && { legacy } })
+  );
+  return {
+    address: matched.address,
+    swapPkScript: matched.script.pkScript,
+    script: matched.script,
+    invoice,
+    refundLocktime,
+    treeParams: {
+      ...treeParams,
+      ...matched.legacy !== void 0 && { legacy: matched.legacy }
+    }
+  };
 }
 async function requestLightningReceive(wallet, arkServerUrl, transport, params) {
   const rfqId = params.rfqId ?? newRfqId();
@@ -1071,7 +1150,7 @@ function deriveOnchainReceive(input) {
   if (refundLocktime === void 0 || claimPubkey === void 0 || htlcLocktime === void 0 || minConfirmations === void 0 || solverRefundPkScriptHex === void 0) {
     throw new Error("onchain-receive quote is missing a binding field");
   }
-  const script = receiveVtxoScript({
+  const treeParams = {
     solverPubkey: toXOnly(hex3.decode(quote.solver_pubkey), "solver key"),
     refundLocktime,
     serverPubkey: input.serverPubkey,
@@ -1081,9 +1160,13 @@ function deriveOnchainReceive(input) {
     solverRefundPkScript: solverHex(solverRefundPkScriptHex, "profile.solver_refund_pk_script"),
     payoutPubkey: input.payoutPubkey,
     payoutPkScript: ArkAddress2.decode(input.payoutAddress).pkScript
-  });
-  const address = script.address(input.hrp, input.serverPubkey).encode();
-  verifyLockupAddress(quote, address);
+  };
+  const { script, address } = matchQuotedLockup(
+    quote,
+    input.hrp,
+    input.serverPubkey,
+    (legacy) => receiveVtxoScript({ ...treeParams, ...legacy !== void 0 && { legacy } })
+  );
   const htlc = onchainHtlcScript(
     {
       paymentHash: input.paymentHash,
@@ -1190,6 +1273,8 @@ export {
   ONCHAIN_DUST_SATS,
   newPreimage,
   paymentHashOf,
+  L1_NETWORKS,
+  l1ScriptForAddress,
   onchainHtlcScript,
   buildHtlcClaim,
   buildHtlcRefund,