testing/integration/examples: isolate to addresses/transactions

examples, use public broadcast endpoints

Author: dcousens

README.md

@@ -100,8 +100,8 @@ The definitions are complete and up to date with version 2.2.0. The definitions
 The below examples are implemented as integration tests, they should be very easy to understand.  Otherwise, pull requests are appreciated.
 
 - [Generate a random address](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L9)
-- [Generate a address from a SHA256 hash](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L20)
-- [Generate a address and WIF for Litecoin](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L30)
+- [Generate an address from a SHA256 hash](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L20)
+- [Generate an address and WIF for Litecoin](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L30)
 - [Import an address via WIF](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L43)
 - [Create a Transaction](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/basic.js#L50)
 - [Create an OP RETURN transaction](https://github.com/bitcoinjs/bitcoinjs-lib/blob/d853806/test/integration/advanced.js#L24)

package.json

@@ -62,7 +62,7 @@
     "pushdata-bitcoin": "^1.0.1",
     "randombytes": "^2.0.1",
     "safe-buffer": "^5.0.1",
-    "typeforce": "^1.8.7",
+    "typeforce": "^1.11.3",
     "varuint-bitcoin": "^1.0.4",
     "wif": "^2.0.1"
   },
@@ -72,6 +72,7 @@
     "bs58": "^4.0.0",
     "cb-http-client": "^0.2.0",
     "coinselect": "^3.1.1",
+    "dhttp": "^2.3.5",
     "minimaldata": "^1.0.2",
     "mocha": "^3.1.0",
     "nyc": "^10.2.0",

test/integration/_mainnet.js

@@ -0,0 +1,3 @@
+var Blockchain = require('cb-http-client')
+var BLOCKTRAIL_API_KEY = process.env.BLOCKTRAIL_API_KEY || 'c0bd8155c66e3fb148bb1664adc1e4dacd872548'
+module.exports = new Blockchain('https://api.blocktrail.com/cb/v0.2.1/BTC', { api_key: BLOCKTRAIL_API_KEY })

test/integration/_blockchain.js renamed to test/integration/_testnet.js

@@ -1,13 +1,12 @@
+var async = require('async')
 var bitcoin = require('../../')
 var Blockchain = require('cb-http-client')
-var BLOCKTRAIL_API_KEY = process.env.BLOCKTRAIL_API_KEY || 'c0bd8155c66e3fb148bb1664adc1e4dacd872548'
 var coinSelect = require('coinselect')
 var typeforce = require('typeforce')
 var types = require('../../src/types')
 
-var mainnet = new Blockchain('https://api.blocktrail.com/cb/v0.2.1/BTC', { api_key: BLOCKTRAIL_API_KEY })
-var testnet = new Blockchain('https://api.blocktrail.com/cb/v0.2.1/tBTC', { api_key: BLOCKTRAIL_API_KEY })
-
+var BLOCKTRAIL_API_KEY = process.env.BLOCKTRAIL_API_KEY || 'c0bd8155c66e3fb148bb1664adc1e4dacd872548'
+var blockchain = new Blockchain('https://api.blocktrail.com/cb/v0.2.1/tBTC', { api_key: BLOCKTRAIL_API_KEY })
 var kpNetwork = bitcoin.networks.testnet
 var keyPair = bitcoin.ECPair.fromWIF('cQqjeq2rxqwnqwMewJhkNtJDixtX8ctA4bYoWHdxY4xRPVvAEjmk', kpNetwork)
 var kpAddress = keyPair.getAddress()
@@ -37,20 +36,20 @@ function fundAddress (unspents, outputs, callback) {
   var tx = txb.build()
   var txId = tx.getId()
 
-  testnet.transactions.propagate(tx.toHex(), function (err) {
+  blockchain.transactions.propagate(tx.toHex(), function (err) {
     if (err) return callback(err)
 
     // FIXME: @blocktrail can be very slow, give it time
-    setTimeout(() => {
+    setTimeout(function () {
       callback(null, outputs.map(function (_, i) {
         return { txId: txId, vout: i }
       }))
     }, 3000)
   })
 }
 
-testnet.faucetMany = function faucetMany (outputs, callback) {
-  testnet.addresses.unspents(kpAddress, function (err, unspents) {
+blockchain.faucetMany = function faucetMany (outputs, callback) {
+  blockchain.addresses.unspents(kpAddress, function (err, unspents) {
     if (err) return callback(err)
 
     typeforce([{
@@ -63,15 +62,28 @@ testnet.faucetMany = function faucetMany (outputs, callback) {
   })
 }
 
-testnet.faucet = function faucet (address, value, callback) {
-  testnet.faucetMany([{ address: address, value: value }], function (err, unspents) {
+blockchain.faucet = function faucet (address, value, callback) {
+  blockchain.faucetMany([{ address: address, value: value }], function (err, unspents) {
     callback(err, unspents && unspents[0])
   })
 }
 
-testnet.RETURN = kpAddress
-
-module.exports = {
-  m: mainnet,
-  t: testnet
+// verify TX was accepted
+blockchain.verify = function (address, txId, value, done) {
+  async.retry(5, function (callback) {
+    setTimeout(function () {
+      // check that the above transaction included the intended address
+      blockchain.addresses.unspents(blockchain.RETURN_ADDRESS, function (err, unspents) {
+        if (err) return callback(err)
+        if (!unspents.some(function (x) {
+          return x.txId === txId && x.value === value
+        })) return callback(new Error('Could not find unspent'))
+
+        callback()
+      })
+    }, 600)
+  }, done)
 }
+
+blockchain.RETURN_ADDRESS = kpAddress
+module.exports = blockchain

test/integration/addresses.js

@@ -0,0 +1,92 @@
+/* global describe, it */
+
+var assert = require('assert')
+var bigi = require('bigi')
+var bitcoin = require('../../')
+var dhttp = require('dhttp/200')
+
+// deterministic RNG for testing only
+function rng () { return Buffer.from('zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz') }
+
+describe('bitcoinjs-lib (addresses)', function () {
+  it('can generate a random address', function () {
+    var keyPair = bitcoin.ECPair.makeRandom({ rng: rng })
+    var address = keyPair.getAddress()
+
+    assert.strictEqual(address, '1F5VhMHukdnUES9kfXqzPzMeF1GPHKiF64')
+  })
+
+  it('can generate an address from a SHA256 hash', function () {
+    var hash = bitcoin.crypto.sha256('correct horse battery staple')
+    var d = bigi.fromBuffer(hash)
+
+    var keyPair = new bitcoin.ECPair(d)
+    var address = keyPair.getAddress()
+
+    assert.strictEqual(address, '1C7zdTfnkzmr13HfA2vNm5SJYRK6nEKyq8')
+  })
+
+  it('can import an address via WIF', function () {
+    var keyPair = bitcoin.ECPair.fromWIF('Kxr9tQED9H44gCmp6HAdmemAzU3n84H3dGkuWTKvE23JgHMW8gct')
+    var address = keyPair.getAddress()
+
+    assert.strictEqual(address, '19AAjaTUbRjQCMuVczepkoPswiZRhjtg31')
+  })
+
+  it('can generate a 2-of-3 multisig P2SH address', function () {
+    var pubKeys = [
+      '026477115981fe981a6918a6297d9803c4dc04f328f22041bedff886bbc2962e01',
+      '02c96db2302d19b43d4c69368babace7854cc84eb9e061cde51cfa77ca4a22b8b9',
+      '03c6103b3b83e4a24a0e33a4df246ef11772f9992663db0c35759a5e2ebf68d8e9'
+    ].map(function (hex) {
+      return Buffer.from(hex, 'hex')
+    })
+
+    var redeemScript = bitcoin.script.multisig.output.encode(2, pubKeys) // 2 of 3
+    var scriptPubKey = bitcoin.script.scriptHash.output.encode(bitcoin.crypto.hash160(redeemScript))
+    var address = bitcoin.address.fromOutputScript(scriptPubKey)
+
+    assert.strictEqual(address, '36NUkt6FWUi3LAWBqWRdDmdTWbt91Yvfu7')
+  })
+
+  it('can support the retrieval of transactions for an address (3rd party blockchain)', function (done) {
+    var keyPair = bitcoin.ECPair.makeRandom()
+    var address = keyPair.getAddress()
+
+    dhttp({
+      method: 'POST',
+      url: 'https://api.ei8ht.com.au/3/addrtxs',
+      body: {
+        addrs: [address],
+        height: 0
+      }
+    }, function (err, transactions) {
+      if (err) return done(err)
+
+      // random private keys [probably] have no transactions
+      assert.strictEqual(Object.keys(transactions).length, 0)
+      done()
+    })
+  })
+
+  // other networks
+  it('can generate a Testnet address', function () {
+    var testnet = bitcoin.networks.testnet
+    var keyPair = bitcoin.ECPair.makeRandom({ network: testnet, rng: rng })
+    var wif = keyPair.toWIF()
+    var address = keyPair.getAddress()
+
+    assert.strictEqual(address, 'mubSzQNtZfDj1YdNP6pNDuZy6zs6GDn61L')
+    assert.strictEqual(wif, 'cRgnQe9MUu1JznntrLaoQpB476M8PURvXVQB5R2eqms5tXnzNsrr')
+  })
+
+  it('can generate a Litecoin address', function () {
+    var litecoin = bitcoin.networks.litecoin
+    var keyPair = bitcoin.ECPair.makeRandom({ network: litecoin, rng: rng })
+    var wif = keyPair.toWIF()
+    var address = keyPair.getAddress()
+
+    assert.strictEqual(address, 'LZJSxZbjqJ2XVEquqfqHg1RQTDdfST5PTn')
+    assert.strictEqual(wif, 'T7A4PUSgTDHecBxW1ZiYFrDNRih2o7M8Gf9xpoCgudPF9gDiNvuS')
+  })
+})

test/integration/advanced.js

@@ -1,13 +1,8 @@
 /* global describe, it */
 
 var assert = require('assert')
-var bigi = require('bigi')
 var bip39 = require('bip39')
 var bitcoin = require('../../')
-var crypto = require('crypto')
-
-var ecurve = require('ecurve')
-var secp256k1 = ecurve.getCurveByName('secp256k1')
 
 describe('bitcoinjs-lib (BIP32)', function () {
   it('can import a BIP32 testnet xpriv and export to WIF', function () {
@@ -66,53 +61,6 @@ describe('bitcoinjs-lib (BIP32)', function () {
     assert.equal(address, '2Mww8dCYPUpKHofjgcXcBCEGmniw9CoaiD2')
   })
 
-  it('can recover a BIP32 parent private key from the parent public key, and a derived, non-hardened child private key', function () {
-    function recoverParent (master, child) {
-      assert(!master.keyPair.d, 'You already have the parent private key')
-      assert(child.keyPair.d, 'Missing child private key')
-
-      var curve = secp256k1
-      var QP = master.keyPair.Q
-      var serQP = master.keyPair.getPublicKeyBuffer()
-
-      var d1 = child.keyPair.d
-      var d2
-      var data = Buffer.alloc(37)
-      serQP.copy(data, 0)
-
-      // search index space until we find it
-      for (var i = 0; i < bitcoin.HDNode.HIGHEST_BIT; ++i) {
-        data.writeUInt32BE(i, 33)
-
-        // calculate I
-        var I = crypto.createHmac('sha512', master.chainCode).update(data).digest()
-        var IL = I.slice(0, 32)
-        var pIL = bigi.fromBuffer(IL)
-
-        // See hdnode.js:273 to understand
-        d2 = d1.subtract(pIL).mod(curve.n)
-
-        var Qp = new bitcoin.ECPair(d2).Q
-        if (Qp.equals(QP)) break
-      }
-
-      var node = new bitcoin.HDNode(new bitcoin.ECPair(d2), master.chainCode, master.network)
-      node.depth = master.depth
-      node.index = master.index
-      node.masterFingerprint = master.masterFingerprint
-      return node
-    }
-
-    var seed = crypto.randomBytes(32)
-    var master = bitcoin.HDNode.fromSeedBuffer(seed)
-    var child = master.derive(6) // m/6
-
-    // now for the recovery
-    var neuteredMaster = master.neutered()
-    var recovered = recoverParent(neuteredMaster, child)
-    assert.strictEqual(recovered.toBase58(), master.toBase58())
-  })
-
   it('can use BIP39 to generate BIP32 wallet address', function () {
 //     var mnemonic = bip39.generateMnemonic()
     var mnemonic = 'praise you muffin lion enable neck grocery crumble super myself license ghost'