@btc-vision/bitcoin 6.3.2 → 6.3.4

package/eslint.config.js

@@ -1,56 +1,56 @@
-// @ts-check
-
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-
-export default tseslint.config(
-    eslint.configs.recommended,
-    ...tseslint.configs.strictTypeChecked,
-    {
-        languageOptions: {
-            parserOptions: {
-                projectService: true,
-                tsconfigDirName: import.meta.dirname,
-            },
-        },
-        rules: {
-            'no-undef': 'off',
-            '@typescript-eslint/no-unused-vars': 'off',
-            'no-empty': 'off',
-            '@typescript-eslint/restrict-template-expressions': 'off',
-            '@typescript-eslint/only-throw-error': 'off',
-            '@typescript-eslint/no-unnecessary-condition': 'off',
-            '@typescript-eslint/unbound-method': 'warn',
-            '@typescript-eslint/no-confusing-void-expression': 'off',
-            '@typescript-eslint/no-extraneous-class': 'off',
-            'no-async-promise-executor': 'off',
-            '@typescript-eslint/no-misused-promises': 'off',
-            '@typescript-eslint/no-unnecessary-type-parameters': 'off',
-            '@typescript-eslint/no-duplicate-enum-values': 'off',
-            'prefer-spread': 'off',
-            '@typescript-eslint/no-empty-object-type': 'off',
-            /** TO FIX */
-            '@typescript-eslint/no-unsafe-call': 'warn',
-            '@typescript-eslint/no-unsafe-assignment': 'warn',
-            'prefer-rest-params': 'warn',
-            '@typescript-eslint/restrict-plus-operands': 'warn',
-            '@typescript-eslint/no-unsafe-member-access': 'warn',
-            '@typescript-eslint/no-unsafe-return': 'warn',
-            '@typescript-eslint/no-require-imports': 'warn',
-            '@typescript-eslint/no-explicit-any': 'warn',
-            '@typescript-eslint/no-unsafe-argument': 'warn',
-            '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
-            '@typescript-eslint/no-non-null-assertion': 'warn',
-            '@typescript-eslint/no-invalid-void-type': 'warn',
-            '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'warn',
-            '@typescript-eslint/no-unnecessary-template-expression': 'warn',
-            'no-case-declarations': 'warn',
-            '@typescript-eslint/ban-ts-comment': 'warn',
-            '@typescript-eslint/no-deprecated': 'warn',
-        },
-    },
-    {
-        files: ['**/*.js'],
-        ...tseslint.configs.disableTypeChecked,
-    },
-);
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    ...tseslint.configs.strictTypeChecked,
+    {
+        languageOptions: {
+            parserOptions: {
+                projectService: true,
+                tsconfigDirName: import.meta.dirname,
+            },
+        },
+        rules: {
+            'no-undef': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            'no-empty': 'off',
+            '@typescript-eslint/restrict-template-expressions': 'off',
+            '@typescript-eslint/only-throw-error': 'off',
+            '@typescript-eslint/no-unnecessary-condition': 'off',
+            '@typescript-eslint/unbound-method': 'warn',
+            '@typescript-eslint/no-confusing-void-expression': 'off',
+            '@typescript-eslint/no-extraneous-class': 'off',
+            'no-async-promise-executor': 'off',
+            '@typescript-eslint/no-misused-promises': 'off',
+            '@typescript-eslint/no-unnecessary-type-parameters': 'off',
+            '@typescript-eslint/no-duplicate-enum-values': 'off',
+            'prefer-spread': 'off',
+            '@typescript-eslint/no-empty-object-type': 'off',
+            /** TO FIX */
+            '@typescript-eslint/no-unsafe-call': 'warn',
+            '@typescript-eslint/no-unsafe-assignment': 'warn',
+            'prefer-rest-params': 'warn',
+            '@typescript-eslint/restrict-plus-operands': 'warn',
+            '@typescript-eslint/no-unsafe-member-access': 'warn',
+            '@typescript-eslint/no-unsafe-return': 'warn',
+            '@typescript-eslint/no-require-imports': 'warn',
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-unsafe-argument': 'warn',
+            '@typescript-eslint/no-unnecessary-type-assertion': 'warn',
+            '@typescript-eslint/no-non-null-assertion': 'warn',
+            '@typescript-eslint/no-invalid-void-type': 'warn',
+            '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'warn',
+            '@typescript-eslint/no-unnecessary-template-expression': 'warn',
+            'no-case-declarations': 'warn',
+            '@typescript-eslint/ban-ts-comment': 'warn',
+            '@typescript-eslint/no-deprecated': 'warn',
+        },
+    },
+    {
+        files: ['**/*.js'],
+        ...tseslint.configs.disableTypeChecked,
+    },
+);

package/package.json

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

package/src/address.ts

@@ -1,211 +1,211 @@
-/**
- * bitcoin address decode and encode tools, include base58、bech32 and output script
- *
- * networks support bitcoin、bitcoin testnet and bitcoin regtest
- *
- * addresses support P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
- *
- * @packageDocumentation
- */
-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: Buffer, network: Network): string {
-    const data = output.slice(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');
-
-    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
- */
-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 };
-}
-
-/**
- * decode address with bech32 specification,  return address version、address prefix and address data if valid
- */
-export function fromBech32(address: string): Bech32Result {
-    let result;
-    let version;
-    try {
-        result = bech32.decode(address);
-    } catch (e) {}
-
-    if (result) {
-        version = result.words[0];
-        if (version !== 0) throw new TypeError(address + ' uses wrong encoding');
-    } else {
-        result = bech32m.decode(address);
-        version = result.words[0];
-        if (version === 0) throw new TypeError(address + ' uses wrong encoding');
-    }
-
-    const data = bech32.fromWords(result.words.slice(1));
-
-    return {
-        version,
-        prefix: result.prefix,
-        data: Buffer.from(data),
-    };
-}
-
-/**
- * encode address hash to base58 address with version
- */
-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.default.encode(payload);
-}
-
-/**
- * encode address hash to bech32 address with version and prefix
- */
-export function toBech32(data: Buffer, version: number, prefix: string): string {
-    const words = bech32.toWords(data);
-    words.unshift(version);
-
-    return version === 0 ? bech32.encode(prefix, words) : bech32m.encode(prefix, words);
-}
-
-/**
- * decode address from output script with network, return address if matched
- */
-export function fromOutputScript(output: Buffer, network?: Network): string {
-    // TODO: Network
-    network = network || networks.bitcoin;
-
-    try {
-        return payments.p2pkh({ output, network }).address as string;
-    } catch (e) {}
-    try {
-        return payments.p2sh({ output, network }).address as string;
-    } catch (e) {}
-    try {
-        return payments.p2wpkh({ output, network }).address as string;
-    } catch (e) {}
-    try {
-        return payments.p2wsh({ output, network }).address as string;
-    } catch (e) {}
-    try {
-        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');
-}
-
-/**
- * encodes address to output script with network, return output script if address matched
- */
-export function toOutputScript(address: string, network?: Network): Buffer {
-    network = network || networks.bitcoin;
-
-    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 as Buffer;
-        if (decodeBase58.version === network.scriptHash)
-            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 as Buffer;
-                if (decodeBech32.data.length === 32)
-                    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 as Buffer;
-            } 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);
-
-                return bscript.compile([
-                    decodeBech32.version + FUTURE_SEGWIT_VERSION_DIFF,
-                    decodeBech32.data,
-                ]);
-            }
-        }
-    }
-
-    return Buffer.from(address, 'hex');
-}
+/**
+ * bitcoin address decode and encode tools, include base58、bech32 and output script
+ *
+ * networks support bitcoin、bitcoin testnet and bitcoin regtest
+ *
+ * addresses support P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on
+ *
+ * @packageDocumentation
+ */
+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: Buffer, network: Network): string {
+    const data = output.slice(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');
+
+    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
+ */
+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 };
+}
+
+/**
+ * decode address with bech32 specification,  return address version、address prefix and address data if valid
+ */
+export function fromBech32(address: string): Bech32Result {
+    let result;
+    let version;
+    try {
+        result = bech32.decode(address);
+    } catch (e) {}
+
+    if (result) {
+        version = result.words[0];
+        if (version !== 0) throw new TypeError(address + ' uses wrong encoding');
+    } else {
+        result = bech32m.decode(address);
+        version = result.words[0];
+        if (version === 0) throw new TypeError(address + ' uses wrong encoding');
+    }
+
+    const data = bech32.fromWords(result.words.slice(1));
+
+    return {
+        version,
+        prefix: result.prefix,
+        data: Buffer.from(data),
+    };
+}
+
+/**
+ * encode address hash to base58 address with version
+ */
+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.default.encode(payload);
+}
+
+/**
+ * encode address hash to bech32 address with version and prefix
+ */
+export function toBech32(data: Buffer, version: number, prefix: string): string {
+    const words = bech32.toWords(data);
+    words.unshift(version);
+
+    return version === 0 ? bech32.encode(prefix, words) : bech32m.encode(prefix, words);
+}
+
+/**
+ * decode address from output script with network, return address if matched
+ */
+export function fromOutputScript(output: Buffer, network?: Network): string {
+    // TODO: Network
+    network = network || networks.bitcoin;
+
+    try {
+        return payments.p2pkh({ output, network }).address as string;
+    } catch (e) {}
+    try {
+        return payments.p2sh({ output, network }).address as string;
+    } catch (e) {}
+    try {
+        return payments.p2wpkh({ output, network }).address as string;
+    } catch (e) {}
+    try {
+        return payments.p2wsh({ output, network }).address as string;
+    } catch (e) {}
+    try {
+        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');
+}
+
+/**
+ * encodes address to output script with network, return output script if address matched
+ */
+export function toOutputScript(address: string, network?: Network): Buffer {
+    network = network || networks.bitcoin;
+
+    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 as Buffer;
+        if (decodeBase58.version === network.scriptHash)
+            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 as Buffer;
+                if (decodeBech32.data.length === 32)
+                    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 as Buffer;
+            } 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);
+
+                return bscript.compile([
+                    decodeBech32.version + FUTURE_SEGWIT_VERSION_DIFF,
+                    decodeBech32.data,
+                ]);
+            }
+        }
+    }
+
+    return Buffer.from(address, 'hex');
+}