Merge pull request #1734 from bitcoinjs/feat/modular

Refactor: Remove all require statements, remove ECPair, remove tiny-secp256k1 dep

Author: junderw

README.md

@@ -35,10 +35,18 @@ You can find a [Web UI](https://bitcoincore.tech/apps/bitcoinjs-ui/index.html) t
 ## Installation
 ``` bash
 npm install bitcoinjs-lib
+# optionally, install a key derivation library as well
+npm install ecpair bip32
+# ecpair is the ECPair class for single keys
+# bip32 is for generating HD keys
 ```
 
-Typically we support the [Node Maintenance LTS version](https://github.com/nodejs/Release).
-If in doubt, see the [.travis.yml](.travis.yml) for what versions are used by our continuous integration tests.
+Previous versions of the library included classes for key management (ECPair, HDNode(->"bip32")) but now these have been separated into different libraries. This lowers the bundle size significantly if you don't need to perform any crypto functions (converting private to public keys and deriving HD keys).
+
+Typically we support the [Node Maintenance LTS version](https://github.com/nodejs/Release). TypeScript target will be set
+to the ECMAScript version in which all features are fully supported by current Active Node LTS.
+However, depending on adoption among other environments (browsers etc.) we may keep the target back a year or two.
+If in doubt, see the [main_ci.yml](.github/workflows/main_ci.yml) for what versions are used by our continuous integration tests.
 
 **WARNING**: We presently don't provide any tooling to verify that the release on `npm` matches GitHub.  As such, you should verify anything downloaded by `npm` against your own verified copy.
 

package-lock.json

@@ -3,7 +3,7 @@
   "version": "5.2.0",
   "description": "Client-side Bitcoin JavaScript library",
   "main": "./src/index.js",
-  "types": "./types/index.d.ts",
+  "types": "./src/index.d.ts",
   "engines": {
     "node": ">=8.0.0"
   },
@@ -18,7 +18,7 @@
     "audit": "NPM_AUDIT_IGNORE_DEV=1 NPM_AUDIT_IGNORE_LEVEL=low npm-audit-whitelister .npm-audit-whitelister.json",
     "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 types",
+    "clean": "rimraf src",
     "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",
@@ -46,49 +46,47 @@
     "url": "https://github.com/bitcoinjs/bitcoinjs-lib.git"
   },
   "files": [
-    "src",
-    "types"
+    "src"
   ],
   "dependencies": {
     "bech32": "^2.0.0",
     "bip174": "^2.0.1",
-    "bip32": "^2.0.4",
-    "bip66": "^1.1.0",
-    "bitcoin-ops": "^1.4.0",
-    "bs58check": "^2.0.0",
+    "bs58check": "^2.1.2",
     "create-hash": "^1.1.0",
-    "create-hmac": "^1.1.3",
-    "merkle-lib": "^2.0.10",
-    "pushdata-bitcoin": "^1.0.1",
-    "randombytes": "^2.0.1",
-    "tiny-secp256k1": "^1.1.6",
     "typeforce": "^1.11.3",
-    "varuint-bitcoin": "^1.0.4",
+    "varuint-bitcoin": "^1.1.2",
     "wif": "^2.0.1"
   },
   "devDependencies": {
     "@types/bs58": "^4.0.0",
+    "@types/bs58check": "^2.1.0",
+    "@types/create-hash": "^1.2.2",
     "@types/mocha": "^5.2.7",
-    "@types/node": "12.7.5",
+    "@types/node": "^16.11.1",
     "@types/proxyquire": "^1.3.28",
+    "@types/randombytes": "^2.0.0",
+    "@types/wif": "^2.0.2",
+    "bip32": "^2.0.6",
     "bip39": "^3.0.2",
     "bip65": "^1.0.1",
     "bip68": "^1.0.3",
     "bn.js": "^4.11.8",
     "bs58": "^4.0.0",
     "dhttp": "^3.0.0",
+    "ecpair": "^1.0.0",
     "hoodwink": "^2.0.0",
     "minimaldata": "^1.0.2",
     "mocha": "^7.1.1",
     "npm-audit-whitelister": "^1.0.2",
     "nyc": "^15.1.0",
     "prettier": "1.16.4",
     "proxyquire": "^2.0.1",
+    "randombytes": "^2.1.0",
     "regtest-client": "0.2.0",
     "rimraf": "^2.6.3",
     "ts-node": "^8.3.0",
-    "tslint": "^5.20.1",
-    "typescript": "3.2.2"
+    "tslint": "^6.1.3",
+    "typescript": "^4.4.4"
   },
   "license": "MIT"
 }

package.json

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { Network } from './networks';
 export interface Base58CheckResult {
     hash: Buffer;

types/address.d.ts renamed to src/address.d.ts

@@ -1,12 +1,13 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
+exports.toOutputScript = exports.fromOutputScript = exports.toBech32 = exports.toBase58Check = exports.fromBech32 = exports.fromBase58Check = void 0;
 const networks = require('./networks');
 const payments = require('./payments');
 const bscript = require('./script');
 const types = require('./types');
-const { bech32, bech32m } = require('bech32');
+const bech32_1 = require('bech32');
 const bs58check = require('bs58check');
-const typeforce = require('typeforce');
+const { typeforce } = types;
 const FUTURE_SEGWIT_MAX_SIZE = 40;
 const FUTURE_SEGWIT_MIN_SIZE = 2;
 const FUTURE_SEGWIT_MAX_VERSION = 16;
@@ -43,17 +44,17 @@ function fromBech32(address) {
   let result;
   let version;
   try {
-    result = bech32.decode(address);
+    result = bech32_1.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);
+    result = bech32_1.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));
+  const data = bech32_1.bech32.fromWords(result.words.slice(1));
   return {
     version,
     prefix: result.prefix,
@@ -70,11 +71,11 @@ function toBase58Check(hash, version) {
 }
 exports.toBase58Check = toBase58Check;
 function toBech32(data, version, prefix) {
-  const words = bech32.toWords(data);
+  const words = bech32_1.bech32.toWords(data);
   words.unshift(version);
   return version === 0
-    ? bech32.encode(prefix, words)
-    : bech32m.encode(prefix, words);
+    ? bech32_1.bech32.encode(prefix, words)
+    : bech32_1.bech32m.encode(prefix, words);
 }
 exports.toBech32 = toBech32;
 function fromOutputScript(output, network) {

src/address.js

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+export declare function check(buffer: Buffer): boolean;
+export declare function decode(buffer: Buffer): {
+    r: Buffer;
+    s: Buffer;
+};
+export declare function encode(r: Buffer, s: Buffer): Buffer;

src/bip66.d.ts

@@ -0,0 +1,102 @@
+'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) {
+  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;
+  return true;
+}
+exports.check = check;
+function decode(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[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 (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.
+ *
+ * The DER format uses the most significant bit as a sign bit (& 0x80).
+ * If the significant bit is set AND the integer is positive, a 0x00 is prepended.
+ *
+ * Examples:
+ *
+ *      0 =>     0x00
+ *      1 =>     0x01
+ *     -1 =>     0xff
+ *    127 =>     0x7f
+ *   -127 =>     0x81
+ *    128 =>   0x0080
+ *   -128 =>     0x80
+ *    255 =>   0x00ff
+ *   -255 =>   0xff01
+ *  16300 =>   0x3fac
+ * -16300 =>   0xc054
+ *  62300 => 0x00f35c
+ * -62300 => 0xff0ca4
+ */
+function encode(r, s) {
+  const lenR = r.length;
+  const lenS = s.length;
+  if (lenR === 0) throw new Error('R length is zero');
+  if (lenS === 0) throw new Error('S length is zero');
+  if (lenR > 33) throw new Error('R length is too long');
+  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');
+  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;
+  signature[2] = 0x02;
+  signature[3] = r.length;
+  r.copy(signature, 4);
+  signature[4 + lenR] = 0x02;
+  signature[5 + lenR] = s.length;
+  s.copy(signature, 6 + lenR);
+  return signature;
+}
+exports.encode = encode;

src/bip66.js

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { Transaction } from './transaction';
 export declare class Block {
     static fromBuffer(buffer: Buffer): Block;

types/block.d.ts renamed to src/block.d.ts

@@ -1,12 +1,12 @@
 'use strict';
 Object.defineProperty(exports, '__esModule', { value: true });
+exports.Block = void 0;
 const bufferutils_1 = require('./bufferutils');
 const bcrypto = require('./crypto');
+const merkle_1 = require('./merkle');
 const transaction_1 = require('./transaction');
 const types = require('./types');
-const fastMerkleRoot = require('merkle-lib/fastRoot');
-const typeforce = require('typeforce');
-const varuint = require('varuint-bitcoin');
+const { typeforce } = types;
 const errorMerkleNoTxes = new TypeError(
   'Cannot compute merkle root for zero transactions',
 );
@@ -72,7 +72,7 @@ class Block {
     const hashes = transactions.map(transaction =>
       transaction.getHash(forWitness),
     );
-    const rootHash = fastMerkleRoot(hashes, bcrypto.hash256);
+    const rootHash = (0, merkle_1.fastMerkleRoot)(hashes, bcrypto.hash256);
     return forWitness
       ? bcrypto.hash256(
           Buffer.concat([rootHash, transactions[0].ins[0].witness[0]]),
@@ -117,15 +117,15 @@ class Block {
     if (headersOnly || !this.transactions) return 80;
     return (
       80 +
-      varuint.encodingLength(this.transactions.length) +
+      bufferutils_1.varuint.encodingLength(this.transactions.length) +
       this.transactions.reduce((a, x) => a + x.byteLength(allowWitness), 0)
     );
   }
   getHash() {
     return bcrypto.hash256(this.toBuffer(true));
   }
   getId() {
-    return bufferutils_1.reverseBuffer(this.getHash()).toString('hex');
+    return (0, bufferutils_1.reverseBuffer)(this.getHash()).toString('hex');
   }
   getUTCDate() {
     const date = new Date(0); // epoch
@@ -143,8 +143,12 @@ class Block {
     bufferWriter.writeUInt32(this.bits);
     bufferWriter.writeUInt32(this.nonce);
     if (headersOnly || !this.transactions) return buffer;
-    varuint.encode(this.transactions.length, buffer, bufferWriter.offset);
-    bufferWriter.offset += varuint.encode.bytes;
+    bufferutils_1.varuint.encode(
+      this.transactions.length,
+      buffer,
+      bufferWriter.offset,
+    );
+    bufferWriter.offset += bufferutils_1.varuint.encode.bytes;
     this.transactions.forEach(tx => {
       const txSize = tx.byteLength(); // TODO: extract from toBuffer?
       tx.toBuffer(buffer, bufferWriter.offset);
@@ -166,7 +170,7 @@ class Block {
     );
   }
   checkProofOfWork() {
-    const hash = bufferutils_1.reverseBuffer(this.getHash());
+    const hash = (0, bufferutils_1.reverseBuffer)(this.getHash());
     const target = Block.calculateTarget(this.bits);
     return hash.compare(target) <= 0;
   }

src/block.js

@@ -1,3 +1,6 @@
+/// <reference types="node" />
+import * as varuint from 'varuint-bitcoin';
+export { varuint };
 export declare function readUInt64LE(buffer: Buffer, offset: number): number;
 export declare function writeUInt64LE(buffer: Buffer, value: number, offset: number): number;
 export declare function reverseBuffer(buffer: Buffer): Buffer;