Merge pull request #247 from OriginTrail/sharding-table-migration

Added migration function to Sharding table v2 contract
OriginTrail · Apr 17, 2024 · d5cb77c · d5cb77c
2 parents 5afb00d + 8bb871f
commit d5cb77c
Show file tree

Hide file tree

Showing 6 changed files with 130 additions and 179 deletions.
diff --git a/abi/ShardingTableV2.json b/abi/ShardingTableV2.json
@@ -5,6 +5,11 @@
         "internalType": "address",
         "name": "hubAddress",
         "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "migrationPeriodEnd_",
+        "type": "uint256"
       }
     ],
     "stateMutability": "nonpayable",
@@ -245,6 +250,42 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "uint72",
+        "name": "startingIdentityId",
+        "type": "uint72"
+      },
+      {
+        "internalType": "uint16",
+        "name": "numberOfNodes",
+        "type": "uint16"
+      },
+      {
+        "internalType": "address",
+        "name": "shardingTableStorageV1Address",
+        "type": "address"
+      }
+    ],
+    "name": "migrateOldShardingTable",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "migrationPeriodEnd",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "name",

diff --git a/contracts/v2/ShardingTable.sol b/contracts/v2/ShardingTable.sol
@@ -4,6 +4,7 @@ pragma solidity ^0.8.16;
 
 import {ProfileStorage} from "../v1/storage/ProfileStorage.sol";
 import {ShardingTableStorageV2} from "./storage/ShardingTableStorage.sol";
+import {ShardingTableStorage} from "../v1/storage/ShardingTableStorage.sol";
 import {StakingStorage} from "../v1/storage/StakingStorage.sol";
 import {ContractStatus} from "../v1/abstract/ContractStatus.sol";
 import {Initializable} from "../v1/interface/Initializable.sol";
@@ -20,21 +21,30 @@ contract ShardingTableV2 is Named, Versioned, ContractStatus, Initializable {
     event NodeRemoved(uint72 indexed identityId, bytes nodeId);
 
     string private constant _NAME = "ShardingTable";
-    string private constant _VERSION = "2.0.0";
+    string private constant _VERSION = "2.0.1";
 
     ProfileStorage public profileStorage;
     ShardingTableStorageV2 public shardingTableStorage;
     StakingStorage public stakingStorage;
 
+    uint256 public migrationPeriodEnd;
+
     // solhint-disable-next-line no-empty-blocks
-    constructor(address hubAddress) ContractStatus(hubAddress) {}
+    constructor(address hubAddress, uint256 migrationPeriodEnd_) ContractStatus(hubAddress) {
+        migrationPeriodEnd = migrationPeriodEnd_;
+    }
 
     function initialize() public onlyHubOwner {
         profileStorage = ProfileStorage(hub.getContractAddress("ProfileStorage"));
         shardingTableStorage = ShardingTableStorageV2(hub.getContractAddress("ShardingTableStorage"));
         stakingStorage = StakingStorage(hub.getContractAddress("StakingStorage"));
     }
 
+    modifier timeLimited() {
+        require(block.timestamp < migrationPeriodEnd, "Migration period has ended");
+        _;
+    }
+
     function name() external pure virtual override returns (string memory) {
         return _NAME;
     }
@@ -65,6 +75,24 @@ contract ShardingTableV2 is Named, Versioned, ContractStatus, Initializable {
         _insertNode(index, identityId, uint256(profileStorage.getNodeAddress(identityId, 1)));
     }
 
+    function migrateOldShardingTable(
+        uint72 startingIdentityId,
+        uint16 numberOfNodes,
+        address shardingTableStorageV1Address
+    ) external onlyHubOwner timeLimited {
+        ShardingTableStorageV2 stsv2 = shardingTableStorage;
+        ShardingTableStorage stsv1 = ShardingTableStorage(shardingTableStorageV1Address);
+
+        ShardingTableStructsV1.Node[] memory nodes = stsv1.getMultipleNodes(startingIdentityId, numberOfNodes);
+
+        for (uint i = 0; i < nodes.length; i++) {
+            if (!stsv2.nodeExists(nodes[i].identityId)) {
+                uint256 nodeHashRingPosition = uint256(profileStorage.getNodeAddress(nodes[i].identityId, 1));
+                _insertNode(_binarySearchForIndex(nodeHashRingPosition), nodes[i].identityId, nodeHashRingPosition);
+            }
+        }
+    }
+
     function removeNode(uint72 identityId) external onlyContracts {
         ShardingTableStorageV2 sts = shardingTableStorage;
 

diff --git a/deploy/027_deploy_sharding_table_v2.ts b/deploy/027_deploy_sharding_table_v2.ts
@@ -2,20 +2,76 @@ import { DeployFunction } from 'hardhat-deploy/types';
 import { HardhatRuntimeEnvironment } from 'hardhat/types';
 
 const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const isMigration = hre.helpers.contractDeployments.contracts['ShardingTable']?.migration || false;
+
   if (
     hre.helpers.isDeployed('ShardingTable') &&
     (hre.helpers.contractDeployments.contracts['ShardingTable'].version === undefined ||
-      hre.helpers.contractDeployments.contracts['ShardingTable'].version?.startsWith('1.'))
+      hre.helpers.contractDeployments.contracts['ShardingTable'].version?.startsWith('1.')) &&
+    !isMigration
   ) {
     return;
   }
 
+  const oldShardingTableAddress = hre.helpers.contractDeployments.contracts['ShardingTable']?.evmAddress;
+
   console.log('Deploying ShardingTable V2...');
 
+  const blockTimeNow = (await hre.ethers.provider.getBlock('latest')).timestamp;
+
   await hre.helpers.deploy({
     newContractName: 'ShardingTableV2',
     newContractNameInHub: 'ShardingTable',
+    additionalArgs: [isMigration ? blockTimeNow + 3600 : blockTimeNow],
   });
+
+  if (hre.helpers.contractDeployments.contracts['ShardingTable'].migration && hre.network.name.startsWith('otp')) {
+    const { deployer } = await hre.getNamedAccounts();
+
+    console.log(`Executing sharding table storage v1 to v2 migration`);
+    const newShardingTableAddress = hre.helpers.contractDeployments.contracts['ShardingTable'].evmAddress;
+    const shardingTableStorageAddress = hre.helpers.contractDeployments.contracts['ShardingTableStorage'].evmAddress;
+
+    console.log(
+      `Old ShardingTable: ${oldShardingTableAddress}, New ShardingTable: ${newShardingTableAddress}, ShardingTableStorage: ${shardingTableStorageAddress}`,
+    );
+
+    const oldShardingTable = await hre.ethers.getContractAt('ShardingTable', oldShardingTableAddress, deployer);
+    const newShardingTable = await hre.ethers.getContractAt('ShardingTable', newShardingTableAddress, deployer);
+
+    const nodes = await oldShardingTable.getShardingTable();
+    let identityId = nodes[0]?.identityId;
+    console.log(`Found ${nodes.length} nodes in the old ShardingTable, starting identityId: ${identityId}`);
+
+    const numberOfNodesInBatch = 10;
+    let iteration = 1;
+
+    const encodedDataArray = [];
+
+    while (identityId) {
+      console.log(
+        `Migrating sharding table with starting identityId: ${identityId}, number of nodes in batch: ${numberOfNodesInBatch}, ShardingTableStorage: ${shardingTableStorageAddress}`,
+      );
+
+      encodedDataArray.push(
+        newShardingTable.interface.encodeFunctionData('migrateOldShardingTable', [
+          identityId,
+          numberOfNodesInBatch,
+          oldShardingTableAddress,
+        ]),
+      );
+
+      console.log(
+        `Migration COMPLETED iteration: ${iteration} with starting identityId: ${identityId}, number of nodes in batch: ${numberOfNodesInBatch}, ShardingTableStorage: ${shardingTableStorageAddress}`,
+      );
+      iteration += 1;
+      identityId = nodes[iteration * numberOfNodesInBatch]?.identityId;
+    }
+
+    for (let i = 0; i < encodedDataArray.length; i++) {
+      hre.helpers.setParametersEncodedData.push(['ShardingTable', [encodedDataArray[i]]]);
+    }
+  }
 };
 
 export default func;

diff --git a/deployments/hardhat_contracts.json b/deployments/hardhat_contracts.json
diff --git a/test/v2/unit/ShardingTableV2.test.ts b/test/v2/unit/ShardingTableV2.test.ts
@@ -148,7 +148,7 @@ describe('@v2 @unit ShardingTableV2 contract', function () {
     const version = await ShardingTable.version();
 
     expect(name).to.equal('ShardingTable');
-    expect(version).to.equal('2.0.0');
+    expect(version).to.equal('2.0.1');
   });
 
   it('Insert 5 nodes, nodes are sorted expect to pass', async () => {

diff --git a/utils/helpers.ts b/utils/helpers.ts
@@ -30,6 +30,7 @@ type ContractDeployments = {
       deploymentBlock: number;
       deploymentTimestamp: number;
       deployed: boolean;
+      migration?: boolean;
     };
   };
 };