@btc-vision/bitcoin 6.4.0 → 6.4.1

package/build/address.d.ts

@@ -8,6 +8,7 @@ export interface Bech32Result {
     prefix: string;
     data: Buffer;
 }
+export declare function toFutureOPNetAddress(output: Buffer, network: Network): string;
 export declare function fromBase58Check(address: string): Base58CheckResult;
 export declare function fromBech32(address: string): Bech32Result;
 export declare function toBase58Check(hash: Buffer, version: number): string;

package/build/address.js

@@ -1,12 +1,13 @@
 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 * as bscript from './script.js';
 import { Hash160bit, tuple, typeforce, UInt8 } from './types.js';
 const FUTURE_SEGWIT_MAX_SIZE = 40;
 const FUTURE_SEGWIT_MIN_SIZE = 2;
-const FUTURE_SEGWIT_MAX_VERSION = 16;
+const FUTURE_SEGWIT_MAX_VERSION = 15;
+const FUTURE_MAX_VERSION = 16;
 const FUTURE_OPNET_VERSION = 16;
 const FUTURE_SEGWIT_MIN_VERSION = 2;
 const FUTURE_SEGWIT_VERSION_DIFF = 0x50;
@@ -14,15 +15,49 @@ const FUTURE_SEGWIT_VERSION_WARNING = 'WARNING: Sending to a future segwit versi
     'End users MUST be warned carefully in the GUI and asked if they wish to proceed ' +
     '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.';
+export function toFutureOPNetAddress(output, network) {
+    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];
+    let pushPos = 1, progLen;
+    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');
+    }
+    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 = opcode === opcodes.OP_0
+        ? 0
+        : opcode >= opcodes.OP_1 && opcode <= opcodes.OP_16
+            ? opcode - (opcodes.OP_1 - 1)
+            : -1;
+    if (version < FUTURE_SEGWIT_MAX_VERSION || version > FUTURE_MAX_VERSION)
+        throw new TypeError(`Invalid segwit version ${version}`);
+    const words = [version, ...bech32m.toWords(program)];
+    return bech32m.encode(network.bech32Opnet, words);
+}
 function _toFutureSegwitAddress(output, network) {
-    const data = output.slice(2);
-    if (data.length < FUTURE_SEGWIT_MIN_SIZE || data.length > FUTURE_SEGWIT_MAX_SIZE)
+    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)
+    if (version < FUTURE_SEGWIT_MIN_VERSION || version > FUTURE_SEGWIT_MAX_VERSION) {
         throw new TypeError('Invalid version for segwit address');
-    if (output[1] !== data.length)
-        throw new TypeError('Invalid script for segwit address');
+    }
+    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);
 }
 export function fromBase58Check(address) {
@@ -32,7 +67,7 @@ export function fromBase58Check(address) {
     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 };
 }
 export function fromBech32(address) {
@@ -97,6 +132,10 @@ export function fromOutputScript(output, network) {
         return payments.p2tr({ output, network }).address;
     }
     catch (e) { }
+    try {
+        return toFutureOPNetAddress(output, network);
+    }
+    catch (e) { }
     try {
         return _toFutureSegwitAddress(output, network);
     }
@@ -137,6 +176,15 @@ export function toOutputScript(address, network) {
                 if (decodeBech32.data.length === 32)
                     return payments.p2tr({ pubkey: decodeBech32.data }).output;
             }
+            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 &&

package/build/networks.js

@@ -1,7 +1,7 @@
 export const bitcoin = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'bc',
-    bech32Opnet: 'opnet',
+    bech32Opnet: 'op',
     bip32: {
         public: 0x0488b21e,
         private: 0x0488ade4,
@@ -13,7 +13,7 @@ export const bitcoin = {
 export const regtest = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'bcrt',
-    bech32Opnet: 'opreg',
+    bech32Opnet: 'opr',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,
@@ -25,7 +25,7 @@ export const regtest = {
 export const testnet = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'tb',
-    bech32Opnet: 'optest',
+    bech32Opnet: 'opt',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,
@@ -61,7 +61,7 @@ export const dogecoinTestnet = {
 export const litecoin = {
     messagePrefix: '\x19Litecoin Signed Message:\n',
     bech32: 'ltc',
-    bech32Opnet: 'opltc',
+    bech32Opnet: 'opl',
     bip32: {
         public: 0x019da462,
         private: 0x019d9cfe,
@@ -73,7 +73,7 @@ export const litecoin = {
 export const litecoinTestnet = {
     messagePrefix: '\x19Litecoin Signed Message:\n',
     bech32: 'tltc',
-    bech32Opnet: 'opltct',
+    bech32Opnet: 'oplt',
     bip32: {
         public: 0x0436ef7d,
         private: 0x0436f6e1,
@@ -97,7 +97,7 @@ export const bitcoinCash = {
 export const bitcoinCashTestnet = {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'bchtest',
-    bech32Opnet: 'opbchtest',
+    bech32Opnet: 'opbcht',
     bip32: {
         public: 0x043587cf,
         private: 0x04358394,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@btc-vision/bitcoin",
     "type": "module",
-    "version": "6.4.0",
+    "version": "6.4.1",
     "description": "Client-side Bitcoin JavaScript library",
     "engines": {
         "node": ">=16.0.0"

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,8 @@ 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;
@@ -45,18 +46,66 @@ 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_MAX_VERSION || version > FUTURE_MAX_VERSION)
+        throw new TypeError(`Invalid segwit version ${version}`);
+
+    const words = [version, ...bech32m.toWords(program)];
+    return bech32m.encode(network.bech32Opnet, words);
+}
 
-    if (version < FUTURE_SEGWIT_MIN_VERSION || version > FUTURE_SEGWIT_MAX_VERSION)
+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');
+    }
 
-    if (output[1] !== data.length) throw new TypeError('Invalid script for segwit address');
+    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);
 }
@@ -72,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 };
 }
@@ -159,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) {}
@@ -203,6 +255,16 @@ 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 &&