@cheqd/did-provider-cheqd 1.1.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2021 Cheqd Foundation Limited (doing business as "cheqd")
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,34 @@
+# Veramo plugin template
+
+This template repository provides a bare-bones structure for writing an agent plugin for Veramo and/or for providing
+your own implementations for key management and storage, or for DID storage.
+
+## Quick start
+
+- Copy this repo
+- Rename package in `package.json`
+- `yarn`
+- `yarn build` or `yarn watch`
+- `yarn generate-plugin-schema`
+- `yarn start` or VSCode Debugger (CMD + Shift + D) > Run `OpenAPI server`
+
+## Structure of this template
+
+### Using plugin with @veramo/cli
+
+See [./agent.yml](./agent.yml) for an example Veramo CLI configuration that uses the plugin and customizations from this
+template alongside other Veramo plugins to create a fully functioning agent.
+
+## Testing your plugin
+
+There are a number of ways to test your plugin.
+
+### Integration tests
+
+Will be added in the nearest future.
+
+### Call your agent using the Veramo OpenAPI server
+
+You can also run `yarn veramo server` in your terminal and then go to <http://localhost:3335/api-docs> to see all the
+available plugin methods. You can call them after you click Authorize and provide the API key defined
+in [agent.yml](./agent.yml#L119). By default, it is `test123`.

package/build/did-manager/cheqd-did-provider.d.ts

@@ -0,0 +1,61 @@
+import { IIdentifier, IKey, IService, IAgentContext, IKeyManager } from '@veramo/core';
+import { AbstractIdentifierProvider } from '@veramo/did-manager';
+declare type IContext = IAgentContext<IKeyManager>;
+export declare enum DefaultRPCUrl {
+    Mainnet = "https://rpc.cheqd.net",
+    Testnet = "https://rpc.cheqd.network"
+}
+export declare enum NetworkType {
+    Mainnet = "mainnet",
+    Testnet = "testnet"
+}
+/**
+ * You can use this template for an `AbstractIdentifierProvider` implementation.
+ *
+ * Implementations of this interface are used by `@veramo/did-manager` to implement
+ * CRUD operations for various DID methods.
+ *
+ * If you wish to implement support for a particular DID method, this is the type of class
+ * you need to implement.
+ *
+ * If you don't want to customize this, then it is safe to remove from the template.
+ *
+ * @alpha
+ */
+export declare class CheqdDIDProvider extends AbstractIdentifierProvider {
+    private defaultKms;
+    private readonly network;
+    private rpcUrl;
+    constructor(options: {
+        defaultKms: string;
+        rpcUrl?: string;
+        networkType?: NetworkType;
+    });
+    createIdentifier({ kms, alias }: {
+        kms?: string;
+        alias?: string;
+    }, context: IContext): Promise<Omit<IIdentifier, 'provider'>>;
+    deleteIdentifier(identity: IIdentifier, context: IContext): Promise<boolean>;
+    addKey({ identifier, key, options, }: {
+        identifier: IIdentifier;
+        key: IKey;
+        options?: any;
+    }, context: IContext): Promise<any>;
+    addService({ identifier, service, options, }: {
+        identifier: IIdentifier;
+        service: IService;
+        options?: any;
+    }, context: IContext): Promise<any>;
+    removeKey(args: {
+        identifier: IIdentifier;
+        kid: string;
+        options?: any;
+    }, context: IContext): Promise<any>;
+    removeService(args: {
+        identifier: IIdentifier;
+        id: string;
+        options?: any;
+    }, context: IContext): Promise<any>;
+}
+export {};
+//# sourceMappingURL=cheqd-did-provider.d.ts.map

package/build/did-manager/cheqd-did-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheqd-did-provider.d.ts","sourceRoot":"","sources":["../../src/did-manager/cheqd-did-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,WAAW,EACX,IAAI,EACJ,QAAQ,EACR,aAAa,EACb,WAAW,EAEX,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAA;AAIhE,aAAK,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAC,CAAA;AAE1C,oBAAY,aAAa;IACvB,OAAO,0BAA0B;IACjC,OAAO,8BAA8B;CACtC;AAED,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,OAAO,YAAY;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAiB,SAAQ,0BAA0B;IAC/D,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,MAAM,CAAQ;gBAEV,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,WAAW,CAAA;KAAE;IAOjF,gBAAgB,CAErB,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAChD,OAAO,EAAE,QAAQ,GACf,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IA8BnC,gBAAgB,CACrB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,QAAQ,GACf,OAAO,CAAC,OAAO,CAAC;IAOb,MAAM,CACX,EAEC,UAAU,EAEV,GAAG,EAEH,OAAO,GAEP,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,GAAG,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAExD,OAAO,EAAE,QAAQ,GAEf,OAAO,CAAC,GAAG,CAAC;IAIT,UAAU,CACf,EAEC,UAAU,EAEV,OAAO,EAEP,OAAO,GAEP,EAAE;QAAE,UAAU,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,QAAQ,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,CAAA;KAAE,EAEhE,OAAO,EAAE,QAAQ,GAEf,OAAO,CAAC,GAAG,CAAC;IAIT,SAAS,CAEd,IAAI,EAAE;QACL,UAAU,EAAE,WAAW,CAAC;QACxB,GAAG,EAAE,MAAM,CAAC;QAEZ,OAAO,CAAC,EAAE,GAAG,CAAA;KACb,EAED,OAAO,EAAE,QAAQ,GAEf,OAAO,CAAC,GAAG,CAAC;IAIT,aAAa,CAElB,IAAI,EAAE;QACL,UAAU,EAAE,WAAW,CAAC;QACxB,EAAE,EAAE,MAAM,CAAC;QAEX,OAAO,CAAC,EAAE,GAAG,CAAA;KACb,EAED,OAAO,EAAE,QAAQ,GAEf,OAAO,CAAC,GAAG,CAAC;CAGf"}

package/build/did-manager/cheqd-did-provider.js

@@ -0,0 +1,129 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheqdDIDProvider = exports.NetworkType = exports.DefaultRPCUrl = void 0;
+const did_manager_1 = require("@veramo/did-manager");
+const multibase_1 = __importDefault(require("multibase"));
+const multicodec_1 = __importDefault(require("multicodec"));
+var DefaultRPCUrl;
+(function (DefaultRPCUrl) {
+    DefaultRPCUrl["Mainnet"] = "https://rpc.cheqd.net";
+    DefaultRPCUrl["Testnet"] = "https://rpc.cheqd.network";
+})(DefaultRPCUrl = exports.DefaultRPCUrl || (exports.DefaultRPCUrl = {}));
+var NetworkType;
+(function (NetworkType) {
+    NetworkType["Mainnet"] = "mainnet";
+    NetworkType["Testnet"] = "testnet";
+})(NetworkType = exports.NetworkType || (exports.NetworkType = {}));
+/**
+ * You can use this template for an `AbstractIdentifierProvider` implementation.
+ *
+ * Implementations of this interface are used by `@veramo/did-manager` to implement
+ * CRUD operations for various DID methods.
+ *
+ * If you wish to implement support for a particular DID method, this is the type of class
+ * you need to implement.
+ *
+ * If you don't want to customize this, then it is safe to remove from the template.
+ *
+ * @alpha
+ */
+class CheqdDIDProvider extends did_manager_1.AbstractIdentifierProvider {
+    constructor(options) {
+        super();
+        this.defaultKms = options.defaultKms;
+        this.network = options.networkType ? options.networkType : NetworkType.Testnet;
+        this.rpcUrl = options.rpcUrl ? options.rpcUrl : (this.network === NetworkType.Testnet ? DefaultRPCUrl.Testnet : DefaultRPCUrl.Mainnet);
+    }
+    createIdentifier(
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    { kms, alias }, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const key = yield context.agent.keyManagerCreate({
+                kms: kms || this.defaultKms,
+                type: 'Ed25519',
+            });
+            const methodSpecificId = Buffer.from(multibase_1.default.encode('base58btc', multicodec_1.default.addPrefix('ed25519-pub', Buffer.from(key.publicKeyHex, 'hex'))))
+                .toString()
+                .substr(0, 32);
+            const identifier = {
+                did: `did:cheqd:${this.network}:` + methodSpecificId,
+                controllerKeyId: key.kid,
+                keys: [key],
+                services: [],
+                provider: 'cheqd',
+            };
+            // TODO: Implement custom debugger on creation.
+            return identifier;
+        });
+    }
+    deleteIdentifier(identity, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const { kid } of identity.keys) {
+                yield context.agent.keyManagerDelete({ kid });
+            }
+            return true;
+        });
+    }
+    addKey({ 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    identifier, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    key, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options,
+    //  eslint-disable-next-line @typescript-eslint/no-explicit-any
+     }, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw Error('CheqdDIDProvider addKey not supported yet.');
+        });
+    }
+    addService({ 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    identifier, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    service, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options,
+    //  eslint-disable-next-line @typescript-eslint/no-explicit-any
+     }, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw Error('CheqdDIDProvider addService not supported yet.');
+        });
+    }
+    removeKey(
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    args, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw Error('CheqdDIDProvider removeKey not supported yet.');
+        });
+    }
+    removeService(
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    args, 
+    //  eslint-disable-next-line @typescript-eslint/no-unused-vars
+    context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throw Error('CheqdDIDProvider removeService not supported yet.');
+        });
+    }
+}
+exports.CheqdDIDProvider = CheqdDIDProvider;
+//# sourceMappingURL=cheqd-did-provider.js.map

package/build/did-manager/cheqd-did-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheqd-did-provider.js","sourceRoot":"","sources":["../../src/did-manager/cheqd-did-provider.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQA,qDAAgE;AAChE,0DAAiC;AACjC,4DAAmC;AAInC,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,kDAAiC,CAAA;IACjC,sDAAqC,CAAA;AACvC,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;AACpB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED;;;;;;;;;;;;GAYG;AACH,MAAa,gBAAiB,SAAQ,wCAA0B;IAK/D,YAAY,OAA2E;QACtF,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAA;QAC9E,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,OAAO,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAE,CAAA;IACzI,CAAC;IAEK,gBAAgB;IACrB,8DAA8D;IAC9D,EAAE,GAAG,EAAE,KAAK,EAAoC,EAChD,OAAiB;;YAEjB,MAAM,GAAG,GAAmB,MAAM,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC;gBAChE,GAAG,EAAE,GAAG,IAAI,IAAI,CAAC,UAAU;gBAC3B,IAAI,EAAE,SAAS;aACf,CAAC,CAAA;YAEF,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CACnC,mBAAS,CAAC,MAAM,CACf,WAAW,EACX,oBAAU,CAAC,SAAS,CACnB,aAAa,EACb,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CACpC,CACD,CACD;iBACC,QAAQ,EAAE;iBACV,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YAEf,MAAM,UAAU,GAAgB;gBAC/B,GAAG,EAAE,aAAa,IAAI,CAAC,OAAO,GAAG,GAAG,gBAAgB;gBACpD,eAAe,EAAE,GAAG,CAAC,GAAG;gBACxB,IAAI,EAAE,CAAC,GAAG,CAAC;gBACX,QAAQ,EAAE,EAAE;gBACZ,QAAQ,EAAE,OAAO;aACjB,CAAA;YAED,+CAA+C;YAC/C,OAAO,UAAU,CAAA;QAClB,CAAC;KAAA;IAEK,gBAAgB,CACrB,QAAqB,EACrB,OAAiB;;YAEjB,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,QAAQ,CAAC,IAAI,EAAE;gBACpC,MAAM,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;aAC7C;YACD,OAAO,IAAI,CAAA;QACZ,CAAC;KAAA;IAEK,MAAM,CACX;IACC,8DAA8D;IAC9D,UAAU;IACV,8DAA8D;IAC9D,GAAG;IACH,8DAA8D;IAC9D,OAAO;IACP,+DAA+D;MACR;IACxD,8DAA8D;IAC9D,OAAiB;;YAGjB,MAAM,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC1D,CAAC;KAAA;IAEK,UAAU,CACf;IACC,8DAA8D;IAC9D,UAAU;IACV,8DAA8D;IAC9D,OAAO;IACP,8DAA8D;IAC9D,OAAO;IACP,+DAA+D;MACA;IAChE,8DAA8D;IAC9D,OAAiB;;YAGjB,MAAM,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAC9D,CAAC;KAAA;IAEK,SAAS;IACd,8DAA8D;IAC9D,IAKC;IACD,8DAA8D;IAC9D,OAAiB;;YAGjB,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAC7D,CAAC;KAAA;IAEK,aAAa;IAClB,8DAA8D;IAC9D,IAKC;IACD,8DAA8D;IAC9D,OAAiB;;YAGjB,MAAM,KAAK,CAAC,mDAAmD,CAAC,CAAA;QACjE,CAAC;KAAA;CACD;AAvHD,4CAuHC"}

package/build/did-manager/cheqd-did-resolver.d.ts

@@ -0,0 +1,9 @@
+import { DIDResolutionOptions, DIDResolutionResult, DIDResolver, ParsedDID, Resolvable } from 'did-resolver';
+export declare function getResolver(resolverUrl?: string): Record<string, DIDResolver>;
+export declare class CheqdDidResolver {
+    private resolverUrl;
+    constructor(resolverUrl?: string);
+    resolve(did: string, parsed: ParsedDID, _unused: Resolvable, options: DIDResolutionOptions): Promise<DIDResolutionResult>;
+    build(): Record<string, DIDResolver>;
+}
+//# sourceMappingURL=cheqd-did-resolver.d.ts.map

package/build/did-manager/cheqd-did-resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheqd-did-resolver.d.ts","sourceRoot":"","sources":["../../src/did-manager/cheqd-did-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,EACX,SAAS,EACT,UAAU,EACX,MAAM,cAAc,CAAA;AAMrB,wBAAgB,WAAW,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAI7E;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,WAAW,CAC4B;gBAEnC,WAAW,CAAC,EAAE,MAAM;IAI1B,OAAO,CACX,GAAG,EAAE,MAAM,EAEX,MAAM,EAAE,SAAS,EAEjB,OAAO,EAAE,UAAU,EAEnB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,mBAAmB,CAAC;IAY/B,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC;CAGrC"}

package/build/did-manager/cheqd-did-resolver.js

@@ -0,0 +1,53 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheqdDidResolver = exports.getResolver = void 0;
+/* interface Options {
+    resolver: Resolvable
+} */
+function getResolver(resolverUrl) {
+    if (resolverUrl)
+        return new CheqdDidResolver(resolverUrl).build();
+    return new CheqdDidResolver().build();
+}
+exports.getResolver = getResolver;
+class CheqdDidResolver {
+    constructor(resolverUrl) {
+        this.resolverUrl = 'https://resolver.cheqd.net/1.0/identifiers/';
+        if (resolverUrl)
+            this.resolverUrl = resolverUrl;
+    }
+    resolve(did, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    parsed, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _unused, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield fetch(this.resolverUrl + did, {
+                    headers: { 'Content-Type': 'application/did+json' },
+                });
+                const ddo = (yield result.json());
+                return ddo;
+            }
+            catch (e) {
+                return Promise.reject(e);
+            }
+        });
+    }
+    build() {
+        return { cheqd: this.resolve.bind(this) };
+    }
+}
+exports.CheqdDidResolver = CheqdDidResolver;
+//# sourceMappingURL=cheqd-did-resolver.js.map

package/build/did-manager/cheqd-did-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cheqd-did-resolver.js","sourceRoot":"","sources":["../../src/did-manager/cheqd-did-resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAQA;;IAEI;AAEJ,SAAgB,WAAW,CAAC,WAAoB;IAC9C,IAAI,WAAW;QAAE,OAAO,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,CAAA;IAEjE,OAAO,IAAI,gBAAgB,EAAE,CAAC,KAAK,EAAE,CAAA;AACvC,CAAC;AAJD,kCAIC;AAED,MAAa,gBAAgB;IAI3B,YAAY,WAAoB;QAHxB,gBAAW,GACjB,6CAA6C,CAAA;QAG7C,IAAI,WAAW;YAAE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IACjD,CAAC;IAEK,OAAO,CACX,GAAW;IACX,6DAA6D;IAC7D,MAAiB;IACjB,6DAA6D;IAC7D,OAAmB;IACnB,6DAA6D;IAC7D,OAA6B;;YAE7B,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,WAAW,GAAG,GAAG,EAAE;oBACjD,OAAO,EAAE,EAAE,cAAc,EAAE,sBAAsB,EAAE;iBACpD,CAAC,CAAA;gBACF,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAwB,CAAA;gBACxD,OAAO,GAAG,CAAA;aACX;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;aACzB;QACH,CAAC;KAAA;IAED,KAAK;QACH,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;IAC3C,CAAC;CACF;AA/BD,4CA+BC"}

package/build/did-manager/resolver.d.ts

@@ -0,0 +1,46 @@
+import { DIDResolver } from 'did-resolver';
+interface Options {
+    url: string;
+}
+/**
+ * @deprecated please use `getUniresolver(url)` or `getUniresolverFor(methods, url)` instead
+ */
+export declare class CheqdResolver {
+    constructor(options: Options);
+}
+/**
+ * Creates a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolver()
+ * const resolver = new Resolver({
+ *   web: uniResolver,
+ *   key: uniResolver,
+ *   elem: uniResolver
+ * })
+ * ```
+ *
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `DIDResolver`
+ */
+export declare function getUniversalResolver(url?: string): DIDResolver;
+/**
+ * Creates a mapping of DID methods to a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolverFor(['web', 'key', 'elem'])
+ * const resolver = new Resolver({
+ *   ...uniResolver,
+ *   // other resolvers
+ * })
+ * ```
+ *
+ * @param methods an array of DID methods that should be resolved by this universal resolver
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `Record<string, DIDResolver>` a mapping of the given methods to an instance of `DIDResolver`
+ */
+export declare function getUniversalResolverFor(methods: string[], url?: string): Record<string, DIDResolver>;
+export {};
+//# sourceMappingURL=resolver.d.ts.map

package/build/did-manager/resolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../../src/did-manager/resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE1C,UAAU,OAAO;IACf,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,qBAAa,aAAa;gBACZ,OAAO,EAAE,OAAO;CAG7B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,SAAgD,GAClD,WAAW,CAmBb;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,SAAgD,GAClD,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAO7B"}

package/build/did-manager/resolver.js

@@ -0,0 +1,83 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUniversalResolverFor = exports.getUniversalResolver = exports.CheqdResolver = void 0;
+/**
+ * @deprecated please use `getUniresolver(url)` or `getUniresolverFor(methods, url)` instead
+ */
+class CheqdResolver {
+    constructor(options) {
+        return getUniversalResolver(options.url);
+    }
+}
+exports.CheqdResolver = CheqdResolver;
+/**
+ * Creates a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolver()
+ * const resolver = new Resolver({
+ *   web: uniResolver,
+ *   key: uniResolver,
+ *   elem: uniResolver
+ * })
+ * ```
+ *
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `DIDResolver`
+ */
+function getUniversalResolver(url = 'https://resolver.cheqd.net/1.0/identifiers/') {
+    if (!url) {
+        throw Error('[did-resolver] Universal: url required');
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const resolve = (didUrl) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const result = yield fetch(url + didUrl, {
+                headers: { 'Content-Type': 'application/did+ld+json' },
+            });
+            const ddo = yield result.json();
+            return ddo;
+        }
+        catch (e) {
+            return Promise.reject(e);
+        }
+    });
+    return resolve;
+}
+exports.getUniversalResolver = getUniversalResolver;
+/**
+ * Creates a mapping of DID methods to a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolverFor(['web', 'key', 'elem'])
+ * const resolver = new Resolver({
+ *   ...uniResolver,
+ *   // other resolvers
+ * })
+ * ```
+ *
+ * @param methods an array of DID methods that should be resolved by this universal resolver
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `Record<string, DIDResolver>` a mapping of the given methods to an instance of `DIDResolver`
+ */
+function getUniversalResolverFor(methods, url = 'https://resolver.cheqd.net/1.0/identifiers/') {
+    const uniResolver = getUniversalResolver(url);
+    const mapping = {};
+    for (const method of methods) {
+        mapping[method] = uniResolver;
+    }
+    return mapping;
+}
+exports.getUniversalResolverFor = getUniversalResolverFor;
+//# sourceMappingURL=resolver.js.map

package/build/did-manager/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../../src/did-manager/resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAMA;;GAEG;AACH,MAAa,aAAa;IACxB,YAAY,OAAgB;QAC1B,OAAO,oBAAoB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1C,CAAC;CACF;AAJD,sCAIC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,oBAAoB,CAClC,GAAG,GAAG,6CAA6C;IAEnD,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,KAAK,CAAC,wCAAwC,CAAC,CAAA;KACtD;IAED,8DAA8D;IAC9D,MAAM,OAAO,GAAgB,CAAO,MAAc,EAAgB,EAAE;QAClE,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,MAAM,EAAE;gBACvC,OAAO,EAAE,EAAE,cAAc,EAAE,yBAAyB,EAAE;aACvD,CAAC,CAAA;YACF,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAA;YAC/B,OAAO,GAAG,CAAA;SACX;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;SACzB;IACH,CAAC,CAAA,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AArBD,oDAqBC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,uBAAuB,CACrC,OAAiB,EACjB,GAAG,GAAG,6CAA6C;IAEnD,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;IAC7C,MAAM,OAAO,GAAgC,EAAE,CAAA;IAC/C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,OAAO,CAAC,MAAM,CAAC,GAAG,WAAW,CAAA;KAC9B;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAVD,0DAUC"}

package/build/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @public
+ */
+declare const schema: any;
+export { schema };
+export { CheqdDIDProvider } from './did-manager/cheqd-did-provider';
+export { CheqdDidResolver, getResolver } from './did-manager/cheqd-did-resolver';
+export { CheqdResolver } from './did-manager/resolver';
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,QAAA,MAAM,MAAM,KAAmC,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACnE,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAChF,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA"}

package/build/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheqdResolver = exports.getResolver = exports.CheqdDidResolver = exports.CheqdDIDProvider = exports.schema = void 0;
+/**
+ * @public
+ */
+// It can be disabled even not import statement is needed
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const schema = require('../plugin.schema.json');
+exports.schema = schema;
+var cheqd_did_provider_1 = require("./did-manager/cheqd-did-provider");
+Object.defineProperty(exports, "CheqdDIDProvider", { enumerable: true, get: function () { return cheqd_did_provider_1.CheqdDIDProvider; } });
+var cheqd_did_resolver_1 = require("./did-manager/cheqd-did-resolver");
+Object.defineProperty(exports, "CheqdDidResolver", { enumerable: true, get: function () { return cheqd_did_resolver_1.CheqdDidResolver; } });
+Object.defineProperty(exports, "getResolver", { enumerable: true, get: function () { return cheqd_did_resolver_1.getResolver; } });
+var resolver_1 = require("./did-manager/resolver");
+Object.defineProperty(exports, "CheqdResolver", { enumerable: true, get: function () { return resolver_1.CheqdResolver; } });
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAAyD;AACzD,8DAA8D;AAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAA;AACtC,wBAAM;AACf,uEAAmE;AAA1D,sHAAA,gBAAgB,OAAA;AACzB,uEAAgF;AAAvE,sHAAA,gBAAgB,OAAA;AAAE,iHAAA,WAAW,OAAA;AACtC,mDAAsD;AAA7C,yGAAA,aAAa,OAAA"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@cheqd/did-provider-cheqd",
+  "version": "1.1.1",
+  "description": "Veramo SDK plugin for the did:cheqd DID method",
+  "licence": "Apache-2.0",
+  "source": "src/index.ts",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "author": "Cheqd Foundation Limited (https://github.com/cheqd)",
+  "repository": "https://github.com/cheqd/did-provider-cheqd.git",
+  "bugs": {
+    "url": "https://github.com/cheqd/did-provider-cheqd/issues"
+  },
+  "homepage": "https://github.com/cheqd/did-provider-cheqd#readme",
+  "veramo": {
+    "pluginInterfaces": {
+      "IMyAgentPlugin": "./src/types/IMyAgentPlugin.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "generate-plugin-schema": "yarn veramo dev generate-plugin-schema",
+    "start": "veramo server",
+    "build:watch": "tsc -b --watch",
+    "test:ci": "jest --config=jest.json",
+    "test": "jest --passWithNoTests",
+    "test:watch": "yarn test --watch --verbose",
+    "clean": "rm -rf tmp && rm database.sqlite && rm -rf build && rm tsconfig.tsbuildinfo",
+    "lint": "eslint --max-warnings=0 src",
+    "semantic": "npx semantic-release"
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "typescript",
+      "prettier"
+    ]
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^8.0.5",
+    "@semantic-release/npm": "^9.0.1",
+    "@semantic-release/release-notes-generator": "^10.0.3",
+    "@types/jest": "27.5.1",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
+    "@veramo/cli": "^3.1.5",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-typescript": "^3.0.0",
+    "jest": "27.5.1",
+    "prettier": "^2.7.1",
+    "semantic-release": "^19.0.3",
+    "ts-jest": "27.1.5",
+    "typescript": "4.7.3"
+  },
+  "files": [
+    "build/**/*",
+    "src/**/*",
+    "README.md",
+    "plugin.schema.json",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@veramo/core": "^3.1.3",
+    "@veramo/did-manager": "^3.1.3",
+    "@veramo/did-provider-key": "^3.1.3",
+    "@veramo/key-manager": "^3.1.3",
+    "debug": "^4.3.4",
+    "multibase": "^4.0.6",
+    "multicodec": "^3.2.1"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/plugin.schema.json

@@ -0,0 +1,48 @@
+{
+  "IMyAgentPlugin": {
+    "components": {
+      "schemas": {
+        "IMyAgentPluginFooArgs": {
+          "type": "object",
+          "properties": {
+            "did": {
+              "type": "string",
+              "description": "Decentralized identifier"
+            },
+            "bar": {
+              "type": "string",
+              "description": "Lorem ipsum"
+            },
+            "foo": {
+              "type": "string",
+              "description": "Dolorem"
+            }
+          },
+          "required": ["did", "bar", "foo"],
+          "description": "Arguments needed for  {@link  MyAgentPlugin.myPluginFoo } \nTo be able to export a plugin schema, your plugin methods should use an `args` parameter of a named type or interface."
+        },
+        "IMyAgentPluginFooResult": {
+          "type": "object",
+          "properties": {
+            "foobar": {
+              "type": "string"
+            },
+            "baz": {}
+          },
+          "description": "Result of  {@link  MyAgentPlugin.myPluginFoo } \nTo be able to export a plugin schema, your plugin return types need to be Promises of a named type or interface."
+        }
+      },
+      "methods": {
+        "myPluginFoo": {
+          "description": "Your plugin method description",
+          "arguments": {
+            "$ref": "#/components/schemas/IMyAgentPluginFooArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/IMyAgentPluginFooResult"
+          }
+        }
+      }
+    }
+  }
+}

package/src/did-manager/cheqd-did-provider.ts

@@ -0,0 +1,157 @@
+import {
+	IIdentifier,
+	IKey,
+	IService,
+	IAgentContext,
+	IKeyManager,
+	ManagedKeyInfo,
+} from '@veramo/core'
+import { AbstractIdentifierProvider } from '@veramo/did-manager'
+import Multibase from 'multibase'
+import Multicodec from 'multicodec'
+
+type IContext = IAgentContext<IKeyManager>
+
+export enum DefaultRPCUrl {
+  Mainnet = 'https://rpc.cheqd.net',
+  Testnet = 'https://rpc.cheqd.network'
+}
+
+export enum NetworkType {
+	Mainnet = "mainnet",
+	Testnet = "testnet"
+}
+
+/**
+ * You can use this template for an `AbstractIdentifierProvider` implementation.
+ *
+ * Implementations of this interface are used by `@veramo/did-manager` to implement
+ * CRUD operations for various DID methods.
+ *
+ * If you wish to implement support for a particular DID method, this is the type of class
+ * you need to implement.
+ *
+ * If you don't want to customize this, then it is safe to remove from the template.
+ *
+ * @alpha
+ */
+export class CheqdDIDProvider extends AbstractIdentifierProvider {
+	private defaultKms: string
+	private readonly network: NetworkType
+	private rpcUrl: string
+
+	constructor(options: { defaultKms: string, rpcUrl?: string, networkType?: NetworkType }) {
+		super()
+		this.defaultKms = options.defaultKms
+		this.network = options.networkType ? options.networkType : NetworkType.Testnet
+		this.rpcUrl = options.rpcUrl ? options.rpcUrl : ( this.network === NetworkType.Testnet ? DefaultRPCUrl.Testnet : DefaultRPCUrl.Mainnet )
+	}
+
+	async createIdentifier(
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		{ kms, alias }: { kms?: string; alias?: string },
+		context: IContext,
+	): Promise<Omit<IIdentifier, 'provider'>> {
+		const key: ManagedKeyInfo = await context.agent.keyManagerCreate({
+			kms: kms || this.defaultKms,
+			type: 'Ed25519',
+		})
+
+		const methodSpecificId = Buffer.from(
+			Multibase.encode(
+				'base58btc',
+				Multicodec.addPrefix(
+					'ed25519-pub',
+					Buffer.from(key.publicKeyHex, 'hex'),
+				),
+			),
+		)
+			.toString()
+			.substr(0, 32)
+
+		const identifier: IIdentifier = {
+			did: `did:cheqd:${this.network}:` + methodSpecificId,
+			controllerKeyId: key.kid,
+			keys: [key],
+			services: [],
+			provider: 'cheqd',
+		}
+
+		// TODO: Implement custom debugger on creation.
+		return identifier
+	}
+
+	async deleteIdentifier(
+		identity: IIdentifier,
+		context: IContext,
+	): Promise<boolean> {
+		for (const { kid } of identity.keys) {
+			await context.agent.keyManagerDelete({ kid })
+		}
+		return true
+	}
+
+	async addKey(
+		{
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			identifier,
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			key,
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			options,
+			//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+		}: { identifier: IIdentifier; key: IKey; options?: any },
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		context: IContext,
+		//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+	): Promise<any> {
+		throw Error('CheqdDIDProvider addKey not supported yet.')
+	}
+
+	async addService(
+		{
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			identifier,
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			service,
+			//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+			options,
+			//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+		}: { identifier: IIdentifier; service: IService; options?: any },
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		context: IContext,
+		//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+	): Promise<any> {
+		throw Error('CheqdDIDProvider addService not supported yet.')
+	}
+
+	async removeKey(
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		args: {
+			identifier: IIdentifier;
+			kid: string;
+			//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+			options?: any
+		},
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		context: IContext,
+		//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+	): Promise<any> {
+		throw Error('CheqdDIDProvider removeKey not supported yet.')
+	}
+
+	async removeService(
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		args: {
+			identifier: IIdentifier;
+			id: string;
+			//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+			options?: any
+		},
+		//  eslint-disable-next-line @typescript-eslint/no-unused-vars
+		context: IContext,
+		//  eslint-disable-next-line @typescript-eslint/no-explicit-any
+	): Promise<any> {
+		throw Error('CheqdDIDProvider removeService not supported yet.')
+	}
+}

package/src/did-manager/cheqd-did-resolver.ts

@@ -0,0 +1,50 @@
+import {
+  DIDResolutionOptions,
+  DIDResolutionResult,
+  DIDResolver,
+  ParsedDID,
+  Resolvable,
+} from 'did-resolver'
+
+/* interface Options {
+    resolver: Resolvable
+} */
+
+export function getResolver(resolverUrl?: string): Record<string, DIDResolver> {
+  if (resolverUrl) return new CheqdDidResolver(resolverUrl).build()
+
+  return new CheqdDidResolver().build()
+}
+
+export class CheqdDidResolver {
+  private resolverUrl: undefined | string =
+    'https://resolver.cheqd.net/1.0/identifiers/'
+
+  constructor(resolverUrl?: string) {
+    if (resolverUrl) this.resolverUrl = resolverUrl
+  }
+
+  async resolve(
+    did: string,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    parsed: ParsedDID,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _unused: Resolvable,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    options: DIDResolutionOptions,
+  ): Promise<DIDResolutionResult> {
+    try {
+      const result = await fetch(this.resolverUrl + did, {
+        headers: { 'Content-Type': 'application/did+json' },
+      })
+      const ddo = (await result.json()) as DIDResolutionResult
+      return ddo
+    } catch (e) {
+      return Promise.reject(e)
+    }
+  }
+
+  build(): Record<string, DIDResolver> {
+    return { cheqd: this.resolve.bind(this) }
+  }
+}

package/src/did-manager/resolver.ts

@@ -0,0 +1,81 @@
+import { DIDResolver } from 'did-resolver'
+
+interface Options {
+  url: string
+}
+
+/**
+ * @deprecated please use `getUniresolver(url)` or `getUniresolverFor(methods, url)` instead
+ */
+export class CheqdResolver {
+  constructor(options: Options) {
+    return getUniversalResolver(options.url)
+  }
+}
+
+/**
+ * Creates a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolver()
+ * const resolver = new Resolver({
+ *   web: uniResolver,
+ *   key: uniResolver,
+ *   elem: uniResolver
+ * })
+ * ```
+ *
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `DIDResolver`
+ */
+export function getUniversalResolver(
+  url = 'https://resolver.cheqd.net/1.0/identifiers/',
+): DIDResolver {
+  if (!url) {
+    throw Error('[did-resolver] Universal: url required')
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const resolve: DIDResolver = async (didUrl: string): Promise<any> => {
+    try {
+      const result = await fetch(url + didUrl, {
+        headers: { 'Content-Type': 'application/did+ld+json' },
+      })
+      const ddo = await result.json()
+      return ddo
+    } catch (e) {
+      return Promise.reject(e)
+    }
+  }
+
+  return resolve
+}
+
+/**
+ * Creates a mapping of DID methods to a DIDResolver instance that can be used with `did-resolver`
+ *
+ * @example
+ * ```typescript
+ * const uniResolver = getUniversalResolverFor(['web', 'key', 'elem'])
+ * const resolver = new Resolver({
+ *   ...uniResolver,
+ *   // other resolvers
+ * })
+ * ```
+ *
+ * @param methods an array of DID methods that should be resolved by this universal resolver
+ * @param url the URL for the universal resolver instance (See https://uniresolver.io )
+ * @returns `Record<string, DIDResolver>` a mapping of the given methods to an instance of `DIDResolver`
+ */
+export function getUniversalResolverFor(
+  methods: string[],
+  url = 'https://resolver.cheqd.net/1.0/identifiers/',
+): Record<string, DIDResolver> {
+  const uniResolver = getUniversalResolver(url)
+  const mapping: Record<string, DIDResolver> = {}
+  for (const method of methods) {
+    mapping[method] = uniResolver
+  }
+  return mapping
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+/**
+ * @public
+ */
+// It can be disabled even not import statement is needed
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const schema = require('../plugin.schema.json')
+export { schema }
+export { CheqdDIDProvider } from './did-manager/cheqd-did-provider'
+export { CheqdDidResolver, getResolver } from './did-manager/cheqd-did-resolver'
+export { CheqdResolver } from './did-manager/resolver'