Update Resolver to support MultiApi modules (#466)

* Update `Resolver` to support `MultiApi` modules

* Tweaks for tests and docs

* Example tweak

* Corrections

* Tutorial tweak

* Temporary disable autogenerated resolver tests

* Misc tweaks

* Tweaks

* Small tweak

* Fix docs

* Update scripts

* Tweaks

* More fixes

* Tweaks + update scripts

* Tweaks

* Lints

examples/bbs-dock.js

@@ -1,5 +1,5 @@
 import { initializeWasm } from '@docknetwork/credential-sdk/crypto';
-import { DIDResolver } from '@docknetwork/credential-sdk/resolver';
+import { Resolver } from '@docknetwork/credential-sdk/resolver';
 import Bls12381G2KeyPairDock2022 from '@docknetwork/credential-sdk/vc/crypto/Bls12381G2KeyPairDock2022';
 import {
   issueCredential,
@@ -15,8 +15,10 @@ const keypairOpts = {
     'przwNdX6Bn5TzwmX56fYKQr6vk5U2DsfJJHZJQzr1Sxd9oJUg1rEEoUP7Bz33WNpykvkkqoTByMwnceCx9yvTW8CG1V5XpSwHPSN222cwMe9xr4mViyLWkKtoraybEPeLHT',
 };
 
-class ExampleDIDResolver extends DIDResolver {
-  static METHOD = 'example';
+class ExampleDIDResolver extends Resolver {
+  prefix = 'did';
+
+  method = 'example';
 
   constructor() {
     super(void 0);

examples/resolver.js

@@ -6,13 +6,15 @@ import {
   DidKey,
   DIDDocument,
 } from '@docknetwork/credential-sdk/types';
+import { parseDIDUrl } from '@docknetwork/credential-sdk/utils';
 import { NoDIDError } from '@docknetwork/credential-sdk/modules/abstract/did';
 import {
-  DIDResolver,
   DIDKeyResolver,
   UniversalResolver,
   WILDCARD,
-  DockDIDResolver,
+  DIDResolver,
+  ResolverRouter,
+  Resolver,
 } from '@docknetwork/credential-sdk/resolver';
 import { DockDIDModule } from '@docknetwork/dock-blockchain-modules';
 
@@ -39,16 +41,18 @@ const dock = new DockAPI();
 const didModule = new DockDIDModule(dock);
 
 // Custom ethereum resolver class
-class EtherResolver extends DIDResolver {
-  static METHOD = 'ethr';
+class EtherResolver extends Resolver {
+  prefix = 'did';
+
+  method = 'ethr';
 
   constructor(config) {
     super();
     this.ethres = ethr.getResolver(config).ethr;
   }
 
   async resolve(did) {
-    const parsed = this.parseDid(did);
+    const parsed = parseDIDUrl(did);
     try {
       return this.ethres(did, parsed);
     } catch (e) {
@@ -86,12 +90,12 @@ async function main() {
 
   const resolvers = [
     new DIDKeyResolver(), // did:key resolver
-    new DockDIDResolver(didModule), // Prebuilt resolver
+    new DIDResolver(didModule), // Prebuilt resolver
     new EtherResolver(ethereumProviderConfig), // Custom resolver
   ];
 
-  class AnyDIDResolver extends DIDResolver {
-    static METHOD = WILDCARD;
+  class AnyDIDResolver extends ResolverRouter {
+    method = WILDCARD;
   }
 
   const resolver = new AnyDIDResolver([

examples/schema.js

@@ -21,8 +21,8 @@ import {
 
 import {
   UniversalResolver,
-  DockResolver,
-  WildcardMultiResolver,
+  CoreResolver,
+  WildcardResolverRouter,
 } from '@docknetwork/credential-sdk/resolver';
 
 const dock = new DockAPI();
@@ -103,8 +103,8 @@ async function main() {
   console.log('Result from chain:', result);
 
   const universalResolverUrl = 'https://uniresolver.io';
-  const resolver = new WildcardMultiResolver([
-    new DockResolver(modules),
+  const resolver = new WildcardResolverRouter([
+    new CoreResolver(modules),
     new UniversalResolver(universalResolverUrl),
   ]);
 

packages/cheqd-blockchain-api/src/index.js

@@ -6,7 +6,10 @@ import {
 } from '@docknetwork/credential-sdk/utils';
 import { DirectSecp256k1HdWallet } from '@cosmjs/proto-signing';
 import {
-  DIDModule, ResourceModule, createCheqdSDK, CheqdNetwork,
+  DIDModule,
+  ResourceModule,
+  createCheqdSDK,
+  CheqdNetwork,
 } from '@cheqd/sdk';
 import {
   MsgCreateDidDocPayload,
@@ -167,6 +170,10 @@ export class CheqdAPI extends ApiProvider {
     return res;
   }
 
+  methods() {
+    return ['cheqd'];
+  }
+
   supportsIdentifier(id) {
     this.ensureInitialized();
 
@@ -182,6 +189,8 @@ export class CheqdAPI extends ApiProvider {
       return this.supportsIdentifier(id[0]);
     } else if (id instanceof TypedEnum) {
       return this.supportsIdentifier(this.value);
+    } else if (id.Qualifier?.contains('cheqd:')) {
+      return true;
     }
 
     return false;

packages/cheqd-blockchain-modules/src/common/cheqd-api-provider.js

@@ -16,6 +16,10 @@ class CheqdApiProvider extends ApiProvider {
     return this.cheqd.fees;
   }
 
+  methods() {
+    return this.cheqd.methods();
+  }
+
   isInitialized() {
     return this.cheqd.isInitialized();
   }

packages/cheqd-blockchain-modules/src/common/inject-cheqd.js

@@ -1,7 +1,7 @@
 import { withExtendedStaticProperties } from '@docknetwork/credential-sdk/utils/inheritance';
 import CheqdAPIProvider from './cheqd-api-provider';
 
-export default function injectDock(klass) {
+export default function injectCheqd(klass) {
   const name = `withCheqd(${klass.name})`;
 
   const obj = {
@@ -22,6 +22,10 @@ export default function injectDock(klass) {
       supportsIdentifier(id) {
         return this.apiProvider.supportsIdentifier(id);
       }
+
+      methods() {
+        return this.apiProvider.methods();
+      }
     },
   };
 

packages/credential-sdk/src/modules/abstract/common/api-provider.js

@@ -2,6 +2,15 @@ import { withExtendedPrototypeProperties } from '../../../utils';
 
 class ApiProvider {
   /**
+   * Returns array of the methods supported by the given API.
+   * @returns {Array<string>}
+   */
+  methods() {
+    throw new Error('Unimplemented');
+  }
+
+  /**
+   * Returns `true` is the API was initialized.
    * @returns {boolean}
    */
   isInitialized() {
@@ -39,6 +48,6 @@ class ApiProvider {
  * Base class that must be extended by all API providers.
  */
 export default withExtendedPrototypeProperties(
-  ['isInitialized', 'stateChangeBytes', 'signAndSend'],
+  ['methods', 'isInitialized', 'stateChangeBytes', 'signAndSend'],
   ApiProvider,
 );

packages/credential-sdk/src/modules/abstract/common/base-module.js

@@ -1,7 +1,6 @@
-/**
- * Base module class that must be extended by all modules.
- */
-export default class AbstractBaseModule {
+import { withExtendedPrototypeProperties } from '../../../utils';
+
+class AbstractBaseModule {
   /**
    * Signs and sends provided extrinsic.
    *
@@ -19,3 +18,8 @@ export default class AbstractBaseModule {
     return await this.apiProvider.signAndSend(extrinsic, params);
   }
 }
+
+/**
+ * Base module class that must be extended by all modules.
+ */
+export default withExtendedPrototypeProperties(['methods'], AbstractBaseModule);

packages/credential-sdk/src/modules/abstract/index.js

@@ -54,7 +54,10 @@ export const AbstractCoreModules = withExtendedStaticProperties(
       AttestModule: { key: 'attest', optional: false },
       BlobModule: { key: 'blob', optional: false },
       DIDModule: { key: 'did', optional: false },
-      OffchainSignaturesModule: { key: 'offchainSignatures', optional: false },
+      OffchainSignaturesModule: {
+        key: 'offchainSignatures',
+        optional: false,
+      },
       BBSModule: { key: 'bbs', optional: false },
       BBSPlusModule: { key: 'bbsPlus', optional: false },
       PSModule: { key: 'ps', optional: false },

packages/credential-sdk/src/modules/multi-api/common.js

@@ -26,6 +26,10 @@ export function injectModuleRouter(klass) {
       dispatchById(id, fn) {
         return fn(this.moduleById(id));
       }
+
+      methods() {
+        return this.modules.flatMap((module) => module.methods());
+      }
     },
   };
 

packages/credential-sdk/src/modules/tests/blob-module.js

@@ -2,6 +2,8 @@ import { DidKeypair, Ed25519Keypair } from '../../keypairs';
 import { NoBlobError } from '../abstract/blob/errors';
 import { DIDDocument } from '../../types';
 import { itIf } from './common';
+import { BlobResolver } from '../../resolver/blob';
+import { stringToU8a } from '../../utils';
 
 // eslint-disable-next-line jest/no-export
 export default function generateBlobModuleTests(
@@ -56,5 +58,28 @@ export default function generateBlobModuleTests(
         new NoBlobError(id),
       );
     });
+
+    test('`BlobResolver`', async () => {
+      const resolver = new BlobResolver(blobModule);
+      const did = DID.random();
+
+      const keyPair = Ed25519Keypair.random();
+      const didKeypair = new DidKeypair([did, 1], keyPair);
+
+      const document = DIDDocument.create(did, [didKeypair.didKey()]);
+
+      await didModule.createDocument(document, didKeypair);
+
+      const blob1 = {
+        id: BlobId.random(did),
+        blob: 'abcdef',
+      };
+
+      await blobModule.new(blob1, didKeypair);
+      expect(await resolver.resolve(String(blob1.id))).toEqual([
+        String(did),
+        stringToU8a(blob1.blob),
+      ]);
+    });
   });
 }

packages/credential-sdk/src/modules/tests/did-module.js

@@ -1,4 +1,5 @@
 import { DidKeypair, Ed25519Keypair } from '../../keypairs';
+import { DIDResolver } from '../../resolver';
 import {
   DIDDocument,
   BBSPublicKeyValue,
@@ -229,5 +230,19 @@ export default function generateDIDModuleTests(
         new NoDIDError(did),
       );
     });
+
+    test('`DIDResolver`', async () => {
+      const resolver = new DIDResolver(module);
+      const did = DID.random();
+
+      const keyPair = Ed25519Keypair.random();
+      const didKeypair = new DidKeypair([did, 1], keyPair);
+
+      const document = DIDDocument.create(did, [didKeypair.didKey()]);
+
+      await module.createDocument(document, didKeypair);
+
+      expect(await resolver.resolve(String(did))).toEqual(document.toJSON());
+    });
   });
 }

packages/credential-sdk/src/resolver/blob/blob-resolver.js

@@ -1,9 +1,36 @@
-import { MultiResolver } from '../generic';
+import { ensureInstanceOf } from '../../utils';
+import { AbstractBlobModule } from '../../modules/abstract/blob';
+import { Resolver } from '../generic';
+
+class DockBlobResolver extends Resolver {
+  prefix = 'blob';
+
+  get method() {
+    return this.blobModule.methods();
+  }
+
+  /**
+   * @param {AbstractBlobModule}
+   * @constructor
+   */
+  constructor(blobModule) {
+    super();
+
+    /**
+     * @type {AbstractBlobModule}
+     */
+    this.blobModule = ensureInstanceOf(blobModule, AbstractBlobModule);
+  }
+
+  async resolve(blobUri) {
+    const [author, blob] = await this.blobModule.get(blobUri);
+
+    return [String(author), blob.toObjectOrBytes()];
+  }
+}
 
 /**
- * Resolves `Blob` with the identifier `blob:*`.
- * @abstract
+ * Resolves `Blob`s with identifier `blob:dock:*`.
+ * @type {DockBlobResolver}
  */
-export default class BlobResolver extends MultiResolver {
-  static PREFIX = 'blob';
-}
+export default DockBlobResolver;

packages/credential-sdk/src/resolver/blob/index.js

@@ -1,2 +1 @@
 export { default as BlobResolver } from './blob-resolver';
-export { default as DockBlobResolver } from './dock-blob-resolver';

packages/credential-sdk/src/resolver/core-resolver.js

@@ -0,0 +1,21 @@
+import { DIDResolver } from './did';
+import { StatusList2021Resolver } from './status-list2021';
+import { ResolverRouter } from './generic';
+import { BlobResolver } from './blob';
+import { ensureInstanceOf } from '../utils';
+import { AbstractCoreModules } from '../modules';
+
+/**
+ * Resolves dock-hosted entities such us `did:dock:*` and `status-list2021:dock:*`, `rev-reg:dock:*`, `blob:dock:*`.
+ */
+export default class CoreResolver extends ResolverRouter {
+  constructor(modules) {
+    ensureInstanceOf(modules, AbstractCoreModules);
+
+    super([
+      new DIDResolver(modules.did),
+      new StatusList2021Resolver(modules.statusListCredential),
+      new BlobResolver(modules.blob),
+    ]);
+  }
+}