feat!: update InstantLock class to work with DashCore v0.18.0 (#239)

Author: Konstantin Shuplenkov

lib/instantlock/instantlock.js

@@ -6,7 +6,7 @@ const $ = require('../util/preconditions');
 const constants = require('../constants');
 const doubleSha256 = require('../crypto/hash').sha256sha256;
 
-const { isHexaString, isHexStringOfSize } = require('../util/js');
+const { isHexaString, isHexStringOfSize, isUnsignedInteger } = require('../util/js');
 
 const { SHA256_HASH_SIZE, BLS_SIGNATURE_SIZE } = constants;
 const bls = require('../crypto/bls');
@@ -29,8 +29,10 @@ class InstantLock {
     }
     const info = InstantLock._from(arg);
 
+    this.version = info.version;
     this.inputs = info.inputs;
     this.txid = info.txid;
+    this.cyclehash = info.cyclehash;
     this.signature = info.signature;
     this.validate();
     return this;
@@ -63,11 +65,14 @@ class InstantLock {
   static _fromObject(data) {
     $.checkArgument(data, 'data is required');
     const txid = data.txid || data.txId;
-    const { signature } = data;
+    const cyclehash = data.cyclehash || data.cycleHash;
+    const { signature, version } = data;
 
     return {
+      version,
       inputs: data.inputs,
       txid,
+      cyclehash,
       signature,
     };
   }
@@ -79,6 +84,7 @@ class InstantLock {
    */
   static _fromBufferReader(br) {
     const info = {};
+    info.version = br.readUInt8();
     const inputsCount = br.readVarintNum();
     info.inputs = [];
     for (let i = 0; i < inputsCount; i += 1) {
@@ -88,6 +94,7 @@ class InstantLock {
       info.inputs.push(outpoint);
     }
     info.txid = br.readReverse(SHA256_HASH_SIZE).toString('hex');
+    info.cyclehash = br.readReverse(SHA256_HASH_SIZE).toString('hex');
     info.signature = br.read(BLS_SIGNATURE_SIZE).toString('hex');
     return info;
   }
@@ -215,6 +222,10 @@ class InstantLock {
    * Validate InstantLock structure
    */
   validate() {
+    $.checkArgument(
+      isUnsignedInteger(this.version),
+      "Expected version to be an unsigned integer"
+    );
     $.checkArgument(
       this.inputs.length > 0,
       "TXs with no inputs can't be locked"
@@ -227,6 +238,10 @@ class InstantLock {
       isHexStringOfSize(this.txid.toString('hex'), SHA256_HASH_SIZE * 2),
       `Expected txid to be a hex string of size ${SHA256_HASH_SIZE}`
     );
+    $.checkArgument(
+      isHexStringOfSize(this.cyclehash.toString('hex'), SHA256_HASH_SIZE * 2),
+      `Expected cycleHash to be a hex string of size ${SHA256_HASH_SIZE}`
+    );
     $.checkArgument(
       isHexStringOfSize(this.signature.toString('hex'), BLS_SIGNATURE_SIZE * 2),
       'Expected signature to be a bls signature'
@@ -314,8 +329,10 @@ class InstantLock {
   toObject() {
     this.validate();
     return {
+      version: this.version,
       inputs: this.inputs,
       txid: this.txid,
+      cyclehash: this.cyclehash.toString('hex'),
       signature: this.signature.toString('hex'),
     };
   }
@@ -351,6 +368,7 @@ class InstantLock {
    */
   toBufferWriter(bw) {
     const bufferWriter = bw || new BufferWriter();
+    bufferWriter.writeUInt8(this.version);
     const inputsCount = this.inputs.length;
     bufferWriter.writeVarintNum(inputsCount);
     for (let i = 0; i < inputsCount; i += 1) {
@@ -360,6 +378,7 @@ class InstantLock {
       bufferWriter.writeInt32LE(this.inputs[i].outpointIndex);
     }
     bufferWriter.writeReverse(Buffer.from(this.txid, 'hex'));
+    bufferWriter.writeReverse(Buffer.from(this.cyclehash, 'hex'));
     bufferWriter.write(Buffer.from(this.signature, 'hex'));
     return bufferWriter;
   }