@btc-vision/bitcoin 6.3.0 → 6.3.2

package/package.json

@@ -1,11 +1,31 @@
 {
     "name": "@btc-vision/bitcoin",
-    "version": "6.3.0",
+    "type": "module",
+    "version": "6.3.2",
     "description": "Client-side Bitcoin JavaScript library",
-    "main": "./src/index.js",
-    "types": "./src/index.d.ts",
     "engines": {
-        "node": ">=8.0.0"
+        "node": ">=16.0.0"
+    },
+    "exports": {
+        ".": {
+            "browser": "./browser/index.js",
+            "import": "./build/index.js",
+            "require": "./build/index.js",
+            "types": "./build/index.d.ts"
+        },
+        "./browser": {
+            "import": "./browser/index.js",
+            "require": "./browser/index.js",
+            "types": "./browser/index.d.ts"
+        }
+    },
+    "browser": {
+        "./build/index.js": "./browser/index.js",
+        "./build/index.d.ts": "./browser/index.d.ts",
+        "Buffer": "buffer",
+        "crypto": "./src/crypto/crypto-browser.js",
+        "stream": "stream-browserify",
+        "zlib": "browserify-zlib"
     },
     "keywords": [
         "bitcoinjs",
@@ -14,11 +34,27 @@
         "javascript",
         "bitcoinjs"
     ],
+    "license": "MIT",
+    "main": "build/index.js",
+    "types": "build/index.d.ts",
+    "typings": "build/index.d.ts",
+    "module": "build/index.js",
+    "publishConfig": {
+        "access": "public",
+        "tag": "latest"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/btc-vision/bitcoin.git"
+    },
     "scripts": {
+        "watch": "gulp watch",
+        "build": "gulp build",
+        "setup": "npm i && npm run build",
+        "browserBuild": "webpack --mode production",
         "audit": "better-npm-audit audit -l high",
-        "build": "npm run clean && tsc -p ./tsconfig.json && npm run formatjs",
         "build:tests": "npm run clean:jstests && tsc -p ./test/tsconfig.json",
-        "clean": "rimraf src",
+        "clean": "rimraf build",
         "clean:jstests": "rimraf 'test/**/!(ts-node-register)*.js'",
         "coverage-report": "npm run build && npm run nobuild:coverage-report",
         "coverage-html": "npm run build && npm run nobuild:coverage-html",
@@ -29,7 +65,7 @@
         "format:ci": "npm run prettier -- --check && npm run prettierjs -- --check",
         "gitdiff:ci": "npm run build && git diff --exit-code",
         "integration": "npm run build && npm run nobuild:integration",
-        "lint": "eslint ts_src/** src/**/*.js",
+        "lint": "eslint ts_src/**",
         "lint:tests": "eslint test/**/*.spec.ts",
         "mocha:ts": "mocha --recursive --require test/ts-node-register",
         "nobuild:coverage-report": "nyc report --reporter=lcov",
@@ -38,58 +74,77 @@
         "nobuild:integration": "npm run mocha:ts -- --timeout 50000 'test/integration/*.ts'",
         "nobuild:unit": "npm run mocha:ts -- 'test/*.ts'",
         "prettier": "prettier \"ts_src/**/*.ts\" \"test/**/*.ts\" --ignore-path ./.prettierignore",
-        "prettierjs": "prettier \"src/**/*.js\" --ignore-path ./.prettierignore",
         "test": "npm run build && npm run format:ci && npm run lint && npm run nobuild:coverage",
         "unit": "npm run build && npm run nobuild:unit"
     },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/btc-vision/bitcoin.git"
-    },
-    "files": [
-        "src"
-    ],
-    "dependencies": {
-        "@noble/hashes": "^1.2.0",
-        "bech32": "^2.0.0",
-        "bip174": "^2.1.1",
-        "bs58check": "^3.0.1",
-        "typeforce": "^1.11.3",
-        "varuint-bitcoin": "^1.1.2"
-    },
     "devDependencies": {
-        "@types/bs58": "^4.0.0",
-        "@types/bs58check": "^2.1.0",
-        "@types/mocha": "^5.2.7",
-        "@types/node": "^16.11.7",
-        "@types/proxyquire": "^1.3.28",
-        "@types/randombytes": "^2.0.0",
-        "@typescript-eslint/eslint-plugin": "^8.7.0",
-        "@typescript-eslint/parser": "^8.7.0",
-        "better-npm-audit": "^3.7.3",
+        "@babel/core": "^7.26.0",
+        "@babel/plugin-proposal-class-properties": "^7.18.6",
+        "@babel/plugin-transform-runtime": "^7.25.9",
+        "@babel/preset-env": "^7.26.0",
+        "@babel/preset-flow": "^7.25.9",
+        "@babel/preset-react": "^7.26.3",
+        "@babel/preset-typescript": "^7.26.0",
+        "@types/bs58check": "^2.1.2",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^20.17.10",
+        "@types/proxyquire": "^1.3.31",
+        "@types/randombytes": "^2.0.3",
+        "better-npm-audit": "^3.11.0",
         "bip32": "^4.0.0",
         "bip39": "^3.1.0",
-        "bip65": "^1.0.1",
-        "bip68": "^1.0.3",
-        "bs58": "^4.0.0",
-        "dhttp": "^3.0.0",
+        "bip65": "^1.0.3",
+        "bip68": "^1.0.4",
+        "bs58": "^6.0.0",
+        "dhttp": "^3.0.3",
         "ecpair": "^2.0.1",
-        "eslint": "^8.29.0",
-        "eslint-config-prettier": "^8.5.0",
-        "eslint-plugin-prettier": "^4.2.1",
+        "eslint": "^9.17.0",
+        "gulp": "^5.0.0",
+        "gulp-cached": "^1.1.1",
+        "gulp-typescript": "^6.0.0-alpha.1",
         "hoodwink": "^2.0.0",
+        "https-browserify": "^1.0.0",
         "minimaldata": "^1.0.2",
-        "mocha": "^10.0.0",
-        "nyc": "^15.1.0",
-        "prettier": "^2.8.0",
-        "proxyquire": "^2.0.1",
+        "mocha": "^11.0.1",
+        "nyc": "^17.1.0",
+        "os-browserify": "^0.3.0",
+        "prettier": "^3.4.2",
+        "proxyquire": "^2.1.3",
         "randombytes": "^2.1.0",
-        "regtest-client": "0.2.0",
-        "rimraf": "^2.6.3",
-        "tiny-secp256k1": "^2.2.0",
-        "ts-node": "^8.3.0",
-        "typedoc": "^0.25.1",
-        "typescript": "^4.4.4"
+        "regtest-client": "0.2.1",
+        "rimraf": "^6.0.1",
+        "stream-browserify": "^3.0.0",
+        "stream-http": "^3.2.0",
+        "tiny-secp256k1": "^2.2.3",
+        "ts-loader": "^9.5.1",
+        "ts-node": "^10.9.2",
+        "typedoc": "^0.27.6",
+        "typescript": "^5.7.2",
+        "typescript-eslint": "^8.19.0",
+        "webpack": "^5.97.1",
+        "webpack-cli": "^6.0.1"
     },
-    "license": "MIT"
+    "dependencies": {
+        "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+        "@btc-vision/logger": "^1.0.6",
+        "@eslint/js": "^9.17.0",
+        "@noble/hashes": "^1.6.1",
+        "@noble/secp256k1": "^2.1.0",
+        "assert": "^2.1.0",
+        "babel-loader": "^9.2.1",
+        "babel-plugin-transform-import-meta": "^2.2.1",
+        "babel-preset-react": "^6.24.1",
+        "babelify": "^10.0.0",
+        "bech32": "^2.0.0",
+        "bip174": "^2.1.1",
+        "browserify-zlib": "^0.2.0",
+        "bs58check": "^4.0.0",
+        "buffer": "^6.0.3",
+        "gulp-clean": "^0.4.0",
+        "gulp-eslint-new": "^2.4.0",
+        "gulp-logger-new": "^1.0.1",
+        "process": "^0.11.10",
+        "typeforce": "^1.18.0",
+        "varuint-bitcoin": "^1.1.2"
+    }
 }

package/src/{address.js → address.ts}

@@ -1,12 +1,3 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.toOutputScript =
-    exports.fromOutputScript =
-    exports.toBech32 =
-    exports.toBase58Check =
-    exports.fromBech32 =
-    exports.fromBase58Check =
-        void 0;
 /**
  * bitcoin address decode and encode tools, include base58、bech32 and output script
  *
@@ -16,162 +7,190 @@ exports.toOutputScript =
  *
  * @packageDocumentation
  */
-const networks = require('./networks');
-const payments = require('./payments');
-const bscript = require('./script');
-const types_1 = require('./types');
-const bech32_1 = require('bech32');
-const bs58check = require('bs58check');
-const FUTURE_SEGWIT_MAX_SIZE = 40;
-const FUTURE_SEGWIT_MIN_SIZE = 2;
-const FUTURE_SEGWIT_MAX_VERSION = 16;
-const FUTURE_SEGWIT_MIN_VERSION = 2;
-const FUTURE_SEGWIT_VERSION_DIFF = 0x50;
-const FUTURE_SEGWIT_VERSION_WARNING =
+import { bech32, bech32m } from 'bech32';
+import * as bs58check from 'bs58check';
+import { payments } from './index.js';
+import * as networks from './networks.js';
+import { Network } from './networks.js';
+import * as bscript from './script.js';
+import { Hash160bit, tuple, typeforce, UInt8 } from './types.js';
+
+/** base58check decode result */
+export interface Base58CheckResult {
+    /** address hash */
+    hash: Buffer;
+    /** address version: 0x00 for P2PKH, 0x05 for P2SH */
+    version: number;
+}
+
+/** bech32 decode result */
+export interface Bech32Result {
+    /** address version: 0x00 for P2WPKH、P2WSH, 0x01 for P2TR*/
+    version: number;
+    /** address prefix: bc for P2WPKH、P2WSH、P2TR */
+    prefix: string;
+    /** address data：20 bytes for P2WPKH, 32 bytes for P2WSH、P2TR */
+    data: Buffer;
+}
+
+const FUTURE_SEGWIT_MAX_SIZE: number = 40;
+const FUTURE_SEGWIT_MIN_SIZE: number = 2;
+const FUTURE_SEGWIT_MAX_VERSION: number = 16;
+const FUTURE_SEGWIT_MIN_VERSION: number = 2;
+const FUTURE_SEGWIT_VERSION_DIFF: number = 0x50;
+const FUTURE_SEGWIT_VERSION_WARNING: string =
     'WARNING: Sending to a future segwit version address can lead to loss of funds. ' +
     '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.';
-function _toFutureSegwitAddress(output, network) {
+
+function _toFutureSegwitAddress(output: Buffer, network: Network): string {
     const data = output.slice(2);
-    if (
-        data.length < FUTURE_SEGWIT_MIN_SIZE ||
-        data.length > FUTURE_SEGWIT_MAX_SIZE
-    )
+
+    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');
+
     console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+
     return toBech32(data, version, network.bech32);
 }
+
 /**
  * decode address with base58 specification,  return address version and address hash if valid
  */
-function fromBase58Check(address) {
-    const payload = Buffer.from(bs58check.decode(address));
+export function fromBase58Check(address: string): Base58CheckResult {
+    const payload = Buffer.from(bs58check.default.decode(address));
+
     // TODO: 4.0.0, move to "toOutputScript"
     if (payload.length < 21) throw new TypeError(address + ' is too short');
     if (payload.length > 21) throw new TypeError(address + ' is too long');
+
     const version = payload.readUInt8(0);
     const hash = payload.slice(1);
+
     return { version, hash };
 }
-exports.fromBase58Check = fromBase58Check;
+
 /**
  * decode address with bech32 specification,  return address version、address prefix and address data if valid
  */
-function fromBech32(address) {
+export function fromBech32(address: string): Bech32Result {
     let result;
     let version;
     try {
-        result = bech32_1.bech32.decode(address);
+        result = bech32.decode(address);
     } catch (e) {}
+
     if (result) {
         version = result.words[0];
-        if (version !== 0)
-            throw new TypeError(address + ' uses wrong encoding');
+        if (version !== 0) throw new TypeError(address + ' uses wrong encoding');
     } else {
-        result = bech32_1.bech32m.decode(address);
+        result = bech32m.decode(address);
         version = result.words[0];
-        if (version === 0)
-            throw new TypeError(address + ' uses wrong encoding');
+        if (version === 0) throw new TypeError(address + ' uses wrong encoding');
     }
-    const data = bech32_1.bech32.fromWords(result.words.slice(1));
+
+    const data = bech32.fromWords(result.words.slice(1));
+
     return {
         version,
         prefix: result.prefix,
         data: Buffer.from(data),
     };
 }
-exports.fromBech32 = fromBech32;
+
 /**
  * encode address hash to base58 address with version
  */
-function toBase58Check(hash, version) {
-    (0, types_1.typeforce)(
-        (0, types_1.tuple)(types_1.Hash160bit, types_1.UInt8),
-        arguments,
-    );
+export function toBase58Check(hash: Buffer, version: number): string {
+    typeforce(tuple(Hash160bit, UInt8), arguments);
+
     const payload = Buffer.allocUnsafe(21);
     payload.writeUInt8(version, 0);
     hash.copy(payload, 1);
-    return bs58check.encode(payload);
+
+    return bs58check.default.encode(payload);
 }
-exports.toBase58Check = toBase58Check;
+
 /**
  * encode address hash to bech32 address with version and prefix
  */
-function toBech32(data, version, prefix) {
-    const words = bech32_1.bech32.toWords(data);
+export function toBech32(data: Buffer, version: number, prefix: string): string {
+    const words = bech32.toWords(data);
     words.unshift(version);
-    return version === 0
-        ? bech32_1.bech32.encode(prefix, words)
-        : bech32_1.bech32m.encode(prefix, words);
+
+    return version === 0 ? bech32.encode(prefix, words) : bech32m.encode(prefix, words);
 }
-exports.toBech32 = toBech32;
+
 /**
  * decode address from output script with network, return address if matched
  */
-function fromOutputScript(output, network) {
+export function fromOutputScript(output: Buffer, network?: Network): string {
     // TODO: Network
     network = network || networks.bitcoin;
+
     try {
-        return payments.p2pkh({ output, network }).address;
+        return payments.p2pkh({ output, network }).address as string;
     } catch (e) {}
     try {
-        return payments.p2sh({ output, network }).address;
+        return payments.p2sh({ output, network }).address as string;
     } catch (e) {}
     try {
-        return payments.p2wpkh({ output, network }).address;
+        return payments.p2wpkh({ output, network }).address as string;
     } catch (e) {}
     try {
-        return payments.p2wsh({ output, network }).address;
+        return payments.p2wsh({ output, network }).address as string;
     } catch (e) {}
     try {
-        return payments.p2tr({ output, network }).address;
+        return payments.p2tr({ output, network }).address as string;
     } catch (e) {}
     try {
         return _toFutureSegwitAddress(output, network);
     } catch (e) {}
+
     throw new Error(bscript.toASM(output) + ' has no matching Address');
 }
-exports.fromOutputScript = fromOutputScript;
+
 /**
  * encodes address to output script with network, return output script if address matched
  */
-function toOutputScript(address, network) {
+export function toOutputScript(address: string, network?: Network): Buffer {
     network = network || networks.bitcoin;
-    let decodeBase58;
-    let decodeBech32;
+
+    let decodeBase58: Base58CheckResult | undefined;
+    let decodeBech32: Bech32Result | undefined;
     try {
         decodeBase58 = fromBase58Check(address);
     } catch (e) {}
+
     if (decodeBase58) {
         if (decodeBase58.version === network.pubKeyHash)
-            return payments.p2pkh({ hash: decodeBase58.hash }).output;
+            return payments.p2pkh({ hash: decodeBase58.hash }).output as Buffer;
         if (decodeBase58.version === network.scriptHash)
-            return payments.p2sh({ hash: decodeBase58.hash }).output;
+            return payments.p2sh({ hash: decodeBase58.hash }).output as Buffer;
     } else {
         try {
             decodeBech32 = fromBech32(address);
         } catch (e) {}
+
         if (decodeBech32) {
             if (decodeBech32.prefix !== network.bech32)
                 throw new Error(address + ' has an invalid prefix');
             if (decodeBech32.version === 0) {
                 if (decodeBech32.data.length === 20)
-                    return payments.p2wpkh({ hash: decodeBech32.data }).output;
+                    return payments.p2wpkh({ hash: decodeBech32.data }).output as Buffer;
                 if (decodeBech32.data.length === 32)
-                    return payments.p2wsh({ hash: decodeBech32.data }).output;
+                    return payments.p2wsh({ hash: decodeBech32.data }).output as Buffer;
             } else if (decodeBech32.version === 1) {
                 if (decodeBech32.data.length === 32)
-                    return payments.p2tr({ pubkey: decodeBech32.data }).output;
+                    return payments.p2tr({ pubkey: decodeBech32.data }).output as Buffer;
             } else if (
                 decodeBech32.version >= FUTURE_SEGWIT_MIN_VERSION &&
                 decodeBech32.version <= FUTURE_SEGWIT_MAX_VERSION &&
@@ -179,6 +198,7 @@ function toOutputScript(address, network) {
                 decodeBech32.data.length <= FUTURE_SEGWIT_MAX_SIZE
             ) {
                 console.warn(FUTURE_SEGWIT_VERSION_WARNING);
+
                 return bscript.compile([
                     decodeBech32.version + FUTURE_SEGWIT_VERSION_DIFF,
                     decodeBech32.data,
@@ -186,6 +206,6 @@ function toOutputScript(address, network) {
             }
         }
     }
+
     return Buffer.from(address, 'hex');
 }
-exports.toOutputScript = toOutputScript;

package/src/{bip66.js → bip66.ts}

@@ -1,58 +1,62 @@
-'use strict';
 // Reference https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki
 // Format: 0x30 [total-length] 0x02 [R-length] [R] 0x02 [S-length] [S]
 // NOTE: SIGHASH byte ignored AND restricted, truncate before use
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.encode = exports.decode = exports.check = void 0;
-function check(buffer) {
+
+export function check(buffer: Buffer): boolean {
     if (buffer.length < 8) return false;
     if (buffer.length > 72) return false;
     if (buffer[0] !== 0x30) return false;
     if (buffer[1] !== buffer.length - 2) return false;
     if (buffer[2] !== 0x02) return false;
+
     const lenR = buffer[3];
     if (lenR === 0) return false;
     if (5 + lenR >= buffer.length) return false;
     if (buffer[4 + lenR] !== 0x02) return false;
+
     const lenS = buffer[5 + lenR];
     if (lenS === 0) return false;
     if (6 + lenR + lenS !== buffer.length) return false;
+
     if (buffer[4] & 0x80) return false;
     if (lenR > 1 && buffer[4] === 0x00 && !(buffer[5] & 0x80)) return false;
+
     if (buffer[lenR + 6] & 0x80) return false;
-    if (lenS > 1 && buffer[lenR + 6] === 0x00 && !(buffer[lenR + 7] & 0x80))
-        return false;
+    if (lenS > 1 && buffer[lenR + 6] === 0x00 && !(buffer[lenR + 7] & 0x80)) return false;
     return true;
 }
-exports.check = check;
-function decode(buffer) {
+
+export function decode(buffer: Buffer): { r: Buffer; s: Buffer } {
     if (buffer.length < 8) throw new Error('DER sequence length is too short');
     if (buffer.length > 72) throw new Error('DER sequence length is too long');
     if (buffer[0] !== 0x30) throw new Error('Expected DER sequence');
-    if (buffer[1] !== buffer.length - 2)
-        throw new Error('DER sequence length is invalid');
+    if (buffer[1] !== buffer.length - 2) throw new Error('DER sequence length is invalid');
     if (buffer[2] !== 0x02) throw new Error('Expected DER integer');
+
     const lenR = buffer[3];
     if (lenR === 0) throw new Error('R length is zero');
     if (5 + lenR >= buffer.length) throw new Error('R length is too long');
     if (buffer[4 + lenR] !== 0x02) throw new Error('Expected DER integer (2)');
+
     const lenS = buffer[5 + lenR];
     if (lenS === 0) throw new Error('S length is zero');
-    if (6 + lenR + lenS !== buffer.length)
-        throw new Error('S length is invalid');
+    if (6 + lenR + lenS !== buffer.length) throw new Error('S length is invalid');
+
     if (buffer[4] & 0x80) throw new Error('R value is negative');
     if (lenR > 1 && buffer[4] === 0x00 && !(buffer[5] & 0x80))
         throw new Error('R value excessively padded');
+
     if (buffer[lenR + 6] & 0x80) throw new Error('S value is negative');
     if (lenS > 1 && buffer[lenR + 6] === 0x00 && !(buffer[lenR + 7] & 0x80))
         throw new Error('S value excessively padded');
+
     // non-BIP66 - extract R, S values
     return {
         r: buffer.slice(4, 4 + lenR),
         s: buffer.slice(6 + lenR),
     };
 }
-exports.decode = decode;
+
 /*
  * Expects r and s to be positive DER integers.
  *
@@ -75,7 +79,7 @@ exports.decode = decode;
  *  62300 => 0x00f35c
  * -62300 => 0xff0ca4
  */
-function encode(r, s) {
+export function encode(r: Buffer, s: Buffer): Buffer {
     const lenR = r.length;
     const lenS = s.length;
     if (lenR === 0) throw new Error('R length is zero');
@@ -84,11 +88,11 @@ function encode(r, s) {
     if (lenS > 33) throw new Error('S length is too long');
     if (r[0] & 0x80) throw new Error('R value is negative');
     if (s[0] & 0x80) throw new Error('S value is negative');
-    if (lenR > 1 && r[0] === 0x00 && !(r[1] & 0x80))
-        throw new Error('R value excessively padded');
-    if (lenS > 1 && s[0] === 0x00 && !(s[1] & 0x80))
-        throw new Error('S value excessively padded');
+    if (lenR > 1 && r[0] === 0x00 && !(r[1] & 0x80)) throw new Error('R value excessively padded');
+    if (lenS > 1 && s[0] === 0x00 && !(s[1] & 0x80)) throw new Error('S value excessively padded');
+
     const signature = Buffer.allocUnsafe(6 + lenR + lenS);
+
     // 0x30 [total-length] 0x02 [R-length] [R] 0x02 [S-length] [S]
     signature[0] = 0x30;
     signature[1] = signature.length - 2;
@@ -98,6 +102,6 @@ function encode(r, s) {
     signature[4 + lenR] = 0x02;
     signature[5 + lenR] = s.length;
     s.copy(signature, 6 + lenR);
+
     return signature;
 }
-exports.encode = encode;