Merge pull request #1476 from bitcoinjs/removeTxb

Tests cleanup

Author: d-yokoi

.travis.yml

@@ -19,6 +19,8 @@ matrix:
       env: TEST_SUITE=gitdiff:ci
     - node_js: "lts/*"
       env: TEST_SUITE=lint
+    - node_js: "lts/*"
+      env: TEST_SUITE=lint:tests
     - node_js: "lts/*"
       env: TEST_SUITE=coverage
 env:

README.md

@@ -85,14 +85,6 @@ The below examples are implemented as integration tests, they should be very eas
 Otherwise, pull requests are appreciated.
 Some examples interact (via HTTPS) with a 3rd Party Blockchain Provider (3PBP).
 
-### Warning: Currently the tests use TransactionBuilder, which will be removed in the future (v6.x.x or higher)
-We will move towards replacing all instances of TransactionBuilder in the tests with the new Psbt.
-
-Currently we have a few examples on how to use the newer Psbt class at the following link:
-- [Psbt examples](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions-psbt.spec.ts)
-
-The rest of the examples are below (using TransactionBuilder for Transaction creation)
-
 - [Generate a random address](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/addresses.spec.ts)
 - [Import an address via WIF](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/addresses.spec.ts)
 - [Generate a 2-of-3 P2SH multisig address](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/addresses.spec.ts)
@@ -104,15 +96,14 @@ The rest of the examples are below (using TransactionBuilder for Transaction cre
 - [Generate a Testnet address](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/addresses.spec.ts)
 - [Generate a Litecoin address](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/addresses.spec.ts)
 - [Create a 1-to-1 Transaction](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
-- [Create a 2-to-2 Transaction](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a typical Transaction](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with an OP\_RETURN output](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with a 2-of-4 P2SH(multisig) input](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with a SegWit P2SH(P2WPKH) input](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with a SegWit P2WPKH input](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with a SegWit P2PK input](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Create (and broadcast via 3PBP) a Transaction with a SegWit 3-of-4 P2SH(P2WSH(multisig)) input](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
-- [Verify a Transaction signature](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
+- [Create (and broadcast via 3PBP) a Transaction and sign with an HDSigner interface (bip32)](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/transactions.spec.ts)
 - [Import a BIP32 testnet xpriv and export to WIF](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/bip32.spec.ts)
 - [Export a BIP32 xpriv, then import it](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/bip32.spec.ts)
 - [Export a BIP32 xpub](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/bip32.spec.ts)

package-lock.json

@@ -28,6 +28,7 @@
     "gitdiff:ci": "npm run build && git diff --exit-code",
     "integration": "npm run build && npm run nobuild:integration",
     "lint": "tslint -p tsconfig.json -c tslint.json",
+    "lint:tests": "tslint -p test/tsconfig.json -c tslint.json",
     "mocha:ts": "mocha --recursive --require test/ts-node-register",
     "nobuild:coverage-report": "nyc report --reporter=lcov",
     "nobuild:coverage-html": "nyc report --reporter=html",
@@ -48,7 +49,7 @@
     "types"
   ],
   "dependencies": {
-    "@types/node": "10.12.18",
+    "@types/node": "12.7.5",
     "bech32": "^1.1.2",
     "bip174": "^1.0.1",
     "bip32": "^2.0.4",

package.json

@@ -7,8 +7,8 @@ import * as base58KeysInvalid from './fixtures/core/base58_keys_invalid.json';
 import * as base58KeysValid from './fixtures/core/base58_keys_valid.json';
 import * as blocksValid from './fixtures/core/blocks.json';
 import * as sigCanonical from './fixtures/core/sig_canonical.json';
-import * as sigHash from './fixtures/core/sighash.json';
 import * as sigNoncanonical from './fixtures/core/sig_noncanonical.json';
+import * as sigHash from './fixtures/core/sighash.json';
 import * as txValid from './fixtures/core/tx_valid.json';
 
 describe('Bitcoin-core', () => {
@@ -72,11 +72,11 @@ describe('Bitcoin-core', () => {
     ];
 
     base58KeysInvalid.forEach(f => {
-      const string = f[0];
+      const strng = f[0];
 
-      it('throws on ' + string, () => {
+      it('throws on ' + strng, () => {
         assert.throws(() => {
-          const address = bitcoin.address.fromBase58Check(string);
+          const address = bitcoin.address.fromBase58Check(strng);
 
           assert.notStrictEqual(
             allowedNetworks.indexOf(address.version),
@@ -121,11 +121,11 @@ describe('Bitcoin-core', () => {
     ];
 
     base58KeysInvalid.forEach(f => {
-      const string = f[0];
+      const strng = f[0];
 
-      it('throws on ' + string, () => {
+      it('throws on ' + strng, () => {
         assert.throws(() => {
-          bitcoin.ECPair.fromWIF(string, allowedNetworks);
+          bitcoin.ECPair.fromWIF(strng, allowedNetworks);
         }, /(Invalid|Unknown) (checksum|compression flag|network version|WIF length)/);
       });
     });
@@ -242,9 +242,14 @@ describe('Bitcoin-core', () => {
       const buffer = Buffer.from(hex, 'hex');
 
       it('throws on ' + description, () => {
+        const reg = new RegExp(
+          'Expected DER (integer|sequence)|(R|S) value (excessively ' +
+            'padded|is negative)|(R|S|DER sequence) length is (zero|too ' +
+            'short|too long|invalid)|Invalid hashType',
+        );
         assert.throws(() => {
           bitcoin.script.signature.decode(buffer);
-        }, /Expected DER (integer|sequence)|(R|S) value (excessively padded|is negative)|(R|S|DER sequence) length is (zero|too short|too long|invalid)|Invalid hashType/);
+        }, reg);
       });
     });
   });

test/bitcoin.core.spec.ts

@@ -8,7 +8,9 @@ describe('Block', () => {
   describe('version', () => {
     it('should be interpreted as an int32le', () => {
       const blockHex =
-        'ffffffff0000000000000000000000000000000000000000000000000000000000000000414141414141414141414141414141414141414141414141414141414141414101000000020000000300000000';
+        'ffffffff000000000000000000000000000000000000000000000000000000000000' +
+        '00004141414141414141414141414141414141414141414141414141414141414141' +
+        '01000000020000000300000000';
       const block = Block.fromHex(blockHex);
       assert.strictEqual(-1, block.version);
       assert.strictEqual(1, block.timestamp);

test/block.spec.ts

@@ -9,9 +9,9 @@ describe('bufferutils', () => {
     fixtures.valid.forEach(f => {
       it('decodes ' + f.hex, () => {
         const buffer = Buffer.from(f.hex, 'hex');
-        const number = bufferutils.readUInt64LE(buffer, 0);
+        const num = bufferutils.readUInt64LE(buffer, 0);
 
-        assert.strictEqual(number, f.dec);
+        assert.strictEqual(num, f.dec);
       });
     });
 

test/bufferutils.spec.ts

@@ -1,7 +1,7 @@
 import * as assert from 'assert';
 import { describe, it } from 'mocha';
-import * as bscript from '../src/script';
 import * as classify from '../src/classify';
+import * as bscript from '../src/script';
 
 import * as fixtures from './fixtures/templates.json';
 
@@ -10,9 +10,9 @@ import * as nullData from '../src/templates/nulldata';
 import * as pubKey from '../src/templates/pubkey';
 import * as pubKeyHash from '../src/templates/pubkeyhash';
 import * as scriptHash from '../src/templates/scripthash';
+import * as witnessCommitment from '../src/templates/witnesscommitment';
 import * as witnessPubKeyHash from '../src/templates/witnesspubkeyhash';
 import * as witnessScriptHash from '../src/templates/witnessscripthash';
-import * as witnessCommitment from '../src/templates/witnesscommitment';
 
 const tmap = {
   pubKey,

test/classify.spec.ts

@@ -6,23 +6,27 @@ const dhttp = regtestUtils.dhttp;
 const TESTNET = bitcoin.networks.testnet;
 
 describe('bitcoinjs-lib (addresses)', () => {
-  it('can generate a random address [and support the retrieval of transactions for that address (via 3PBP)', async () => {
-    const keyPair = bitcoin.ECPair.makeRandom();
-    const { address } = bitcoin.payments.p2pkh({ pubkey: keyPair.publicKey });
-
-    // bitcoin P2PKH addresses start with a '1'
-    assert.strictEqual(address!.startsWith('1'), true);
-
-    const result = await dhttp({
-      method: 'GET',
-      url: 'https://blockchain.info/rawaddr/' + address,
-    });
-
-    // random private keys [probably!] have no transactions
-    assert.strictEqual((result as any).n_tx, 0);
-    assert.strictEqual((result as any).total_received, 0);
-    assert.strictEqual((result as any).total_sent, 0);
-  });
+  it(
+    'can generate a random address [and support the retrieval of ' +
+      'transactions for that address (via 3PBP)]',
+    async () => {
+      const keyPair = bitcoin.ECPair.makeRandom();
+      const { address } = bitcoin.payments.p2pkh({ pubkey: keyPair.publicKey });
+
+      // bitcoin P2PKH addresses start with a '1'
+      assert.strictEqual(address!.startsWith('1'), true);
+
+      const result = await dhttp({
+        method: 'GET',
+        url: 'https://blockchain.info/rawaddr/' + address,
+      });
+
+      // random private keys [probably!] have no transactions
+      assert.strictEqual((result as any).n_tx, 0);
+      assert.strictEqual((result as any).total_received, 0);
+      assert.strictEqual((result as any).total_sent, 0);
+    },
+  );
 
   it('can import an address via WIF', () => {
     const keyPair = bitcoin.ECPair.fromWIF(

test/integration/addresses.spec.ts

@@ -1,7 +1,7 @@
 import * as assert from 'assert';
-import { describe, it } from 'mocha';
 import * as bip32 from 'bip32';
 import * as bip39 from 'bip39';
+import { describe, it } from 'mocha';
 import * as bitcoin from '../..';
 
 function getAddress(node: any, network?: any): string {
@@ -25,8 +25,8 @@ describe('bitcoinjs-lib (BIP32)', () => {
       'praise you muffin lion enable neck grocery crumble super myself license ghost';
     const seed = bip39.mnemonicToSeedSync(mnemonic);
     const node = bip32.fromSeed(seed);
-    const string = node.toBase58();
-    const restored = bip32.fromBase58(string);
+    const strng = node.toBase58();
+    const restored = bip32.fromBase58(strng);
 
     assert.strictEqual(getAddress(node), getAddress(restored)); // same public key
     assert.strictEqual(node.toWIF(), restored.toWIF()); // same private key
@@ -37,10 +37,10 @@ describe('bitcoinjs-lib (BIP32)', () => {
       'praise you muffin lion enable neck grocery crumble super myself license ghost';
     const seed = bip39.mnemonicToSeedSync(mnemonic);
     const node = bip32.fromSeed(seed);
-    const string = node.neutered().toBase58();
+    const strng = node.neutered().toBase58();
 
     assert.strictEqual(
-      string,
+      strng,
       'xpub661MyMwAqRbcGhVeaVfEBA25e3cP9DsJQZoE8iep5fZSxy3TnPBNBgWnMZx56oreNc48ZoTkQfatNJ9VWnQ7ZcLZcVStpaXLTeG8bGrzX3n',
     );
   });