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

package/eslint.config.js

@@ -47,6 +47,9 @@ export default tseslint.config(
             'no-case-declarations': 'warn',
             '@typescript-eslint/ban-ts-comment': 'warn',
             '@typescript-eslint/no-deprecated': 'warn',
+
+            // Stupid new eslint rule that can cause nice bugs.
+            'no-useless-assignment': 'off',
         },
     },
     {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@btc-vision/bitcoin",
     "type": "module",
-    "version": "7.0.0-beta.0",
+    "version": "7.0.0-beta.1",
     "sideEffects": false,
     "description": "Client-side Bitcoin JavaScript library",
     "engines": {
@@ -116,6 +116,9 @@
         "stream": "stream-browserify",
         "zlib": "browserify-zlib"
     },
+    "react-native": {
+        "./build/crypto-hashes.js": "./build/crypto-hashes.native.js"
+    },
     "keywords": [
         "bitcoinjs",
         "bitcoin",
@@ -163,8 +166,10 @@
         "prebuild": "npm run prebuild:ecc && npm run check:circular"
     },
     "devDependencies": {
-        "@eslint/js": "^9.39.2",
-        "@types/node": "^25.0.10",
+        "@btc-vision/bs58check": "^5.0.1",
+        "@eslint/js": "^10.0.1",
+        "@scure/base": "^2.0.0",
+        "@types/node": "^25.2.3",
         "@types/randombytes": "^2.0.3",
         "@vitest/browser": "^4.0.18",
         "@vitest/browser-playwright": "^4.0.18",
@@ -173,26 +178,25 @@
         "bip39": "^3.1.0",
         "bip65": "^1.0.3",
         "bip68": "^1.0.4",
-        "bs58": "^6.0.0",
         "dhttp": "^3.0.3",
-        "eslint": "^9.39.2",
+        "eslint": "^10.0.0",
         "https-browserify": "^1.0.0",
         "madge": "^8.0.0",
         "minimaldata": "^1.0.2",
         "os-browserify": "^0.3.0",
-        "playwright": "^1.58.0",
+        "playwright": "^1.58.2",
         "prettier": "^3.8.1",
         "randombytes": "^2.1.0",
         "regtest-client": "0.2.1",
-        "rimraf": "^6.1.2",
+        "rimraf": "^6.1.3",
         "stream-browserify": "^3.0.0",
         "stream-http": "^3.2.0",
         "tiny-secp256k1": "^2.2.4",
         "ts-node": "^10.9.2",
-        "typedoc": "^0.28.16",
+        "typedoc": "^0.28.17",
         "typedoc-material-theme": "^1.4.1",
         "typescript": "^5.9.3",
-        "typescript-eslint": "^8.53.1",
+        "typescript-eslint": "^8.56.0",
         "vite": "^7.3.1",
         "vite-plugin-dts": "^4.5.4",
         "vite-plugin-node-polyfills": "^0.25.0",
@@ -201,8 +205,8 @@
         "vitest": "^4.0.18"
     },
     "peerDependencies": {
-        "react-native-worklets": ">=0.7.0",
-        "react-native-quick-crypto": ">=1.0.0"
+        "react-native-quick-crypto": ">=1.0.0",
+        "react-native-worklets": ">=0.7.0"
     },
     "peerDependenciesMeta": {
         "react-native-worklets": {
@@ -213,8 +217,8 @@
         }
     },
     "dependencies": {
-        "@btc-vision/bip32": "^7.0.2",
-        "@btc-vision/ecpair": "^4.0.2",
+        "@btc-vision/bip32": "^7.1.2",
+        "@btc-vision/ecpair": "^4.0.5",
         "@btc-vision/logger": "^1.0.8",
         "@noble/hashes": "^2.0.1",
         "@noble/secp256k1": "^3.0.0",
@@ -222,7 +226,6 @@
         "bech32": "^2.0.0",
         "bip174": "^3.0.0",
         "browserify-zlib": "^0.2.0",
-        "@scure/base": "^1.2.4",
         "buffer": "^6.0.3",
         "process": "^0.11.10",
         "varuint-bitcoin": "^2.0.0"

package/src/address.ts

@@ -15,6 +15,7 @@ import * as networks from './networks.js';
 import { p2op } from './payments/p2op.js';
 import { p2pkh } from './payments/p2pkh.js';
 import { p2sh } from './payments/p2sh.js';
+import { p2mr } from './payments/p2mr.js';
 import { p2tr } from './payments/p2tr.js';
 import { p2wpkh } from './payments/p2wpkh.js';
 import { p2wsh } from './payments/p2wsh.js';
@@ -22,6 +23,7 @@ import * as bscript from './script.js';
 import { opcodes } from './script.js';
 import {
     type Bytes20,
+    type Script,
     isBytes20,
     isUInt8,
     toBytes20,
@@ -89,8 +91,9 @@ export function toFutureOPNetAddress(output: Uint8Array, network: Network): stri
     const opcode = output[0];
 
     // work out where the push-data really starts
-    let pushPos = 1,
+    let pushPos: number = 1,
         progLen: number;
+
     const byte1 = output[1];
     const byte2 = output[2];
     if (byte1 !== undefined && byte1 < 0x4c) {
@@ -198,7 +201,7 @@ export function toBech32(
  * P2WPKH, P2WSH, P2TR) to avoid constructing payment objects and catching
  * exceptions. Falls back to payment constructors for exotic types.
  */
-export function fromOutputScript(output: Uint8Array, network?: Network): string {
+export function fromOutputScript(output: Uint8Array | Script, network?: Network): string {
     network = network || networks.bitcoin;
     const len = output.length;
 
@@ -236,6 +239,13 @@ export function fromOutputScript(output: Uint8Array, network?: Network): string
         return bech32m.encode(network.bech32, words);
     }
 
+    // P2MR: OP_2(0x52) 0x20 <32-byte merkle root>
+    if (len === 34 && output[0] === 0x52 && output[1] === 0x20) {
+        const words = bech32m.toWords(output.subarray(2, 34));
+        words.unshift(2);
+        return bech32m.encode(network.bech32, words);
+    }
+
     // Fallback for exotic types
     try {
         return toFutureOPNetAddress(output, network);
@@ -268,12 +278,12 @@ 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 function toOutputScript(
     address: string,
     networkOrOptions?: Network | ToOutputScriptOptions,
-): Uint8Array {
+): Script {
     let network: Network;
     let onFutureSegwitWarning: ((warning: string) => void) | undefined;
 
@@ -296,9 +306,9 @@ export function toOutputScript(
 
     if (decodeBase58) {
         if (decodeBase58.version === network.pubKeyHash)
-            return p2pkh({ hash: decodeBase58.hash }).output as Uint8Array;
+            return p2pkh({ hash: decodeBase58.hash }).output as Script;
         if (decodeBase58.version === network.scriptHash)
-            return p2sh({ hash: decodeBase58.hash }).output as Uint8Array;
+            return p2sh({ hash: decodeBase58.hash }).output as Script;
     } else {
         try {
             decodeBech32 = fromBech32(address);
@@ -313,19 +323,21 @@ export function toOutputScript(
                 throw new Error(address + ' has an invalid prefix');
             if (decodeBech32.version === 0) {
                 if (decodeBech32.data.length === 20)
-                    return p2wpkh({ hash: toBytes20(decodeBech32.data) }).output as Uint8Array;
+                    return p2wpkh({ hash: toBytes20(decodeBech32.data) }).output as Script;
                 if (decodeBech32.data.length === 32)
-                    return p2wsh({ hash: toBytes32(decodeBech32.data) }).output as Uint8Array;
+                    return p2wsh({ hash: toBytes32(decodeBech32.data) }).output as Script;
             } else if (decodeBech32.version === 1) {
                 if (decodeBech32.data.length === 32)
                     return p2tr({ pubkey: decodeBech32.data as XOnlyPublicKey })
-                        .output as Uint8Array;
+                        .output as Script;
+            } else if (decodeBech32.version === 2 && decodeBech32.data.length === 32) {
+                return p2mr({ hash: toBytes32(decodeBech32.data) }).output as Script;
             } else if (decodeBech32.version === FUTURE_OPNET_VERSION) {
                 if (!network.bech32Opnet) throw new Error(address + ' has an invalid prefix');
                 return p2op({
                     program: decodeBech32.data,
                     network,
-                }).output as Uint8Array;
+                }).output as Script;
             } else if (
                 decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
                 decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&

package/src/index.ts

@@ -95,6 +95,7 @@ export type {
     BasePayment,
     P2SHPayment,
     P2TRPayment,
+    P2MRPayment,
     P2WPKHPayment,
     P2PKHPayment,
     P2MSPayment,

package/src/io/base58check.ts

@@ -1,35 +1 @@
-/**
- * Base58Check encoding/decoding using @scure/base and @noble/hashes.
- *
- * Base58Check is a binary-to-text encoding with a 4-byte checksum
- * derived from double SHA-256, used for Bitcoin addresses and WIF keys.
- *
- * @packageDocumentation
- */
-
-import { createBase58check } from '@scure/base';
-import { sha256 } from '@noble/hashes/sha2.js';
-
-/**
- * Base58Check codec instance using SHA-256 for checksum.
- */
-export const base58check = createBase58check(sha256);
-
-/**
- * Encode a Uint8Array to a Base58Check string.
- * @param data - The data to encode
- * @returns The Base58Check encoded string
- */
-export function encode(data: Uint8Array): string {
-    return base58check.encode(data);
-}
-
-/**
- * Decode a Base58Check string to a Uint8Array.
- * @param str - The Base58Check encoded string
- * @returns The decoded data
- * @throws If the checksum is invalid or the string is malformed
- */
-export function decode(str: string): Uint8Array {
-    return base58check.decode(str);
-}
+export { encode, decode, decodeUnsafe } from '@btc-vision/bs58check';

package/src/io/base64.ts

@@ -11,11 +11,16 @@
  * @returns Uint8Array containing the decoded bytes
  */
 export function fromBase64(base64: string): Uint8Array {
+    if (base64.startsWith('0x')) {
+        throw new Error('Invalid base64 string: should not start with 0x');
+    }
+
     const binaryString = atob(base64);
     const bytes = new Uint8Array(binaryString.length);
     for (let i = 0; i < binaryString.length; i++) {
         bytes[i] = binaryString.charCodeAt(i);
     }
+
     return bytes;
 }
 

package/src/networks.ts

@@ -92,6 +92,19 @@ export const testnet: Network = {
     wif: 0xef,
 };
 
+export const opnetTestnet: Network = {
+    messagePrefix: '\x18Bitcoin Signed Message:\n',
+    bech32: 'opt',
+    bech32Opnet: 'opt',
+    bip32: {
+        public: 0x043587cf,
+        private: 0x04358394,
+    },
+    pubKeyHash: 0x6f,
+    scriptHash: 0xc4,
+    wif: 0xef,
+};
+
 /**
  * Represents the Dogecoin mainnet configuration.
  *

package/src/payments/bip341.ts

@@ -59,6 +59,34 @@ export function rootHashFromPath(controlBlock: Uint8Array, leafHash: Uint8Array)
     return kj as Bytes32;
 }
 
+/**
+ * Calculates the root hash from a P2MR control block and leaf hash.
+ * P2MR control blocks have no internal pubkey, so the merkle path starts at offset 1.
+ * @param controlBlock - The P2MR control block: [control_byte (1)] [merkle_path (32*m)]
+ * @param leafHash - The leaf hash.
+ * @returns The root hash.
+ * @throws {TypeError} If the control block length is less than 1.
+ */
+export function rootHashFromPathP2MR(controlBlock: Uint8Array, leafHash: Uint8Array): Bytes32 {
+    if (controlBlock.length < 1)
+        throw new TypeError(
+            `The control-block length is too small. Got ${controlBlock.length}, expected min 1.`,
+        );
+    const m = (controlBlock.length - 1) / 32;
+
+    let kj = leafHash;
+    for (let j = 0; j < m; j++) {
+        const ej = controlBlock.subarray(1 + 32 * j, 33 + 32 * j);
+        if (compare(kj, ej) < 0) {
+            kj = tapBranchHash(kj, ej);
+        } else {
+            kj = tapBranchHash(ej, kj);
+        }
+    }
+
+    return kj as Bytes32;
+}
+
 /**
  * Build a hash tree of merkle nodes from the scripts binary tree.
  * @param scriptTree - the tree of scripts to pairwise hash.
@@ -128,7 +156,14 @@ export function tweakKey(pubKey: XOnlyPublicKey, h: Bytes32 | undefined): Tweake
     };
 }
 
-function tapBranchHash(a: Uint8Array, b: Uint8Array): Bytes32 {
+/**
+ * Computes the TapBranch tagged hash of two child hashes.
+ *
+ * @param a - First child hash (left branch).
+ * @param b - Second child hash (right branch).
+ * @returns The 32-byte TapBranch hash.
+ */
+export function tapBranchHash(a: Uint8Array, b: Uint8Array): Bytes32 {
     return bcrypto.taggedHash('TapBranch', concat([a, b]));
 }
 

package/src/payments/index.ts

@@ -18,6 +18,7 @@ export {
     type P2WPKHPayment,
     type P2WSHPayment,
     type P2TRPayment,
+    type P2MRPayment,
     type P2OPPayment,
     type P2OPPaymentParams,
     type EmbedPayment,
@@ -35,6 +36,7 @@ export { P2MS, p2ms } from './p2ms.js';
 export { P2SH, p2sh } from './p2sh.js';
 export { P2WSH, p2wsh } from './p2wsh.js';
 export { P2TR, p2tr } from './p2tr.js';
+export { P2MR, p2mr } from './p2mr.js';
 export { P2OP, p2op } from './p2op.js';
 
 // BIP341 Taproot utilities
@@ -43,6 +45,8 @@ export {
     LEAF_VERSION_TAPSCRIPT,
     MAX_TAPTREE_DEPTH,
     rootHashFromPath,
+    rootHashFromPathP2MR,
+    tapBranchHash,
     tapleafHash,
     toHashTree,
     tweakKey,