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

package/src/index.ts

@@ -17,6 +17,18 @@ import * as payments from './payments/index.js';
 import * as script from './script.js';
 import * as crypto from './crypto.js';
 import * as Transaction from './transaction.js';
+// Custom error types
+import {
+    AddressError,
+    BitcoinError,
+    EccError,
+    InvalidInputError,
+    InvalidOutputError,
+    PsbtError,
+    ScriptError,
+    SignatureError,
+    ValidationError,
+} from './errors.js';
 
 export * as address from './address.js';
 export * as crypto from './crypto.js';
@@ -140,19 +152,6 @@ export {
 } from './types.js';
 export type { XOnlyPointAddTweakResult } from './ecc/types.js';
 
-// Custom error types
-import {
-    BitcoinError,
-    ValidationError,
-    InvalidInputError,
-    InvalidOutputError,
-    ScriptError,
-    PsbtError,
-    EccError,
-    AddressError,
-    SignatureError,
-} from './errors.js';
-
 export {
     BitcoinError,
     ValidationError,

package/src/io/BinaryReader.ts

@@ -70,24 +70,6 @@ export class BinaryReader {
         this.#offset = offset;
     }
 
-    /**
-     * Creates a BinaryReader from a hex string.
-     *
-     * @param hex - Hex string (with or without 0x prefix)
-     * @returns A new BinaryReader instance
-     *
-     * @example
-     * ```typescript
-     * import { BinaryReader } from '@btc-vision/bitcoin';
-     *
-     * const reader = BinaryReader.fromHex('01000000');
-     * const version = reader.readInt32LE(); // 1
-     * ```
-     */
-    public static fromHex(hex: string): BinaryReader {
-        return new BinaryReader(fromHex(hex));
-    }
-
     /**
      * Current read position in the buffer.
      */
@@ -129,6 +111,24 @@ export class BinaryReader {
         return this.#data;
     }
 
+    /**
+     * Creates a BinaryReader from a hex string.
+     *
+     * @param hex - Hex string (with or without 0x prefix)
+     * @returns A new BinaryReader instance
+     *
+     * @example
+     * ```typescript
+     * import { BinaryReader } from '@btc-vision/bitcoin';
+     *
+     * const reader = BinaryReader.fromHex('01000000');
+     * const version = reader.readInt32LE(); // 1
+     * ```
+     */
+    public static fromHex(hex: string): BinaryReader {
+        return new BinaryReader(fromHex(hex));
+    }
+
     /**
      * Reads an 8-bit unsigned integer.
      *

package/src/io/BinaryWriter.ts

@@ -91,26 +91,6 @@ export class BinaryWriter {
         this.#view = new DataView(this.#data.buffer, this.#data.byteOffset, this.#data.byteLength);
     }
 
-    /**
-     * Creates a BinaryWriter with automatic capacity management.
-     *
-     * Initial capacity is 256 bytes, grows as needed.
-     *
-     * @returns A new GrowableBinaryWriter instance
-     *
-     * @example
-     * ```typescript
-     * import { BinaryWriter } from '@btc-vision/bitcoin';
-     *
-     * const writer = BinaryWriter.growable();
-     * writer.writeUInt32LE(1);
-     * writer.writeBytes(new Uint8Array(1000)); // Automatically grows
-     * ```
-     */
-    public static growable(initialCapacity: number = 256): GrowableBinaryWriter {
-        return new GrowableBinaryWriter(initialCapacity);
-    }
-
     /**
      * Current write position in the buffer.
      */
@@ -152,6 +132,26 @@ export class BinaryWriter {
         return this.#data;
     }
 
+    /**
+     * Creates a BinaryWriter with automatic capacity management.
+     *
+     * Initial capacity is 256 bytes, grows as needed.
+     *
+     * @returns A new GrowableBinaryWriter instance
+     *
+     * @example
+     * ```typescript
+     * import { BinaryWriter } from '@btc-vision/bitcoin';
+     *
+     * const writer = BinaryWriter.growable();
+     * writer.writeUInt32LE(1);
+     * writer.writeBytes(new Uint8Array(1000)); // Automatically grows
+     * ```
+     */
+    public static growable(initialCapacity: number = 256): GrowableBinaryWriter {
+        return new GrowableBinaryWriter(initialCapacity);
+    }
+
     /**
      * Writes an 8-bit unsigned integer.
      *
@@ -583,29 +583,6 @@ export class GrowableBinaryWriter {
         return this.#data.length;
     }
 
-    /**
-     * Ensures the buffer has enough space for additional bytes.
-     *
-     * @param additionalBytes - Number of additional bytes needed
-     */
-    #ensureCapacity(additionalBytes: number): void {
-        const required = this.#offset + additionalBytes;
-        if (required <= this.#data.length) {
-            return;
-        }
-
-        // Grow by at least 2x or to required size
-        let newCapacity = this.#data.length * 2;
-        while (newCapacity < required) {
-            newCapacity *= 2;
-        }
-
-        const newData = new Uint8Array(newCapacity);
-        newData.set(this.#data.subarray(0, this.#offset));
-        this.#data = newData;
-        this.#view = new DataView(this.#data.buffer);
-    }
-
     public writeUInt8(value: number): this {
         this.#ensureCapacity(1);
         this.#data[this.#offset++] = value & 0xff;
@@ -693,4 +670,27 @@ export class GrowableBinaryWriter {
     public toHex(): string {
         return toHex(this.finish());
     }
+
+    /**
+     * Ensures the buffer has enough space for additional bytes.
+     *
+     * @param additionalBytes - Number of additional bytes needed
+     */
+    #ensureCapacity(additionalBytes: number): void {
+        const required = this.#offset + additionalBytes;
+        if (required <= this.#data.length) {
+            return;
+        }
+
+        // Grow by at least 2x or to required size
+        let newCapacity = this.#data.length * 2;
+        while (newCapacity < required) {
+            newCapacity *= 2;
+        }
+
+        const newData = new Uint8Array(newCapacity);
+        newData.set(this.#data.subarray(0, this.#offset));
+        this.#data = newData;
+        this.#view = new DataView(this.#data.buffer);
+    }
 }

package/src/io/MemoryPool.ts

@@ -77,6 +77,38 @@ export class MemoryPool {
         this.#maxSize = size;
     }
 
+    /**
+     * Total capacity of the pool in bytes.
+     */
+    public get capacity(): number {
+        return this.#maxSize;
+    }
+
+    /**
+     * Current allocation offset (bytes used).
+     *
+     * Uses Atomics for thread-safe reading.
+     */
+    public get used(): number {
+        return Atomics.load(this.#control, 0);
+    }
+
+    /**
+     * Remaining available bytes.
+     */
+    public get available(): number {
+        return this.#maxSize - this.used;
+    }
+
+    /**
+     * The underlying SharedArrayBuffer.
+     *
+     * Can be transferred to Workers for shared memory access.
+     */
+    public get sharedBuffer(): SharedArrayBuffer {
+        return this.#buffer;
+    }
+
     /**
      * Creates a MemoryPool from an existing SharedArrayBuffer.
      *
@@ -111,38 +143,6 @@ export class MemoryPool {
         return pool;
     }
 
-    /**
-     * Total capacity of the pool in bytes.
-     */
-    public get capacity(): number {
-        return this.#maxSize;
-    }
-
-    /**
-     * Current allocation offset (bytes used).
-     *
-     * Uses Atomics for thread-safe reading.
-     */
-    public get used(): number {
-        return Atomics.load(this.#control, 0);
-    }
-
-    /**
-     * Remaining available bytes.
-     */
-    public get available(): number {
-        return this.#maxSize - this.used;
-    }
-
-    /**
-     * The underlying SharedArrayBuffer.
-     *
-     * Can be transferred to Workers for shared memory access.
-     */
-    public get sharedBuffer(): SharedArrayBuffer {
-        return this.#buffer;
-    }
-
     /**
      * Allocates memory from the pool.
      *

package/src/payments/bip341.ts

@@ -1,10 +1,8 @@
 import * as bcrypto from '../crypto.js';
 import { getEccLib } from '../ecc/context.js';
-import { concat, compare, equals, alloc } from '../io/index.js';
-import { varuint } from '../io/index.js';
+import { alloc, compare, concat, equals, varuint } from '../io/index.js';
+import type { Bytes32, Tapleaf, Taptree, XOnlyPublicKey } from '../types.js';
 import { isTapleaf } from '../types.js';
-import type { Tapleaf, Taptree } from '../types.js';
-import type { Bytes32, XOnlyPublicKey } from '../types.js';
 
 export const LEAF_VERSION_TAPSCRIPT = 0xc0;
 export const MAX_TAPTREE_DEPTH = 128;

package/src/payments/embed.ts

@@ -9,9 +9,9 @@
 
 import { bitcoin as BITCOIN_NETWORK, type Network } from '../networks.js';
 import * as bscript from '../script.js';
-import { stacksEqual, type Stack } from '../types.js';
 import type { Script } from '../types.js';
-import { PaymentType, type EmbedPayment, type PaymentOpts } from './types.js';
+import { type Stack, stacksEqual } from '../types.js';
+import { type EmbedPayment, type PaymentOpts, PaymentType } from './types.js';
 
 const OPS = bscript.opcodes;
 
@@ -162,6 +162,20 @@ export class Embed {
 
     // Private computation methods
 
+    /**
+     * Converts to a plain EmbedPayment object for backwards compatibility.
+     *
+     * @returns An EmbedPayment object
+     */
+    toPayment(): EmbedPayment {
+        return {
+            name: this.name,
+            network: this.network,
+            data: this.data,
+            output: this.output,
+        };
+    }
+
     #computeData(): Uint8Array[] | undefined {
         if (this.#inputData) {
             return this.#inputData;
@@ -176,6 +190,8 @@ export class Embed {
         return undefined;
     }
 
+    // Validation
+
     #computeOutput(): Uint8Array | undefined {
         if (this.#inputOutput) {
             return this.#inputOutput;
@@ -186,8 +202,6 @@ export class Embed {
         return bscript.compile(([OPS.OP_RETURN] as Stack).concat(this.#inputData)) as Script;
     }
 
-    // Validation
-
     #validate(): void {
         if (this.#inputOutput) {
             const chunks = bscript.decompile(this.#inputOutput);
@@ -206,20 +220,6 @@ export class Embed {
             }
         }
     }
-
-    /**
-     * Converts to a plain EmbedPayment object for backwards compatibility.
-     *
-     * @returns An EmbedPayment object
-     */
-    toPayment(): EmbedPayment {
-        return {
-            name: this.name,
-            network: this.network,
-            data: this.data,
-            output: this.output,
-        };
-    }
 }
 
 /**

package/src/payments/p2ms.ts

@@ -9,8 +9,15 @@
 
 import { bitcoin as BITCOIN_NETWORK, type Network } from '../networks.js';
 import * as bscript from '../script.js';
-import { isPoint, stacksEqual, type PublicKey, type Script, type Signature, type Stack } from '../types.js';
-import { PaymentType, type P2MSPayment, type PaymentOpts } from './types.js';
+import {
+    isPoint,
+    type PublicKey,
+    type Script,
+    type Signature,
+    type Stack,
+    stacksEqual,
+} from '../types.js';
+import { type P2MSPayment, type PaymentOpts, PaymentType } from './types.js';
 
 const OPS = bscript.opcodes;
 const OP_INT_BASE = OPS.OP_RESERVED; // OP_1 - 1
@@ -274,6 +281,27 @@ export class P2MS {
 
     // Private helper methods
 
+    /**
+     * Converts to a plain P2MSPayment object for backwards compatibility.
+     *
+     * @returns A P2MSPayment object
+     */
+    toPayment(): P2MSPayment {
+        return {
+            name: this.name,
+            network: this.network,
+            m: this.m,
+            n: this.n,
+            pubkeys: this.pubkeys,
+            signatures: this.signatures,
+            output: this.output,
+            input: this.input,
+            witness: this.witness,
+        };
+    }
+
+    // Private computation methods
+
     #decode(output: Uint8Array | Stack): void {
         if (this.#decoded) return;
         this.#decoded = true;
@@ -286,8 +314,6 @@ export class P2MS {
         this.#pubkeysComputed = true;
     }
 
-    // Private computation methods
-
     #computeM(): number | undefined {
         if (this.#inputM !== undefined) {
             return this.#inputM;
@@ -364,6 +390,8 @@ export class P2MS {
         return bscript.compile(([OPS.OP_0] as Stack).concat(this.#inputSignatures)) as Script;
     }
 
+    // Validation
+
     #computeWitness(): Uint8Array[] | undefined {
         if (this.input) {
             return [];
@@ -371,8 +399,6 @@ export class P2MS {
         return undefined;
     }
 
-    // Validation
-
     #isAcceptableSignature(x: Uint8Array | number): boolean {
         return (
             bscript.isCanonicalScriptSignature(x as Uint8Array) ||
@@ -465,25 +491,6 @@ export class P2MS {
             }
         }
     }
-
-    /**
-     * Converts to a plain P2MSPayment object for backwards compatibility.
-     *
-     * @returns A P2MSPayment object
-     */
-    toPayment(): P2MSPayment {
-        return {
-            name: this.name,
-            network: this.network,
-            m: this.m,
-            n: this.n,
-            pubkeys: this.pubkeys,
-            signatures: this.signatures,
-            output: this.output,
-            input: this.input,
-            witness: this.witness,
-        };
-    }
 }
 
 /**

package/src/payments/p2op.ts

@@ -13,7 +13,7 @@ import { bitcoin as BITCOIN_NETWORK, type Network } from '../networks.js';
 import * as bscript from '../script.js';
 import { alloc, concat, equals } from '../io/index.js';
 import type { Bytes20, Script } from '../types.js';
-import { PaymentType, type P2OPPayment, type PaymentOpts } from './types.js';
+import { type P2OPPayment, type PaymentOpts, PaymentType } from './types.js';
 
 const OPS = bscript.opcodes;
 const P2OP_WITNESS_VERSION = 0x10;
@@ -241,6 +241,23 @@ export class P2OP {
 
     // Private helper methods
 
+    /**
+     * Converts to a plain P2OPPayment object for backwards compatibility.
+     *
+     * @returns A P2OPPayment object
+     */
+    toPayment(): P2OPPayment {
+        return {
+            name: this.name,
+            network: this.network,
+            address: this.address,
+            program: this.program,
+            deploymentVersion: this.deploymentVersion,
+            hash160: this.hash160,
+            output: this.output as Script | undefined,
+        };
+    }
+
     #getDecodedAddress(): { version: number; prefix: string; data: Uint8Array } | undefined {
         if (!this.#decodedAddressComputed) {
             if (this.#inputAddress) {
@@ -258,6 +275,8 @@ export class P2OP {
         return this.#decodedAddress;
     }
 
+    // Private computation methods
+
     #makeProgramFromParts(): Uint8Array | undefined {
         if (
             typeof this.#inputDeploymentVersion !== 'undefined' &&
@@ -274,8 +293,6 @@ export class P2OP {
         return undefined;
     }
 
-    // Private computation methods
-
     #computeAddress(): string | undefined {
         if (this.#inputAddress) {
             return this.#inputAddress;
@@ -346,6 +363,8 @@ export class P2OP {
         return prog.subarray(1) as Bytes20;
     }
 
+    // Validation
+
     #computeOutput(): Uint8Array | undefined {
         if (this.#inputOutput) {
             return this.#inputOutput;
@@ -356,8 +375,6 @@ export class P2OP {
         return bscript.compile([OPS.OP_16, prog]);
     }
 
-    // Validation
-
     #validate(): void {
         let prog: Uint8Array = alloc(0);
 
@@ -416,23 +433,6 @@ export class P2OP {
             throw new TypeError('hash160 mismatch');
         }
     }
-
-    /**
-     * Converts to a plain P2OPPayment object for backwards compatibility.
-     *
-     * @returns A P2OPPayment object
-     */
-    toPayment(): P2OPPayment {
-        return {
-            name: this.name,
-            network: this.network,
-            address: this.address,
-            program: this.program,
-            deploymentVersion: this.deploymentVersion,
-            hash160: this.hash160,
-            output: this.output as Script | undefined,
-        };
-    }
 }
 
 /**

package/src/payments/p2pk.ts

@@ -11,7 +11,7 @@ import { bitcoin as BITCOIN_NETWORK, type Network } from '../networks.js';
 import * as bscript from '../script.js';
 import { isPoint, type PublicKey, type Script, type Signature } from '../types.js';
 import { equals } from '../io/index.js';
-import { PaymentType, type P2PKPayment, type PaymentOpts } from './types.js';
+import { type P2PKPayment, type PaymentOpts, PaymentType } from './types.js';
 
 const OPS = bscript.opcodes;
 
@@ -238,6 +238,23 @@ export class P2PK {
 
     // Private computation methods
 
+    /**
+     * Converts to a plain P2PKPayment object for backwards compatibility.
+     *
+     * @returns A P2PKPayment object
+     */
+    toPayment(): P2PKPayment {
+        return {
+            name: this.name,
+            network: this.network,
+            pubkey: this.pubkey,
+            signature: this.signature,
+            output: this.output,
+            input: this.input,
+            witness: this.witness,
+        };
+    }
+
     #computePubkey(): PublicKey | undefined {
         if (this.#inputPubkey) {
             return this.#inputPubkey as PublicKey;
@@ -284,6 +301,8 @@ export class P2PK {
         return undefined;
     }
 
+    // Validation
+
     #computeWitness(): Uint8Array[] | undefined {
         if (this.input) {
             return [];
@@ -291,8 +310,6 @@ export class P2PK {
         return undefined;
     }
 
-    // Validation
-
     #validate(): void {
         if (this.#inputOutput) {
             if (this.#inputOutput[this.#inputOutput.length - 1] !== OPS.OP_CHECKSIG) {
@@ -329,23 +346,6 @@ export class P2PK {
             }
         }
     }
-
-    /**
-     * Converts to a plain P2PKPayment object for backwards compatibility.
-     *
-     * @returns A P2PKPayment object
-     */
-    toPayment(): P2PKPayment {
-        return {
-            name: this.name,
-            network: this.network,
-            pubkey: this.pubkey,
-            signature: this.signature,
-            output: this.output,
-            input: this.input,
-            witness: this.witness,
-        };
-    }
 }
 
 /**