feat: add schema module config

.changeset/config.json

@@ -3,7 +3,7 @@
   "changelog": "@changesets/cli/changelog",
   "commit": "./commit",
   "privatePackages": false,
-  "fixed": [["@ayanworks/*"]],
+  "fixed": [["@bhutan-ndi/*"]],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",

.github/workflows/ci.yml

@@ -4,9 +4,11 @@ on:
   pull_request:
     branches:
       - main
+      - dev
   push:
     branches:
       - main
+      - dev
 
 concurrency:
   # Cancel previous runs that are not completed yet

.github/workflows/release.yml

@@ -8,16 +8,19 @@ on:
     branches:
       - main
 
-concurrency: ${{ github.workflow }}-${{ github.ref }}
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 permissions:
   pull-requests: write
   contents: write
+  id-token: write
 
 jobs:
   release-stable:
-    runs-on: ubuntu-latest
     name: Release Stable
+    runs-on: ubuntu-latest
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
       - name: Checkout Repo
@@ -27,38 +30,39 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'yarn'
+          cache: yarn
+          registry-url: https://registry.npmjs.org/
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
 
-      - name: Create Release Pull Request or Publish to npm
+      - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1
         with:
           title: 'chore(release): new version'
           commit: 'chore(release): new version'
-          publish: yarn release
           version: yarn changeset-version
+          publish: yarn release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Get current package version
+        if: steps.changesets.outputs.published == 'true'
         id: get_version
         run: echo "CURRENT_PACKAGE_VERSION=$(node -p "require('./package.json').version")" >> $GITHUB_ENV
 
       - name: Create Github Release
-        if: "startsWith(github.event.head_commit.message, 'chore(release): new version')"
+        if: steps.changesets.outputs.published == 'true'
         uses: softprops/action-gh-release@v2
         with:
           tag_name: v${{ env.CURRENT_PACKAGE_VERSION }}
 
   release-unstable:
+    name: Release Unstable (Alpha Snapshot)
     runs-on: ubuntu-latest
-    name: Release Unstable
-    needs: release-stable
-    if: "always() && (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'ayanworks/credo-ethr-module') || (github.event_name == 'push' && !startsWith(github.event.head_commit.message, 'chore(release): new version'))"
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
 
     steps:
       - name: Checkout Repo
@@ -68,40 +72,32 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'yarn'
+          cache: yarn
+          registry-url: https://registry.npmjs.org
 
       - name: Install Dependencies
         run: yarn install --frozen-lockfile
 
-      - name: Creating .npmrc
+      - name: Configure npm authentication
         run: |
-          cat << EOF > ".npmrc"
-            //registry.npmjs.org/:_authToken=$NPM_TOKEN
-          EOF
+          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - name: Create unstable release
+      - name: Create snapshot release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
-          # this ensures there's always a patch release created
-          cat << 'EOF' > .changeset/snapshot-template-changeset.md
-          ---
-          '@ayanworks/credo-ethr-module': patch
-          ---
-
-          snapshot release
-          EOF
-
           yarn changeset version --snapshot alpha
           yarn prettier --write .
           yarn build
           yarn changeset publish --tag alpha
 
           CURRENT_PACKAGE_VERSION=$(node -p "require('./package.json').version")
-          git config --global user.name "Ayanworks"
-          git config --global user.email "github@ayanworks.com"
+
+          git config --global user.name "Bhutan NDI"
+          git config --global user.email "github@bhutanndi.bt"
+
           git tag v$CURRENT_PACKAGE_VERSION
           git push origin v$CURRENT_PACKAGE_VERSION --no-verify

.prettierignore

@@ -0,0 +1,7 @@
+# Node modules & build
+node_modules
+dist
+build
+
+# Ignore generated ABI
+src/abi/SchemaRegistry.json

CHANGELOG.md

@@ -0,0 +1,7 @@
+# @bhutan-ndi/ethr-credo-module
+
+## 1.0.3
+
+### Patch Changes
+
+- f5ce7c6: Refactor publicKeyHex to publicKeyBase58

README.md

@@ -5,7 +5,7 @@
 ## Usage
 
 ```ts
-import { EthereumDidResolver, EthereumDidRegistrar, EthereumModule } from 'credo-ethr-module'
+import { EthereumDidResolver, EthereumDidRegistrar, EthereumModule } from '@bhutan-ndi/ethr-credo-module'
 
 const agent = new Agent({
   config: {
@@ -26,5 +26,6 @@ const agent = new Agent({
       schemaManagerContractAddress: 'schemaManagerContractAddress' // ethereum schema manager contract address,
       serverUrl: 'serverUrl' // ethereum file server url,
     }),
+  }
 })
 ```

jest.config.ts

@@ -8,6 +8,7 @@ const config: Config.InitialOptions = {
   displayName: packageJson.name,
   setupFilesAfterEnv: ['./tests/setup.ts'],
   testTimeout: 120000,
+  forceExit: true,
 }
 
 export default config

package.json

@@ -1,32 +1,32 @@
 {
-  "name": "@ayanworks/credo-ethr-module",
+  "name": "@bhutan-ndi/ethr-credo-module",
   "main": "build/index",
   "types": "build/index",
-  "version": "0.0.1",
+  "version": "1.0.3",
   "files": [
     "build"
   ],
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://github.com/ayanworks/credo-ethr-module",
+  "homepage": "https://github.com/Bhutan-NDI/ethr-credo-module",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ayanworks/credo-ethr-module"
+    "url": "https://github.com/Bhutan-NDI/ethr-credo-module"
   },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./build",
     "compile": "tsc -p tsconfig.build.json",
     "prepublishOnly": "yarn run build",
     "check-types": "tsc --noEmit -p tsconfig.build.json",
-    "check-format": "yarn prettier --check",
-    "prettier": "prettier --ignore-path .gitignore '**/*.+(js|json|ts|md|yml|yaml)'",
+    "check-format": "prettier --check .",
+    "format": "prettier --write .",
     "test": "jest",
     "lint": "eslint --ignore-path .gitignore .",
     "release": "yarn build && yarn changeset publish --no-git-tag",
-    "changeset-version": "yarn changeset version && yarn prettier --write"
+    "changeset-version": "yarn changeset version && yarn prettier --write ."
   },
   "dependencies": {
     "@credo-ts/askar": "0.5.3",

src/EthereumApi.ts

@@ -17,6 +17,11 @@ export class EthereumApi {
     return schemaDetails
   }
 
+  public async createExistingSchema({ did, schemaId }: { did: string; schemaId: string }) {
+    const schemaDetails = await this.ledgerService.createExistingSchema(this.agentContext, { did, schemaId })
+    return schemaDetails
+  }
+
   public async getSchemaById(did: string, schemaId: string) {
     const schemaDetails = await this.ledgerService.getSchemaByDidAndSchemaId(this.agentContext, did, schemaId)
     return schemaDetails

src/EthereumModuleConfig.ts

@@ -5,17 +5,17 @@ import type { ConfigurationOptions } from 'ethr-did-resolver/lib/configuration'
  */
 export interface EthereumModuleConfigOptions {
   config: ConfigurationOptions
-  rpcUrl: string
-  fileServerToken: string
-  schemaManagerContractAddress: string
-  serverUrl: string
+  rpcUrl?: string
+  fileServerToken?: string
+  schemaManagerContractAddress?: string
+  serverUrl?: string
 }
 
 export class EthereumModuleConfig {
-  public rpcUrl: string
-  public fileServerToken: string
-  public schemaManagerContractAddress: string
-  public serverUrl: string
+  public rpcUrl: string | undefined
+  public fileServerToken: string | undefined
+  public schemaManagerContractAddress: string | undefined
+  public serverUrl: string | undefined
   public readonly config: ConfigurationOptions
 
   public constructor({