feat!: Release V2 registrar (#77)

* build: Add cheqd sdk official beta package (#22) * chore(release): 1.1.3-develop.1 [skip ci] ## [1.1.3-develop.1](1.1.2...1.1.3-develop.1) (2022-10-26) * feat: integrate v2 protos && support resource creation * feat: Support deactivate did tx * feat: Create address from mnemonic * feat: Support mnemonic secret && Update validation and swagger * build: Upgade cheqd sdk * chore(release): 1.2.0-develop.1 [skip ci] ## [1.2.0-develop.1](1.1.3-develop.1...1.2.0-develop.1) (2023-01-03) ### Features * Create address from mnemonic ([f706427](f706427)) * integrate v2 protos && support resource creation ([53d9f20](53d9f20)) * Integrate v2protos ([#53](#53)) ([4b416a1](4b416a1)) * Support deactivate did tx ([ea4b28f](ea4b28f)) * Support mnemonic secret && Update validation and swagger ([c5bafed](c5bafed)) * feat: Support Client managed secret mode (#66) * feat: Update payload type * feat: Support signing response * build: Fix linting error * feat: Add node-cache * feat: Update signature type * feat: Update resource creation * feat: Update helper method * feat: Update swagger * build: Upgrade cheqd sdk * fix: rpc urls * feat: Update error handling * lint: Fix swagger linting errors * chore(release): 1.2.0-develop.2 [skip ci] ## [1.2.0-develop.2](1.2.0-develop.1...1.2.0-develop.2) (2023-01-25) ### Features * Support Client managed secret mode ([#66](#66)) ([a8fe2b4](a8fe2b4)) * fix: Env change (#67) * chore(release): 1.2.0-develop.3 [skip ci] ## [1.2.0-develop.3](1.2.0-develop.2...1.2.0-develop.3) (2023-01-25) ### Bug Fixes * Env change ([#67](#67)) ([c3dcef9](c3dcef9)) * feat: Upgrade sdk && refactor * feat: Remove internal secret mode * feat!: Refactor code according to latest sdk * chore(release): 2.0.0-develop.1 [skip ci] ## [2.0.0-develop.1](1.2.0-develop.3...2.0.0-develop.1) (2023-01-30) ### ⚠ BREAKING CHANGES * Refactor code according to latest sdk ### Features * Refactor code according to latest sdk ([efcc992](efcc992)) * Remove internal secret mode ([1978583](1978583)) * Upgrade sdk && refactor ([8854932](8854932)) * fix: DID Document validation (#73) * fix: DID Document validation * feat: Update error handling * fix: Deactivate DID bug * chore(release): 2.0.0-develop.2 [skip ci] ## [2.0.0-develop.2](2.0.0-develop.1...2.0.0-develop.2) (2023-01-31) ### Bug Fixes * DID Document validation ([#73](#73)) ([c963e78](c963e78)) * docs: Update Readme (#74) * docs: Update Readme * feat: Update swagger * chore(release): 2.0.0-develop.3 [skip ci] ## [2.0.0-develop.3](2.0.0-develop.2...2.0.0-develop.3) (2023-01-31) --------- Co-authored-by: semantic-release-bot <[email protected]>
cheqd · Jan 31, 2023 · 2790782 · 2790782
1 parent 6f7343d
commit 2790782
Show file tree

Hide file tree

Showing 19 changed files with 1,889 additions and 1,577 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -51,7 +51,7 @@ jobs:
         id: set-version
         run: |
           VERSION=$( git describe --tags ${{ github.sha }})
-          echo ::set-output name=VERSION::"$VERSION"
+          echo "VERSION=$VERSION" >> "$GITHUB_OUTPUT"
 
 
   release-docker:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,54 @@
 # Changelog
 
+## [2.0.0-develop.3](https://github.com/cheqd/did-registrar/compare/2.0.0-develop.2...2.0.0-develop.3) (2023-01-31)
+
+## [2.0.0-develop.2](https://github.com/cheqd/did-registrar/compare/2.0.0-develop.1...2.0.0-develop.2) (2023-01-31)
+
+
+### Bug Fixes
+
+* DID Document validation ([#73](https://github.com/cheqd/did-registrar/issues/73)) ([c963e78](https://github.com/cheqd/did-registrar/commit/c963e78535aa3c63901b865db9705e7c29da7d49))
+
+## [2.0.0-develop.1](https://github.com/cheqd/did-registrar/compare/1.2.0-develop.3...2.0.0-develop.1) (2023-01-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* Refactor code according to latest sdk
+
+### Features
+
+* Refactor code according to latest sdk ([efcc992](https://github.com/cheqd/did-registrar/commit/efcc9923ec8285a082caf09020c5cbfb453746e6))
+* Remove internal secret mode ([1978583](https://github.com/cheqd/did-registrar/commit/1978583e434c08b6e31e37f6d2342d9df09f138d))
+* Upgrade sdk && refactor ([8854932](https://github.com/cheqd/did-registrar/commit/8854932a8b8cf33d5aef5ab19770a8052b197846))
+
+## [1.2.0-develop.3](https://github.com/cheqd/did-registrar/compare/1.2.0-develop.2...1.2.0-develop.3) (2023-01-25)
+
+
+### Bug Fixes
+
+* Env change ([#67](https://github.com/cheqd/did-registrar/issues/67)) ([c3dcef9](https://github.com/cheqd/did-registrar/commit/c3dcef99c2c598f05d8502af724beef3034f0d92))
+
+## [1.2.0-develop.2](https://github.com/cheqd/did-registrar/compare/1.2.0-develop.1...1.2.0-develop.2) (2023-01-25)
+
+
+### Features
+
+* Support Client managed secret mode ([#66](https://github.com/cheqd/did-registrar/issues/66)) ([a8fe2b4](https://github.com/cheqd/did-registrar/commit/a8fe2b493abda38e967ab9af30f1b4f51ae61f8c))
+
+## [1.2.0-develop.1](https://github.com/cheqd/did-registrar/compare/1.1.3-develop.1...1.2.0-develop.1) (2023-01-03)
+
+
+### Features
+
+* Create address from mnemonic ([f706427](https://github.com/cheqd/did-registrar/commit/f7064272b95d7486e97aa6293ef8122823128923))
+* integrate v2 protos && support resource creation ([53d9f20](https://github.com/cheqd/did-registrar/commit/53d9f2065e2163a2958e4b505458b68c3b32a5c6))
+* Integrate v2protos ([#53](https://github.com/cheqd/did-registrar/issues/53)) ([4b416a1](https://github.com/cheqd/did-registrar/commit/4b416a18d6174dd06edc9f20b2ffe99c2056f38e))
+* Support deactivate did tx ([ea4b28f](https://github.com/cheqd/did-registrar/commit/ea4b28f7a42f666e75f377595a79ac443dec39ac))
+* Support mnemonic secret && Update validation and swagger ([c5bafed](https://github.com/cheqd/did-registrar/commit/c5bafed3f294637f3389789d21740d25634951f9))
+
+## [1.1.3-develop.1](https://github.com/cheqd/did-registrar/compare/1.1.2...1.1.3-develop.1) (2022-10-26)
+
 ## [1.1.5](https://github.com/cheqd/did-registrar/compare/1.1.4...1.1.5) (2022-11-29)
 
 ## [1.1.4](https://github.com/cheqd/did-registrar/compare/1.1.3...1.1.4) (2022-11-09)

diff --git a/Dockerfile b/Dockerfile
@@ -32,17 +32,17 @@ COPY --from=builder /home/node/app/dist .
 ARG NODE_ENV=production
 ARG NPM_CONFIG_LOGLEVEL=warn
 ARG PORT=3000
-ARG FEE_PAYER_ADDRESS
-ARG FEE_PAYER_MNEMONIC
+ARG FEE_PAYER_TESTNET_MNEMONIC
+ARG FEE_PAYER_MAINNET_MNEMONIC
 
 # NPM environment variables
 ENV NODE_ENV ${NODE_ENV}
 ENV NPM_CONFIG_LOGLEVEL ${NPM_CONFIG_LOGLEVEL}
 ENV PORT ${PORT}
 
 # App-specific environment variables
-ENV FEE_PAYER_ADDRESS ${FEE_PAYER_ADDRESS}
-ENV FEE_PAYER_MNEMONIC ${FEE_PAYER_MNEMONIC}
+ENV FEE_PAYER_TESTNET_MNEMONIC ${FEE_PAYER_TESTNET_MNEMONIC}
+ENV FEE_PAYER_MAINNET_MNEMONIC ${FEE_PAYER_MAINNET_MNEMONIC}
 
 # Install pre-requisites
 RUN npm install [email protected] && \

diff --git a/README.md b/README.md
@@ -14,16 +14,55 @@ The purpose of this service is to provide a [Universal Registrar driver](https:/
 
 - `/create`
 - `/update`
+- `/deactivate`
+- `/create-resource`
 - `/api-docs`
 
 ## 🧑‍💻🛠 Developer Guide
 
 ### Setup
 
-To build and run in Docker, use the [Dockerfile](Dockerfile) provided.
+#### Environment variable configuration
+
+Environment variables needed for the Registrar are
+
+1. `FEE_PAYER_TESTNET_MNEMONIC` : The cosmos payer mnemonic for the Cheqd Mainnet
+2. `FEE_PAYER_MAINNET_MNEMONIC` : The cosmos payer mnemonic for the Cheqd Tesnet, By default it's the Testnet Faucet
+3. `LOCAL_STORE_TTL` (default: `600`): The time in seconds for the registrar to store data in cache
+4. `PORT` (default: `3000`): The port number
+
+
+Clone the repository
+
+```bash
+git clone [email protected]:cheqd/did-registrar.git
+cd did-registrar
+```
+
+***
+
+### Running a DID Registrar Using Docker
+
+Build Docker container image using Dockerfile:
+
+```bash
+docker build --target cheqd-did-registrar . --tag did-registrar:local
+```
+
+Run the Docker container (modify according to your own build tags and other desired parameters):
+
+```bash
+docker run -it did-registrar:local
+```
+
+***
+
+### Running a DID Registrar Locally
 
 ```bash
-docker build -t cheqd-did-registrar .
+npm install
+npm run build
+npm start 
 ```
 
 ## 🐞 Bug reports & 🤔 feature requests

diff --git a/env.example b/env.example
@@ -1,3 +1,4 @@
-FEE_PAYER_ADDRESS=cheqd1ew***********u7tc98v
-FEE_PAYER_MNEMONIC=<PUT YOUR MNEMONIC HERE>
+FEE_PAYER_MAINNET_MNEMONIC=<PUT YOUR MNEMONIC HERE>
+FEE_PAYER_TESTNET_MNEMONIC=<PUT YOUR MNEMONIC HERE>
 PORT=3000
+LOCAL_STORE_TTL=600