@alexbosworth/blockchain 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Versions
 
+## 1.6.0
+
+- `previousBlockId`: Add method to get the previous block id from a block
+
 ## 1.5.0
 
 - `scriptAsScriptElements`: Convert an encoded script into script elements

package/README.md

@@ -105,6 +105,22 @@ Convert a number to compact size integer serialization
       encoded: <Serialized Compact Integer Buffer Object>
     }
 
+### previousBlockId
+
+Given a raw block, return the previous block id
+
+    {
+      block: <Hex Encoded Block String>
+    }
+
+    @throws
+    <Error>
+
+    @returns
+    {
+      previous: <Previous Block Id Hex String>
+    }
+
 ### scriptAsScriptElements
 
 Map a serialized script into an array of script elements

package/hashes/index.js

@@ -1,4 +1,5 @@
 const idForBlock = require('./id_for_block');
 const noLocktimeIdForTransaction = require('./no_locktime_id_for_transaction');
+const previousBlockId = require('./previous_block_id');
 
-module.exports = {idForBlock, noLocktimeIdForTransaction};
+module.exports = {idForBlock, noLocktimeIdForTransaction, previousBlockId};

package/hashes/previous_block_id.js

@@ -0,0 +1,28 @@
+const hashBytesHexCount = 32 * 2;
+const reverseByteOrder = n => Buffer.from(n, 'hex').reverse().toString('hex');
+const versionBytesHexCount = 4 * 2;
+
+/** Given a raw block, return the previous block id
+
+  {
+    block: <Hex Encoded Block String>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    previous: <Previous Block Id Hex String>
+  }
+*/
+module.exports = ({block}) => {
+  if (!block) {
+    throw new Error('ExpectedHexEncodedBlockToDerivePreviousBlockId');
+  }
+
+  const end = hashBytesHexCount + versionBytesHexCount;
+  const start = versionBytesHexCount;
+
+  return {previous: reverseByteOrder(block.substring(start, end))};
+};

package/index.js

@@ -3,6 +3,7 @@ const {componentsOfTransaction} = require('./transactions');
 const {idForBlock} = require('./hashes');
 const {noLocktimeIdForTransaction} = require('./hashes');
 const {numberAsCompactInt} = require('./numbers');
+const {previousBlockId} = require('./hashes');
 const {scriptAsScriptElements} = require('./script');
 const {scriptElementsAsScript} = require('./script');
 
@@ -12,6 +13,7 @@ module.exports = {
   idForBlock,
   noLocktimeIdForTransaction,
   numberAsCompactInt,
+  previousBlockId,
   scriptAsScriptElements,
   scriptElementsAsScript,
 };

package/package.json

@@ -19,5 +19,5 @@
   "scripts": {
     "test": "npx nyc@latest node --experimental-test-coverage --test test/hashes/*.js test/numbers/*.js test/script/*.js test/transactions/*.js"
   },
-  "version": "1.5.0"
+  "version": "1.6.0"
 }

package/test/hashes/test_id_for_block.js

@@ -1,6 +1,6 @@
 const {deepStrictEqual} = require('node:assert').strict;
-const {throws} = require('node:assert').strict;
 const test = require('node:test');
+const {throws} = require('node:assert').strict;
 
 const {idForBlock} = require('./../../');
 

package/test/hashes/test_previous_block_id.js

@@ -0,0 +1,38 @@
+const {deepEqual} = require('node:assert').strict;
+const test = require('node:test');
+const {throws} = require('node:assert').strict;
+
+const {previousBlockId} = require('./../../');
+
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
+
+const tests = [
+  {
+    args: {block: ''},
+    description: 'A hex encoded block is required',
+    error: 'ExpectedHexEncodedBlockToDerivePreviousBlockId',
+  },
+  {
+    args: {
+      block: '00609c32519912209ce3196c09d7a409035874057780d4072fa31adc1f0000000000000090882aac112a7353ffc0cf13ebc8196620bc83c810b03bd5d6678b536a203c4b1a45d264f4422e193e7ea2ab01010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff1a03ceb625012013090909200909200904631e00a3290000000000ffffffff02be40250000000000160014820d4a343a44e915c36494995c2899abe37418930000000000000000266a24aa21a9ede2f61c3f71d1defd3fa999dfa36953755c690689799962b48bebd836974e8cf90120000000000000000000000000000000000000000000000000000000000000000000000000',
+    },
+    description: 'The previous block id is returned',
+    expected: {
+      previous: '000000000000001fdc1aa32f07d480770574580309a4d7096c19e39c20129951',
+    },
+  },
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, (t, end) => {
+    if (!!error) {
+      throws(() => previousBlockId(args), new Error(error), 'Error returned');
+    } else {
+      const res = previousBlockId(args);
+
+      deepEqual(res, expected, 'Got expected result');
+    }
+
+    return end();
+  });
+});