@btc-vision/bitcoin 6.3.6 → 6.4.0

package/src/bufferutils.ts

@@ -1,180 +1,188 @@
-import * as varuint from 'varuint-bitcoin';
-import * as types from './types.js';
-
-const { typeforce } = types;
-
-export { varuint };
-
-// https://github.com/feross/buffer/blob/master/index.js#L1127
-function verifuint(value: number, max: number): void {
-    if (typeof value !== 'number') throw new Error('cannot write a non-number as a number');
-    if (value < 0) throw new Error('specified a negative value for writing an unsigned value');
-    if (value > max) throw new Error('RangeError: value out of range');
-    if (Math.floor(value) !== value) throw new Error('value has a fractional component');
-}
-
-export function readUInt64LE(buffer: Buffer, offset: number): number {
-    const a = buffer.readUInt32LE(offset);
-    let b = buffer.readUInt32LE(offset + 4);
-    b *= 0x100000000;
-
-    verifuint(b + a, 0x001fffffffffffff);
-    return b + a;
-}
-
-/**
- * Writes a 64-bit unsigned integer in little-endian format to the specified buffer at the given offset.
- *
- * @param buffer - The buffer to write the value to.
- * @param value - The 64-bit unsigned integer value to write.
- * @param offset - The offset in the buffer where the value should be written.
- * @returns The new offset after writing the value.
- */
-export function writeUInt64LE(buffer: Buffer, value: number, offset: number): number {
-    verifuint(value, 0x001fffffffffffff);
-
-    buffer.writeInt32LE(value & -1, offset);
-    buffer.writeUInt32LE(Math.floor(value / 0x100000000), offset + 4);
-    return offset + 8;
-}
-
-/**
- * Reverses the order of bytes in a buffer.
- * @param buffer - The buffer to reverse.
- * @returns A new buffer with the bytes reversed.
- */
-export function reverseBuffer(buffer: Buffer): Buffer {
-    if (buffer.length < 1) return buffer;
-    let j = buffer.length - 1;
-    let tmp = 0;
-    for (let i = 0; i < buffer.length / 2; i++) {
-        tmp = buffer[i];
-        buffer[i] = buffer[j];
-        buffer[j] = tmp;
-        j--;
-    }
-    return buffer;
-}
-
-export function cloneBuffer(buffer: Buffer): Buffer {
-    const clone = Buffer.allocUnsafe(buffer.length);
-    buffer.copy(clone);
-    return clone;
-}
-
-/**
- * Helper class for serialization of bitcoin data types into a pre-allocated buffer.
- */
-export class BufferWriter {
-    constructor(public buffer: Buffer, public offset: number = 0) {
-        typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
-    }
-
-    static withCapacity(size: number): BufferWriter {
-        return new BufferWriter(Buffer.alloc(size));
-    }
-
-    writeUInt8(i: number): void {
-        this.offset = this.buffer.writeUInt8(i, this.offset);
-    }
-
-    writeInt32(i: number): void {
-        this.offset = this.buffer.writeInt32LE(i, this.offset);
-    }
-
-    writeUInt32(i: number): void {
-        this.offset = this.buffer.writeUInt32LE(i, this.offset);
-    }
-
-    writeUInt64(i: number): void {
-        this.offset = writeUInt64LE(this.buffer, i, this.offset);
-    }
-
-    writeVarInt(i: number): void {
-        varuint.encode(i, this.buffer, this.offset);
-        this.offset += varuint.encode.bytes;
-    }
-
-    writeSlice(slice: Buffer): void {
-        if (this.buffer.length < this.offset + slice.length) {
-            throw new Error('Cannot write slice out of bounds');
-        }
-        this.offset += slice.copy(this.buffer, this.offset);
-    }
-
-    writeVarSlice(slice: Buffer): void {
-        this.writeVarInt(slice.length);
-        this.writeSlice(slice);
-    }
-
-    writeVector(vector: Buffer[]): void {
-        this.writeVarInt(vector.length);
-        vector.forEach((buf: Buffer) => this.writeVarSlice(buf));
-    }
-
-    end(): Buffer {
-        if (this.buffer.length === this.offset) {
-            return this.buffer;
-        }
-        throw new Error(`buffer size ${this.buffer.length}, offset ${this.offset}`);
-    }
-}
-
-/**
- * Helper class for reading of bitcoin data types from a buffer.
- */
-export class BufferReader {
-    constructor(public buffer: Buffer, public offset: number = 0) {
-        typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
-    }
-
-    readUInt8(): number {
-        const result = this.buffer.readUInt8(this.offset);
-        this.offset++;
-        return result;
-    }
-
-    readInt32(): number {
-        const result = this.buffer.readInt32LE(this.offset);
-        this.offset += 4;
-        return result;
-    }
-
-    readUInt32(): number {
-        const result = this.buffer.readUInt32LE(this.offset);
-        this.offset += 4;
-        return result;
-    }
-
-    readUInt64(): number {
-        const result = readUInt64LE(this.buffer, this.offset);
-        this.offset += 8;
-        return result;
-    }
-
-    readVarInt(): number {
-        const vi = varuint.decode(this.buffer, this.offset);
-        this.offset += varuint.decode.bytes;
-        return vi;
-    }
-
-    readSlice(n: number): Buffer {
-        if (this.buffer.length < this.offset + n) {
-            throw new Error('Cannot read slice out of bounds');
-        }
-        const result = this.buffer.slice(this.offset, this.offset + n);
-        this.offset += n;
-        return result;
-    }
-
-    readVarSlice(): Buffer {
-        return this.readSlice(this.readVarInt());
-    }
-
-    readVector(): Buffer[] {
-        const count = this.readVarInt();
-        const vector: Buffer[] = [];
-        for (let i = 0; i < count; i++) vector.push(this.readVarSlice());
-        return vector;
-    }
-}
+import * as varuint from 'varuint-bitcoin';
+import * as types from './types.js';
+
+const { typeforce } = types;
+
+export { varuint };
+
+// https://github.com/feross/buffer/blob/master/index.js#L1127
+function verifuint(value: number, max: number): void {
+    if (typeof value !== 'number') throw new Error('cannot write a non-number as a number');
+    if (value < 0) throw new Error('specified a negative value for writing an unsigned value');
+    if (value > max) throw new Error('RangeError: value out of range');
+    if (Math.floor(value) !== value) throw new Error('value has a fractional component');
+}
+
+export function readUInt64LE(buffer: Buffer, offset: number): number {
+    const a = buffer.readUInt32LE(offset);
+    let b = buffer.readUInt32LE(offset + 4);
+    b *= 0x100000000;
+
+    verifuint(b + a, 0x001fffffffffffff);
+    return b + a;
+}
+
+/**
+ * Writes a 64-bit unsigned integer in little-endian format to the specified buffer at the given offset.
+ *
+ * @param buffer - The buffer to write the value to.
+ * @param value - The 64-bit unsigned integer value to write.
+ * @param offset - The offset in the buffer where the value should be written.
+ * @returns The new offset after writing the value.
+ */
+export function writeUInt64LE(buffer: Buffer, value: number, offset: number): number {
+    verifuint(value, 0x001fffffffffffff);
+
+    buffer.writeInt32LE(value & -1, offset);
+    buffer.writeUInt32LE(Math.floor(value / 0x100000000), offset + 4);
+    return offset + 8;
+}
+
+/**
+ * Reverses the order of bytes in a buffer.
+ * @param buffer - The buffer to reverse.
+ * @returns A new buffer with the bytes reversed.
+ */
+export function reverseBuffer(buffer: Buffer): Buffer {
+    if (buffer.length < 1) return buffer;
+    let j = buffer.length - 1;
+    let tmp = 0;
+    for (let i = 0; i < buffer.length / 2; i++) {
+        tmp = buffer[i];
+        buffer[i] = buffer[j];
+        buffer[j] = tmp;
+        j--;
+    }
+    return buffer;
+}
+
+export function cloneBuffer(buffer: Buffer): Buffer {
+    const clone = Buffer.allocUnsafe(buffer.length);
+    buffer.copy(clone);
+    return clone;
+}
+
+/**
+ * Helper class for serialization of bitcoin data types into a pre-allocated buffer.
+ */
+export class BufferWriter {
+    constructor(
+        public buffer: Buffer,
+        public offset: number = 0,
+    ) {
+        typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
+    }
+
+    static withCapacity(size: number): BufferWriter {
+        return new BufferWriter(Buffer.alloc(size));
+    }
+
+    writeUInt8(i: number): void {
+        this.offset = this.buffer.writeUInt8(i, this.offset);
+    }
+
+    writeInt32(i: number): void {
+        this.offset = this.buffer.writeInt32LE(i, this.offset);
+    }
+
+    writeUInt32(i: number): void {
+        this.offset = this.buffer.writeUInt32LE(i, this.offset);
+    }
+
+    writeUInt64(i: number): void {
+        this.offset = writeUInt64LE(this.buffer, i, this.offset);
+    }
+
+    writeVarInt(i: number): void {
+        const encode = varuint.encode(i, this.buffer, this.offset);
+        this.offset += encode.bytes;
+    }
+
+    writeSlice(slice: Buffer): void {
+        if (this.buffer.length < this.offset + slice.length) {
+            throw new Error('Cannot write slice out of bounds');
+        }
+        this.offset += slice.copy(this.buffer, this.offset);
+    }
+
+    writeVarSlice(slice: Buffer): void {
+        this.writeVarInt(slice.length);
+        this.writeSlice(slice);
+    }
+
+    writeVector(vector: Buffer[]): void {
+        this.writeVarInt(vector.length);
+        vector.forEach((buf: Buffer) => this.writeVarSlice(buf));
+    }
+
+    end(): Buffer {
+        if (this.buffer.length === this.offset) {
+            return this.buffer;
+        }
+        throw new Error(`buffer size ${this.buffer.length}, offset ${this.offset}`);
+    }
+}
+
+/**
+ * Helper class for reading of bitcoin data types from a buffer.
+ */
+export class BufferReader {
+    constructor(
+        public buffer: Buffer,
+        public offset: number = 0,
+    ) {
+        typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
+    }
+
+    readUInt8(): number {
+        const result = this.buffer.readUInt8(this.offset);
+        this.offset++;
+        return result;
+    }
+
+    readInt32(): number {
+        const result = this.buffer.readInt32LE(this.offset);
+        this.offset += 4;
+        return result;
+    }
+
+    readUInt32(): number {
+        const result = this.buffer.readUInt32LE(this.offset);
+        this.offset += 4;
+        return result;
+    }
+
+    readUInt64(): number {
+        const result = readUInt64LE(this.buffer, this.offset);
+        this.offset += 8;
+        return result;
+    }
+
+    readVarInt(): number {
+        const vi = varuint.decode(this.buffer, this.offset);
+        this.offset += vi.bytes;
+
+        return vi.numberValue || 0;
+    }
+
+    readSlice(n: number): Buffer {
+        if (this.buffer.length < this.offset + n) {
+            throw new Error('Cannot read slice out of bounds');
+        }
+
+        const result = this.buffer.subarray(this.offset, this.offset + n);
+        this.offset += n;
+        return result;
+    }
+
+    readVarSlice(): Buffer {
+        return this.readSlice(this.readVarInt());
+    }
+
+    readVector(): Buffer[] {
+        const count = this.readVarInt();
+        const vector: Buffer[] = [];
+        for (let i = 0; i < count; i++) vector.push(this.readVarSlice());
+        return vector;
+    }
+}

package/src/index.ts

@@ -1,86 +1,86 @@
-import {
-    PsbtInput as _PsbtInput,
-    PsbtInputUpdate as _PsbtInputUpdate,
-    PsbtOutput as _PsbtOutput,
-    TapBip32Derivation as _TapBip32Derivation,
-    TapInternalKey as _TapInternalKey,
-    TapKeySig as _TapKeySig,
-    TapLeaf as _TapLeaf,
-    TapLeafScript as _TapLeafScript,
-    TapMerkleRoot as _TapMerkleRoot,
-    TapScriptSig as _TapScriptSig,
-    TapTree as _TapTree,
-} from 'bip174/src/lib/interfaces.js';
-import * as networks from './networks.js';
-import * as address from './address.js';
-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';
-
-export * as address from './address.js';
-export * as crypto from './crypto.js';
-export * as networks from './networks.js';
-export * as payments from './payments/index.js';
-export * as script from './script.js';
-
-export { Block } from './block.js';
-/** @hidden */
-export * from './crypto.js';
-export * from './psbt.js';
-/** @hidden */
-export { OPS as opcodes } from './ops.js';
-export { Transaction } from './transaction.js';
-/** @hidden */
-export { Network } from './networks.js';
-/** @hidden */
-export { initEccLib } from './ecc_lib.js';
-export { Payment, PaymentCreator, PaymentOpts, Stack, StackElement } from './payments/index.js';
-export { Input as TxInput, Output as TxOutput } from './transaction.js';
-
-export interface PsbtInput extends _PsbtInput {}
-
-export interface PsbtOutput extends _PsbtOutput {}
-
-export interface TapInternalKey extends _TapInternalKey {}
-
-export interface TapLeaf extends _TapLeaf {}
-
-export interface TapScriptSig extends _TapScriptSig {}
-
-export interface TapKeySig extends _TapKeySig {}
-
-export interface TapTree extends _TapTree {}
-
-export interface TapMerkleRoot extends _TapMerkleRoot {}
-
-export interface TapLeafScript extends _TapLeafScript {}
-
-export interface TapBip32Derivation extends _TapBip32Derivation {}
-
-export interface PsbtInputUpdate extends _PsbtInputUpdate {}
-
-export * from './psbt/bip371.js';
-export * from './address.js';
-export * from './bufferutils.js';
-export * from './payments/bip341.js';
-export * from './psbt/psbtutils.js';
-
-export {
-    Taptree,
-    XOnlyPointAddTweakResult,
-    Tapleaf,
-    TinySecp256k1Interface,
-    TAPLEAF_VERSION_MASK,
-} from './types.js';
-
-const bitcoin = {
-    networks,
-    address,
-    payments,
-    script,
-    crypto,
-    Transaction,
-};
-
-export default bitcoin;
+import {
+    PsbtInput as _PsbtInput,
+    PsbtInputUpdate as _PsbtInputUpdate,
+    PsbtOutput as _PsbtOutput,
+    TapBip32Derivation as _TapBip32Derivation,
+    TapInternalKey as _TapInternalKey,
+    TapKeySig as _TapKeySig,
+    TapLeaf as _TapLeaf,
+    TapLeafScript as _TapLeafScript,
+    TapMerkleRoot as _TapMerkleRoot,
+    TapScriptSig as _TapScriptSig,
+    TapTree as _TapTree,
+} from 'bip174/src/lib/interfaces.js';
+import * as networks from './networks.js';
+import * as address from './address.js';
+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';
+
+export * as address from './address.js';
+export * as crypto from './crypto.js';
+export * as networks from './networks.js';
+export * as payments from './payments/index.js';
+export * as script from './script.js';
+
+export { Block } from './block.js';
+/** @hidden */
+export * from './crypto.js';
+export * from './psbt.js';
+/** @hidden */
+export { OPS as opcodes } from './ops.js';
+export { Transaction } from './transaction.js';
+/** @hidden */
+export { Network } from './networks.js';
+/** @hidden */
+export { initEccLib } from './ecc_lib.js';
+export { Payment, PaymentCreator, PaymentOpts, Stack, StackElement } from './payments/index.js';
+export { Input as TxInput, Output as TxOutput } from './transaction.js';
+
+export interface PsbtInput extends _PsbtInput {}
+
+export interface PsbtOutput extends _PsbtOutput {}
+
+export interface TapInternalKey extends _TapInternalKey {}
+
+export interface TapLeaf extends _TapLeaf {}
+
+export interface TapScriptSig extends _TapScriptSig {}
+
+export interface TapKeySig extends _TapKeySig {}
+
+export interface TapTree extends _TapTree {}
+
+export interface TapMerkleRoot extends _TapMerkleRoot {}
+
+export interface TapLeafScript extends _TapLeafScript {}
+
+export interface TapBip32Derivation extends _TapBip32Derivation {}
+
+export interface PsbtInputUpdate extends _PsbtInputUpdate {}
+
+export * from './psbt/bip371.js';
+export * from './address.js';
+export * from './bufferutils.js';
+export * from './payments/bip341.js';
+export * from './psbt/psbtutils.js';
+
+export {
+    Taptree,
+    XOnlyPointAddTweakResult,
+    Tapleaf,
+    TinySecp256k1Interface,
+    TAPLEAF_VERSION_MASK,
+} from './types.js';
+
+const bitcoin = {
+    networks,
+    address,
+    payments,
+    script,
+    crypto,
+    Transaction,
+};
+
+export default bitcoin;

package/src/networks.ts

@@ -17,6 +17,7 @@ export interface Network {
     bip32: Bip32;
     messagePrefix: string;
     bech32: string;
+    bech32Opnet?: string;
     pubKeyHash: number;
     scriptHash: number;
 }
@@ -33,6 +34,7 @@ export const bitcoin: Network = {
      * The Bech32 prefix used for Bitcoin addresses.
      */
     bech32: 'bc',
+    bech32Opnet: 'opnet',
     /**
      * The BIP32 key prefixes for Bitcoin.
      */
@@ -65,6 +67,7 @@ export const bitcoin: Network = {
 export const regtest: Network = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'bcrt',
+    bech32Opnet: 'opreg',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,
@@ -79,6 +82,7 @@ export const regtest: Network = {
 export const testnet: Network = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'tb',
+    bech32Opnet: 'optest',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,
@@ -104,6 +108,7 @@ export const testnet: Network = {
 export const dogecoin: Network = {
     messagePrefix: '\x19Dogecoin Signed Message:\n',
     bech32: '', // Dogecoin does not currently use Bech32
+    bech32Opnet: '',
     bip32: {
         public: 0x02facafd,
         private: 0x02fac398,
@@ -129,6 +134,7 @@ export const dogecoin: Network = {
 export const dogecoinTestnet: Network = {
     messagePrefix: '\x19Dogecoin Signed Message:\n',
     bech32: '', // Dogecoin testnet does not currently use Bech32
+    bech32Opnet: '',
     bip32: {
         public: 0x0432a9a8,
         private: 0x0432a243,
@@ -144,6 +150,7 @@ export const dogecoinTestnet: Network = {
 export const litecoin: Network = {
     messagePrefix: '\x19Litecoin Signed Message:\n',
     bech32: 'ltc',
+    bech32Opnet: 'opltc',
     bip32: {
         public: 0x019da462,
         private: 0x019d9cfe,
@@ -159,6 +166,7 @@ export const litecoin: Network = {
 export const litecoinTestnet: Network = {
     messagePrefix: '\x19Litecoin Signed Message:\n',
     bech32: 'tltc',
+    bech32Opnet: 'opltct',
     bip32: {
         public: 0x0436ef7d,
         private: 0x0436f6e1,
@@ -178,6 +186,7 @@ export const bitcoinCash: Network = {
     // Cashaddr prefix differs from bech32 for general usage, but we can set it similarly.
     // Actual cashaddr prefix is "bitcoincash", but this field is for bech32 which BCH doesn't fully use for segwit (it doesn't have segwit).
     bech32: 'bitcoincash',
+    bech32Opnet: 'opbch',
     bip32: {
         public: 0x0488b21e,
         private: 0x0488ade4,
@@ -193,6 +202,7 @@ export const bitcoinCash: Network = {
 export const bitcoinCashTestnet: Network = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'bchtest',
+    bech32Opnet: 'opbchtest',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,
@@ -210,6 +220,7 @@ export const dash: Network = {
     // As of Dash Core 0.17, this has not changed in code.
     messagePrefix: '\x19DarkCoin Signed Message:\n',
     bech32: '', // Dash does not use Bech32
+    bech32Opnet: '',
     bip32: {
         public: 0x02fe52cc,
         private: 0x02fe52f8,
@@ -225,6 +236,7 @@ export const dash: Network = {
 export const dashTestnet: Network = {
     messagePrefix: '\x19DarkCoin Signed Message:\n',
     bech32: '', // Dash testnet does not use Bech32
+    bech32Opnet: '',
     bip32: {
         public: 0x3a8061a0,
         private: 0x3a805837,