@ayanworks/polygon-did-registry-contract 1.1.1 → 1.1.2

package/contracts/PolygonDidRegistry.sol

@@ -1,68 +1,78 @@
-/**
- *Submitted for verification at polygonscan.com on 2021-12-29
-*/
-
-//SPDX-License-Identifier: MIT
-pragma solidity ^0.8.15;
-// import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+//SPDX-License-Identifier: Apache 2.0
+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;
         uint256 updated;
-        string did_doc;
+        string didDoc;
     }
 
     modifier onlyController(address _id) {
         require(
-            did[_id].controller == msg.sender, "message sender is not the controller of the DID Doc"
+            polyDIDs[_id].controller == msg.sender,
+            "message sender is not the controller of the DID Doc"
         );
         _;
     }
-
-    mapping(address => PolyDID) did;
-    event DidCreated(address id, string doc);
-    event DidUpdated(address id, string doc);
-    event DidDeleted(address id);
+    mapping(address => PolyDID) polyDIDs;
+    mapping(uint256 => address) activeDIDs;
+    mapping(address => uint256) activeAddress;
+    event DIDCreated(address id, string doc);
+    event DIDUpdated(address id, string doc);
+    event DIDDeleted(address id);
     event TransferOwnership(address newOwner);
-        bool private initialized;
+    bool private initialized;
+
+    /**
+     *@dev initializes the ownership of contract
+     **/
 
     function initialize() public {
         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");
+    modifier onlyOwner() {
+        require(msg.sender == owner, "message sender is not the owner");
         _;
     }
 
     /**
-    *@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){
+     *@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 ("New Owner address is equal to original owner address");
+        } else {
+            return ("Ownership cannot be transferred to the same account");
         }
     }
 
     /**
      *@dev Reads contract owner from chain
      */
-    function getOwner() public view returns (address _owner){
+
+    function getOwner() public view returns (address _owner) {
         return owner;
     }
 
@@ -71,24 +81,77 @@ contract PolygonDidRegistry {
      *@param _id - Address that will refer the DID doc
      *@param _doc - A string object that holds the DID Doc
      */
+
     function createDID(address _id, string memory _doc)
         public
-        returns (address controller, uint256 created, uint256 updated, string memory did_doc)
+        returns (
+            address controller,
+            uint256 created,
+            uint256 updated,
+            string memory didDoc
+        )
     {
-        did[_id].controller = msg.sender;
-        did[_id].created = block.timestamp;
-        did[_id].updated = block.timestamp;
-        did[_id].did_doc = _doc;
-        emit DidCreated(_id, _doc);
-        return (did[_id].controller, did[_id].created, did[_id].updated, did[_id].did_doc);
+        polyDIDs[_id].controller = msg.sender;
+        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,
+            polyDIDs[_id].created,
+            polyDIDs[_id].updated,
+            polyDIDs[_id].didDoc
+        );
     }
 
     /**
      *@dev Reads DID Doc from Chain
      *@param _id - Address that refers to the DID doc position
      */
-    function getDID(address _id) public view returns (string memory) {
-        return did[_id].did_doc;
+
+    function getDIDDoc(address _id) public view returns (string memory) {
+        return polyDIDs[_id].didDoc;
+    }
+
+    /**
+     *@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));
+    }
+
+    /**
+     *@dev Reads total number of DIDs deleted from Chain
+     */
+
+    function getTotalNumberOfDeletedDIDs()
+        public
+        view
+        returns (uint256 _deletedDID)
+    {
+        return deletedDID;
+    }
+
+    /**
+     *@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;
     }
 
     /**
@@ -96,22 +159,37 @@ contract PolygonDidRegistry {
      *@param _id - Address that refers to the DID doc
      *@param _doc - A String that holds the DID doc
      */
-    function updateDID(address _id, string memory _doc)
+
+    function updateDIDDoc(address _id, string memory _doc)
         public
-        onlyController(_id) returns(address controller, uint256 created, uint256 updated, string memory did_doc)
+        onlyController(_id)
+        returns (
+            address controller,
+            uint256 created,
+            uint256 updated,
+            string memory didDoc
+        )
     {
-        did[_id].did_doc = _doc;
-        did[_id].updated = block.timestamp;
-        emit DidUpdated(_id, _doc);
-        return (did[_id].controller, did[_id].created, did[_id].updated, did[_id].did_doc);
+        polyDIDs[_id].didDoc = _doc;
+        polyDIDs[_id].updated = block.timestamp;
+        emit DIDUpdated(_id, _doc);
+        return (
+            polyDIDs[_id].controller,
+            polyDIDs[_id].created,
+            polyDIDs[_id].updated,
+            polyDIDs[_id].didDoc
+        );
     }
 
     /**
      *@dev To delete a DID from chain
      *@param _id - Address that refers to the DID doc that need to be deleted
      */
-    function deleteDID(address _id) public onlyController(_id) {
-        delete did[_id];
-        emit DidDeleted(_id);
+
+    function deleteDIDDoc(address _id) public onlyController(_id) {
+        delete polyDIDs[_id];
+        delete activeDIDs[activeAddress[_id]];
+        ++deletedDID;
+        emit DIDDeleted(_id);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ayanworks/polygon-did-registry-contract",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Smart Contract to register DID on Polygon",
   "main": "build/contracts/PolygonDidRegistry.json",
   "directories": {
@@ -15,6 +15,8 @@
   "dependencies": {
     "@openzeppelin/contracts": "^4.7.0",
     "@truffle/hdwallet-provider": "^2.0.10",
+    "dotenv": "^16.0.2",
+    "eslint": "^8.23.1",
     "fs-extra": "8.1.0",
     "ganache-cli": "6.12.2",
     "mocha": "^7.0.0",

package/test/polygon_did_registry_test.js

@@ -66,7 +66,21 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
-    // Describing the 1.2 Test case
+    //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.equal(
+                        currentValue,
+                        1,
+                        'value should be matching'
+                    );
+                });
+            });
+    
+
+    // 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 () => {
@@ -89,7 +103,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
-    //Describing test 1.3 to check if test fails if we update with different controller
+    //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 () => {
@@ -106,7 +120,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
-    // Describing the 1.4 Test case
+    // Describing the 1.5 Test case
     describe('Checking the Delete function in Upgradable Contract', async () => {
 
         it('This should delete the DID doc on Upgradable Contract and will read and check if the value is now an empty string', async () => {
@@ -127,7 +141,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
-    // Describing the 1.5 Test case
+    // Describing the 1.6 Test case
     describe('Checking the Create function in Upgradable Contract', async () => {
 
         it('This should store the DID doc on Upgradable Contract and will read and check if the value stored is not null', async () => {
@@ -151,7 +165,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
-    // Describing the 1.6 Test case
+    // Describing the 1.7 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 has changed', async () => {
@@ -176,7 +190,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
     });
 
 
-    // Describing the 1.7 Test Case
+    // Describing the 1.8 Test Case
     describe('Checking the Delete function in Upgradable Contract', async () => {
 
         it('This should delete the DID doc on Upgradable Contract and will read and check if the value is now not equal to the updated doc', async () => {
@@ -198,8 +212,22 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
 
+      //Describing the 1.9 Test Case
+      describe('Checking the getTotalNumberOfDIDs Function', async () => {
+        it('This should get correct number of DIDs registered', async () => {
+
+            const totalValue = await PolygonUpgradableInstance.getTotalNumberOfDIDs();
+            const deltedValue = await PolygonUpgradableInstance.getTotalNumberOfDeletedDIDs();
+            const currentValue = totalValue - deltedValue;
+            assert.equal(
+                currentValue,
+                0,
+                'value should be matching'
+            );
+        });
+    });
 
-    //Describing the 1.8 Test Case
+    //Describing the 1.10 Test Case
     describe('Checking the Transafer Ownership Function', async () => {
         it('This should transfer ownership of contract to another user', async () => {
 
@@ -216,7 +244,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
         });
     });
    
-        //Describing the 1.9 Test Case
+        //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 () => {
     
@@ -229,9 +257,7 @@ describe('Setting up the Upgradable Smart Contract', async () => {
                 }
             });
         });
-
-})
-
+    })
 
 
 // basic Contract Testing

package/truffle-config.js

@@ -18,7 +18,7 @@
  *
  */
  const HDWalletProvider = require("@truffle/hdwallet-provider");
- const { rpcUrl, mnemonic } = process.env;
+ require('dotenv').config()
 
  module.exports = {
    /**
@@ -39,13 +39,13 @@
      },
      matic: {
        provider: function () {
-         return new HDWalletProvider(mnemonic, rpcUrl);
+         return new HDWalletProvider(process.env.SIGNER, process.env.RPCURL);
        },
        network_id: '80001',
      },
      matic_mainnet: {
        provider: function () {
-         return new HDWalletProvider(mnemonic, rpcUrl);
+         return new HDWalletProvider(process.env.SIGNER, process.env.RPCURL);
        },
        network_id: '137',
      }
@@ -59,7 +59,7 @@
    // Configure your compilers
    compilers: {
      solc: {
-       version: "0.8.15",    // Fetch exact version from solc-bin (default: truffle's version)
+       version: "0.8.16",    // Fetch exact version from solc-bin (default: truffle's version)
      }
    },