@btc-vision/bitcoin 6.3.6 → 6.4.1

package/src/address.ts

@@ -9,7 +9,7 @@
  */
 import { bech32, bech32m } from 'bech32';
 import * as bs58check from 'bs58check';
-import { payments } from './index.js';
+import { opcodes, payments } from './index.js';
 import * as networks from './networks.js';
 import { Network } from './networks.js';
 import * as bscript from './script.js';
@@ -35,7 +35,9 @@ export interface Bech32Result {
 
 const FUTURE_SEGWIT_MAX_SIZE: number = 40;
 const FUTURE_SEGWIT_MIN_SIZE: number = 2;
-const FUTURE_SEGWIT_MAX_VERSION: number = 16;
+const FUTURE_SEGWIT_MAX_VERSION: number = 15;
+const FUTURE_MAX_VERSION: number = 16;
+const FUTURE_OPNET_VERSION: number = 16;
 const FUTURE_SEGWIT_MIN_VERSION: number = 2;
 const FUTURE_SEGWIT_VERSION_DIFF: number = 0x50;
 const FUTURE_SEGWIT_VERSION_WARNING: string =
@@ -44,22 +46,68 @@ const FUTURE_SEGWIT_VERSION_WARNING: string =
     'with caution. Wallets should verify the segwit version from the output of fromBech32, ' +
     'then decide when it is safe to use which version of segwit.';
 
-function _toFutureSegwitAddress(output: Buffer, network: Network): string {
-    const data = output.slice(2);
+/**
+ * Encode a future Taproot-style segwit address (SegWit v2 - v16) using bech32m.
+ * Only for versions not yet assigned specific meanings (future use).
+ *
+ * @param output - Output script buffer containing the version and witness program
+ * @param network - Network object containing bech32 and optional bech32Opnet prefix
+ * @returns Bech32m-encoded future Taproot-style address
+ */
+export function toFutureOPNetAddress(output: Buffer, network: Network): string {
+    if (!Buffer.isBuffer(output)) throw new TypeError('output must be a Buffer');
+    if (!network.bech32Opnet) throw new Error('Network does not support opnet');
+
+    const opcode = output[0];
+
+    // work out where the push-data really starts
+    let pushPos = 1,
+        progLen: number;
+    if (output[1] < 0x4c) {
+        progLen = output[1];
+        pushPos = 2;
+    } else if (output[1] === 0x4c) {
+        progLen = output[2];
+        pushPos = 3;
+    } else {
+        throw new TypeError('Unsupported push opcode in script');
+    }
 
-    if (data.length < FUTURE_SEGWIT_MIN_SIZE || data.length > FUTURE_SEGWIT_MAX_SIZE)
+    const program = output.subarray(pushPos, pushPos + progLen);
+
+    if (program.length < FUTURE_SEGWIT_MIN_SIZE || program.length > FUTURE_SEGWIT_MAX_SIZE)
         throw new TypeError('Invalid program length for segwit address');
 
-    const version = output[0] - FUTURE_SEGWIT_VERSION_DIFF;
+    const version =
+        opcode === opcodes.OP_0
+            ? 0
+            : opcode >= opcodes.OP_1 && opcode <= opcodes.OP_16
+              ? opcode - (opcodes.OP_1 - 1)
+              : -1;
 
-    if (version < FUTURE_SEGWIT_MIN_VERSION || version > FUTURE_SEGWIT_MAX_VERSION)
-        throw new TypeError('Invalid version for segwit address');
+    if (version < FUTURE_SEGWIT_MAX_VERSION || version > FUTURE_MAX_VERSION)
+        throw new TypeError(`Invalid segwit version ${version}`);
 
-    if (output[1] !== data.length) throw new TypeError('Invalid script for segwit address');
+    const words = [version, ...bech32m.toWords(program)];
+    return bech32m.encode(network.bech32Opnet, words);
+}
 
-    console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+function _toFutureSegwitAddress(output: Buffer, network: Network): string {
+    const data = output.subarray(2);
+    if (data.length < FUTURE_SEGWIT_MIN_SIZE || data.length > FUTURE_SEGWIT_MAX_SIZE) {
+        throw new TypeError('Invalid program length for segwit address');
+    }
+
+    const version = output[0] - FUTURE_SEGWIT_VERSION_DIFF;
+    if (version < FUTURE_SEGWIT_MIN_VERSION || version > FUTURE_SEGWIT_MAX_VERSION) {
+        throw new TypeError('Invalid version for segwit address');
+    }
 
-    return toBech32(data, version, network.bech32);
+    if (output[1] !== data.length) {
+        throw new TypeError(`Invalid script for segwit address ${output[1]} !== ${data.length}`);
+    }
+
+    return toBech32(data, version, network.bech32, network.bech32Opnet);
 }
 
 /**
@@ -73,7 +121,7 @@ export function fromBase58Check(address: string): Base58CheckResult {
     if (payload.length > 21) throw new TypeError(address + ' is too long');
 
     const version = payload.readUInt8(0);
-    const hash = payload.slice(1);
+    const hash = payload.subarray(1);
 
     return { version, hash };
 }
@@ -122,10 +170,19 @@ export function toBase58Check(hash: Buffer, version: number): string {
 /**
  * encode address hash to bech32 address with version and prefix
  */
-export function toBech32(data: Buffer, version: number, prefix: string): string {
+export function toBech32(
+    data: Buffer,
+    version: number,
+    prefix: string,
+    prefixOpnet?: string,
+): string {
     const words = bech32.toWords(data);
     words.unshift(version);
 
+    if (version === FUTURE_OPNET_VERSION && prefixOpnet) {
+        return bech32m.encode(prefixOpnet, words);
+    }
+
     return version === 0 ? bech32.encode(prefix, words) : bech32m.encode(prefix, words);
 }
 
@@ -151,6 +208,9 @@ export function fromOutputScript(output: Buffer, network?: Network): string {
     try {
         return payments.p2tr({ output, network }).address as string;
     } catch (e) {}
+    try {
+        return toFutureOPNetAddress(output, network);
+    } catch (e) {}
     try {
         return _toFutureSegwitAddress(output, network);
     } catch (e) {}
@@ -181,7 +241,11 @@ export function toOutputScript(address: string, network?: Network): Buffer {
         } catch (e) {}
 
         if (decodeBech32) {
-            if (decodeBech32.prefix !== network.bech32)
+            if (
+                decodeBech32.prefix !== network.bech32 &&
+                network.bech32Opnet &&
+                decodeBech32.prefix !== network.bech32Opnet
+            )
                 throw new Error(address + ' has an invalid prefix');
             if (decodeBech32.version === 0) {
                 if (decodeBech32.data.length === 20)
@@ -191,13 +255,25 @@ export function toOutputScript(address: string, network?: Network): Buffer {
             } else if (decodeBech32.version === 1) {
                 if (decodeBech32.data.length === 32)
                     return payments.p2tr({ pubkey: decodeBech32.data }).output as Buffer;
+            } else if (decodeBech32.version === FUTURE_OPNET_VERSION) {
+                if (!network.bech32Opnet) throw new Error(address + ' has an invalid prefix');
+                if (
+                    decodeBech32.data.length < FUTURE_SEGWIT_MIN_SIZE ||
+                    decodeBech32.data.length > FUTURE_SEGWIT_MAX_SIZE
+                ) {
+                    throw new Error('Invalid program length for opnet address');
+                }
+
+                return bscript.compile([opcodes.OP_16, decodeBech32.data]);
             } else if (
                 decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
                 decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&
                 decodeBech32.data.length >= FUTURE_SEGWIT_MIN_SIZE &&
                 decodeBech32.data.length <= FUTURE_SEGWIT_MAX_SIZE
             ) {
-                console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+                if (decodeBech32.version !== FUTURE_OPNET_VERSION) {
+                    console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+                }
 
                 return bscript.compile([
                     decodeBech32.version + FUTURE_SEGWIT_VERSION_DIFF,

package/src/block.ts

@@ -155,8 +155,8 @@ export class Block {
 
         if (headersOnly || !this.transactions) return buffer;
 
-        varuint.encode(this.transactions.length, buffer, bufferWriter.offset);
-        bufferWriter.offset += varuint.encode.bytes;
+        const encoded = varuint.encode(this.transactions.length, buffer, bufferWriter.offset);
+        bufferWriter.offset += encoded.bytes;
 
         this.transactions.forEach((tx) => {
             const txSize = tx.byteLength(); // TODO: extract from toBuffer?

package/src/bufferutils.ts

@@ -66,7 +66,10 @@ export function cloneBuffer(buffer: Buffer): Buffer {
  * Helper class for serialization of bitcoin data types into a pre-allocated buffer.
  */
 export class BufferWriter {
-    constructor(public buffer: Buffer, public offset: number = 0) {
+    constructor(
+        public buffer: Buffer,
+        public offset: number = 0,
+    ) {
         typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
     }
 
@@ -91,8 +94,8 @@ export class BufferWriter {
     }
 
     writeVarInt(i: number): void {
-        varuint.encode(i, this.buffer, this.offset);
-        this.offset += varuint.encode.bytes;
+        const encode = varuint.encode(i, this.buffer, this.offset);
+        this.offset += encode.bytes;
     }
 
     writeSlice(slice: Buffer): void {
@@ -124,7 +127,10 @@ export class BufferWriter {
  * Helper class for reading of bitcoin data types from a buffer.
  */
 export class BufferReader {
-    constructor(public buffer: Buffer, public offset: number = 0) {
+    constructor(
+        public buffer: Buffer,
+        public offset: number = 0,
+    ) {
         typeforce(types.tuple(types.Buffer, types.UInt32), [buffer, offset]);
     }
 
@@ -154,15 +160,17 @@ export class BufferReader {
 
     readVarInt(): number {
         const vi = varuint.decode(this.buffer, this.offset);
-        this.offset += varuint.decode.bytes;
-        return vi;
+        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.slice(this.offset, this.offset + n);
+
+        const result = this.buffer.subarray(this.offset, this.offset + n);
         this.offset += n;
         return result;
     }

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: 'op',
     /**
      * 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: 'opr',
     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: 'opt',
     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: 'opl',
     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: 'oplt',
     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: 'opbcht',
     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,