@alexbosworth/blockchain 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 1.0
+# Changelog
+
+## 1.1.0
+
+- Add `noLocktimeIdForTransaction` for a hash that doesn't cover the locktime
+
+## 1.0.0
 
 - Add `compactIntAsNumber` to convert a Bitcoin variable byte size int
 - Add `numberAsCompactInt` to convert a number to a Bitcoin variable byte int

package/hashes/index.js

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

package/hashes/no_locktime_id_for_transaction.js

@@ -0,0 +1,125 @@
+const {createHash} = require('crypto');
+
+const {compactIntAsNumber} = require('./../numbers');
+
+const bufferAsHex = buffer => buffer.toString('hex');
+const byteCountHash = 32;
+const byteCountInt8 = 1;
+const byteCountInt32 = 4;
+const byteCountInt64 = 8;
+const byteCountMarkerFlag = 2;
+const byteCountNoMarkerFlag = 0;
+const decodeCompactInt = (b, o) => compactIntAsNumber({encoded: b, offset: o});
+const defaultStartIndex = 0;
+const defaultWitnessCount = 0;
+const {isBuffer} = Buffer;
+const segWitV0Marker = 0;
+const segWitV0Flag = 1;
+const sha256 = preimage => createHash('sha256').update(preimage).digest();
+const times = n => [...Array(n).keys()];
+
+/** Get an id for a transaction with witness data and mlocktime not included
+
+  {
+    buffer: <Data Buffer Object>
+    [start]: <Starting Offset Index Number>
+  }
+
+  @throws
+  <Error>
+
+  @returns
+  {
+    id: <No nLockTime Transaction Id Hex String>
+  }
+*/
+module.exports = ({buffer, start}) => {
+  if (!isBuffer(buffer)) {
+    throw new Error('ExpectedDataBufferToGetNoLocktimeIdForTransaction');
+  }
+
+  let offset = start || defaultStartIndex;
+
+  // Transaction version is a signed 4 byte integer
+  const version = buffer.readInt32LE(offset, offset + byteCountInt32);
+
+  offset += byteCountInt32;
+
+  // For SegWit transactions, the next 2 bytes would be a marker and flag
+  const markerFlagSplit = offset + byteCountInt8;
+
+  const marker = buffer.readUInt8(offset, markerFlagSplit);
+
+  const flag = buffer.readUInt8(markerFlagSplit, offset + byteCountMarkerFlag);
+
+  // The presence of the marker and flag indicates SegWit tx encoding
+  const isSegWit = !marker && flag === segWitV0Flag;
+
+  // When tx isn't SegWit though, the bytes are not marker and flag
+  offset += isSegWit ? byteCountMarkerFlag : byteCountNoMarkerFlag;
+
+  const inputsCount = decodeCompactInt(buffer, offset);
+
+  offset += inputsCount.bytes;
+
+  // For SegWit the witness stacks will be at the end of the transaction
+  const witnessCount = isSegWit ? inputsCount.number : defaultWitnessCount;
+
+  // Read in the inputs
+  const inputs = times(inputsCount.number).map(i => {
+    // The hash is the internal byte order hash of the tx being spent
+    const hash = buffer.subarray(offset, offset + byteCountHash);
+
+    offset += byteCountHash;
+
+    // The vout is the 4 byte output index of the tx being spent in this input
+    const vout = buffer.readUInt32LE(offset, offset + byteCountInt32);
+
+    offset += byteCountInt32;
+
+    // Before SegWit, scripts were encoded in this input space
+    const scriptLength = decodeCompactInt(buffer, offset);
+
+    offset += scriptLength.bytes;
+
+    // Scripts are variable byte length
+    const script = buffer.subarray(offset, offset + scriptLength.number);
+
+    offset += scriptLength.number;
+
+    // Sequence is a 4 byte unsigned number for an input, used for CSV mainly
+    const sequence = buffer.readUInt32LE(offset, offset + byteCountInt32);
+
+    offset += byteCountInt32;
+
+    return {hash, script, sequence, vout};
+  });
+
+  const outputsCount = decodeCompactInt(buffer, offset);
+
+  offset += outputsCount.bytes;
+
+  // Read in the outputs of the transaction
+  const outputs = times(outputsCount.number).map(i => {
+    // The value being spent
+    const tokens = buffer.readBigUInt64LE(offset, offset + byteCountInt64);
+
+    offset += byteCountInt64;
+
+    // The script being spent to has a variable length
+    const scriptLength = decodeCompactInt(buffer, offset);
+
+    offset += scriptLength.bytes;
+
+    const script = buffer.subarray(offset, offset + scriptLength.number);
+
+    offset += scriptLength.number;
+
+    return {script, tokens};
+  });
+
+  // The remainder of the transaction bytes are witnesses and nlocktime
+  const bytes = buffer.subarray(start, offset);
+
+  return {id: bufferAsHex(sha256(bytes))};
+};

package/index.js

@@ -1,4 +1,9 @@
 const {compactIntAsNumber} = require('./numbers');
+const {noLocktimeIdForTransaction} = require('./hashes');
 const {numberAsCompactInt} = require('./numbers');
 
-module.exports = {compactIntAsNumber, numberAsCompactInt};
+module.exports = {
+  compactIntAsNumber,
+  noLocktimeIdForTransaction,
+  numberAsCompactInt,
+};

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/numbers/*.js"
+    "test": "tap -j 2 --branches=1 --functions=1 --lines=1 --statements=1 -t 200 test/hashes/*.js test/numbers/*.js"
   },
-  "version": "1.0.0"
+  "version": "1.1.0"
 }

package/test/hashes/test_no_locktime_id_for_transaction.js

@@ -0,0 +1,42 @@
+const {test} = require('@alexbosworth/tap');
+
+const {noLocktimeIdForTransaction} = require('./../../');
+
+const hexAsBuffer = hex => Buffer.from(hex, 'hex');
+
+const tests = [
+  {
+    args: {},
+    description: 'A data buffer with a transaction is required',
+    error: 'ExpectedDataBufferToGetNoLocktimeIdForTransaction',
+  },
+  {
+    args: {buffer: hexAsBuffer('02000000000103ae8caf3aad8861142597a29d6377f524a55f4542d5294c8292ce123a956d3e520000000000ffffffff9cbb1c5531a677b90c489d75a198a14f02d49e554ab9cdaa17bd956b127724570200000000ffffffff9cbb1c5531a677b90c489d75a198a14f02d49e554ab9cdaa17bd956b127724570100000000ffffffff0640420f0000000000160014eaa9b76637b1ad340b6efadf773a73b53637d5b6de91f62901000000225120f4c82416bcb08422c195af995e1d248d1378d8b48dafa9f45bc213b83101d49240420f00000000001600148729d17b2aa507ab19051a028384bc6e0ce25e455e368900000000002251200249ccc5af06fa5642f12d42d2a34bfbb08688d54a9b99d07b98619b35df03b440420f0000000000160014d2d59a8a59f997cbc8888411010faf1658e0e3465e368900000000002251207febd720c78518b52aa1a2443823cc8f55e373910f616e112d5d7bd622fe1ab2024830450221008ac71eff4d7e298941be012fc14f0ac9bf62ae6ffeac13522bb27b5b4108d3aa0220192a69ad6fdb86b1e09c7fdcaaafeb58d25060e44199c734dc0d7d385b5d800d0121029943eaccd3987fa495a6b4f47f2fafeb0521e4e12f39498d9465a564ef75329602483045022100f9cde9adb00c0a6c62dae8604ca750039201288c0dafff952461da3caf05e3ae0220679c01f2518413951de3b62531b1cf36bb92562e3bd4197f0fa6e6e3e231272e0121027326b48c9f2729597e328ab6d05f5af75866e1ffa203fadf78387a3b202ff80d0247304402202550beec478845af2df929abf85708f9fcceaae31377f2e01d803e2acf7b426f022036c312b1e38ca333fe70aa37d3093387ac7486f08438eb8eed323699594468cb012102275a197f7ccfece19cf0532b068b6e38ceceda146e791875ecbdc55500bb7efe00000000')},
+    description: 'No locktime id converted at zero locktime',
+    expected: {id: 'e0041a8488ac2a4b80da897ce88e95b054988c6907c0a9355354133fe86b90ef'},
+  },
+  {
+    args: {buffer: hexAsBuffer('02000000000103ae8caf3aad8861142597a29d6377f524a55f4542d5294c8292ce123a956d3e520000000000ffffffff9cbb1c5531a677b90c489d75a198a14f02d49e554ab9cdaa17bd956b127724570200000000ffffffff9cbb1c5531a677b90c489d75a198a14f02d49e554ab9cdaa17bd956b127724570100000000ffffffff0640420f0000000000160014eaa9b76637b1ad340b6efadf773a73b53637d5b6de91f62901000000225120f4c82416bcb08422c195af995e1d248d1378d8b48dafa9f45bc213b83101d49240420f00000000001600148729d17b2aa507ab19051a028384bc6e0ce25e455e368900000000002251200249ccc5af06fa5642f12d42d2a34bfbb08688d54a9b99d07b98619b35df03b440420f0000000000160014d2d59a8a59f997cbc8888411010faf1658e0e3465e368900000000002251207febd720c78518b52aa1a2443823cc8f55e373910f616e112d5d7bd622fe1ab20247304402204fcc9416a9e908cba10595b15c7f455dcae87a7201f984fb79812de0ea7f562c02203acda03ae03a8c40ab314820e99ff09b77cf103131f73225cd228d74a4946e990121029943eaccd3987fa495a6b4f47f2fafeb0521e4e12f39498d9465a564ef7532960247304402204cb0db22579d5e2f9aafaaf9c99e3a96fe5f85b39065c9007506bfa686f311b402206f213de9e805010d84b64f31d65e0619114044dac6bb2c17aa7742f7e98d5f400121027326b48c9f2729597e328ab6d05f5af75866e1ffa203fadf78387a3b202ff80d02483045022100cc54a394ccb687a74f463412349a0f2defb7ec139819530ce06ff5392b4094f40220783fbad9afaa90459fa10f2af8a4225bc1027b6b06d7b886c75a836cad603017012102275a197f7ccfece19cf0532b068b6e38ceceda146e791875ecbdc55500bb7efe37000000')},
+    description: 'No locktime id converted at non zero locktime',
+    expected: {id: 'e0041a8488ac2a4b80da897ce88e95b054988c6907c0a9355354133fe86b90ef'},
+  },
+  {
+    args: {buffer: hexAsBuffer('010000000148c84b39d73d315d9688062359c93bb8bdff77c1cd5875d683f6fa80ae1839651a0000006a4730440220174ba43251b22da52004c0fff73a9f2137b6451c1d2086f0b6a7b7cea893c17f02200e7c36d341432e93abe80e69eed13d918197decdb0a904f245b9ece66ba01bec012102247749b00e239c8be840125258a0e76a82dd7af10615b7675a06d7c6f5c3125dffffffff019e7f05000000000017a914fe5feb6a940b2c302cad971e2c4173ebbbe0ec108700000000')},
+    description: 'A non-segwit transaction is converted',
+    expected: {id: '4bc29bad70d01853a167507beffd38a03db5da565de4645ac576824ce87c9934'},
+  }
+];
+
+tests.forEach(({args, description, error, expected}) => {
+  return test(description, ({end, strictSame, throws}) => {
+    if (!!error) {
+      throws(() => noLocktimeIdForTransaction(args), new Error(error), 'Err');
+    } else {
+      const res = noLocktimeIdForTransaction(args);
+
+      strictSame(res, expected, 'Got expected result');
+    }
+
+    return end();
+  });
+});