@ayanworks/polygon-did-registry-contract 2.0.1-alpha.2 → 2.0.1-alpha.4

package/contracts/PolygonDidRegistry.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.16;
+pragma solidity 0.8.16;
 
 /**
  *@title PolygonDidRegistry
@@ -8,7 +8,6 @@ pragma solidity ^0.8.16;
 contract PolygonDidRegistry {
     uint256 totalDIDs;
     address owner;
-    uint256 deletedDID;
     struct PolyDID {
         address controller;
         uint256 created;
@@ -16,56 +15,71 @@ 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 DIDDeleted(address id);
     event TransferOwnership(address newOwner);
+    event ResourceAdded(
+        address _id,
+        string _resourceId,
+        string _resourcePayload
+    );
+
     bool private initialized;
 
     /**
-     *@dev initializes the ownership of contract
+     *@dev modifiers for access control
      **/
 
-    function initialize() public {
-        require(!initialized, "Contract instance has already been initialized");
+    modifier onlyController(address _id) {
+        require(
+            polyDIDs[_id].controller == msg.sender,
+            'message sender is not the controller of the DID Doc'
+        );
+        _;
+    }
+
+    modifier nonReentrant() {
+        require(!initialized, 'Contract instance has already been initialized');
         initialized = true;
-        owner = msg.sender;
         totalDIDs = 0;
-        deletedDID = 0;
+        _;
     }
 
     modifier onlyOwner() {
-        require(msg.sender == owner, "message sender is not the owner");
+        require(msg.sender == owner, 'message sender is not the owner');
         _;
     }
 
+    /**
+     *@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
      **/
 
-    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");
-        }
+    function transferOwnership(
+        address _newOwner
+    ) 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');
     }
 
     /**
@@ -82,8 +96,11 @@ contract PolygonDidRegistry {
      *@param _doc - A string object that holds the DID Doc
      */
 
-    function createDID(address _id, string memory _doc)
-        public
+    function createDID(
+        address _id,
+        string memory _doc
+    )
+        external
         returns (
             address controller,
             uint256 created,
@@ -91,6 +108,7 @@ contract PolygonDidRegistry {
             string memory didDoc
         )
     {
+        require(_id != address(0), 'Invalid address provided');
         polyDIDs[_id].controller = msg.sender;
         polyDIDs[_id].created = block.timestamp;
         polyDIDs[_id].updated = block.timestamp;
@@ -112,32 +130,23 @@ contract PolygonDidRegistry {
      *@param _id - Address that refers to the DID doc position
      */
 
-    function getDIDDoc(address _id) public view returns (string memory) {
-        return polyDIDs[_id].didDoc;
-    }
+    function getDIDDoc(
+        address _id
+    ) public view returns (string memory, string[] memory) {
+        string[] memory result = new string[](keysById[_id].length);
 
-    /**
-     *@dev Reads total number of DIDs and total number of active DIDs from Chain
-     */
-
-    function getTotalNumberOfDIDs()
-        public
-        view
-        returns (uint256 _totalDIDs, uint256 _activeDIDs)
-    {
-        return (totalDIDs, (totalDIDs - deletedDID));
+        for (uint256 i = 0; i < keysById[_id].length; i++) {
+            result[i] = resourceData[_id][keysById[_id][i]];
+        }
+        return (polyDIDs[_id].didDoc, result);
     }
 
     /**
-     *@dev Reads total number of DIDs deleted from Chain
+     *@dev Reads total number of DIDs and total number of active DIDs from Chain
      */
 
-    function getTotalNumberOfDeletedDIDs()
-        public
-        view
-        returns (uint256 _deletedDID)
-    {
-        return deletedDID;
+    function getTotalNumberOfDIDs() public view returns (uint256 _totalDIDs) {
+        return (totalDIDs);
     }
 
     /**
@@ -146,11 +155,9 @@ contract PolygonDidRegistry {
      *@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)
-    {
+    function getDIDDocByIndex(
+        uint256 _index
+    ) public view returns (string memory) {
         return polyDIDs[activeDIDs[_index]].didDoc;
     }
 
@@ -160,8 +167,11 @@ contract PolygonDidRegistry {
      *@param _doc - A String that holds the DID doc
      */
 
-    function updateDIDDoc(address _id, string memory _doc)
-        public
+    function updateDIDDoc(
+        address _id,
+        string memory _doc
+    )
+        external
         onlyController(_id)
         returns (
             address controller,
@@ -182,14 +192,53 @@ contract PolygonDidRegistry {
     }
 
     /**
-     *@dev To delete a DID from chain
-     *@param _id - Address that refers to the DID doc that need to be deleted
+     *@dev To add linked resource in the DID doc
+     *@param _id - Address that refers to the DID doc
+     *@param _resourceId - Id that refers to the resource
      */
+    function addResource(
+        address _id,
+        string memory _resourceId,
+        string memory _resourcePayload
+    )
+        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);
+        return (_id, _resourceId, _resourcePayload);
+    }
+
+    /**
+     *@dev Reads DID linked resource from Chain
+     *@param _id - Address that refers to the DID doc
+     *@param _resourceId - Id that refers to a specific resource
+     */
+
+    function getResource(
+        address _id,
+        string memory _resourceId
+    ) public view returns (string memory) {
+        return resourceData[_id][_resourceId];
+    }
+
+    /**
+     *@dev Reads all DID linked resource for a specific DID from Chain
+     *@param _id - Address that refers to the DID doc
+     */
+
+    function getAllResources(
+        address _id
+    ) public view returns (string[] memory) {
+        string[] memory result = new string[](keysById[_id].length);
+
+        for (uint256 i = 0; i < keysById[_id].length; i++) {
+            result[i] = resourceData[_id][keysById[_id][i]];
+        }
 
-    function deleteDIDDoc(address _id) public onlyController(_id) {
-        delete polyDIDs[_id];
-        delete activeDIDs[activeAddress[_id]];
-        ++deletedDID;
-        emit DIDDeleted(_id);
+        return result;
     }
-}
+}

package/hardhat.config.js

@@ -0,0 +1,39 @@
+/**
+ * @type import('hardhat/config').HardhatUserConfig
+ */
+
+// import 'hardhat';
+require('@nomicfoundation/hardhat-ethers')
+require('@openzeppelin/hardhat-upgrades')
+require('@nomicfoundation/hardhat-verify')
+
+require('dotenv/config')
+
+module.exports = {
+  solidity: {
+    version: '0.8.16',
+    settings: {
+      optimizer: {
+        enabled: true,
+        runs: 200,
+      },
+    },
+  },
+  networks: {
+    hardhat: {},
+    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.2",
+  "version": "2.0.1-alpha.4",
   "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",
@@ -17,24 +17,24 @@
     "check-format": "pnpm prettier --list-different",
     "check-types": "pnpm build --noEmit",
     "format": "pnpm prettier --write",
-    "release": "git status && release-it"
+    "release": "release-it"
   },
   "license": "MIT",
   "devDependencies": {
-    "@openzeppelin/truffle-upgrades": "^1.15.0",
-    "@truffle/hdwallet-provider": "^2.0.10",
+    "@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",
     "dotenv": "^16.0.2",
     "eslint": "^8.23.1",
     "ethers": "^6.9.0",
     "fs-extra": "^11.1.1",
-    "ganache-cli": "6.12.2",
+    "hardhat": "^2.19.4",
     "mocha": "^7.0.0",
     "prettier": "^3.0.2",
     "release-it": "^16.3.0",
-    "solc": "^0.8.21",
-    "truffle": "^5.5.20",
+    "solc": "0.8.16",
     "ts-node": "^10.9.1",
     "typescript": "^5.1.6"
   },
@@ -52,5 +52,6 @@
   "bugs": {
     "url": "https://github.com/ayanworks/polygon-did-registry-contract/issues"
   },
-  "homepage": "https://github.com/ayanworks/polygon-did-registry-contract#readme"
+  "homepage": "https://github.com/ayanworks/polygon-did-registry-contract#readme",
+  "dependencies": {}
 }

package/scripts/deploy.js

@@ -0,0 +1,31 @@
+const { ethers, upgrades } = require('hardhat')
+
+async function main() {
+  try {
+    console.log('Deploying the smart contract...')
+    const PolygonDidRegistry =
+      await ethers.getContractFactory('PolygonDidRegistry')
+
+    // To deploy the initial upgradable smart contract
+
+    const contract = await upgrades.deployProxy(PolygonDidRegistry, {
+      initializer: 'initialize',
+    })
+
+    // const contract = await upgrades.upgradeProxy(
+    //   process.env.CONTRACT_ADDRESS,
+    //   PolygonDidRegistry,
+    //   {
+    //     initializer: 'initialize',
+    //   },
+    // )
+
+    await contract.waitForDeployment()
+
+    console.log('Contract address::', contract.target)
+  } catch (error) {
+    console.error('Error deploying contract:', error.message)
+  }
+}
+
+main()

package/sst-config.json

@@ -1,3 +1 @@
-{
-  "sourceHash": "0xd34bb18b8a1a061e975b0850a1887bacdf0b8891d51e51399492bb038c05ff96"
-}
+{"sourceHash":"0x99e57955d85cedd34a3d4d094b89b3fbcf3fd704b4c4b67d6dd6544f783afe53"}

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) {}
+    })
+  })
+})

package/migrations/1_initial_migration.js

@@ -1,5 +0,0 @@
-const Migrations = artifacts.require('Migrations')
-
-module.exports = function (deployer) {
-  deployer.deploy(Migrations)
-}

package/migrations/2_deploy_contract.js

@@ -1,8 +0,0 @@
-const { deployProxy } = require('@openzeppelin/truffle-upgrades')
-
-const PolygonDidRegistry = artifacts.require('PolygonDidRegistry')
-
-module.exports = async function (deployer) {
-  const instance = await deployProxy(PolygonDidRegistry, { deployer })
-  console.log('Deployed', instance.address)
-}