Refine the search algorithm for locating verification method references

examples/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @docknetwork/sdk-examples
 
+## 0.14.0
+
+### Minor Changes
+
+- Refine the search algorithm for locating verification method references.
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/dock-blockchain-modules@0.20.0
+  - @docknetwork/dock-blockchain-api@0.16.0
+  - @docknetwork/credential-sdk@0.31.0
+
 ## 0.13.0
 
 ### Minor Changes

examples/package.json

@@ -2,7 +2,7 @@
   "name": "@docknetwork/sdk-examples",
   "private": true,
   "type": "module",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "scripts": {
     "bbs-dock-example": "babel-node ./bbs-dock.js",
     "claim-deduction-example": "babel-node ./claim-deduction.js",
@@ -19,9 +19,9 @@
     "lint": "eslint \"*.js\""
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.30.0",
-    "@docknetwork/dock-blockchain-api": "0.15.0",
-    "@docknetwork/dock-blockchain-modules": "0.19.0"
+    "@docknetwork/credential-sdk": "0.31.0",
+    "@docknetwork/dock-blockchain-api": "0.16.0",
+    "@docknetwork/dock-blockchain-modules": "0.20.0"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",

packages/cheqd-blockchain-api/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @docknetwork/cheqd-blockchain-api
 
+## 0.25.0
+
+### Minor Changes
+
+- Refine the search algorithm for locating verification method references.
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/[email protected]
+
 ## 0.24.0
 
 ### Minor Changes

packages/cheqd-blockchain-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/cheqd-blockchain-api",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "license": "MIT",
   "main": "./dist/esm/index.js",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@cheqd/sdk": "cjs",
-    "@docknetwork/credential-sdk": "0.30.0"
+    "@docknetwork/credential-sdk": "0.31.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",

packages/cheqd-blockchain-modules/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @docknetwork/cheqd-blockchain-modules
 
+## 0.22.0
+
+### Minor Changes
+
+- Refine the search algorithm for locating verification method references.
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/[email protected]
+
 ## 0.21.0
 
 ### Minor Changes

packages/cheqd-blockchain-modules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/cheqd-blockchain-modules",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/esm/index.js",
@@ -33,7 +33,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.30.0"
+    "@docknetwork/credential-sdk": "0.31.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
@@ -42,7 +42,7 @@
     "@babel/plugin-syntax-import-attributes": "^7.25.6",
     "@babel/plugin-transform-modules-commonjs": "^7.24.1",
     "@babel/preset-env": "^7.24.3",
-    "@docknetwork/cheqd-blockchain-api": "0.24.0",
+    "@docknetwork/cheqd-blockchain-api": "0.25.0",
     "@rollup/plugin-alias": "^4.0.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^24.0.0",

packages/cheqd-blockchain-modules/src/did/internal.js

@@ -5,14 +5,20 @@ import {
 import { TypedUUID } from '@docknetwork/credential-sdk/types/generic';
 import { createInternalCheqdModule } from '../common';
 
-function parseDocument(document) {
+function createOrUpdateDidDocument(document) {
   return DIDDocument.from(document).toCheqd(this.types.DidDocument);
 }
+function deactivateDidDocument(id) {
+  return new CheqdDeactivateDidDocument(
+    this.types.Did.from(id),
+    TypedUUID.random(),
+  );
+}
 
 const methods = {
-  createDidDocument: parseDocument,
-  updateDidDocument: parseDocument,
-  deactivateDidDocument: (id) => new CheqdDeactivateDidDocument(id, TypedUUID.random()),
+  createDidDocument: createOrUpdateDidDocument,
+  updateDidDocument: createOrUpdateDidDocument,
+  deactivateDidDocument,
 };
 
 export class CheqdDIDModuleInternal extends createInternalCheqdModule(methods) {

packages/credential-sdk/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @docknetwork/credential-sdk
 
+## 0.31.0
+
+### Minor Changes
+
+- Refine the search algorithm for locating verification method references.
+
 ## 0.30.0
 
 ### Minor Changes

packages/credential-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/credential-sdk",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "license": "MIT",
   "type": "module",
   "files": [

packages/credential-sdk/src/types/did/document/verification-method-ref.js

@@ -1,9 +1,15 @@
-import { withQualifier, TypedTuple, TypedNumber } from '../../generic';
+import {
+  withQualifier,
+  TypedTuple,
+  TypedNumber,
+  createConverter,
+} from '../../generic';
 import {
   NamespaceDid,
   CheqdNamespaceDid,
   CheqdTestnetDid,
   CheqdMainnetDid,
+  DockNamespaceDid,
 } from '../onchain/typed-did';
 
 export class VerificationMethodRef extends withQualifier(TypedTuple) {
@@ -50,10 +56,27 @@ export class CheqdVerificationMethodRef extends VerificationMethodRef {
   static Classes = [CheqdNamespaceDid, TypedNumber];
 }
 
+export class DockVerificartionMethodRef extends VerificationMethodRef {
+  static Classes = [DockNamespaceDid, TypedNumber];
+}
+
 export class CheqdTestnetVerificationMethodRef extends CheqdVerificationMethodRef {
   static Classes = [CheqdTestnetDid, TypedNumber];
 }
 
 export class CheqdMainnetVerificationMethodRef extends CheqdVerificationMethodRef {
   static Classes = [CheqdMainnetDid, TypedNumber];
 }
+
+/**
+ * Retrieve all possible stringified representations of DIDs that can be derived from the provided Dock verification method reference.
+ *
+ * @param {*} verMethodRef
+ * @returns {Array<string>}
+ */
+export const possibleVerificationMethodRefs = createConverter(
+  String,
+  DockVerificartionMethodRef,
+  CheqdTestnetVerificationMethodRef,
+  CheqdMainnetVerificationMethodRef,
+);

packages/credential-sdk/src/types/did/onchain/typed-did/index.js

@@ -4,6 +4,7 @@ import {
   TypedEnum,
   TypedTuple,
   TypedUUID,
+  createConverter,
   withQualifier,
 } from '../../../generic';
 import { CheqdDid, CheqdMainnetDid, CheqdTestnetDid } from './cheqd-did';
@@ -239,5 +240,18 @@ DidOrDidMethodKeySignature.bindVariants(
   DidMethodKeySignature,
 );
 
+/**
+ * Retrieve all possible stringified representations of DIDs that can be derived from the provided Dock DID.
+ *
+ * @param {*} did
+ * @returns {Array<string>}
+ */
+export const possibleDids = createConverter(
+  String,
+  DockDid,
+  CheqdTestnetDid,
+  CheqdMainnetDid,
+);
+
 export { DockDidValue, DidMethodKeyPublicKey };
 export * from './cheqd-did';

packages/credential-sdk/src/types/generic/utils.js

@@ -6,3 +6,22 @@ export class ByteArray extends TypedBytes {}
 export class ArrayOfByteArrays extends TypedArray {
   static Class = TypedBytes;
 }
+
+export const createConverter = (finalize, parserClass, ...parsers) => (item) => {
+  const res = [item];
+  try {
+    const parsedDid = parserClass.from(item);
+
+    for (const parser of parsers) {
+      try {
+        res.push(parser.from(parsedDid));
+      } catch {
+        // Error is intentionally ignored
+      }
+    }
+  } catch {
+    // Error is intentionally ignored
+  }
+
+  return res.map(finalize);
+};

packages/credential-sdk/src/vc/CredentialIssuancePurpose.js

@@ -6,6 +6,7 @@ import jsonld from 'jsonld';
 import jsigs from 'jsonld-signatures';
 import { expandJSONLD } from './helpers';
 import { Bls12381BBDT16MacProofDockName } from './crypto/constants';
+import { possibleDids } from '../types/did/onchain/typed-did';
 
 const { AssertionProofPurpose } = jsigs.purposes;
 
@@ -85,7 +86,11 @@ export default class CredentialIssuancePurpose extends AssertionProofPurpose {
         throw new Error('Credential issuer is required.');
       }
 
-      if (result.controller.id !== issuer[0]['@id']) {
+      if (
+        possibleDids(issuer[0]['@id']).every(
+          (did) => did !== result.controller.id,
+        )
+      ) {
         throw new Error(
           'Credential issuer must match the verification method controller.',
         );

packages/credential-sdk/src/vc/crypto/common/DockCryptoSignature.js

@@ -13,6 +13,7 @@ import { u8aToU8a } from '../../../utils/bytes';
 import { withExtendedStaticProperties } from '../../../utils/inheritance';
 import CustomLinkedDataSignature from './CustomLinkedDataSignature';
 import { deepClone } from '../../../utils/misc';
+import { possibleVerificationMethodRefs } from '../../../types/did/document/verification-method-ref';
 
 const SUITE_CONTEXT_URL = 'https://www.w3.org/2018/credentials/v1';
 
@@ -543,21 +544,23 @@ export default withExtendedStaticProperties(
       if (!verificationMethod) {
         throw new Error('No "verificationMethod" found in proof.');
       }
+
       // Note: `expansionMap` is intentionally not passed; we can safely drop
       // properties here and must allow for it
       const result = await jsonld.frame(
         verificationMethod,
         {
           '@context': jsigs.SECURITY_CONTEXT_URL,
           '@embed': '@always',
-          id: verificationMethod,
+          id: possibleVerificationMethodRefs(verificationMethod),
         },
         {
           documentLoader,
           compactToRelative: false,
           expandContext: jsigs.SECURITY_CONTEXT_URL,
         },
       );
+
       if (!result) {
         throw new Error(`Verification method ${verificationMethod} not found.`);
       }

packages/credential-sdk/src/vc/helpers.js

@@ -24,16 +24,7 @@ import {
 } from './crypto/constants';
 import Bls12381BBDT16MACDock2024 from './crypto/Bls12381BBDT16MACDock2024';
 import { DidKeypair } from '../keypairs';
-import {
-  CheqdMainnetVerificationMethodRef,
-  CheqdTestnetVerificationMethodRef,
-  CheqdVerificationMethodRef,
-  VerificationMethodRef,
-} from '../types/did/document/verification-method-ref';
-import {
-  CheqdMainnetDid,
-  CheqdTestnetDid,
-} from '../types/did/onchain/typed-did';
+import { possibleVerificationMethodRefs } from '../types/did/document/verification-method-ref';
 
 /**
  * @typedef {object} KeyDoc The Options to use in the function createUser.
@@ -87,9 +78,6 @@ export async function getSuiteFromKeyDoc(keyDoc, useProofValue, options) {
     case Ed255192020VerKeyName:
       Cls = Ed25519Signature2020;
       break;
-    /* case Sr25519VerKeyName:
-      Cls = Sr25519Signature2020;
-      break; */
     case Bls12381BBSDockVerKeyName:
       Cls = Bls12381BBSSignatureDock2022;
       break;
@@ -147,43 +135,14 @@ export function potentialToArray(a) {
 
 /**
  * Compares a verification method reference with a key ID to determine if they are equivalent.
- * The function checks if the reference might start with `did:dock:`, and converts it to a `did:cheqd` format for comparison.
+ * The function checks if the reference might start with `did:dock:`, and converts it to a `did:cheqd:` format for comparison.
  *
  * @param {string} ref - The verification method reference to compare.
  * @param {string} keyId - The key ID to compare against.
  * @returns {boolean} - Returns `true` if the references are equivalent, `false` otherwise.
  */
-export const verMethodRefsEqual = (ref, keyId) => {
-  // If the reference matches the key ID directly, return true.
-  if (ref === keyId) {
-    return true;
-  }
-
-  try {
-    // Parse the key ID into a Cheqd verification method reference object.
-    let parsedKeyId = CheqdVerificationMethodRef.from(keyId);
-    const {
-      did: {
-        value: { constructor: CheqdDid },
-      },
-    } = parsedKeyId;
-
-    // Check if the parsed key ID corresponds to the Cheqd Testnet or Mainnet and convert accordingly.
-    if (CheqdDid === CheqdTestnetDid) {
-      parsedKeyId = CheqdTestnetVerificationMethodRef.from(keyId);
-    } else if (CheqdDid === CheqdMainnetDid) {
-      parsedKeyId = CheqdMainnetVerificationMethodRef.from(keyId);
-    } else {
-      throw new Error(`Unknown DID type: \`${CheqdDid.name}\``);
-    }
-
-    // Compare the parsed reference with the provided reference using `eq`.
-    return parsedKeyId.eq(VerificationMethodRef.from(ref));
-  } catch (err) {
-    // If an error occurs during parsing or comparison, assume the references are not equivalent.
-    return false;
-  }
-};
+export const verMethodRefsEqual = (ref, keyId) => ref === keyId
+  || possibleVerificationMethodRefs(ref).some((id) => id === keyId);
 
 export function getKeyFromDIDDocument(didDocument, didUrl) {
   // Ensure not already a key doc