@btc-vision/bitcoin 7.0.0-beta.0 → 7.0.0-beta.1

package/benchmark-compare/harness.ts

@@ -1,10 +1,10 @@
 /**
  * Shared benchmark infrastructure for comparison benchmarks.
- *
  * Provides consistent measurement (warmup + iterations), statistics,
  * and ASCII table formatting.
  */
 
+/** Statistical results from a single benchmark measurement. */
 export interface BenchResult {
     name: string;
     mean: number;
@@ -16,6 +16,7 @@ export interface BenchResult {
     samples: number;
 }
 
+/** Options for controlling warmup and iteration counts. */
 export interface MeasureOpts {
     warmup?: number;
     iterations?: number;
@@ -24,9 +25,7 @@ export interface MeasureOpts {
 const DEFAULT_WARMUP = 5;
 const DEFAULT_ITERATIONS = 50;
 
-/**
- * Force GC if --expose-gc is available.
- */
+/** Forces garbage collection if `--expose-gc` is available. */
 function tryGC(): void {
     if (typeof globalThis.gc === 'function') {
         globalThis.gc();
@@ -34,7 +33,10 @@ function tryGC(): void {
 }
 
 /**
- * Run a function with warmup + measurement iterations, return stats.
+ * Runs a function with warmup + measurement iterations and returns statistical results.
+ * @param name - Display name for the benchmark.
+ * @param fn - The function to benchmark (sync or async).
+ * @param opts - Optional warmup and iteration overrides.
  */
 export async function measure(
     name: string,
@@ -44,14 +46,12 @@ export async function measure(
     const warmup = opts.warmup ?? DEFAULT_WARMUP;
     const iterations = opts.iterations ?? DEFAULT_ITERATIONS;
 
-    // Warmup
     for (let i = 0; i < warmup; i++) {
         await fn();
     }
 
     tryGC();
 
-    // Measure
     const times: number[] = [];
     for (let i = 0; i < iterations; i++) {
         const t0 = performance.now();
@@ -74,7 +74,7 @@ export async function measure(
 }
 
 /**
- * Measure a synchronous function.
+ * Measures a synchronous function. Convenience wrapper around {@link measure}.
  */
 export async function measureSync(
     name: string,
@@ -84,9 +84,7 @@ export async function measureSync(
     return measure(name, fn, opts);
 }
 
-/**
- * Format milliseconds nicely.
- */
+/** Formats milliseconds into a human-readable string (ns/us/ms/s). */
 export function fmt(ms: number): string {
     if (ms < 0.001) return `${(ms * 1_000_000).toFixed(0)}ns`;
     if (ms < 1) return `${(ms * 1000).toFixed(0)}us`;
@@ -94,41 +92,43 @@ export function fmt(ms: number): string {
     return `${(ms / 1000).toFixed(2)}s`;
 }
 
+/** A row in the comparison table with results from all libraries. */
 export interface ComparisonRow {
     scenario: string;
     detail: string;
     fork: BenchResult | null;
     forkNoble: BenchResult | null;
+    scure: BenchResult | null;
     official: BenchResult | null;
 }
 
-/**
- * Print an aligned ASCII comparison table.
- */
+/** Prints an aligned ASCII comparison table to stdout. */
 export function printComparison(title: string, rows: ComparisonRow[]): void {
+    const W = 130;
     console.log();
-    console.log('='.repeat(110));
+    console.log('='.repeat(W));
     console.log(`  ${title}`);
-    console.log('='.repeat(110));
+    console.log('='.repeat(W));
 
     const header = [
         pad('Scenario', 28),
         pad('Detail', 12),
         pad('Fork (Noble)', 14),
         pad('Fork (tiny)', 14),
+        pad('Scure', 14),
         pad('Official', 14),
         pad('Improvement', 14),
     ].join(' | ');
 
     console.log(header);
-    console.log('-'.repeat(110));
+    console.log('-'.repeat(W));
 
     for (const row of rows) {
         const forkNobleMs = row.forkNoble ? fmt(row.forkNoble.median) : '-';
         const forkMs = row.fork ? fmt(row.fork.median) : '-';
+        const scureMs = row.scure ? fmt(row.scure.median) : '-';
         const officialMs = row.official ? fmt(row.official.median) : '-';
 
-        // Calculate improvement: official vs best fork (smallest median wins)
         let improvement = '-';
         const candidates = [row.forkNoble, row.fork].filter(Boolean) as BenchResult[];
         const bestFork = candidates.length > 0
@@ -150,6 +150,7 @@ export function printComparison(title: string, rows: ComparisonRow[]): void {
             pad(row.detail, 12),
             pad(forkNobleMs, 14),
             pad(forkMs, 14),
+            pad(scureMs, 14),
             pad(officialMs, 14),
             pad(improvement, 14),
         ].join(' | ');
@@ -157,7 +158,7 @@ export function printComparison(title: string, rows: ComparisonRow[]): void {
         console.log(line);
     }
 
-    console.log('='.repeat(110));
+    console.log('='.repeat(W));
     console.log();
 }
 
@@ -165,9 +166,7 @@ function pad(s: string, n: number): string {
     return s.length >= n ? s.slice(0, n) : s + ' '.repeat(n - s.length);
 }
 
-/**
- * Print a simple results table for fork-only scenarios (e.g., parallel signing).
- */
+/** Prints a simple results table for fork-only scenarios (e.g., parallel signing). */
 export function printForkOnly(title: string, rows: { scenario: string; detail: string; result: BenchResult }[]): void {
     console.log();
     console.log('='.repeat(80));
@@ -198,9 +197,7 @@ export function printForkOnly(title: string, rows: { scenario: string; detail: s
     console.log();
 }
 
-/**
- * Summary JSON record for machine-readable output.
- */
+/** Machine-readable JSON summary of all benchmark results. */
 export interface BenchSummary {
     timestamp: string;
     node: string;
@@ -209,6 +206,7 @@ export interface BenchSummary {
     scenarios: Record<string, BenchResult>;
 }
 
+/** Builds a {@link BenchSummary} from collected results. */
 export function buildSummary(results: Record<string, BenchResult>): BenchSummary {
     return {
         timestamp: new Date().toISOString(),

package/benchmark-compare/package.json

@@ -9,6 +9,7 @@
     "bench:gc": "node --expose-gc --import tsx compare.bench.ts"
   },
   "devDependencies": {
+    "@scure/btc-signer": "^2.0.1",
     "bitcoinjs-lib": "^7.0.1",
     "ecpair": "^3.0.0",
     "tiny-secp256k1": "^2.2.4",

package/browser/address.d.ts

@@ -1,6 +1,6 @@
 import { Bech32Result, fromBech32 } from './bech32utils.js';
 import { Network } from './networks.js';
-import { Bytes20 } from './types.js';
+import { Bytes20, Script } from './types.js';
 export { fromBech32, type Bech32Result };
 /** base58check decode result */
 export interface Base58CheckResult {
@@ -46,7 +46,7 @@ export declare function toBech32(data: Uint8Array, version: number, prefix: stri
  * P2WPKH, P2WSH, P2TR) to avoid constructing payment objects and catching
  * exceptions. Falls back to payment constructors for exotic types.
  */
-export declare function fromOutputScript(output: Uint8Array, network?: Network): string;
+export declare function fromOutputScript(output: Uint8Array | Script, network?: Network): string;
 /**
  * Options for toOutputScript function.
  */
@@ -67,7 +67,7 @@ export interface ToOutputScriptOptions {
  * Encodes address to output script with network, return output script if address matched.
  * @param address - The address to encode
  * @param networkOrOptions - Network or options object
- * @returns The output script as Uint8Array
+ * @returns The output script
  */
-export declare function toOutputScript(address: string, networkOrOptions?: Network | ToOutputScriptOptions): Uint8Array;
+export declare function toOutputScript(address: string, networkOrOptions?: Network | ToOutputScriptOptions): Script;
 //# sourceMappingURL=address.d.ts.map

package/browser/address.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAU7C,OAAO,EACH,KAAK,OAAO,EAMf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,CAAC;AAEzC,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAC9B,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC5B;AAED,eAAO,MAAM,sBAAsB,EAAE,MAAW,CAAC;AACjD,eAAO,MAAM,sBAAsB,EAAE,MAAU,CAAC;AAChD,eAAO,MAAM,yBAAyB,EAAE,MAAW,CAAC;AACpD,eAAO,MAAM,kBAAkB,EAAE,MAAW,CAAC;AAC7C,eAAO,MAAM,oBAAoB,EAAE,MAAW,CAAC;AAC/C,eAAO,MAAM,yBAAyB,EAAE,MAAU,CAAC;AACnD,eAAO,MAAM,0BAA0B,EAAE,MAAa,CAAC;AAOvD,eAAO,MAAM,sBAAsB,GAAI,QAAQ,UAAU,KAAG,OAoB3D,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAsCjF;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAkBnF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAWlE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CASpE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CACpB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,GACrB,MAAM,CASR;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CA+C9E;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,EACf,gBAAgB,CAAC,EAAE,OAAO,GAAG,qBAAqB,GACnD,UAAU,CAwEZ"}
+{"version":3,"file":"address.d.ts","sourceRoot":"","sources":["../src/address.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAW7C,OAAO,EACH,KAAK,OAAO,EACZ,KAAK,MAAM,EAMd,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,UAAU,EAAE,KAAK,YAAY,EAAE,CAAC;AAEzC,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAC9B,mBAAmB;IACnB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,qDAAqD;IACrD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC5B;AAED,eAAO,MAAM,sBAAsB,EAAE,MAAW,CAAC;AACjD,eAAO,MAAM,sBAAsB,EAAE,MAAU,CAAC;AAChD,eAAO,MAAM,yBAAyB,EAAE,MAAW,CAAC;AACpD,eAAO,MAAM,kBAAkB,EAAE,MAAW,CAAC;AAC7C,eAAO,MAAM,oBAAoB,EAAE,MAAW,CAAC;AAC/C,eAAO,MAAM,yBAAyB,EAAE,MAAU,CAAC;AACnD,eAAO,MAAM,0BAA0B,EAAE,MAAa,CAAC;AAOvD,eAAO,MAAM,sBAAsB,GAAI,QAAQ,UAAU,KAAG,OAoB3D,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAuCjF;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAkBnF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAWlE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CASpE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CACpB,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,WAAW,CAAC,EAAE,MAAM,GACrB,MAAM,CASR;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAsDvF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,OAAO,EAAE,MAAM,EACf,gBAAgB,CAAC,EAAE,OAAO,GAAG,qBAAqB,GACnD,MAAM,CA0ER"}