npm - @ayanworks/polygon-did-registry-contract - Versions diffs - 2.0.1-alpha.8 → 3.0.0 - Mend

@ayanworks/polygon-did-registry-contract 2.0.1-alpha.8 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/.env.sample +4 -3
package/.openzeppelin/polygon.json +4 -4
package/.openzeppelin/unknown-80002.json +4 -454
package/README.md +19 -67
package/package.json +1 -1

package/.env.sample CHANGED Viewed

@@ -1,4 +1,5 @@
-RPCURL=""
-SIGNER=""
-CONTRACT=""
+MAINNET_RPCURL=""
+AMOY_RPCURL=""
+SIGNER_TESTNET=""
+SIGNER_MAINNET=""
 VERIFICATION_KEY=""

package/.openzeppelin/polygon.json CHANGED Viewed

@@ -2,15 +2,15 @@
   "manifestVersion": "3.2",
   "proxies": [
     {
-      "address": "0xdEBc41520F2d8203b282c4dc6c5973e61a14c727",
-      "txHash": "0xac189bd320f5843bf7bd58d308b3e62bc86ff4ab71649981bc7e203101b87bc2",
+      "address": "0x0C16958c4246271622201101C83B9F0Fc7180d15",
+      "txHash": "0xa14cd6a823161901ef272283a60b796d976cc56ac4e90073e7c39d071e4aa261",
       "kind": "transparent"
     }
   ],
   "impls": {
     "4ea697d213312244614a688367167de1e84d9fd58fa073c2461c24e28152def1": {
-      "address": "0x4DF4c35cfaa1a6bC2463205091fd91db259F17Fa",
-      "txHash": "0xb5b3d39dc771662ebc6a3b53c908d0e12fe6786988b5f300bd80d614475808f0",
+      "address": "0xD084c9772Dc6F644Dbe1831d5039BF2e516AEfdc",
+      "txHash": "0x3e047df9361c0d6d64075007cd71d0137d61b9df07bb90d5a84db66d1d28b969",
       "layout": {
         "solcVersion": "0.8.16",
         "storage": [

package/.openzeppelin/unknown-80002.json CHANGED Viewed

@@ -2,465 +2,15 @@
   "manifestVersion": "3.2",
   "proxies": [
     {
-      "address": "0xc087766218b885C6283072BA316a2Bc31B5c17db",
-      "txHash": "0x731adaa41dca5f67d91962c0d2ca905b4ddb325f0726fb0fb8677d43456f54b2",
-      "kind": "transparent"
-    },
-    {
-      "address": "0xC1c392DC1073a86821B4ae37f1F0faCDcFFf45bF",
-      "txHash": "0x82f79c38e7d6c943e76deb166a87515c32441708443abf1b410944fcb848a448",
-      "kind": "transparent"
-    },
-    {
-      "address": "0x8e8E732a564735C18b84F6d51f1F58599EE48211",
-      "txHash": "0x8e1bd9439bff5a69fa632d9801702adf9da77df2cd1c4d9aedc29dc520f28430",
-      "kind": "transparent"
-    },
-    {
-      "address": "0xD73D85F203bbE43f6541eF0177251A74fF151914",
-      "txHash": "0x004700259c28e402d7aa6727dec874a9bcd6faec651c9abadbe0b0f02fbdd72e",
-      "kind": "transparent"
-    },
-    {
-      "address": "0x1adeA199dCf07E17232415Cb232442BE52517Add",
-      "txHash": "0xd1591882691d2945fe906e6ffdc701155d8ae99860ede28dda4a0eca6019ae25",
+      "address": "0xcB80F37eDD2bE3570c6C9D5B0888614E04E1e49E",
+      "txHash": "0x4816779d34173119141afed8604b591eff112911a3b952273686436d9be03470",
       "kind": "transparent"
     }
   ],
   "impls": {
-    "dadc513cd81ce3e765b05219a9f956799b5405d497cd25e1342ce5b4b08463df": {
-      "address": "0x7DcCBBaEcAED517AB8c283C70774676D4479c7C4",
-      "txHash": "0x95b06c40580baf441c23699fe4ebdefcb5916b4886e4e9846a0032fa8d6066d9",
-      "layout": {
-        "solcVersion": "0.8.16",
-        "storage": [
-          {
-            "label": "totalDIDs",
-            "offset": 0,
-            "slot": "0",
-            "type": "t_uint256",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:9"
-          },
-          {
-            "label": "owner",
-            "offset": 0,
-            "slot": "1",
-            "type": "t_address",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:10"
-          },
-          {
-            "label": "polyDIDs",
-            "offset": 0,
-            "slot": "2",
-            "type": "t_mapping(t_address,t_struct(PolyDID)48_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:25"
-          },
-          {
-            "label": "activeDIDs",
-            "offset": 0,
-            "slot": "3",
-            "type": "t_mapping(t_uint256,t_address)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:26"
-          },
-          {
-            "label": "activeAddress",
-            "offset": 0,
-            "slot": "4",
-            "type": "t_mapping(t_address,t_uint256)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:27"
-          },
-          {
-            "label": "resourceData",
-            "offset": 0,
-            "slot": "5",
-            "type": "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:28"
-          },
-          {
-            "label": "keysById",
-            "offset": 0,
-            "slot": "6",
-            "type": "t_mapping(t_address,t_array(t_string_storage)dyn_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:29"
-          },
-          {
-            "label": "initialized",
-            "offset": 0,
-            "slot": "7",
-            "type": "t_bool",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:35"
-          }
-        ],
-        "types": {
-          "t_address": {
-            "label": "address",
-            "numberOfBytes": "20"
-          },
-          "t_array(t_string_storage)dyn_storage": {
-            "label": "string[]",
-            "numberOfBytes": "32"
-          },
-          "t_bool": {
-            "label": "bool",
-            "numberOfBytes": "1"
-          },
-          "t_mapping(t_address,t_array(t_string_storage)dyn_storage)": {
-            "label": "mapping(address => string[])",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))": {
-            "label": "mapping(address => mapping(string => string))",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_struct(PolyDID)48_storage)": {
-            "label": "mapping(address => struct PolygonDidRegistry.PolyDID)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_uint256)": {
-            "label": "mapping(address => uint256)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_string_memory_ptr,t_string_storage)": {
-            "label": "mapping(string => string)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_uint256,t_address)": {
-            "label": "mapping(uint256 => address)",
-            "numberOfBytes": "32"
-          },
-          "t_string_memory_ptr": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_string_storage": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_struct(PolyDID)48_storage": {
-            "label": "struct PolygonDidRegistry.PolyDID",
-            "members": [
-              {
-                "label": "controller",
-                "type": "t_address",
-                "offset": 0,
-                "slot": "0"
-              },
-              {
-                "label": "created",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "1"
-              },
-              {
-                "label": "updated",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "2"
-              },
-              {
-                "label": "didDoc",
-                "type": "t_string_storage",
-                "offset": 0,
-                "slot": "3"
-              }
-            ],
-            "numberOfBytes": "128"
-          },
-          "t_uint256": {
-            "label": "uint256",
-            "numberOfBytes": "32"
-          }
-        },
-        "namespaces": {}
-      }
-    },
-    "c303544cc3632546a76b656533d155e9d46213d28204aec1815e9ce2006085c9": {
-      "address": "0x1c10e4CF0a8914cf2E632D2762085D8C61dB4cCb",
-      "txHash": "0x07b8b1055c4d182e564f941e6c255cf473ca91920131a254f1e00d2aeec9721c",
-      "layout": {
-        "solcVersion": "0.8.16",
-        "storage": [
-          {
-            "label": "totalDIDs",
-            "offset": 0,
-            "slot": "0",
-            "type": "t_uint256",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:9"
-          },
-          {
-            "label": "owner",
-            "offset": 0,
-            "slot": "1",
-            "type": "t_address",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:10"
-          },
-          {
-            "label": "polyDIDs",
-            "offset": 0,
-            "slot": "2",
-            "type": "t_mapping(t_address,t_struct(PolyDID)15_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:18"
-          },
-          {
-            "label": "activeDIDs",
-            "offset": 0,
-            "slot": "3",
-            "type": "t_mapping(t_uint256,t_address)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:19"
-          },
-          {
-            "label": "activeAddress",
-            "offset": 0,
-            "slot": "4",
-            "type": "t_mapping(t_address,t_uint256)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:20"
-          },
-          {
-            "label": "resourceData",
-            "offset": 0,
-            "slot": "5",
-            "type": "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:21"
-          },
-          {
-            "label": "keysById",
-            "offset": 0,
-            "slot": "6",
-            "type": "t_mapping(t_address,t_array(t_string_storage)dyn_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:22"
-          },
-          {
-            "label": "initialized",
-            "offset": 0,
-            "slot": "7",
-            "type": "t_bool",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:32"
-          }
-        ],
-        "types": {
-          "t_address": {
-            "label": "address",
-            "numberOfBytes": "20"
-          },
-          "t_array(t_string_storage)dyn_storage": {
-            "label": "string[]",
-            "numberOfBytes": "32"
-          },
-          "t_bool": {
-            "label": "bool",
-            "numberOfBytes": "1"
-          },
-          "t_mapping(t_address,t_array(t_string_storage)dyn_storage)": {
-            "label": "mapping(address => string[])",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))": {
-            "label": "mapping(address => mapping(string => string))",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_struct(PolyDID)15_storage)": {
-            "label": "mapping(address => struct PolygonDidRegistry.PolyDID)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_uint256)": {
-            "label": "mapping(address => uint256)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_string_memory_ptr,t_string_storage)": {
-            "label": "mapping(string => string)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_uint256,t_address)": {
-            "label": "mapping(uint256 => address)",
-            "numberOfBytes": "32"
-          },
-          "t_string_memory_ptr": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_string_storage": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_struct(PolyDID)15_storage": {
-            "label": "struct PolygonDidRegistry.PolyDID",
-            "members": [
-              {
-                "label": "controller",
-                "type": "t_address",
-                "offset": 0,
-                "slot": "0"
-              },
-              {
-                "label": "created",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "1"
-              },
-              {
-                "label": "updated",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "2"
-              },
-              {
-                "label": "didDoc",
-                "type": "t_string_storage",
-                "offset": 0,
-                "slot": "3"
-              }
-            ],
-            "numberOfBytes": "128"
-          },
-          "t_uint256": {
-            "label": "uint256",
-            "numberOfBytes": "32"
-          }
-        },
-        "namespaces": {}
-      }
-    },
-    "75b86adb6471aac29a596c2ab95b6cc3ffb19eb6c1bc7aafd10402d4762a892a": {
-      "address": "0xddBC6C77E7AA2E220C845b365b3CF76455157aaF",
-      "txHash": "0x82c4ad2dac45630071255f9171e2fb01767ff4ddc85b7b59bab26029b7552532",
-      "layout": {
-        "solcVersion": "0.8.16",
-        "storage": [
-          {
-            "label": "owner",
-            "offset": 0,
-            "slot": "0",
-            "type": "t_address",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:9"
-          },
-          {
-            "label": "polyDIDs",
-            "offset": 0,
-            "slot": "1",
-            "type": "t_mapping(t_address,t_struct(PolyDID)13_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:17"
-          },
-          {
-            "label": "resourceData",
-            "offset": 0,
-            "slot": "2",
-            "type": "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:18"
-          },
-          {
-            "label": "keysById",
-            "offset": 0,
-            "slot": "3",
-            "type": "t_mapping(t_address,t_array(t_string_storage)dyn_storage)",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:19"
-          },
-          {
-            "label": "initialized",
-            "offset": 0,
-            "slot": "4",
-            "type": "t_bool",
-            "contract": "PolygonDidRegistry",
-            "src": "contracts/PolygonDidRegistry.sol:29"
-          }
-        ],
-        "types": {
-          "t_address": {
-            "label": "address",
-            "numberOfBytes": "20"
-          },
-          "t_array(t_string_storage)dyn_storage": {
-            "label": "string[]",
-            "numberOfBytes": "32"
-          },
-          "t_bool": {
-            "label": "bool",
-            "numberOfBytes": "1"
-          },
-          "t_mapping(t_address,t_array(t_string_storage)dyn_storage)": {
-            "label": "mapping(address => string[])",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_mapping(t_string_memory_ptr,t_string_storage))": {
-            "label": "mapping(address => mapping(string => string))",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_address,t_struct(PolyDID)13_storage)": {
-            "label": "mapping(address => struct PolygonDidRegistry.PolyDID)",
-            "numberOfBytes": "32"
-          },
-          "t_mapping(t_string_memory_ptr,t_string_storage)": {
-            "label": "mapping(string => string)",
-            "numberOfBytes": "32"
-          },
-          "t_string_memory_ptr": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_string_storage": {
-            "label": "string",
-            "numberOfBytes": "32"
-          },
-          "t_struct(PolyDID)13_storage": {
-            "label": "struct PolygonDidRegistry.PolyDID",
-            "members": [
-              {
-                "label": "controller",
-                "type": "t_address",
-                "offset": 0,
-                "slot": "0"
-              },
-              {
-                "label": "created",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "1"
-              },
-              {
-                "label": "updated",
-                "type": "t_uint256",
-                "offset": 0,
-                "slot": "2"
-              },
-              {
-                "label": "didDoc",
-                "type": "t_string_storage",
-                "offset": 0,
-                "slot": "3"
-              }
-            ],
-            "numberOfBytes": "128"
-          },
-          "t_uint256": {
-            "label": "uint256",
-            "numberOfBytes": "32"
-          }
-        },
-        "namespaces": {}
-      }
-    },
     "4ea697d213312244614a688367167de1e84d9fd58fa073c2461c24e28152def1": {
-      "address": "0x341A4f3252681208f8fA17891a5cf0bda47007d9",
-      "txHash": "0xe8966f0084f888656da95f48b06a839d2e55446bbff08955728ae0ca8d2cf7b9",
+      "address": "0x6203b92447BF0A3260e5Ee643b472B2D5BeD7Bb6",
+      "txHash": "0xd8abad4e72a8509796ca15095d591d2cb8e5751d7071bb2ca141537cfa9e0e4f",
       "layout": {
         "solcVersion": "0.8.16",
         "storage": [

package/README.md CHANGED Viewed

@@ -8,10 +8,10 @@ The Polygon registry contract acts as a public ledger, where the Polygon-Identit
 ## Contract Deployment
-|     Network     | ChainId |              Registry Address              |
-| :-------------: | :-----: | :----------------------------------------: |
-| Polygon Mainnet |   137   | 0x98bF771e1E93Db917A89986bcdaBa3b43643F367 |
-| Polygon Testnet |  80001  | 0x8B335A167DA81CCef19C53eE629cf2F6291F2255 |
+|        Network         | ChainId |              Registry Address              |
+| :--------------------: | :-----: | :----------------------------------------: |
+|    Polygon Mainnet     |   137   | 0x0C16958c4246271622201101C83B9F0Fc7180d15 |
+| Polygon Testnet (amoy) |  80002  | 0xcB80F37eDD2bE3570c6C9D5B0888614E04E1e49E |
 ## Methods
@@ -19,19 +19,17 @@ The Polygon registry contract acts as a public ledger, where the Polygon-Identit
 - `updateDIDDoc(address, string)` : The method updateDID is included in contract, which will facilitate the controller, and only the controller of the did, to update the document if need arises. Though the Polygon DID method, defines how the DID doc is defined as per standards, and that can be resolved.
-- `deleteDIDDoc(address)` : The method deleteDID is included in the contract, that only the controller of DID can access, to delete a particular DID from ledger.
 - `getDIDDoc(address)` : The method getDID helps to resolve the DID document.
 - `transferOwnership(address)` : The method transferOwnership, helps in transferring the ownership of contract to a new owner. Only the current owner can access this function.
 - `getOwner()` : the method getOwner helps one to fetch the current owner of the contract.
-- `getTotalNumberOfDIDs()` : the method getTotalNumberOfDIDs helps one to fetch the total number of DIDs ever written on Polygon Ledger, with the number of currently active DIDs.
+- `addResource(address, string, string)` : The addResource method allows the controller of a DID to add a linked resource to the DID document. This method ensures that only authorized controllers can add resources by requiring the caller to be the controller of the DID.
-- `getTotalNumberOfDeletedDIDs()`: the method getTotalNumberOfDeletedDIDs helps one fetch the total number of DIDs deleted from Polygon Ledger.
+- `getResource(address, string)` : The getResource method fetches a specific linked resource from the blockchain that is associated with a given DID document.
-- `getDIDDOcByIndex(uint256)` : The method getDIDDOcByIndex helps,to resolve DID document by index.
+- `getAllResources(address)` : The getAllResources method retrieves all resources linked to a specific DID document. This provides a comprehensive list of all resources associated with a given DID.
 ## Example ethers code
@@ -41,7 +39,7 @@ Using ethers, the following illustrates how one can interact with PolygonRegistr
 ```
 const ethers = require('ethers');
-const url = https://rpc-mumbai.matic.today; // For matic testnet
+const url = https://rpc-amoy.polygon.technology; // For amoy testnet
 const DID_ADDRESS = `<Contract Address>`;
 const provider = new ethers.providers.JsonRpcProvider(url);
@@ -49,85 +47,41 @@ let wallet = new ethers.Wallet(`<Signer Key/Private Key>`, provider);
 let registry = new ethers.Contract(DID_ADDRESS, <Contract ABI>, wallet);
 ```
-## Creating a DID
-```
-let returnHashValues = await registry.functions.createDID(<DID address>, DidDoc);
-```
-## Updating a DID
-```
-let returnHashValues = await registry.functions.updateDIDDoc(<DID address>, DidDoc)
-```
-## Delete a DID
-```
-let returnHashValues = await registry.functions.deleteDIDDoc(<DID address>)
-```
-## Resolving a DID
-```
-let returnDidDoc = await registry.functions.getDIDDoc(<DID address>);
-```
 # Deploying the Contract on Matic network
 Pre-requisites
-- NodeJS
-```
-https://nodejs.org/en/download/
-```
-- Truffle
-```
-https://www.trufflesuite.com/docs/truffle/getting-started/truffle-with-metamask
-```
-- Ganache
-```
-https://www.trufflesuite.com/ganache
-```
+- NodeJS - https://nodejs.org/en/download/
+- Hardhat - https://hardhat.org
 - A wallet connected to polygon network, with Matic token in it. One can receive the Matic Test Tokens from their faucet.
 ## Deployment
-Clone the above repository
+Clone the repository
 ```
-git clone https://gitlab.com/polygon-did/polygon-did-smart-contract.git
+git clone https://github.com/ayanworks/polygon-did-registry-contract.git
 ```
 Install Dependencies
 ```
-npm i
-```
-Run a ganache instance (only required for Local Deployment)
-```
-ganache-cli
+pnpm i
 ```
 Update your and RPC URL in .env file.
 ```
-RPCURL="<Place your RPC URL here>"
-SIGNER="<Place your mnemonic/Private Key here>"
+MAINNET_RPCURL="<Place your Mainnet RPC URL here>"
+AMOY_RPCURL="<Place your Amoy RPC URL here>"
+SIGNER_TESTNET="<Place your Testnet Signer Key here>"
+SIGNER_MAINNET="<Place your Mainnet Signer Key here>"
 ```
 On a new console window run
 ```
-truffle migrate --network <network name>
+npx hardhat run deploy --network <network name>
 ```
 ## Testing
@@ -135,7 +89,5 @@ truffle migrate --network <network name>
 For Testing use the command
 ```
-truffle test
+pnpm test
 ```
-The test cases run on a ganache setup.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@ayanworks/polygon-did-registry-contract",
-  "version": "2.0.1-alpha.8",
+  "version": "3.0.0",
   "description": "Smart Contract to register DID on Polygon",
   "main": "build/index.js",
   "directories": {