@alexbosworth/blockchain 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.4.0
+
+- `scriptElementsAsScript`: Convert an array of script elements to a script
+
 ## 1.3.0
 
 - `componentsOfTransaction`: Parse transaction hex into its component elements

package/README.md

@@ -104,3 +104,19 @@ Convert a number to compact size integer serialization
     {
       encoded: <Serialized Compact Integer Buffer Object>
     }
+
+### scriptElementsAsScript
+
+Map array of script buffer elements to a fully formed script
+
+    {
+      elements: [<Data Buffer>, <Script OP_CODE Number>]
+    }
+
+    @throws
+    <Error>
+
+    @returns
+    {
+      script: <Script Hex String>
+    }

package/index.js

@@ -3,6 +3,7 @@ const {componentsOfTransaction} = require('./transactions');
 const {idForBlock} = require('./hashes');
 const {noLocktimeIdForTransaction} = require('./hashes');
 const {numberAsCompactInt} = require('./numbers');
+const {scriptElementsAsScript} = require('./script');
 
 module.exports = {
   compactIntAsNumber,
@@ -10,4 +11,5 @@ module.exports = {
   idForBlock,
   noLocktimeIdForTransaction,
   numberAsCompactInt,
+  scriptElementsAsScript,
 };

package/package.json

@@ -20,7 +20,7 @@
     "url": "https://github.com/alexbosworth/blockchain.git"
   },
   "scripts": {
-    "test": "tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/hashes/*.js test/numbers/*.js test/transactions/*.js"
+    "test": "tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/hashes/*.js test/numbers/*.js test/script/*.js test/transactions/*.js"
   },
-  "version": "1.3.0"
+  "version": "1.4.0"
 }

package/script/index.js

@@ -0,0 +1,3 @@
+const scriptElementsAsScript = require('./script_elements_as_script');
+
+module.exports = {scriptElementsAsScript};

package/script/script_elements_as_script.js

@@ -0,0 +1,42 @@
+const {numberAsCompactInt} = require('./../numbers');
+
+const bufferAsHex = buffer => buffer.toString('hex');
+const {concat} = Buffer;
+const encode = number => numberAsCompactInt({number}).encoded;
+const flatten = arr => arr.reduce((sum, n) => Buffer.concat([sum, n]));
+const {from} = Buffer;
+const {isArray} = Array;
+const {isBuffer} = Buffer;
+
+/** Map array of script buffer elements to a fully formed script
+
+  {
+    elements: [<Data Buffer>, <Script OP_CODE Number>]
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    script: <Script Hex String>
+  }
+*/
+module.exports = ({elements}) => {
+  if (!isArray(elements)) {
+    throw new Error('ExpectedArrayOfScriptElementsToEncodeScript');
+  }
+
+   // Convert numbers to buffers and hex data to pushdata
+  const fullScript = elements.map(element => {
+    // Exit early when element is a data push
+    if (isBuffer(element)) {
+      return concat([encode(element.length), element]);
+    }
+
+    // Non data elements are direct bytes
+    return from([element]);
+  });
+
+  return {script: bufferAsHex(flatten(fullScript))};
+};

package/test/script/test_script_elements_as_script.js

@@ -0,0 +1,30 @@
+const {test} = require('@alexbosworth/tap');
+
+const {scriptElementsAsScript} = require('./../../');
+
+const tests = [
+  {
+    args: {},
+    description: 'An array of eleemnts is required',
+    error: 'ExpectedArrayOfScriptElementsToEncodeScript',
+  },
+  {
+    args: {elements: [118, 169, Buffer.alloc(20), 136, 172]},
+    description: 'Elements are mapped to an output script',
+    expected: {script: '76a914000000000000000000000000000000000000000088ac'},
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => scriptElementsAsScript(args), new Error(error), 'Got err');
+    } else {
+      const res = scriptElementsAsScript(args);
+
+      strictSame(res, expected, 'Got expected result');
+    }
+
+    return end();
+  });
+});