Add reorg tests

Author: Hrom131

contracts/mock/SPVContractMock.sol

@@ -8,6 +8,15 @@ import {SPVContract} from "../SPVContract.sol";
 contract SPVContractMock is SPVContract {
     using BlockHeader for bytes;
 
+    function __SPVContractMock_init(bytes calldata blockHeaderRaw_) external initializer {
+        (BlockHeaderData memory genesisBlockHeader_, bytes32 genesisBlockHash_) = blockHeaderRaw_
+            .parseBlockHeaderData();
+
+        _addBlock(genesisBlockHeader_, genesisBlockHash_, 0);
+
+        emit MainchainHeadUpdated(0, genesisBlockHash_);
+    }
+
     function getStorageMedianTime(
         bytes calldata blockHeaderRaw_,
         uint256 blockHeight_

package-lock.json

@@ -51,11 +51,14 @@
     "@typechain/ethers-v6": "^0.5.1",
     "@typechain/hardhat": "^9.1.0",
     "@types/chai": "^4.3.20",
+    "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.2",
+    "axios": "^1.9.0",
     "chai": "^4.5.0",
     "dotenv": "^16.4.7",
     "ethers": "^6.13.5",
+    "fs-extra": "^11.3.0",
     "hardhat": "^2.22.18",
     "hardhat-contract-sizer": "^2.10.0",
     "hardhat-gas-reporter": "^2.2.2",

package.json

@@ -8,28 +8,32 @@ import {
   getBlockHeaderData,
   getBlockHeaderDataBatch,
   getBlocksDataFilePath,
+  getReorgBlockHeaderData,
+  getReorgBlockHeaderDataBatch,
   Reverter,
 } from "@test-helpers";
 
-import { BlockHeaderMock, SPVContractMock } from "@ethers-v6";
+import { SPVContractMock } from "@ethers-v6";
 
 describe("SPVContract", () => {
   const reverter = new Reverter();
 
   let spvContract: SPVContractMock;
-  let blockHeaderLib: BlockHeaderMock;
 
   let genesisBlockDataFilePath: string;
+  let regtestGenesisBlockDataFilePath: string;
   let firstBlocksDataFilePath: string;
   let newestBlocksDataFilePath: string;
+  let reorgBlocksDataFilePath: string;
 
   before(async () => {
     spvContract = await ethers.deployContract("SPVContractMock");
-    blockHeaderLib = await ethers.deployContract("BlockHeaderMock");
 
     genesisBlockDataFilePath = getBlocksDataFilePath("genesis_block.json");
+    regtestGenesisBlockDataFilePath = getBlocksDataFilePath("regtest_genesis_block.json");
     firstBlocksDataFilePath = getBlocksDataFilePath("headers_1_10000.json");
     newestBlocksDataFilePath = getBlocksDataFilePath("headers_800352_815000.json");
+    reorgBlocksDataFilePath = getBlocksDataFilePath("headers_16_18_reorg.json");
 
     await reverter.snapshot();
   });
@@ -298,6 +302,61 @@ describe("SPVContract", () => {
       }
     });
 
+    it("should correctly update mainchain with the longest chain", async () => {
+      const genesisData = getBlockHeaderData(regtestGenesisBlockDataFilePath, 0);
+
+      await spvContract.__SPVContractMock_init(genesisData.rawHeader);
+
+      const mainchainBlocks = getReorgBlockHeaderDataBatch(reorgBlocksDataFilePath, 1, 15);
+      const rawHeaders = mainchainBlocks.map((blockData) => blockData.rawHeader);
+
+      await spvContract.addBlockHeaderBatch(rawHeaders);
+
+      const altBlock = getReorgBlockHeaderData(reorgBlocksDataFilePath, 16, false);
+
+      let tx = await spvContract.addBlockHeader(altBlock.rawHeader);
+
+      let expectedCurrentBlockHeight = 16;
+
+      await expect(tx)
+        .to.emit(spvContract, "MainchainHeadUpdated")
+        .withArgs(expectedCurrentBlockHeight, altBlock.blockHash);
+      expect(await spvContract.getMainchainHead()).to.be.eq(altBlock.blockHash);
+
+      const newMainchainBlocks = getReorgBlockHeaderDataBatch(reorgBlocksDataFilePath, 16, 2);
+      const newRawHeaders = newMainchainBlocks.map((blockData) => blockData.rawHeader);
+
+      tx = await spvContract.addBlockHeaderBatch(newRawHeaders);
+
+      expectedCurrentBlockHeight = 17;
+      const expectedMainchainHead = newMainchainBlocks[1];
+
+      await expect(tx)
+        .to.emit(spvContract, "MainchainHeadUpdated")
+        .withArgs(expectedCurrentBlockHeight, expectedMainchainHead.blockHash);
+      expect(await spvContract.getMainchainHead()).to.be.eq(expectedMainchainHead.blockHash);
+      expect(await spvContract.isInMainchain(altBlock.blockHash)).to.be.false;
+    });
+
+    it("should correctly add alternative block without mainchain update", async () => {
+      const genesisData = getBlockHeaderData(regtestGenesisBlockDataFilePath, 0);
+
+      await spvContract.__SPVContractMock_init(genesisData.rawHeader);
+
+      const mainchainBlocks = getReorgBlockHeaderDataBatch(reorgBlocksDataFilePath, 1, 21);
+      const rawHeaders = mainchainBlocks.map((blockData) => blockData.rawHeader);
+
+      await spvContract.addBlockHeaderBatch(rawHeaders);
+
+      const altBlock = getReorgBlockHeaderData(reorgBlocksDataFilePath, 16, false);
+
+      const tx = await spvContract.addBlockHeader(altBlock.rawHeader);
+
+      await expect(tx).to.not.emit(spvContract, "MainchainHeadUpdated");
+
+      expect(await spvContract.isInMainchain(altBlock.blockHash)).to.be.false;
+    });
+
     it("should get exception if pass block that already exists", async () => {
       await spvContract["__SPVContract_init()"]();
 

test/SPVContract.test.ts

@@ -0,0 +1 @@
+volumes.dev

test/btc-utils/.gitignore

@@ -0,0 +1,24 @@
+regtest=1
+testnet=0
+dnsseed=0
+upnp=0
+
+[regtest]
+port=18444
+rpcport=18443
+
+server=1
+txindex=1
+rest=1
+
+rpcuser=admin1
+rpcpassword=123
+rpcallowip=0.0.0.0/0
+rpcbind=0.0.0.0
+fallbackfee=0.00001
+
+zmqpubrawblock=tcp://0.0.0.0:28332
+zmqpubrawtx=tcp://0.0.0.0:28333
+
+blockfilterindex=1
+peerblockfilters=1

test/btc-utils/bitcoind.conf

@@ -0,0 +1,39 @@
+version: "3"
+services:
+  bitcoind:
+    image: lncm/bitcoind:v26.0
+    container_name: bitcoind
+    restart: on-failure
+    stop_grace_period: 30s
+    user: 0:0
+    healthcheck:
+      test: [ "CMD", "bitcoin-cli", "getnetworkinfo" ]
+      interval: 2s
+    volumes:
+      - ./bitcoind.conf:/root/.bitcoin/bitcoin.conf
+      - ./volumes.dev/bitcoind:/root/.bitcoin
+    command: [ "-addnode=bitcoind2:18444" ]
+    entrypoint:
+      - "sh"
+      - "-c"
+      - "bitcoind"
+    ports:
+      - 18443:18443
+      - 18444:18444
+
+  bitcoind2:
+    image: lncm/bitcoind:v26.0
+    container_name: bitcoind2
+    restart: on-failure
+    stop_grace_period: 30s
+    user: 0:0
+    healthcheck:
+      test: [ "CMD", "bitcoin-cli", "getnetworkinfo" ]
+      interval: 2s
+    volumes:
+      - ./bitcoind.conf:/root/.bitcoin/bitcoin.conf
+      - ./volumes.dev/bitcoind2:/root/.bitcoin
+    command: [ "-addnode=bitcoind:18444" ]
+    ports:
+      - 18445:18443
+      - 18446:18444