@satora/swap 0.3.1 → 1.0.0

package/dist/bitcoin-reader-electrum-4DOJ7NGH.js

@@ -0,0 +1,7 @@
+import {
+  electrumReader
+} from "./chunk-VHXEU534.js";
+export {
+  electrumReader
+};
+//# sourceMappingURL=bitcoin-reader-electrum-4DOJ7NGH.js.map

package/dist/bitcoin-reader-electrum-4DOJ7NGH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/chunk-VHXEU534.js

@@ -0,0 +1,145 @@
+// src/contracts/bitcoin-reader-electrum.ts
+import { sha256 } from "@noble/hashes/sha2.js";
+import { hex } from "@scure/base";
+import * as btc from "@scure/btc-signer";
+var REGTEST_NETWORK = {
+  bech32: "bcrt",
+  pubKeyHash: 111,
+  scriptHash: 196,
+  wif: 239
+};
+function toBtcSignerNetwork(network) {
+  switch (network) {
+    case "mainnet":
+      return btc.NETWORK;
+    case "testnet":
+    case "signet":
+      return btc.TEST_NETWORK;
+    case "regtest":
+      return REGTEST_NETWORK;
+  }
+}
+function scriptHashOf(script) {
+  return hex.encode(sha256(script).reverse());
+}
+function electrumReader(client, opts) {
+  const network = opts?.network ?? "mainnet";
+  const defaultMinConf = opts?.minConfirmations ?? 0;
+  const fallback = opts?.fallback;
+  const scriptFor = (address) => btc.OutScript.encode(
+    btc.Address(toBtcSignerNetwork(network)).decode(address)
+  );
+  async function getHtlcFactsElectrum(address, required) {
+    const script = scriptFor(address);
+    const scripthash = scriptHashOf(script);
+    const history = await client.request(
+      "blockchain.scripthash.get_history",
+      [scripthash]
+    );
+    if (!history || history.length === 0)
+      return { funding: "absent", fundedSats: 0 };
+    const txs = await Promise.all(
+      history.map(async (entry) => {
+        const raw = await client.request("blockchain.transaction.get", [
+          entry.tx_hash
+        ]);
+        return {
+          entry,
+          tx: btc.Transaction.fromRaw(hex.decode(raw), {
+            allowUnknownOutputs: true,
+            allowUnknownInputs: true,
+            disableScriptCheck: true
+          })
+        };
+      })
+    );
+    const scriptHex = hex.encode(script);
+    const outputIndicesPaying = (tx) => {
+      const indices = [];
+      for (let i = 0; i < tx.outputsLength; i++) {
+        const out = tx.getOutput(i);
+        if (out.script && hex.encode(out.script) === scriptHex) indices.push(i);
+      }
+      return indices;
+    };
+    const funding = txs.find(({ tx }) => outputIndicesPaying(tx).length > 0);
+    if (!funding) return { funding: "absent", fundedSats: 0 };
+    const fundedVouts = outputIndicesPaying(funding.tx);
+    for (const { tx } of txs) {
+      for (let i = 0; i < tx.inputsLength; i++) {
+        const input = tx.getInput(i);
+        if (input.txid && hex.encode(input.txid) === funding.entry.tx_hash && input.index !== void 0 && fundedVouts.includes(input.index)) {
+          return {
+            funding: "confirmed",
+            fundedSats: 0,
+            // already spent — the amount no longer matters
+            spendWitness: (input.finalScriptWitness ?? []).map(
+              (item) => hex.encode(item)
+            )
+          };
+        }
+      }
+    }
+    let fundedSats = 0;
+    for (const i of fundedVouts)
+      fundedSats += Number(funding.tx.getOutput(i).amount ?? 0n);
+    const height = funding.entry.height;
+    const isConfirmed = height > 0;
+    let deepEnough;
+    if (isConfirmed) {
+      if (required <= 1) {
+        deepEnough = true;
+      } else {
+        const tip = await client.request(
+          "blockchain.headers.subscribe",
+          []
+        );
+        deepEnough = tip.height - height + 1 >= required;
+      }
+    } else {
+      deepEnough = required === 0;
+    }
+    return { funding: deepEnough ? "confirmed" : "mempool", fundedSats };
+  }
+  return {
+    async getHtlcFacts(address, minConfirmations) {
+      const required = minConfirmations ?? defaultMinConf;
+      try {
+        return await getHtlcFactsElectrum(address, required);
+      } catch (error) {
+        if (!fallback) throw error;
+        console.warn(
+          "electrumReader: falling back to secondary reader:",
+          error instanceof Error ? error.message : error
+        );
+        return fallback.getHtlcFacts(address, minConfirmations);
+      }
+    },
+    subscribe(address, onChange) {
+      let scripthash;
+      try {
+        scripthash = scriptHashOf(scriptFor(address));
+      } catch (error) {
+        console.warn(
+          "electrumReader: subscribe skipped (address decode failed):",
+          error instanceof Error ? error.message : error
+        );
+        return () => {
+        };
+      }
+      const handler = () => onChange();
+      client.subscribeScriptHash(scripthash, handler).catch((error) => {
+        console.warn(
+          "electrumReader: scripthash subscribe failed:",
+          error instanceof Error ? error.message : error
+        );
+      });
+      return () => client.unsubscribeScriptHash(scripthash, handler);
+    }
+  };
+}
+
+export {
+  electrumReader
+};
+//# sourceMappingURL=chunk-VHXEU534.js.map

package/dist/chunk-VHXEU534.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/contracts/bitcoin-reader-electrum.ts"],"sourcesContent":["/**\n * An Electrum-backed {@link BitcoinChainReader} — reads HTLC facts from our own\n * Fulcrum over WebSocket instead of public esplora REST endpoints.\n *\n * Two advantages over the esplora reader:\n *\n * - **Freshness**: our Fulcrum sees a transaction the moment its bitcoind\n *   accepts it, while public explorers index with a lag — the exact lag that\n *   made a server-funding hint's targeted verify come back \"absent\" and park\n *   the claim on the 60s at-risk poller.\n * - **Push**: implements the reader's optional `subscribe` capability via\n *   `blockchain.scripthash.subscribe`, so the manager reconciles the moment\n *   an HTLC address's history changes instead of waiting for a poll tick.\n *\n * Reads fall back to a wrapped reader (typically the esplora one) whenever the\n * Electrum server errors, so a Fulcrum outage degrades to today's behavior\n * rather than blinding the tracker.\n */\n\nimport { sha256 } from \"@noble/hashes/sha2.js\";\nimport { hex } from \"@scure/base\";\nimport * as btc from \"@scure/btc-signer\";\nimport type { BitcoinHtlcFacts } from \"./bitcoin.js\";\nimport type { BitcoinChainReader } from \"./bitcoin-manager.js\";\nimport type { BitcoinConfirmationPolicy } from \"./bitcoin-reader-esplora.js\";\n\n/** One entry of `blockchain.scripthash.get_history`. */\ntype ElectrumHistoryEntry = {\n  tx_hash: string;\n  /** Block height; 0 for mempool, -1 for mempool with unconfirmed parents. */\n  height: number;\n};\n\n/**\n * The Electrum client surface this reader needs. The pure SDK's\n * `ElectrumWsClient` satisfies it; tests inject a fake.\n */\nexport type ElectrumRpc = {\n  request<T>(method: string, params: unknown[]): Promise<T>;\n  subscribeScriptHash(\n    scripthash: string,\n    onChange: (status: string | null) => void,\n  ): Promise<string | null>;\n  unsubscribeScriptHash(\n    scripthash: string,\n    onChange: (status: string | null) => void,\n  ): void;\n};\n\nexport type ElectrumReaderNetwork =\n  | \"mainnet\"\n  | \"testnet\"\n  | \"signet\"\n  | \"regtest\";\n\n/** btc-signer only ships mainnet/testnet; regtest differs in bech32 prefix. */\nconst REGTEST_NETWORK = {\n  bech32: \"bcrt\",\n  pubKeyHash: 0x6f,\n  scriptHash: 0xc4,\n  wif: 0xef,\n} as const;\n\nfunction toBtcSignerNetwork(network: ElectrumReaderNetwork) {\n  switch (network) {\n    case \"mainnet\":\n      return btc.NETWORK;\n    case \"testnet\":\n    case \"signet\":\n      return btc.TEST_NETWORK;\n    case \"regtest\":\n      return REGTEST_NETWORK;\n  }\n}\n\n/** Electrum scripthash: sha256 of the output script, reversed, hex. */\nfunction scriptHashOf(script: Uint8Array): string {\n  return hex.encode(sha256(script).reverse());\n}\n\n/**\n * Build a {@link BitcoinChainReader} over an Electrum connection, with push\n * support and an optional fallback reader for outages.\n */\nexport function electrumReader(\n  client: ElectrumRpc,\n  opts?: BitcoinConfirmationPolicy & {\n    /** Network the HTLC addresses live on; defaults to mainnet. */\n    network?: ElectrumReaderNetwork;\n    /** Reader consulted when the Electrum server errors (e.g. esplora). */\n    fallback?: BitcoinChainReader;\n  },\n): BitcoinChainReader {\n  const network = opts?.network ?? \"mainnet\";\n  const defaultMinConf = opts?.minConfirmations ?? 0;\n  const fallback = opts?.fallback;\n\n  const scriptFor = (address: string): Uint8Array =>\n    btc.OutScript.encode(\n      btc.Address(toBtcSignerNetwork(network)).decode(address),\n    );\n\n  async function getHtlcFactsElectrum(\n    address: string,\n    required: number,\n  ): Promise<BitcoinHtlcFacts> {\n    const script = scriptFor(address);\n    const scripthash = scriptHashOf(script);\n    const history = await client.request<ElectrumHistoryEntry[]>(\n      \"blockchain.scripthash.get_history\",\n      [scripthash],\n    );\n    if (!history || history.length === 0)\n      return { funding: \"absent\", fundedSats: 0 };\n\n    // HTLC addresses see at most a handful of txs (fund + resolve), so\n    // fetching each raw tx is cheap.\n    const txs = await Promise.all(\n      history.map(async (entry) => {\n        const raw = await client.request<string>(\"blockchain.transaction.get\", [\n          entry.tx_hash,\n        ]);\n        return {\n          entry,\n          tx: btc.Transaction.fromRaw(hex.decode(raw), {\n            allowUnknownOutputs: true,\n            allowUnknownInputs: true,\n            disableScriptCheck: true,\n          }),\n        };\n      }),\n    );\n\n    const scriptHex = hex.encode(script);\n    const outputIndicesPaying = (tx: btc.Transaction): number[] => {\n      const indices: number[] = [];\n      for (let i = 0; i < tx.outputsLength; i++) {\n        const out = tx.getOutput(i);\n        if (out.script && hex.encode(out.script) === scriptHex) indices.push(i);\n      }\n      return indices;\n    };\n\n    const funding = txs.find(({ tx }) => outputIndicesPaying(tx).length > 0);\n    if (!funding) return { funding: \"absent\", fundedSats: 0 };\n    const fundedVouts = outputIndicesPaying(funding.tx);\n\n    // A tx spending one of the funding outputs is the resolving spend; its\n    // witness classifies claim vs refund.\n    for (const { tx } of txs) {\n      for (let i = 0; i < tx.inputsLength; i++) {\n        const input = tx.getInput(i);\n        if (\n          input.txid &&\n          hex.encode(input.txid) === funding.entry.tx_hash &&\n          input.index !== undefined &&\n          fundedVouts.includes(input.index)\n        ) {\n          return {\n            funding: \"confirmed\",\n            fundedSats: 0, // already spent — the amount no longer matters\n            spendWitness: (input.finalScriptWitness ?? []).map((item) =>\n              hex.encode(item),\n            ),\n          };\n        }\n      }\n    }\n\n    let fundedSats = 0;\n    for (const i of fundedVouts)\n      fundedSats += Number(funding.tx.getOutput(i).amount ?? 0n);\n\n    // Same depth policy as the esplora reader: 0/1 read straight off the\n    // confirmed flag; deeper policies need the tip to compute depth.\n    const height = funding.entry.height;\n    const isConfirmed = height > 0;\n    let deepEnough: boolean;\n    if (isConfirmed) {\n      if (required <= 1) {\n        deepEnough = true;\n      } else {\n        const tip = await client.request<{ height: number }>(\n          \"blockchain.headers.subscribe\",\n          [],\n        );\n        deepEnough = tip.height - height + 1 >= required;\n      }\n    } else {\n      deepEnough = required === 0;\n    }\n    return { funding: deepEnough ? \"confirmed\" : \"mempool\", fundedSats };\n  }\n\n  return {\n    async getHtlcFacts(address, minConfirmations) {\n      const required = minConfirmations ?? defaultMinConf;\n      try {\n        return await getHtlcFactsElectrum(address, required);\n      } catch (error) {\n        if (!fallback) throw error;\n        console.warn(\n          \"electrumReader: falling back to secondary reader:\",\n          error instanceof Error ? error.message : error,\n        );\n        return fallback.getHtlcFacts(address, minConfirmations);\n      }\n    },\n\n    subscribe(address, onChange) {\n      // An address the configured network can't decode (e.g. a signet address\n      // under a mainnet-configured reader) must not throw out of register()\n      // and abort tracking — degrade to the poll cadence instead.\n      let scripthash: string;\n      try {\n        scripthash = scriptHashOf(scriptFor(address));\n      } catch (error) {\n        console.warn(\n          \"electrumReader: subscribe skipped (address decode failed):\",\n          error instanceof Error ? error.message : error,\n        );\n        return () => {};\n      }\n      const handler = () => onChange();\n      // Best-effort: if the subscription fails the tracker's poll cadence\n      // remains the backstop, so the error is logged, not thrown.\n      client.subscribeScriptHash(scripthash, handler).catch((error) => {\n        console.warn(\n          \"electrumReader: scripthash subscribe failed:\",\n          error instanceof Error ? error.message : error,\n        );\n      });\n      return () => client.unsubscribeScriptHash(scripthash, handler);\n    },\n  };\n}\n"],"mappings":";AAmBA,SAAS,cAAc;AACvB,SAAS,WAAW;AACpB,YAAY,SAAS;AAmCrB,IAAM,kBAAkB;AAAA,EACtB,QAAQ;AAAA,EACR,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,KAAK;AACP;AAEA,SAAS,mBAAmB,SAAgC;AAC1D,UAAQ,SAAS;AAAA,IACf,KAAK;AACH,aAAW;AAAA,IACb,KAAK;AAAA,IACL,KAAK;AACH,aAAW;AAAA,IACb,KAAK;AACH,aAAO;AAAA,EACX;AACF;AAGA,SAAS,aAAa,QAA4B;AAChD,SAAO,IAAI,OAAO,OAAO,MAAM,EAAE,QAAQ,CAAC;AAC5C;AAMO,SAAS,eACd,QACA,MAMoB;AACpB,QAAM,UAAU,MAAM,WAAW;AACjC,QAAM,iBAAiB,MAAM,oBAAoB;AACjD,QAAM,WAAW,MAAM;AAEvB,QAAM,YAAY,CAAC,YACb,cAAU;AAAA,IACR,YAAQ,mBAAmB,OAAO,CAAC,EAAE,OAAO,OAAO;AAAA,EACzD;AAEF,iBAAe,qBACb,SACA,UAC2B;AAC3B,UAAM,SAAS,UAAU,OAAO;AAChC,UAAM,aAAa,aAAa,MAAM;AACtC,UAAM,UAAU,MAAM,OAAO;AAAA,MAC3B;AAAA,MACA,CAAC,UAAU;AAAA,IACb;AACA,QAAI,CAAC,WAAW,QAAQ,WAAW;AACjC,aAAO,EAAE,SAAS,UAAU,YAAY,EAAE;AAI5C,UAAM,MAAM,MAAM,QAAQ;AAAA,MACxB,QAAQ,IAAI,OAAO,UAAU;AAC3B,cAAM,MAAM,MAAM,OAAO,QAAgB,8BAA8B;AAAA,UACrE,MAAM;AAAA,QACR,CAAC;AACD,eAAO;AAAA,UACL;AAAA,UACA,IAAQ,gBAAY,QAAQ,IAAI,OAAO,GAAG,GAAG;AAAA,YAC3C,qBAAqB;AAAA,YACrB,oBAAoB;AAAA,YACpB,oBAAoB;AAAA,UACtB,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,YAAY,IAAI,OAAO,MAAM;AACnC,UAAM,sBAAsB,CAAC,OAAkC;AAC7D,YAAM,UAAoB,CAAC;AAC3B,eAAS,IAAI,GAAG,IAAI,GAAG,eAAe,KAAK;AACzC,cAAM,MAAM,GAAG,UAAU,CAAC;AAC1B,YAAI,IAAI,UAAU,IAAI,OAAO,IAAI,MAAM,MAAM,UAAW,SAAQ,KAAK,CAAC;AAAA,MACxE;AACA,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,IAAI,KAAK,CAAC,EAAE,GAAG,MAAM,oBAAoB,EAAE,EAAE,SAAS,CAAC;AACvE,QAAI,CAAC,QAAS,QAAO,EAAE,SAAS,UAAU,YAAY,EAAE;AACxD,UAAM,cAAc,oBAAoB,QAAQ,EAAE;AAIlD,eAAW,EAAE,GAAG,KAAK,KAAK;AACxB,eAAS,IAAI,GAAG,IAAI,GAAG,cAAc,KAAK;AACxC,cAAM,QAAQ,GAAG,SAAS,CAAC;AAC3B,YACE,MAAM,QACN,IAAI,OAAO,MAAM,IAAI,MAAM,QAAQ,MAAM,WACzC,MAAM,UAAU,UAChB,YAAY,SAAS,MAAM,KAAK,GAChC;AACA,iBAAO;AAAA,YACL,SAAS;AAAA,YACT,YAAY;AAAA;AAAA,YACZ,eAAe,MAAM,sBAAsB,CAAC,GAAG;AAAA,cAAI,CAAC,SAClD,IAAI,OAAO,IAAI;AAAA,YACjB;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,QAAI,aAAa;AACjB,eAAW,KAAK;AACd,oBAAc,OAAO,QAAQ,GAAG,UAAU,CAAC,EAAE,UAAU,EAAE;AAI3D,UAAM,SAAS,QAAQ,MAAM;AAC7B,UAAM,cAAc,SAAS;AAC7B,QAAI;AACJ,QAAI,aAAa;AACf,UAAI,YAAY,GAAG;AACjB,qBAAa;AAAA,MACf,OAAO;AACL,cAAM,MAAM,MAAM,OAAO;AAAA,UACvB;AAAA,UACA,CAAC;AAAA,QACH;AACA,qBAAa,IAAI,SAAS,SAAS,KAAK;AAAA,MAC1C;AAAA,IACF,OAAO;AACL,mBAAa,aAAa;AAAA,IAC5B;AACA,WAAO,EAAE,SAAS,aAAa,cAAc,WAAW,WAAW;AAAA,EACrE;AAEA,SAAO;AAAA,IACL,MAAM,aAAa,SAAS,kBAAkB;AAC5C,YAAM,WAAW,oBAAoB;AACrC,UAAI;AACF,eAAO,MAAM,qBAAqB,SAAS,QAAQ;AAAA,MACrD,SAAS,OAAO;AACd,YAAI,CAAC,SAAU,OAAM;AACrB,gBAAQ;AAAA,UACN;AAAA,UACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC3C;AACA,eAAO,SAAS,aAAa,SAAS,gBAAgB;AAAA,MACxD;AAAA,IACF;AAAA,IAEA,UAAU,SAAS,UAAU;AAI3B,UAAI;AACJ,UAAI;AACF,qBAAa,aAAa,UAAU,OAAO,CAAC;AAAA,MAC9C,SAAS,OAAO;AACd,gBAAQ;AAAA,UACN;AAAA,UACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC3C;AACA,eAAO,MAAM;AAAA,QAAC;AAAA,MAChB;AACA,YAAM,UAAU,MAAM,SAAS;AAG/B,aAAO,oBAAoB,YAAY,OAAO,EAAE,MAAM,CAAC,UAAU;AAC/D,gBAAQ;AAAA,UACN;AAAA,UACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC3C;AAAA,MACF,CAAC;AACD,aAAO,MAAM,OAAO,sBAAsB,YAAY,OAAO;AAAA,IAC/D;AAAA,EACF;AACF;","names":[]}