@dashevo/dash-spv 5.0.0-rc.2 → 5.1.0-beta.1

package/.ultra.cache.json

@@ -1 +1 @@
-{"files":{".gitignore":"095d365a56f423d4fab2345c95c137e7c6ea45c0",".mocharc.yml":"f6d924f143da5bc22530e55dcec6922aff69d8e1","LICENSE":"95bf3c7cb642fb61c1bbbb319fd3c83e47a5af96","README.md":"3659fd1bfb44b5e6916679ae586ccbff18683e59","config/config.js":"267c3536b5fe54c88080a56241c34d7393a54ac2","eslint.config.mjs":"cdf50e57d0d206e17f37b855643f55f73717fcd2","index.js":"4413accedb71ffb73ea7ce4ad45a2035c2ce92ca","lib/blockstore.js":"1ed82a8c1cfb4bc3aa96f0669a27c94d2e76b164","lib/consensus.js":"73201c7fec9c62f5f87dba7b2d0d54c08fa4fa6f","lib/errors/SPVError.js":"08b7af972c146bcdf29ffaa06eb90ca2c5660914","lib/merkleproofs.js":"dca09952c352109795af64f9490209a96e483e2f","lib/spvchain.js":"4ada79dda7b544debbfc023c1ce5ad058bb0c034","lib/test/bootstrap.js":"e2b2b2b17a9bf0ebff7721d8cb1e5cb75efb0f0f","lib/utils.js":"c2119b88a67698053e783f09c038a04ae208f232","lib/x11.js":"d85e555bad579a8b3e2e92447331933ce9b0c4b1","package.json":"16d4e295753e634788fe6fa947367cc853425a48","test/data/headers.js":"eb9cae85ee11027338fbf1f69e373d22388286d6","test/data/merkleproofs.js":"49ea4c29fb1f0cf6378ed7ee46b0a1db3bb555c1","test/data/rawHeaders.js":"03fed6ca2f8c2d1b63cfa13743431a2d551c7ad9","test/index.js":"e22d4a2ae7ebd44441559a3b728c4fbbb545a68d","test/spvchain.js":"58a7716c91830e0a23bd27ab857cbba70b8bee93"},"deps":{}}
+{"files":{".gitignore":"095d365a56f423d4fab2345c95c137e7c6ea45c0",".mocharc.yml":"f6d924f143da5bc22530e55dcec6922aff69d8e1","LICENSE":"95bf3c7cb642fb61c1bbbb319fd3c83e47a5af96","README.md":"3659fd1bfb44b5e6916679ae586ccbff18683e59","config/config.js":"267c3536b5fe54c88080a56241c34d7393a54ac2","eslint.config.mjs":"cdf50e57d0d206e17f37b855643f55f73717fcd2","index.js":"4413accedb71ffb73ea7ce4ad45a2035c2ce92ca","lib/blockstore.js":"1ed82a8c1cfb4bc3aa96f0669a27c94d2e76b164","lib/consensus.js":"28c3963e8d70d824ed8d6af8fef9062e35f6273b","lib/errors/SPVError.js":"08b7af972c146bcdf29ffaa06eb90ca2c5660914","lib/merkleproofs.js":"1bba2c774e52e3cdfd4b99973c11229e6cf2cf6d","lib/spvchain.js":"314adc7f2e810bcceb5f30f4c90b6e566cf7650a","lib/test/bootstrap.js":"e2b2b2b17a9bf0ebff7721d8cb1e5cb75efb0f0f","lib/utils.js":"4ca99de11dd84867be29f1bab1ef09000fa8b5df","lib/x11.js":"d85e555bad579a8b3e2e92447331933ce9b0c4b1","package.json":"439d9efd858bfa74edaf23fc7fb43cbf37b4af82","test/data/headers.js":"eb9cae85ee11027338fbf1f69e373d22388286d6","test/data/merkleproofs.js":"49ea4c29fb1f0cf6378ed7ee46b0a1db3bb555c1","test/data/rawHeaders.js":"03fed6ca2f8c2d1b63cfa13743431a2d551c7ad9","test/index.js":"1a15df18c1354fcea8015947ed43ac89ab1e7c25","test/spvchain.js":"f6441870e91b7faf2e6b23d034f40d007a697652"},"deps":{}}

package/lib/consensus.js

@@ -1,46 +1,82 @@
-// const { hasValidTarget } = require('@dashevo/dark-gravity-wave');
+const { hasValidTarget } = require('@dashevo/dark-gravity-wave');
+const DashUtil = require('@dashevo/dash-util');
 const merkleProofs = require('./merkleproofs');
-// const utils = require('./utils');
+const utils = require('./utils');
 
-// const MIN_TIMESTAMP_HEADERS = 11;
-// const MIN_DGW_HEADERS = 24;
+const MIN_TIMESTAMP_HEADERS = 11;
+const MIN_DGW_HEADERS = 24;
 
-// function getMedianTimestamp(headers) {
-//   const timestamps = headers.map((h) => h.time);
-//   const median = (arr) => {
-//     const mid = Math.floor(arr.length / 2);
-//     const nums = [...arr].sort((a, b) => a - b);
-//     return arr.length % 2 !== 0 ? nums[mid] : (nums[mid - 1] + nums[mid]) / 2;
-//   };
-//   return median(timestamps);
-// }
+const NETWORK_POW_LIMITS = {
+  mainnet: 0x1e0ffff0,
+  testnet: 0x1e0fffff,
+  devnet: 0x207fffff,
+  regtest: 0x207fffff,
+};
+
+function getMedianTimestamp(headers) {
+  const timestamps = headers.map((h) => h.time).sort((a, b) => a - b);
+  return timestamps[Math.floor(timestamps.length / 2)];
+}
 
 // Must be strictly greater than the median time of the previous 11 blocks.
 // https://dash-docs.github.io/en/developer-reference#block-headers
-// function hasGreaterThanMedianTimestamp(newHeader, previousHeaders) {
-//   if (previousHeaders.length < MIN_TIMESTAMP_HEADERS) return true;
-//   const headerNormalised = utils.normalizeHeader(newHeader);
-//   const normalizedLatestHeaders = previousHeaders.slice(
-//     Math.max(previousHeaders.length - MIN_TIMESTAMP_HEADERS, 0),
-//   ).map((h) => utils.normalizeHeader(h));
-//   return getMedianTimestamp(normalizedLatestHeaders) < headerNormalised.time;
-// }
+function hasGreaterThanMedianTimestamp(newHeader, previousHeaders) {
+  if (previousHeaders.length < MIN_TIMESTAMP_HEADERS) {
+    return true;
+  }
+  const normalizedHeader = utils.normalizeHeader(newHeader);
+  const latestHeaders = previousHeaders
+    .slice(-MIN_TIMESTAMP_HEADERS)
+    .map((header) => utils.normalizeHeader(header));
+  return getMedianTimestamp(latestHeaders) < normalizedHeader.time;
+}
+
+function hasCanonicalTarget(header, network) {
+  const powLimit = NETWORK_POW_LIMITS[network];
+  if (!powLimit || !Number.isInteger(header.bits)) {
+    return false;
+  }
+
+  try {
+    const target = DashUtil.expandTarget(header.bits);
+    const canonicalBits = DashUtil.compressTarget(target);
+    const maximumTarget = DashUtil.expandTarget(powLimit);
+
+    return canonicalBits === header.bits && target.compare(maximumTarget) <= 0;
+  } catch {
+    return false;
+  }
+}
+
+function isValidBlockHeaderWithoutContext(newHeader, network = 'mainnet') {
+  const normalizedHeader = utils.normalizeHeader(newHeader);
+
+  return hasCanonicalTarget(normalizedHeader, network)
+    && utils.validProofOfWork(normalizedHeader)
+    && normalizedHeader.validTimestamp();
+}
+
+function isValidBlockHeader(newHeader, previousHeaders, network = 'mainnet') {
+  const normalizedHeader = utils.normalizeHeader(newHeader);
+  const normalizedPreviousHeaders = previousHeaders.map((header) => utils.normalizeHeader(header));
+
+  if (!isValidBlockHeaderWithoutContext(normalizedHeader, network)
+    || !hasGreaterThanMedianTimestamp(normalizedHeader, normalizedPreviousHeaders)) {
+    return false;
+  }
+
+  // A trusted checkpoint may contain fewer than a full DGW window. Proof of
+  // work, the network pow limit, and timestamp rules still apply immediately;
+  // exact difficulty validation begins as soon as the required history exists.
+  if (normalizedPreviousHeaders.length < MIN_DGW_HEADERS) {
+    return true;
+  }
 
-function isValidBlockHeader(/* newHeader, previousHeaders, network = 'mainnet' */) {
-  // TODO: implement consensus checks properly for all networks
-  return true;
-  // if (previousHeaders.length > MIN_DGW_HEADERS) {
-  //   return newHeader.validProofOfWork()
-  //     && newHeader.validTimestamp()
-  //     && hasGreaterThanMedianTimestamp(newHeader, previousHeaders)
-  //     && hasValidTarget(
-  //       utils.getDgwBlock(newHeader), previousHeaders.map((h) => utils.getDgwBlock(h)), network,
-  //     );
-  // }
-  // // TODO: eventually this check start failing in dashmate
-  // return newHeader.validProofOfWork()
-  //   && newHeader.validTimestamp()
-  //   && hasGreaterThanMedianTimestamp(newHeader, previousHeaders);
+  return hasValidTarget(
+    utils.getDgwBlock(normalizedHeader),
+    normalizedPreviousHeaders.map((header) => utils.getDgwBlock(header)),
+    network,
+  );
 }
 
 /**
@@ -64,5 +100,6 @@ async function areValidTransactions(transactions, merkleBlock, headerChain) {
 
 module.exports = {
   isValidBlockHeader,
+  isValidBlockHeaderWithoutContext,
   areValidTransactions,
 };

package/lib/merkleproofs.js

@@ -13,7 +13,7 @@ const merkleproofs = {
     if (typeof transactions[0] === 'string') {
       txToFilter = txToFilter.map((tx) => DashUtil.toHash(tx).toString('hex'));
     }
-    return merkleBlock.validMerkleTree
+    return merkleBlock.validMerkleTree()
       && txToFilter.filter((tx) => merkleBlock.hasTransaction(tx)).length === transactions.length;
   },
 };

package/lib/spvchain.js

@@ -202,16 +202,53 @@ const SpvChain = class {
       const chunkPrevHash = utils.getCorrectedHash(chunk[0].prevHash);
 
       if (tipHash === chunkPrevHash) {
-        this.appendHeadersToLongestChain(chunk);
-        chunk.forEach((header) => {
-          this.orphansHashes.delete(header.hash);
-        });
-        this.orphanChunks.splice(i, 1);
-        i -= 1;
+        try {
+          this.validateConnectedHeaders(chunk, this.getValidationHistory(), true);
+          this.appendHeadersToLongestChain(chunk);
+          chunk.forEach((header) => {
+            this.orphansHashes.delete(header.hash);
+          });
+          this.orphanChunks.splice(i, 1);
+          i -= 1;
+        } catch (e) {
+          chunk.forEach((header) => {
+            this.orphansHashes.delete(header.hash);
+          });
+          this.orphanChunks.splice(i, 1);
+          throw e;
+        }
       }
     }
   }
 
+  /** @private */
+  getValidationHistory() {
+    return this.prunedHeaders.concat(this.getLongestChain()).slice(-24);
+  }
+
+  /** @private */
+  validateConnectedHeaders(headers, initialHistory, allowKnownOrphans = false) {
+    const history = initialHistory.slice();
+
+    headers.forEach((header) => {
+      const previousHeader = history[history.length - 1];
+      if (!previousHeader || !SpvChain.isParentChild(header, previousHeader)) {
+        throw new SPVError(`SPV: Header ${header.hash} is not connected to verified history`);
+      }
+
+      const isKnown = this.heightByHash.has(header.hash)
+        || (!allowKnownOrphans && this.orphansHashes.has(header.hash));
+      if (isKnown || !Consensus.isValidBlockHeader(header, history, this.network)) {
+        throw new SPVError(`SPV: Header ${header.hash} is invalid`);
+      }
+
+      history.push(header);
+      if (history.length > 24) {
+        history.shift();
+      }
+    });
+  }
+
   /** @private */
   getOrphanChunks() {
     return this.orphanChunks;
@@ -230,7 +267,6 @@ const SpvChain = class {
     return !!validBlockHeader && !duplicate;
   }
 
-  /* eslint-disable no-param-reassign */
   /**
    * verifies the parent child connection
    * between two adjacent dashcore.BlockHeader objects
@@ -331,10 +367,9 @@ const SpvChain = class {
 
       isOrphan = !SpvChain.isParentChild(firstHeader, tip);
     } else if (batchHeadHeight === this.pendingStartBlockHeight) {
-      // Header at pendingStartBlockHeight is found, initialize chain
-      this.startBlockHeight = this.pendingStartBlockHeight;
-      this.pendingStartBlockHeight = null;
-      isOrphan = false;
+      throw new SPVError(
+        'SPV chain cannot initialize from an unauthenticated remote checkpoint',
+      );
     } else if (batchHeadHeight > this.pendingStartBlockHeight) {
       // Orphan chunk has arrived
       isOrphan = true;
@@ -342,38 +377,25 @@ const SpvChain = class {
       throw new SPVError(`Batch at invalid height arrived: ${batchHeadHeight}, expected > ${this.pendingStartBlockHeight}`);
     }
 
-    const allValid = normalizedHeaders.reduce((acc, header, index, array) => {
-      const previousHeaders = normalizedHeaders.slice(0, index);
-      if (index !== 0) {
-        if (!SpvChain.isParentChild(header, array[index - 1])) {
-          throw new SPVError(`SPV: Header ${header.hash} is not a child of ${array[index - 1].hash}`);
+    if (isOrphan) {
+      normalizedHeaders.forEach((header, index) => {
+        if (index > 0 && !SpvChain.isParentChild(header, normalizedHeaders[index - 1])) {
+          throw new SPVError(
+            `SPV: Header ${header.hash} is not a child of ${normalizedHeaders[index - 1].hash}`,
+          );
         }
-
-        if (!this.isValid(header, previousHeaders)) {
+        if (this.isDuplicate(header.hash)
+          || !Consensus.isValidBlockHeaderWithoutContext(header, this.network)) {
           throw new SPVError(`SPV: Header ${header.hash} is invalid`);
         }
-        return acc && true;
-      }
-      if (isOrphan) {
-        if (!this.isValid(header, previousHeaders)) {
-          throw new SPVError('Some headers are invalid');
-        }
-        return acc && true;
-      }
-      if (!this.isValid(header, this.getLongestChain())) {
-        throw new SPVError('Some headers are invalid');
-      }
-      return acc && true;
-    }, true);
-    if (!allValid) {
-      throw new SPVError('Some headers are invalid');
-    }
-    if (isOrphan) {
+      });
+
       normalizedHeaders.forEach((header) => {
         this.orphansHashes.add(header.hash);
       });
       this.orphanChunks.push(normalizedHeaders);
     } else {
+      this.validateConnectedHeaders(normalizedHeaders, this.getValidationHistory());
       this.appendHeadersToLongestChain(normalizedHeaders);
     }
     if (this.orphanChunks.length > 0) {

package/lib/utils.js

@@ -1,5 +1,4 @@
 /* eslint no-underscore-dangle: ["error", { "allow": ["_getHash"] }] */
-/* eslint-disable no-bitwise */
 const DashUtil = require('@dashevo/dash-util');
 const dashcore = require('@dashevo/dashcore-lib');
 
@@ -42,7 +41,7 @@ module.exports = {
   validProofOfWork(header) {
     const target = DashUtil.expandTarget(header.bits);
     const hash = header._getHash().reverse();
-    return hash.compare(target) === -1;
+    return hash.compare(target) <= 0;
   },
   createBlock(prev, bits) {
     let i = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dash-spv",
-  "version": "5.0.0-rc.2",
+  "version": "5.1.0-beta.1",
   "description": "Repository containing SPV functions used by @dashevo",
   "main": "index.js",
   "scripts": {

package/test/index.js

@@ -67,8 +67,7 @@ describe('SPV-DASH (forks & re-orgs) deserialized headers', () => {
     chain.getLongestChain().length.should.equal(25);
   });
 
-  // TODO: restore when conesnsus rules are enabled
-  it.skip('not add an invalid header', () => {
+  it('should not add an invalid header', () => {
     should(() => chain.addHeaders([headers[25]])).throw();
     chain.getLongestChain().length.should.equal(25);
   });
@@ -78,7 +77,7 @@ describe('SPV-DASH (forks & re-orgs) deserialized headers', () => {
       chain.addHeaders([headers[25], headers[10]]);
       done(new Error('SPV chain failed to throw an error on invalid block'));
     } catch (e) {
-      e.message.should.equal('SPV: Header 00000ce430de949c85a145b02e33ebbaed3772dc8f3d668f66edc6852c24d002 is not a child of e59b97d3d11b4d4563b557e32c62afbdb6e947e9cbb4915c94073f08f7936d5f');
+      e.message.should.match(/SPV: Header .* (is invalid|is not a child of)/);
       done();
     }
   });
@@ -129,6 +128,39 @@ describe('SPV-DASH (forks & re-orgs) serialized raw headers for mainnet', () =>
   });
 });
 
+describe('Block header consensus validation', () => {
+  before(async () => {
+    await Blockchain.wasmX11Ready();
+  });
+
+  it('should reject a linked header that does not satisfy proof of work', () => {
+    const invalidHeader = utils.normalizeHeader(headers[0]);
+    invalidHeader.bits = 0;
+
+    consensus.isValidBlockHeader(
+      invalidHeader,
+      [new Blockchain('testnet').genesis],
+      'testnet',
+    ).should.equal(false);
+  });
+
+  it('should validate difficulty using history from before the current batch', () => {
+    const previousHeaders = mainnet.slice(0, 24).map(utils.normalizeHeader);
+    const nextHeader = utils.normalizeHeader(mainnet[24]);
+
+    consensus.isValidBlockHeader(nextHeader, previousHeaders, 'mainnet')
+      .should.equal(true);
+  });
+
+  it('should reject a proof-of-work-valid header for the wrong difficulty history', () => {
+    const wrongHistory = testnet.slice(0, 24).map(utils.normalizeHeader);
+    const nextHeader = utils.normalizeHeader(mainnet[24]);
+
+    consensus.isValidBlockHeader(nextHeader, wrongHistory, 'mainnet')
+      .should.equal(false);
+  });
+});
+
 describe('SPV-DASH (addHeaders) add many headers for testnet', () => {
   before(async () => {
     chain = new Blockchain('testnet', 10000);
@@ -197,7 +229,7 @@ describe('SPV-DASH (addHeaders) add many headers for testnet', () => {
       chain.addHeaders([badRawHeaders[0], badRawHeaders[2]]);
       done(new Error('SPV chain failed to throw an error on invalid block'));
     } catch (e) {
-      e.message.should.equal('Some headers are invalid');
+      e.message.should.match(/SPV: Header .* (is invalid|is not a child of)/);
       done();
     }
   });
@@ -279,9 +311,9 @@ describe('SPV-DASH (addHeaders) add many headers for mainnet', () => {
     chain.getLongestChain().length.should.equal(1500);
   });
 
-  it('should orphan and not add invalid but consistent headers', () => {
-    chain.addHeaders([badRawHeaders[0], badRawHeaders[1]]);
-    chain.getOrphanChunks().length.should.equal(1);
+  it('should reject orphan headers outside the network proof-of-work limit', () => {
+    should(() => chain.addHeaders([badRawHeaders[0], badRawHeaders[1]])).throw();
+    chain.getOrphanChunks().length.should.equal(0);
     chain.getLongestChain().length.should.equal(1500);
   });
 
@@ -290,7 +322,7 @@ describe('SPV-DASH (addHeaders) add many headers for mainnet', () => {
       chain.addHeaders([badRawHeaders[0], badRawHeaders[2]]);
       done(new Error('SPV chain failed to throw an error on invalid block'));
     } catch (e) {
-      e.message.should.equal('Some headers are invalid');
+      e.message.should.match(/SPV: Header .* (is invalid|is not a child of)/);
       done();
     }
   });

package/test/spvchain.js

@@ -56,6 +56,13 @@ describe('SPVChain', () => {
         .to.throw('Chain not initialized, either call initialize() or set pendingStartBlockHeight');
     });
 
+    it('should reject an unauthenticated remote bootstrap header', () => {
+      spvChain.pendingStartBlockHeight = 10400;
+
+      expect(() => spvChain.addHeaders(testnet.slice(400), 10400))
+        .to.throw('SPV chain cannot initialize from an unauthenticated remote checkpoint');
+    });
+
     it('should assemble headers chain if headers arriving out of order', async () => {
       expect(true).to.equal(true);