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

package/.github/workflows/pipeline.yaml

@@ -0,0 +1,85 @@
+name: 'Pipeline'
+
+concurrency:
+  # Cancel previous runs that are not completed yet
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: ['main']
+
+  pull_request:
+    types: [opened, synchronize]
+
+  workflow_dispatch:
+    inputs:
+      release-type:
+        description: 'Type of release (major, minor, patch, alpha)'
+        required: true
+        default: alpha
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+          - alpha
+
+jobs:
+  continuous-integration:
+    name: 'Continuous Integration'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.6.0
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Check formatting
+        run: pnpm check-format
+
+  continuous-deployment:
+    if: github.event_name == 'workflow_dispatch'
+
+    name: 'Continuous Deployment'
+    runs-on: ubuntu-latest
+    needs: ['continuous-integration']
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TOKEN }}
+
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8.6.0
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Initialize the NPM config
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
+
+      - name: Publish
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo ${{ inputs.release-type }}
+          git config --global user.email "amit.padmani@ayanworks.com"
+          git config --global user.name "Amit Padmani"
+
+          if [ ${{ inputs.release-type }} == 'alpha' ]; then
+            pnpm release --preRelease=${{ inputs.release-type }} --npm.tag=alpha
+          else
+            pnpm release ${{ inputs.release-type }} --npm.tag=latest
+          fi

package/.prettierignore

@@ -1 +1,6 @@
-pnpm-lock.yaml
+pnpm-lock.yaml
+node_modules
+.DS_Store
+build
+artifacts
+sst-config.json

package/.release-it.json

@@ -1,8 +1,11 @@
 {
   "git": {
-    "commitMessage": "chore: release v${version}"
+    "commitMessage": "chore: release v${version} [skip ci]",
+    "commitArgs": ["--signoff"]
   },
   "github": {
-    "release": true
-  }
+    "release": true,
+    "autoGenerate": true
+  },
+  "requireCleanWorkingDir": false
 }

package/README.md

@@ -4,34 +4,34 @@ This library is an implementation of a registry contract that supports the Polyg
 
 ## Overview
 
-The Polygon registry contract acts as a public ledger, where the Polygon-Identity specified Decentralised Identifiers will be logged. The specifications related to polygon DID method are mentioned in the      document. A DID generated using the Polygon DID generator, can be stored and managed on the ledger using this contract library.
+The Polygon registry contract acts as a public ledger, where the Polygon-Identity specified Decentralised Identifiers will be logged. The specifications related to polygon DID method are mentioned in the document. A DID generated using the Polygon DID generator, can be stored and managed on the ledger using this contract library.
 
 ## Contract Deployment
 
-| Network | ChainId | Registry Address |
-| :---: | :---: | :---: | 
-| Polygon Mainnet | 137 | 0x98bF771e1E93Db917A89986bcdaBa3b43643F367 |
-| Polygon Testnet | 80001 | 0x8B335A167DA81CCef19C53eE629cf2F6291F2255 |
+|     Network     | ChainId |              Registry Address              |
+| :-------------: | :-----: | :----------------------------------------: |
+| Polygon Mainnet |   137   | 0x98bF771e1E93Db917A89986bcdaBa3b43643F367 |
+| Polygon Testnet |  80001  | 0x8B335A167DA81CCef19C53eE629cf2F6291F2255 |
 
 ## Methods
 
-* ```createDID(address, string)``` : The method createDID is used to create and log a new DID on the polygon chain. The parameter of address type, will act as the reference key, to refer  the did document stored on the chain. The string type variable will contain the did document, that will be stored on the matic chain.
+- `createDID(address, string)` : The method createDID is used to create and log a new DID on the polygon chain. The parameter of address type, will act as the reference key, to refer the did document stored on the chain. The string type variable will contain the did document, that will be stored on the matic chain.
 
-* ```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.  
+- `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.
+- `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.
+- `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.
+- `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.
+- `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.
+- `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.
 
-* ```getTotalNumberOfDeletedDIDs()```: the method getTotalNumberOfDeletedDIDs helps one fetch the total number of DIDs deleted from Polygon Ledger.
+- `getTotalNumberOfDeletedDIDs()`: the method getTotalNumberOfDeletedDIDs helps one fetch the total number of DIDs deleted from Polygon Ledger.
 
-* ```getDIDDOcByIndex(uint256)``` : The method getDIDDOcByIndex helps,to resolve DID document by index.
+- `getDIDDOcByIndex(uint256)` : The method getDIDDOcByIndex helps,to resolve DID document by index.
 
 ## Example ethers code
 
@@ -57,7 +57,6 @@ let returnHashValues = await registry.functions.createDID(<DID address>, DidDoc)
 
 ## Updating a DID
 
-
 ```
 let returnHashValues = await registry.functions.updateDIDDoc(<DID address>, DidDoc)
 ```
@@ -68,7 +67,7 @@ let returnHashValues = await registry.functions.updateDIDDoc(<DID address>, DidD
 let returnHashValues = await registry.functions.deleteDIDDoc(<DID address>)
 ```
 
-## Resolving a DID 
+## Resolving a DID
 
 ```
 let returnDidDoc = await registry.functions.getDIDDoc(<DID address>);
@@ -78,27 +77,26 @@ let returnDidDoc = await registry.functions.getDIDDoc(<DID address>);
 
 Pre-requisites
 
-* NodeJS 
+- NodeJS
 
 ```
 https://nodejs.org/en/download/
 ```
 
-* Truffle
+- Truffle
 
 ```
 https://www.trufflesuite.com/docs/truffle/getting-started/truffle-with-metamask
 ```
 
-* Ganache
+- Ganache
 
 ```
 https://www.trufflesuite.com/ganache
 ```
 
-* A wallet connected to polygon network, with Matic token in it. One can receive the Matic Test Tokens from their faucet.
+- 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
@@ -113,7 +111,7 @@ Install Dependencies
 npm i
 ```
 
-Run a ganache instance (only required for Local Deployment) 
+Run a ganache instance (only required for Local Deployment)
 
 ```
 ganache-cli
@@ -139,4 +137,5 @@ For Testing use the command
 ```
 truffle test
 ```
-The test cases run on a ganache setup.
+
+The test cases run on a ganache setup.