templates: stricter type definitions

Author: dcousens

package.json

@@ -63,7 +63,7 @@
     "pushdata-bitcoin": "^1.0.1",
     "randombytes": "^2.0.1",
     "safe-buffer": "^5.0.1",
-    "typeforce": "^1.11.3",
+    "typeforce": "^1.11.4",
     "varuint-bitcoin": "^1.0.4",
     "wif": "^2.0.1"
   },

src/script.js

@@ -157,8 +157,7 @@ function fromASM (asm) {
   }))
 }
 
-function toStack (chunks) {
-  chunks = decompile(chunks)
+function toWitness (chunks) {
   typeforce(isPushOnly, chunks)
 
   return chunks.map(function (op) {
@@ -169,6 +168,12 @@ function toStack (chunks) {
   })
 }
 
+function toStack (chunks) {
+  console.warn('toStack is deprecated, use toWitness')
+  chunks = decompile(chunks)
+  return toWitness(chunks)
+}
+
 function isCanonicalPubKey (buffer) {
   if (!Buffer.isBuffer(buffer)) return false
   if (buffer.length < 33) return false
@@ -203,17 +208,76 @@ module.exports = {
   decompile: decompile,
   fromASM: fromASM,
   toASM: toASM,
-  toStack: toStack,
+  toWitness: toWitness,
 
   number: require('./script_number'),
 
   isCanonicalPubKey: isCanonicalPubKey,
   isCanonicalSignature: isCanonicalSignature,
+  isDefinedHashType: isDefinedHashType,
   isPushOnly: isPushOnly,
-  isDefinedHashType: isDefinedHashType
+
+  // TODO: remove in 4.0.0
+  toStack: toStack
 }
 
 var templates = require('./templates')
 for (var key in templates) {
-  module.exports[key] = templates[key]
+  var template = templates[key]
+
+  // TODO: remove the wrappers in 4.0.0???
+  if (template.input) {
+    var input = template.input
+
+    if (!input.checkWitness) {
+      input.checkWitness = function checkWitness (witness, allowIncomplete) {
+        typeforce(types.Witness, witness)
+        return input.checkRaw(witness, allowIncomplete)
+      }
+      input.checkWitness.toJSON = input.checkRaw.toJSON
+    }
+    if (!input.check) {
+      input.check = function check (script, allowIncomplete) {
+        typeforce(types.Buffer, script)
+        return input.checkRaw(decompile(script), allowIncomplete)
+      }
+      input.check.toJSON = input.checkRaw.toJSON
+    }
+
+    if (!input.encodeWitness) {
+      input.encodeWitness = function encodeWitness () {
+        return toWitness(input.encodeRaw.apply(null, arguments))
+      }
+    }
+    if (!input.noScript && !input.encode) {
+      input.encode = function encode () {
+        return compile(input.encodeRaw.apply(null, arguments))
+      }
+    }
+
+    if (!input.decodeWitness) {
+      input.decode = function decodeWitness (witness, allowIncomplete) {
+        typeforce(types.Witness, witness)
+        return input.decodeRaw(decompile(witness), allowIncomplete)
+      }
+    }
+    if (!input.noScript && !input.decode) {
+      input.decode = function decode (script, allowIncomplete) {
+        typeforce(types.Buffer, script)
+        return input.decodeRaw(decompile(script), allowIncomplete)
+      }
+    }
+
+    // TODO: deprecated, remove in 4.0.0
+    input.decodeStack = function decodeStack () {
+      console.warn('decodeStack/encodeStack is deprecated, see #863')
+      return input.decodeRaw.apply(null, arguments)
+    }
+    input.encodeStack = function encodeStack () {
+      console.warn('decodeStack/encodeStack is deprecated, see #863')
+      return input.encodeRaw.apply(null, arguments)
+    }
+  }
+
+  module.exports[key] = template
 }

src/templates/index.js

@@ -1,4 +1,3 @@
-var decompile = require('../script').decompile
 var multisig = require('./multisig')
 var nullData = require('./nulldata')
 var pubKey = require('./pubkey')
@@ -25,35 +24,26 @@ function classifyOutput (script) {
   if (witnessScriptHash.output.check(script)) return types.P2WSH
   if (pubKeyHash.output.check(script)) return types.P2PKH
   if (scriptHash.output.check(script)) return types.P2SH
-
-  // XXX: optimization, below functions .decompile before use
-  var chunks = decompile(script)
-  if (multisig.output.check(chunks)) return types.MULTISIG
-  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
+  if (multisig.output.check(script)) return types.MULTISIG
+  if (pubKey.output.check(script)) return types.P2PK
+  if (witnessCommitment.output.check(script)) return types.WITNESS_COMMITMENT
+  if (nullData.output.check(script)) return types.NULLDATA
 
   return types.NONSTANDARD
 }
 
 function classifyInput (script, allowIncomplete) {
-  // XXX: optimization, below functions .decompile before use
-  var chunks = decompile(script)
-
-  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 (pubKey.input.check(chunks)) return types.P2PK
+  if (pubKeyHash.input.check(script)) return types.P2PKH
+  if (scriptHash.input.check(script, allowIncomplete)) return types.P2SH
+  if (multisig.input.check(script, allowIncomplete)) return types.MULTISIG
+  if (pubKey.input.check(script)) return types.P2PK
 
   return types.NONSTANDARD
 }
 
-function classifyWitness (script, allowIncomplete) {
-  // XXX: optimization, below functions .decompile before use
-  var chunks = decompile(script)
-
-  if (witnessPubKeyHash.input.check(chunks)) return types.P2WPKH
-  if (witnessScriptHash.input.check(chunks, allowIncomplete)) return types.P2WSH
+function classifyWitness (stack, allowIncomplete) {
+  if (witnessPubKeyHash.input.checkStack(stack)) return types.P2WPKH
+  if (witnessScriptHash.input.checkStack(stack, allowIncomplete)) return types.P2WSH
 
   return types.NONSTANDARD
 }

src/templates/multisig/input.js

@@ -1,16 +1,17 @@
 // OP_0 [signatures ...]
 
-var Buffer = require('safe-buffer').Buffer
 var bscript = require('../../script')
+var types = require('../../types')
 var typeforce = require('typeforce')
 var OPS = require('bitcoin-ops')
 
 function partialSignature (value) {
   return value === OPS.OP_0 || bscript.isCanonicalSignature(value)
 }
 
-function check (script, allowIncomplete) {
-  var chunks = bscript.decompile(script)
+// check
+function checkRaw (chunks, allowIncomplete) {
+  typeforce(types.Array, chunks)
   if (chunks.length < 2) return false
   if (chunks[0] !== OPS.OP_0) return false
 
@@ -20,11 +21,9 @@ function check (script, allowIncomplete) {
 
   return chunks.slice(1).every(bscript.isCanonicalSignature)
 }
-check.toJSON = function () { return 'multisig input' }
+checkRaw.toJSON = function () { return 'multisig input' }
 
-var EMPTY_BUFFER = Buffer.allocUnsafe(0)
-
-function encodeStack (signatures, scriptPubKey) {
+function encodeRaw (signatures, scriptPubKey) {
   typeforce([partialSignature], signatures)
 
   if (scriptPubKey) {
@@ -39,27 +38,16 @@ function encodeStack (signatures, scriptPubKey) {
     }
   }
 
-  return [].concat(EMPTY_BUFFER, signatures)
-}
-
-function encode (signatures, scriptPubKey) {
-  return bscript.compile(encodeStack(signatures, scriptPubKey))
-}
-
-function decodeStack (stack, allowIncomplete) {
-  typeforce(check, stack, allowIncomplete)
-  return stack.slice(1)
+  return [].concat(OPS.OP_0, signatures)
 }
 
-function decode (buffer, allowIncomplete) {
-  var stack = bscript.decompile(buffer)
-  return decodeStack(stack, allowIncomplete)
+function decodeRaw (chunks, allowIncomplete) {
+  typeforce(checkRaw, chunks, allowIncomplete)
+  return chunks.slice(1)
 }
 
 module.exports = {
-  check: check,
-  decode: decode,
-  decodeStack: decodeStack,
-  encode: encode,
-  encodeStack: encodeStack
+  checkRaw: checkRaw,
+  decodeRaw: decodeRaw,
+  encodeRaw: encodeRaw
 }

src/templates/nulldata.js

@@ -6,22 +6,19 @@ var typeforce = require('typeforce')
 var OPS = require('bitcoin-ops')
 
 function check (script) {
-  var buffer = bscript.compile(script)
-
-  return buffer.length > 1 &&
-    buffer[0] === OPS.OP_RETURN
+  typeforce(types.Buffer, script)
+  return script.length > 1 &&
+    script[0] === OPS.OP_RETURN
 }
 check.toJSON = function () { return 'null data output' }
 
 function encode (data) {
   typeforce(types.Buffer, data)
-
   return bscript.compile([OPS.OP_RETURN, data])
 }
 
 function decode (buffer) {
   typeforce(check, buffer)
-
   return buffer.slice(2)
 }
 

src/templates/pubkey/input.js

@@ -1,39 +1,29 @@
 // {signature}
 
 var bscript = require('../../script')
+var types = require('../../types')
 var typeforce = require('typeforce')
 
-function check (script) {
-  var chunks = bscript.decompile(script)
-
+function checkRaw (chunks) {
+  typeforce(types.Array, chunks)
   return chunks.length === 1 &&
     bscript.isCanonicalSignature(chunks[0])
 }
-check.toJSON = function () { return 'pubKey input' }
+checkRaw.toJSON = function () { return 'pubKey input' }
 
-function encodeStack (signature) {
+// encode
+function encodeRaw (signature) {
   typeforce(bscript.isCanonicalSignature, signature)
   return [signature]
 }
 
-function encode (signature) {
-  return bscript.compile(encodeStack(signature))
-}
-
-function decodeStack (stack) {
-  typeforce(check, stack)
-  return stack[0]
-}
-
-function decode (buffer) {
-  var stack = bscript.decompile(buffer)
-  return decodeStack(stack)
+function decodeRaw (chunks) {
+  typeforce(checkRaw, chunks)
+  return chunks[0]
 }
 
 module.exports = {
-  check: check,
-  decode: decode,
-  decodeStack: decodeStack,
-  encode: encode,
-  encodeStack: encodeStack
+  checkRaw: checkRaw,
+  decodeRaw: decodeRaw,
+  encodeRaw: encodeRaw
 }

src/templates/pubkeyhash/input.js

@@ -1,18 +1,18 @@
 // {signature} {pubKey}
 
 var bscript = require('../../script')
+var types = require('../../types')
 var typeforce = require('typeforce')
 
-function check (script) {
-  var chunks = bscript.decompile(script)
-
+function checkRaw (chunks) {
+  typeforce(types.Array, chunks)
   return chunks.length === 2 &&
     bscript.isCanonicalSignature(chunks[0]) &&
     bscript.isCanonicalPubKey(chunks[1])
 }
-check.toJSON = function () { return 'pubKeyHash input' }
+checkRaw.toJSON = function () { return 'pubKeyHash input' }
 
-function encodeStack (signature, pubKey) {
+function encodeRaw (signature, pubKey) {
   typeforce({
     signature: bscript.isCanonicalSignature,
     pubKey: bscript.isCanonicalPubKey
@@ -24,28 +24,16 @@ function encodeStack (signature, pubKey) {
   return [signature, pubKey]
 }
 
-function encode (signature, pubKey) {
-  return bscript.compile(encodeStack(signature, pubKey))
-}
-
-function decodeStack (stack) {
-  typeforce(check, stack)
-
+function decodeRaw (chunks, allowIncomplete) {
+  typeforce(checkRaw, chunks, allowIncomplete)
   return {
-    signature: stack[0],
-    pubKey: stack[1]
+    signature: chunks[0],
+    pubKey: chunks[1]
   }
 }
 
-function decode (buffer) {
-  var stack = bscript.decompile(buffer)
-  return decodeStack(stack)
-}
-
 module.exports = {
-  check: check,
-  decode: decode,
-  decodeStack: decodeStack,
-  encode: encode,
-  encodeStack: encodeStack
+  checkRaw: checkRaw,
+  decodeRaw: decodeRaw,
+  encodeRaw: encodeRaw
 }