@ayanworks/polygon-did-registry-contract 2.0.1-alpha.3 → 2.0.1-alpha.5

package/contracts/PolygonDidRegistry.sol

@@ -1,14 +1,12 @@
 //SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.16;
+pragma solidity 0.8.16;
 
 /**
  *@title PolygonDidRegistry
  *@dev Smart Contract for Polygon DID Method
  */
 contract PolygonDidRegistry {
-    uint256 totalDIDs;
     address owner;
-    uint256 deletedDID;
     struct PolyDID {
         address controller;
         uint256 created;
@@ -16,17 +14,9 @@ contract PolygonDidRegistry {
         string didDoc;
     }
 
-    modifier onlyController(address _id) {
-        require(
-            polyDIDs[_id].controller == msg.sender,
-            'message sender is not the controller of the DID Doc'
-        );
-        _;
-    }
     mapping(address => PolyDID) polyDIDs;
-    mapping(uint256 => address) activeDIDs;
-    mapping(address => uint256) activeAddress;
-
+    mapping(address => mapping(string => string)) resourceData;
+    mapping(address => string[]) private keysById;
     event DIDCreated(address id, string doc);
     event DIDUpdated(address id, string doc);
     event TransferOwnership(address newOwner);
@@ -39,17 +29,21 @@ contract PolygonDidRegistry {
     bool private initialized;
 
     /**
-     *@dev initializes the ownership of contract
+     *@dev modifiers for access control
      **/
 
-    mapping(address => string[]) private keysById;
-    mapping(address => mapping(string => string)) resourceData;
+    modifier onlyController(address _id) {
+        require(
+            polyDIDs[_id].controller == msg.sender,
+            'message sender is not the controller of the DID Doc'
+        );
+        _;
+    }
 
-    function initialize() public {
+    modifier nonReentrant() {
         require(!initialized, 'Contract instance has already been initialized');
         initialized = true;
-        owner = msg.sender;
-        totalDIDs = 0;
+        _;
     }
 
     modifier onlyOwner() {
@@ -57,6 +51,15 @@ contract PolygonDidRegistry {
         _;
     }
 
+    /**
+     *@dev initializes the ownership of contract
+     **/
+
+    function initialize() external nonReentrant {
+        require(msg.sender != address(0), 'Invalid owner address');
+        owner = msg.sender;
+    }
+
     /**
      *@dev transfer the ownership of contract
      *@param _newOwner - Address of the new owner to whom the ownership needs to be passed
@@ -64,14 +67,15 @@ contract PolygonDidRegistry {
 
     function transferOwnership(
         address _newOwner
-    ) public onlyOwner returns (string memory) {
-        if (owner != _newOwner) {
-            owner = _newOwner;
-            emit TransferOwnership(owner);
-            return ('Ownership transferred successfully');
-        } else {
-            return ('Ownership cannot be transferred to the same account');
-        }
+    ) external onlyOwner returns (string memory) {
+        require(_newOwner != address(0), 'Invalid owner address');
+        require(
+            owner != _newOwner,
+            'Ownership cannot be transferred to the same account'
+        );
+        owner = _newOwner;
+        emit TransferOwnership(owner);
+        return ('Ownership transferred successfully');
     }
 
     /**
@@ -92,7 +96,7 @@ contract PolygonDidRegistry {
         address _id,
         string memory _doc
     )
-        public
+        external
         returns (
             address controller,
             uint256 created,
@@ -100,13 +104,12 @@ contract PolygonDidRegistry {
             string memory didDoc
         )
     {
-        polyDIDs[_id].controller = msg.sender;
+        require(_id != address(0), 'Invalid address provided');
+        require(polyDIDs[_id].controller != _id, 'DID already exist');
+        polyDIDs[_id].controller = _id;
         polyDIDs[_id].created = block.timestamp;
         polyDIDs[_id].updated = block.timestamp;
         polyDIDs[_id].didDoc = _doc;
-        activeDIDs[totalDIDs] = msg.sender;
-        activeAddress[_id] = totalDIDs;
-        ++totalDIDs;
         emit DIDCreated(_id, _doc);
         return (
             polyDIDs[_id].controller,
@@ -132,26 +135,6 @@ contract PolygonDidRegistry {
         return (polyDIDs[_id].didDoc, result);
     }
 
-    /**
-     *@dev Reads total number of DIDs and total number of active DIDs from Chain
-     */
-
-    function getTotalNumberOfDIDs() public view returns (uint256 _totalDIDs) {
-        return (totalDIDs);
-    }
-
-    /**
-     *@dev Reads one DID at a time from Chain based on index
-     *@param _index - Uint256 type variable that refers to the DID position
-     *@return _did - returns the DID Doc assciated with the index. Returns null if the DID Doc is deleted.
-     */
-
-    function getDIDDocByIndex(
-        uint256 _index
-    ) public view returns (string memory) {
-        return polyDIDs[activeDIDs[_index]].didDoc;
-    }
-
     /**
      *@dev To Update the DID doc
      *@param _id - Address that refers to the DID doc
@@ -162,7 +145,7 @@ contract PolygonDidRegistry {
         address _id,
         string memory _doc
     )
-        public
+        external
         onlyController(_id)
         returns (
             address controller,
@@ -192,10 +175,11 @@ contract PolygonDidRegistry {
         string memory _resourceId,
         string memory _resourcePayload
     )
-        public
+        external
         onlyController(_id)
         returns (address, string memory, string memory)
     {
+        require(_id != address(0), 'Invalid address provided');
         resourceData[_id][_resourceId] = _resourcePayload;
         keysById[_id].push(_resourceId);
         emit ResourceAdded(_id, _resourceId, _resourcePayload);

package/hardhat.config.js

@@ -5,6 +5,7 @@
 // import 'hardhat';
 require('@nomicfoundation/hardhat-ethers')
 require('@openzeppelin/hardhat-upgrades')
+require('@nomicfoundation/hardhat-verify')
 
 require('dotenv/config')
 
@@ -20,9 +21,19 @@ module.exports = {
   },
   networks: {
     hardhat: {},
-    mumbai: {
-      url: process.env.RPCURL, // Update with Mumbai Matic RPC URL
+    amoy: {
+      url: process.env.AMOY_RPCURL,
       accounts: [`0x${process.env.SIGNER}`],
     },
+    //Use for mainnet deployment
+    // polygon: {
+    //   url: process.env.RPCURL_POLYON_MAINNET,
+    //   accounts: [`0x${process.env.SIGNER}`],
+    // },
+  },
+  etherscan: {
+    apiKey: {
+      polygonMumbai: process.env.VERIFICATION_KEY,
+    },
   },
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ayanworks/polygon-did-registry-contract",
-  "version": "2.0.1-alpha.3",
+  "version": "2.0.1-alpha.5",
   "description": "Smart Contract to register DID on Polygon",
   "main": "build/index.js",
   "directories": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "deploy": "node deploy.js",
-    "test": "node compile.js && mocha --timeout 30000",
+    "test": "node --require ts-node/register --test ./tests/polygon_did_registry_test.test.js",
     "clean": "rm -rf build",
     "clean:deps": "pnpm clean && rm -rf node_modules",
     "build": "pnpm clean && pnpm build:sol && tsc",
@@ -22,6 +22,7 @@
   "license": "MIT",
   "devDependencies": {
     "@nomicfoundation/hardhat-ethers": "^3.0.5",
+    "@nomicfoundation/hardhat-verify": "^2.0.3",
     "@openzeppelin/hardhat-upgrades": "^3.0.1",
     "@types/fs-extra": "^11.0.1",
     "@types/node": "^18.17.0",
@@ -33,7 +34,7 @@
     "mocha": "^7.0.0",
     "prettier": "^3.0.2",
     "release-it": "^16.3.0",
-    "solc": "^0.8.21",
+    "solc": "0.8.16",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
   },

package/scripts/deploy.js

@@ -8,17 +8,17 @@ async function main() {
 
     // To deploy the initial upgradable smart contract
 
-    // const contract = await upgrades.deployProxy(PolygonDidRegistry, {
-    //   initializer: 'initialize',
-    // })
+    const contract = await upgrades.deployProxy(PolygonDidRegistry, {
+      initializer: 'initialize',
+    })
 
-    const contract = await upgrades.upgradeProxy(
-      process.env.CONTRACT_ADDRESS,
-      PolygonDidRegistry,
-      {
-        initializer: 'initialize',
-      },
-    )
+    // const contract = await upgrades.upgradeProxy(
+    //   process.env.CONTRACT_ADDRESS,
+    //   PolygonDidRegistry,
+    //   {
+    //     initializer: 'initialize',
+    //   },
+    // )
 
     await contract.waitForDeployment()
 

package/sst-config.json

@@ -1 +1 @@
-{"sourceHash":"0xb57d8b09722fddffbc5855f1dfba236305522e3e11aa91722f77789c16a9629b"}
+{"sourceHash":"0x7cfa8ab1c0bc24dcb13a69e00eca9da0d9850c96acb083ce64a7a18ebdca959f"}

package/tests/polygon_did_registry_test.test.js

@@ -0,0 +1,117 @@
+const { ethers, upgrades } = require('hardhat')
+const assert = require('assert')
+const { describe, it } = require('node:test')
+
+// Initializing the build files
+const PolygonDIDRegistryJSON = require('../artifacts/contracts/PolygonDidRegistry.sol/PolygonDidRegistry.json')
+
+let PolygonUpgradableInstance, PolygonUpgradableInstance_test
+walletKey = process.env.SIGNER
+
+// Upgradable with Proxy
+// Deployment Testing 1.0
+describe('Setting up the Upgradable Smart Contract', async () => {
+  describe('Setting up the contract', async () => {
+    it('Should deploy contract with Proxy, with no parameters/Constructor', async () => {
+      const PolygonDidRegistry =
+        await ethers.getContractFactory('PolygonDidRegistry')
+      PolygonUpgradableInstance = await upgrades.deployProxy(PolygonDidRegistry)
+      await PolygonUpgradableInstance.waitForDeployment()
+      PolygonUpgradableInstance_test = new ethers.Contract(
+        PolygonUpgradableInstance.target,
+        PolygonDIDRegistryJSON.abi,
+        walletKey,
+      )
+      assert.ok(
+        PolygonUpgradableInstance.target,
+        'Upgradeable contract is deployed',
+      )
+    })
+  })
+
+  //Check Create Function test 1.1
+  describe('Checking the Create function using Upgradeable Contract', async () => {
+    it('This should store the DID doc on Upgradable Contract and will read and check if the value stored is correct', async () => {
+      // This will send the value to local ganache blockchain
+      const did = '0x2f65b747440deaf596892dfc7965040be8b99100'
+      const doc =
+        '{"@context":"https://w3id.org/did/v1","id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","verificationMethod":[{"id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","type":"EcdsaSecp256k1VerificationKey2019","controller":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","publicKeyBase58":"NDaEdTguJV39Ns8BZkxQ3XR6GUinZAJfVoyEMkK9fP7XQmpSkT3UsLHB52cFpDqoM6m4Hevtba8pkmjvEG3Ur7ji"}]}'
+      const tx = await PolygonUpgradableInstance.createDID(did, doc)
+
+      // Getting the set value in ganache blockchain
+      const currentValue = await PolygonUpgradableInstance.getDIDDoc(did)
+      // Comparing the set value to confirm
+      assert.notEqual(currentValue, null, 'value set must be able to get')
+
+      assert.notEqual(currentValue, null, 'value should not be empty')
+    })
+  })
+
+  //Describing the 1.2 Test Case
+  describe('Checking the getTotalNumberOfDIDs Function', async () => {
+    it('This should get correct number of DIDs registered', async () => {
+      const currentValue =
+        await PolygonUpgradableInstance.getTotalNumberOfDIDs()
+      assert(currentValue > 0, 'value should be less than 0')
+    })
+  })
+
+  // Describing the 1.3 Test case
+  describe('Checking the Update function in Upgradable Contract', async () => {
+    it('This should update the DID doc on Upgradable Contract and will read and check if the value stored is correct', async () => {
+      // This will send the value to local ganache blockchain
+      const did = '0x2f65b747440deaf596892dfc7965040be8b99100'
+      //changed the controller
+      const doc =
+        '{"@context":"https://w3id.org/did/v1","id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","verificationMethod":[{"id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","type":"EcdsaSecp256k1VerificationKey2019","controller":"did:polygon:0x2f65b747440deaf596892dfc7965040be8c66666","publicKeyBase58":"NDaEdTguJV39Ns8BZkxQ3XR6GUinZAJfVoyEMkK9fP7XQmpSkT3UsLHB52cFpDqoM6m4Hevtba8pkmjvEG3Ur7ji"}]}'
+      const tx = await PolygonUpgradableInstance.updateDIDDoc(did, doc)
+
+      // Getting the set value in ganache blockchain
+      const currentValue = await PolygonUpgradableInstance.getDIDDoc(did)
+
+      // Comparing the set value to confirm
+      assert.notEqual(currentValue, null, 'value set must be able to get')
+    })
+  })
+
+  //Describing test 1.4 to check if test fails if we update with different controller
+  describe('Checking update with wrong controller', async () => {
+    it('This should not update DID doc ', async () => {
+      const did = '0x2f65b747440deaf596892dfc7965040be8b99109'
+      const doc =
+        '{"@context":"https://w3id.org/did/v1","id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","verificationMethod":[{"id":"did:polygon:0x2f65b747440deaf596892dfc7965040be8b99100","type":"EcdsaSecp256k1VerificationKey2019","controller":"did:polygon:0x2f65b747440deaf596892dfc7965040be8c66666","publicKeyBase58":"NDaEdTguJV39Ns8BZkxQ3XR6GUinZAJfVoyEMkK9fP7XQmpSkT3UsLHB52cFpDqoM6m4Hevtba8pkmjvEG3Ur7ji"}]}'
+      try {
+        assert.ifError(
+          //sending transaction using different controller
+          await PolygonUpgradableInstance_test.functions.updateDID(did, doc),
+        )
+      } catch (error) {}
+    })
+  })
+
+  //   //Describing the 1.10 Test Case
+  describe('Checking the Transafer Ownership Function', async () => {
+    it('This should transfer ownership of contract to another user', async () => {
+      const newOwner = '0x2f65b747440deaf596892dfc7965040be8b99109'
+      const owner = await PolygonUpgradableInstance.getOwner()
+      const tx = await PolygonUpgradableInstance.transferOwnership(newOwner)
+      const currentOwner = await PolygonUpgradableInstance.getOwner()
+      assert.notEqual(owner, currentOwner, 'value should not be equal')
+    })
+  })
+
+  //Describing the 1.11 Test Case
+  describe('Checking the Transafer Ownership Function', async () => {
+    it('This should not transfer ownership of contract to another user since the transaction is being initiated by different owner', async () => {
+      const newOwner = '0x2f65b747440deaf596892dfc7965040be8b99100'
+      try {
+        assert.ifError(
+          //sending transaction using different controller
+          await PolygonUpgradableInstance_test.functions.transferOwnership(
+            newOwner,
+          ),
+        )
+      } catch (error) {}
+    })
+  })
+})