fix: Broken release/2.x branch tests

.github/workflows/build.yml

@@ -50,7 +50,7 @@ jobs:
       - name: Download binary artifact
         run: |
           mkdir -p ${{ env.RUNNER_BIN_DIR }}
-          CHEQD_NODE_VERSION="$(cut -c2- <<< "$(jq -r 'map(select(.prerelease)) | first | .tag_name' <<< "$(curl --silent https://api.github.com/repos/cheqd/cheqd-node/releases)")")"
+          CHEQD_NODE_VERSION="$(cut -c2- <<< "$(curl  -s "https://api.github.com/repos/cheqd/cheqd-node/tags" | jq -r '.[0].name')")"
           wget -c "https://github.com/cheqd/cheqd-node/releases/download/v${CHEQD_NODE_VERSION}/cheqd-noded-${CHEQD_NODE_VERSION}-linux-amd64.tar.gz"
           tar -xvf "cheqd-noded-${CHEQD_NODE_VERSION}-linux-amd64.tar.gz" -C ${{ env.RUNNER_BIN_DIR }}
           sudo chmod +x ${{ env.RUNNER_BIN_DIR }}/cheqd-noded
@@ -67,7 +67,7 @@ jobs:
       - name: Set up Docker localnet
         working-directory: ./docker/localnet
         run: |
-          CHEQD_NODE_VERSION="$(cut -c2- <<< "$(jq -r 'map(select(.prerelease)) | first | .tag_name' <<< "$(curl --silent https://api.github.com/repos/cheqd/cheqd-node/releases)")")"
+          CHEQD_NODE_VERSION="$(cut -c2- <<< "$(curl  -s "https://api.github.com/repos/cheqd/cheqd-node/tags" | jq -r '.[0].name')")"
           BUILD_IMAGE="ghcr.io/cheqd/cheqd-node:$CHEQD_NODE_VERSION"
           export BUILD_IMAGE
           docker compose up --detach
@@ -81,4 +81,6 @@ jobs:
         run: npm ci
 
       - name: Run Tests
-        run: npm test
+        run: |
+          sleep 1m
+          npm test

.github/workflows/pull-request.yml

@@ -4,7 +4,6 @@ on:
     branches:
       - main
       - develop
-      - commonjs
       - release/**
     types:
       - opened

CHANGELOG.md

@@ -1,30 +1,30 @@
 # Changelog
 
-## [3.4.0](https://github.com/cheqd/sdk/compare/3.3.1-commonjs...3.4.0-commonjs) (2023-04-14)
+## [3.3.0-develop.4](https://github.com/cheqd/sdk/compare/3.3.0-develop.3...3.3.0-develop.4) (2023-04-14)
 
+## [3.3.0-develop.3](https://github.com/cheqd/sdk/compare/3.3.0-develop.2...3.3.0-develop.3) (2023-04-14)
 
-### Features
-
-* Bump resource gas ([#178](https://github.com/cheqd/sdk/issues/178)) ([a67b3e1](https://github.com/cheqd/sdk/commit/a67b3e14589569b5ad01e8d0b0bdfd8370cb4f9a))
-
-## [3.3.1](https://github.com/cheqd/sdk/compare/3.3.0-commonjs...3.3.1-commonjs) (2023-04-06)
+## [3.3.0-develop.2](https://github.com/cheqd/sdk/compare/3.3.0-develop.1...3.3.0-develop.2) (2023-04-14)
 
-## [3.3.0](https://github.com/cheqd/sdk/compare/3.2.1-commonjs...3.3.0-commonjs) (2023-04-03)
+## [3.3.0-develop.1](https://github.com/cheqd/sdk/compare/3.2.1-develop.1...3.3.0-develop.1) (2023-04-14)
 
 
 ### Features
 
-* Add @cosmjs/crypto as direct dependency ([#174](https://github.com/cheqd/sdk/issues/174)) ([9af5faf](https://github.com/cheqd/sdk/commit/9af5faf6336bae048860669a83da598dd704818c))
+* Bump resource gas ([#179](https://github.com/cheqd/sdk/issues/179)) ([8de317b](https://github.com/cheqd/sdk/commit/8de317bdd2521f5b6f8728d049f7a3f647d6d26b))
 
-## [3.2.1](https://github.com/cheqd/sdk/compare/3.2.0-commonjs...3.2.1-commonjs) (2023-04-03)
+## [3.2.1](https://github.com/cheqd/sdk/compare/3.2.0...3.2.1) (2023-04-05)
 
-## [3.2.0](https://github.com/cheqd/sdk/compare/3.1.1...3.2.0) (2023-03-09)
+## [3.2.1-develop.1](https://github.com/cheqd/sdk/compare/3.2.0...3.2.1-develop.1) (2023-04-03)
 
+## [3.2.0](https://github.com/cheqd/sdk/compare/3.1.1...3.2.0) (2023-03-09)
 
 ### Features
 
 * Update @cheqd/ts-proto from 3.1.2 to 3.1.3 ([#151](https://github.com/cheqd/sdk/issues/151)) ([f6ac275](https://github.com/cheqd/sdk/commit/f6ac2759255ed612a99aff35d497468ff4530e11))
 
+## [3.2.0-develop.1](https://github.com/cheqd/sdk/compare/3.1.2-develop.1...3.2.0-develop.1) (2023-03-09)
+
 ## [3.1.2-develop.1](https://github.com/cheqd/sdk/compare/3.1.1...3.1.2-develop.1) (2023-03-09)
 
 ## [3.1.1](https://github.com/cheqd/sdk/compare/3.1.0...3.1.1) (2023-02-28)
@@ -44,11 +44,9 @@
 
 ## [3.0.2-develop.2](https://github.com/cheqd/sdk/compare/3.0.2-develop.1...3.0.2-develop.2) (2023-02-27)
 
-## [3.0.2-develop.1](https://github.com/cheqd/sdk/compare/3.0.1...3.0.2-develop.1) (2023-02-20)
-
 ## [3.0.2](https://github.com/cheqd/sdk/compare/3.0.1...3.0.2) (2023-02-20)
 
-## [3.0.2](https://github.com/cheqd/sdk/compare/3.0.1...3.0.2) (2023-02-17)
+## [3.0.2-develop.1](https://github.com/cheqd/sdk/compare/3.0.1...3.0.2-develop.1) (2023-02-20)
 
 ## [3.0.1](https://github.com/cheqd/sdk/compare/3.0.0...3.0.1) (2023-02-17)
 

README.md

@@ -8,28 +8,55 @@
 
 ## ℹ️ Overview
 
-The purpose of this [`@cheqd/sdk` NPM package](https://www.npmjs.com/package/@cheqd/sdk) is to provide a mechanism of integrating cheqd functionality in an application *without* using a 3rd-party SDK like [Veramo SDK for cheqd](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd).
+The purpose of this [`@cheqd/sdk` NPM package](https://www.npmjs.com/package/@cheqd/sdk) is to provide base functionality for interacting with cheqd network. It combines the DID and [DID-Linked Resources](https://docs.cheqd.io/identity/guides/did-linked-resources) modules, and putting them into a Cosmos transaction wrapper using [CosmJS](https://github.com/cosmos/cosmjs).
+
+This package is consumed by other SDKs/libraries such as [Veramo SDK for cheqd](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd) and [Hyperledger Aries Framework JavaScript (AFJ)](https://github.com/hyperledger/aries-framework-javascript) to add cheqd network support.
 
 This package includes:
 
 * [TypeScript Protobuf definitions](https://github.com/cheqd/ts-proto) for custom cheqd Cosmos SDK modules
 * [CosmJS](https://github.com/cosmos/cosmjs), for base Cosmos SDK module functions
 
-If you are using [Veramo SDK for cheqd](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd), this SDK package is automatically installed and consumed by the [`@cheqd/did-provider-cheqd` Veramo plugin](https://github.com/cheqd/did-provider-cheqd).
-
 ## 🆔 Features
 
+Our identity documentation site provides [tutorials for utilising the identity features](https://docs.cheqd.io/identity/overview/readme) on cheqd network.
+
 With this SDK, developers are able to:
 
 * ✅ Create a `did:cheqd` method DID
 * ✅ Update a `did:cheqd` method DID
-* ✅ Create Resource within a `did:cheqd` method DID
+* ✅ Deactivate a `did:cheqd` method DID
+* ✅ Create or update [a DID-Linked Resource](https://docs.cheqd.io/identity/tutorials/did-linked-resources/create-resource)
 
 ### 🧰 Tooling
 
 * ✅ **Raw payload creator**: Enables users to generate a valid raw DID payload which is ready to be populated, depending on the use case. For example, `did-provider-cheqd` leverages this helper in the CLI application.
 * ✅ **Identity key converter**: Enables users to convert specific key formats from different kinds of SDKs, by transforming the input keys into valid sign inputs for a cheqd specific DID transaction (e.g. `createDidDocTx`, `updateDidDocTx`). For example, the Veramo SDK for cheqd uses this helper to enable users to pass a key in a Veramo SDK specific format to a cheqd sign input keys interface.
 
+## 🧑‍💻 Developer Guide
+
+### Installing in ESM projects
+
+To install this NPM package in a project that needs ESM builds, use our `latest` release channel to install the stable version:
+
+```bash
+npm install @cheqd/sdk@latest
+```
+
+To install beta releases instead, use our `-develop` releases from the `beta` channel:
+
+```bash
+npm install @cheqd/sdk@beta
+```
+
+### Installing in CommonJS projects
+
+To install this NPM package in a project that needs CommonJS builds, use our `cjs` release channel to install the latest stable CommonJS version:
+
+```bash
+npm install @cheqd/sdk@cjs
+```
+
 ## 📖 Documentation
 
 Our [identity documentation site](https://docs.cheqd.io/identity/) explains how `@cheqd/sdk` is [consumed in Veramo SDK for cheqd](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd) (as an example of how this package can be consumed).