Updated bitcoinjs-lib to version 4.0.3.

corey-phillips · corey-phillips · commit a57c6d32872f · 2019-02-03T11:58:02.000-05:00
Updated README.md, LICENSE &amp; CHANGELOG.md to reflect version 4.0.3 changes.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+# 4.0.3
+__fixed__
+- Fixed `TransactionBuilder` to require that the Transaction has outputs before signing (#1151)
+- Fixed `payments.p2sh`, which now takes the network from the redeem attribute if one is not given in the object argument (#1232)
+- Fixed `Block.calculateTarget` to allow for exponents up to 29 (#1285)
+- Fixed some low priority rarely occurring bugs with multisig payments and `TransactionBuilder` multisig processing (#1307)
+
+__added__
+- Regtest network object to `networks` (#1261)
+
 # 4.0.2
 __fixed__
 - Fixed `TransactionBuilder` not throwing when payment type validation should fail (#1195)
@@ -19,7 +29,7 @@ __added__
 
 __changed__
 - `ECPair.prototype.sign` now returns a 64-byte signature `Buffer`, not an `ECSignature` object (#1084)
-- `ECPair` (and all ECDSA code) now uses [`tiny-secp256k1`](http://github.com/bitcoinjs/tiny-secp256k1), which uses the [`libsecp256k1` library](https://github.com/bitcoin-core/secp256k1) (#1070)
+- `ECPair` (and all ECDSA code) now uses [`tiny-secp256k1`](https://github.com/bitcoinjs/tiny-secp256k1), which uses the [`libsecp256k1` library](https://github.com/bitcoin-core/secp256k1) (#1070)
 - `TransactionBuilder` internal variables are now `__` prefixed to discourage public usage (#1038)
 - `TransactionBuilder` now defaults to version 2 transaction versions (#1036)
 - `script.decompile` now returns `[Buffer]` or `null`, if decompilation failed (#1039)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2011-2018 bitcoinjs-lib contributors
+Copyright (c) 2011-2019 bitcoinjs-lib contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "rn-bitcoinjs-lib",
-  "version": "4.0.2-3",
+  "version": "4.0.3",
   "description": "Client-side Bitcoin JavaScript library",
   "main": "./src/index.js",
   "engines": {
@@ -52,7 +52,7 @@
     "bip68": "^1.0.3",
     "bn.js": "^4.11.8",
     "bs58": "^4.0.0",
-    "dhttp": "^2.5.0",
+    "dhttp": "^3.0.0",
     "hoodwink": "^2.0.0",
     "minimaldata": "^1.0.2",
     "mocha": "^5.2.0",
@@ -62,19 +62,23 @@
   },
   "license": "MIT",
   "react-native": {
+    "crypto": "react-native-crypto",
     "_stream_transform": "readable-stream/transform",
     "_stream_readable": "readable-stream/readable",
     "_stream_writable": "readable-stream/writable",
     "_stream_duplex": "readable-stream/duplex",
     "_stream_passthrough": "readable-stream/passthrough",
-    "stream": "stream-browserify"
+    "stream": "stream-browserify",
+    "vm": "vm-browserify"
   },
   "browser": {
+    "crypto": "react-native-crypto",
     "_stream_transform": "readable-stream/transform",
     "_stream_readable": "readable-stream/readable",
     "_stream_writable": "readable-stream/writable",
     "_stream_duplex": "readable-stream/duplex",
     "_stream_passthrough": "readable-stream/passthrough",
-    "stream": "stream-browserify"
+    "stream": "stream-browserify",
+    "vm": "vm-browserify"
   }
 }
diff --git a/src/block.js b/src/block.js
@@ -145,7 +145,7 @@ Block.calculateTarget = function (bits) {
   const exponent = ((bits & 0xff000000) >> 24) - 3
   const mantissa = bits & 0x007fffff
   const target = Buffer.alloc(32, 0)
-  target.writeUInt32BE(mantissa, 28 - exponent)
+  target.writeUIntBE(mantissa, 29 - exponent, 3)
   return target
 }
 
diff --git a/src/classify.js b/src/classify.js
@@ -9,7 +9,7 @@ const witnessScriptHash = require('./templates/witnessscripthash')
 const witnessCommitment = require('./templates/witnesscommitment')
 
 const types = {
-  MULTISIG: 'multisig',
+  P2MS: 'multisig',
   NONSTANDARD: 'nonstandard',
   NULLDATA: 'nulldata',
   P2PK: 'pubkey',
@@ -30,7 +30,7 @@ function classifyOutput (script) {
   const chunks = decompile(script)
   if (!chunks) throw new TypeError('Invalid script')
 
-  if (multisig.output.check(chunks)) return types.MULTISIG
+  if (multisig.output.check(chunks)) return types.P2MS
   if (pubKey.output.check(chunks)) return types.P2PK
   if (witnessCommitment.output.check(chunks)) return types.WITNESS_COMMITMENT
   if (nullData.output.check(chunks)) return types.NULLDATA
@@ -45,7 +45,7 @@ function classifyInput (script, allowIncomplete) {
 
   if (pubKeyHash.input.check(chunks)) return types.P2PKH
   if (scriptHash.input.check(chunks, allowIncomplete)) return types.P2SH
-  if (multisig.input.check(chunks, allowIncomplete)) return types.MULTISIG
+  if (multisig.input.check(chunks, allowIncomplete)) return types.P2MS
   if (pubKey.input.check(chunks)) return types.P2PK
 
   return types.NONSTANDARD
diff --git a/src/ecpair.js b/src/ecpair.js
@@ -1,6 +1,5 @@
-import { randomBytes } from 'react-native-randombytes'
-
 const ecc = require('tiny-secp256k1')
+import { randomBytes } from 'react-native-randombytes'
 const typeforce = require('typeforce')
 const types = require('./types')
 const wif = require('wif')
diff --git a/src/networks.js b/src/networks.js
@@ -13,6 +13,17 @@ module.exports = {
     scriptHash: 0x05,
     wif: 0x80
   },
+  regtest: {
+    messagePrefix: '\x18Bitcoin Signed Message:\n',
+    bech32: 'bcrt',
+    bip32: {
+      public: 0x043587cf,
+      private: 0x04358394
+    },
+    pubKeyHash: 0x6f,
+    scriptHash: 0xc4,
+    wif: 0xef
+  },
   testnet: {
     messagePrefix: '\x18Bitcoin Signed Message:\n',
     bech32: 'tb',
diff --git a/src/payments/p2ms.js b/src/payments/p2ms.js
@@ -129,7 +129,7 @@ function p2ms (a, opts) {
       if (a.input[0] !== OPS.OP_0) throw new TypeError('Input is invalid')
       if (o.signatures.length === 0 || !o.signatures.every(isAcceptableSignature)) throw new TypeError('Input has invalid signature(s)')
 
-      if (a.signatures && !stacksEqual(a.signatures.equals(o.signatures))) throw new TypeError('Signature mismatch')
+      if (a.signatures && !stacksEqual(a.signatures, o.signatures)) throw new TypeError('Signature mismatch')
       if (a.m !== undefined && a.m !== a.signatures.length) throw new TypeError('Signature count mismatch')
     }
   }
diff --git a/src/payments/p2sh.js b/src/payments/p2sh.js
@@ -45,7 +45,11 @@ function p2sh (a, opts) {
     witness: typef.maybe(typef.arrayOf(typef.Buffer))
   }, a)
 
-  const network = a.network || BITCOIN_NETWORK
+  let network = a.network
+  if (!network) {
+    network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK
+  }
+
   const o = { network }
 
   const _address = lazy.value(function () {
diff --git a/src/payments/p2wsh.js b/src/payments/p2wsh.js
@@ -59,7 +59,11 @@ function p2wsh (a, opts) {
   })
   const _rchunks = lazy.value(function () { return bscript.decompile(a.redeem.input) })
 
-  const network = a.network || BITCOIN_NETWORK
+  let network = a.network
+  if (!network) {
+    network = (a.redeem && a.redeem.network) || BITCOIN_NETWORK
+  }
+
   const o = { network }
 
   lazy.prop(o, 'address', function () {
diff --git a/src/transaction_builder.js b/src/transaction_builder.js
@@ -56,16 +56,17 @@ function expandInput (scriptSig, witnessStack, type, scriptPubKey) {
       }
     }
 
-    case SCRIPT_TYPES.MULTISIG: {
-      const { pubkeys, signatures } = payments.p2ms({
+    case SCRIPT_TYPES.P2MS: {
+      const { m, pubkeys, signatures } = payments.p2ms({
         input: scriptSig,
         output: scriptPubKey
       }, { allowIncomplete: true })
 
       return {
-        prevOutType: SCRIPT_TYPES.MULTISIG,
+        prevOutType: SCRIPT_TYPES.P2MS,
         pubkeys: pubkeys,
-        signatures: signatures
+        signatures: signatures,
+        maxSignatures: m
       }
     }
   }
@@ -126,7 +127,7 @@ function expandInput (scriptSig, witnessStack, type, scriptPubKey) {
 
 // could be done in expandInput, but requires the original Transaction for hashForSignature
 function fixMultisigOrder (input, transaction, vin) {
-  if (input.redeemScriptType !== SCRIPT_TYPES.MULTISIG || !input.redeemScript) return
+  if (input.redeemScriptType !== SCRIPT_TYPES.P2MS || !input.redeemScript) return
   if (input.pubkeys.length === input.signatures.length) return
 
   const unmatched = input.signatures.concat()
@@ -202,20 +203,21 @@ function expandOutput (script, ourPubKey) {
       }
     }
 
-    case SCRIPT_TYPES.MULTISIG: {
+    case SCRIPT_TYPES.P2MS: {
       const p2ms = payments.p2ms({ output: script })
       return {
         type,
         pubkeys: p2ms.pubkeys,
-        signatures: p2ms.pubkeys.map(() => undefined)
+        signatures: p2ms.pubkeys.map(() => undefined),
+        maxSignatures: p2ms.m
       }
     }
   }
 
   return { type }
 }
 
-function prepareInput (input, ourPubKey, redeemScript, witnessValue, witnessScript) {
+function prepareInput (input, ourPubKey, redeemScript, witnessScript) {
   if (redeemScript && witnessScript) {
     const p2wsh = payments.p2wsh({ redeem: { output: witnessScript } })
     const p2wshAlt = payments.p2wsh({ output: redeemScript })
@@ -250,7 +252,8 @@ function prepareInput (input, ourPubKey, redeemScript, witnessValue, witnessScri
       signType: expanded.type,
 
       pubkeys: expanded.pubkeys,
-      signatures: expanded.signatures
+      signatures: expanded.signatures,
+      maxSignatures: expanded.maxSignatures
     }
   }
 
@@ -288,7 +291,8 @@ function prepareInput (input, ourPubKey, redeemScript, witnessValue, witnessScri
       signType: expanded.type,
 
       pubkeys: expanded.pubkeys,
-      signatures: expanded.signatures
+      signatures: expanded.signatures,
+      maxSignatures: expanded.maxSignatures
     }
   }
 
@@ -321,7 +325,8 @@ function prepareInput (input, ourPubKey, redeemScript, witnessValue, witnessScri
       signType: expanded.type,
 
       pubkeys: expanded.pubkeys,
-      signatures: expanded.signatures
+      signatures: expanded.signatures,
+      maxSignatures: expanded.maxSignatures
     }
   }
 
@@ -351,7 +356,8 @@ function prepareInput (input, ourPubKey, redeemScript, witnessValue, witnessScri
       signType: expanded.type,
 
       pubkeys: expanded.pubkeys,
-      signatures: expanded.signatures
+      signatures: expanded.signatures,
+      maxSignatures: expanded.maxSignatures
     }
   }
 
@@ -392,14 +398,18 @@ function build (type, input, allowIncomplete) {
 
       return payments.p2pk({ signature: signatures[0] })
     }
-    case SCRIPT_TYPES.MULTISIG: {
+    case SCRIPT_TYPES.P2MS: {
+      const m = input.maxSignatures
       if (allowIncomplete) {
         signatures = signatures.map(x => x || ops.OP_0)
       } else {
         signatures = signatures.filter(x => x)
       }
 
-      return payments.p2ms({ signatures }, { allowIncomplete })
+      // if the transaction is not not complete (complete), or if signatures.length === m, validate
+      // otherwise, the number of OP_0's may be >= m, so don't validate (boo)
+      const validate = !allowIncomplete || (m === signatures.length)
+      return payments.p2ms({ m, pubkeys, signatures }, { allowIncomplete, validate })
     }
     case SCRIPT_TYPES.P2SH: {
       const redeem = build(input.redeemScriptType, input, allowIncomplete)
@@ -633,7 +643,9 @@ TransactionBuilder.prototype.sign = function (vin, keyPair, redeemScript, hashTy
   // TODO: remove keyPair.network matching in 4.0.0
   if (keyPair.network && keyPair.network !== this.network) throw new TypeError('Inconsistent network')
   if (!this.__inputs[vin]) throw new Error('No input at index: ' + vin)
+
   hashType = hashType || Transaction.SIGHASH_ALL
+  if (this.__needsOutputs(hashType)) throw new Error('Transaction needs outputs')
 
   const input = this.__inputs[vin]
 
@@ -653,7 +665,7 @@ TransactionBuilder.prototype.sign = function (vin, keyPair, redeemScript, hashTy
     }
 
     if (!canSign(input)) {
-      const prepared = prepareInput(input, ourPubKey, redeemScript, witnessValue, witnessScript)
+      const prepared = prepareInput(input, ourPubKey, redeemScript, witnessScript)
 
       // updates inline
       Object.assign(input, prepared)
@@ -694,8 +706,7 @@ function signatureHashType (buffer) {
 
 TransactionBuilder.prototype.__canModifyInputs = function () {
   return this.__inputs.every(function (input) {
-    // any signatures?
-    if (input.signatures === undefined) return true
+    if (!input.signatures) return true
 
     return input.signatures.every(function (signature) {
       if (!signature) return true
@@ -708,6 +719,25 @@ TransactionBuilder.prototype.__canModifyInputs = function () {
   })
 }
 
+TransactionBuilder.prototype.__needsOutputs = function (signingHashType) {
+  if (signingHashType === Transaction.SIGHASH_ALL) {
+    return this.__tx.outs.length === 0
+  }
+
+  // if inputs are being signed with SIGHASH_NONE, we don't strictly need outputs
+  // .build() will fail, but .buildIncomplete() is OK
+  return (this.__tx.outs.length === 0) && this.__inputs.some((input) => {
+    if (!input.signatures) return false
+
+    return input.signatures.some((signature) => {
+      if (!signature) return false // no signature, no issue
+      const hashType = signatureHashType(signature)
+      if (hashType & Transaction.SIGHASH_NONE) return false // SIGHASH_NONE doesn't care about outputs
+      return true // SIGHASH_* does care
+    })
+  })
+}
+
 TransactionBuilder.prototype.__canModifyOutputs = function () {
   const nInputs = this.__tx.ins.length
   const nOutputs = this.__tx.outs.length

Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ Block.calculateTarget = function (bits) {`
`145`	`145`	`const exponent = ((bits & 0xff000000) >> 24) - 3`
`146`	`146`	`const mantissa = bits & 0x007fffff`
`147`	`147`	`const target = Buffer.alloc(32, 0)`
`148`		`- target.writeUInt32BE(mantissa, 28 - exponent)`
	`148`	`+ target.writeUIntBE(mantissa, 29 - exponent, 3)`
`149`	`149`	`return target`
`150`	`150`	`}`
`151`	`151`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ function p2ms (a, opts) {`
`129`	`129`	`if (a.input[0] !== OPS.OP_0) throw new TypeError('Input is invalid')`
`130`	`130`	`if (o.signatures.length === 0 \|\| !o.signatures.every(isAcceptableSignature)) throw new TypeError('Input has invalid signature(s)')`
`131`	`131`
`132`		`- if (a.signatures && !stacksEqual(a.signatures.equals(o.signatures))) throw new TypeError('Signature mismatch')`
	`132`	`+ if (a.signatures && !stacksEqual(a.signatures, o.signatures)) throw new TypeError('Signature mismatch')`
`133`	`133`	`if (a.m !== undefined && a.m !== a.signatures.length) throw new TypeError('Signature count mismatch')`
`134`	`134`	`}`
`135`	`135`	`}`