Improve docs + force DIDDocument to check for duplicates

docknetwork · Oct 10, 2024 · b3ff16a · b3ff16a
1 parent 395f5cc
commit b3ff16a
Show file tree

Hide file tree

Showing 19 changed files with 225 additions and 49 deletions.
diff --git a/examples/CHANGELOG.md b/examples/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @docknetwork/sdk-examples
 
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/dock-blockchain-modules@0.2.0
+  - @docknetwork/credential-sdk@0.2.0
+  - @docknetwork/dock-blockchain-api@0.1.2
+
 ## 0.1.1
 
 ### Patch Changes

diff --git a/examples/package.json b/examples/package.json
@@ -2,7 +2,7 @@
   "name": "@docknetwork/sdk-examples",
   "private": true,
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "scripts": {
     "bbs-dock-example": "babel-node --loader=./loader.mjs ./bbs-dock.js",
     "claim-deduction-example": "babel-node --loader=./loader.mjs ./claim-deduction.js",
@@ -19,9 +19,9 @@
     "lint": "eslint \"*.js\""
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.1.1",
-    "@docknetwork/dock-blockchain-api": "0.1.1",
-    "@docknetwork/dock-blockchain-modules": "0.1.1"
+    "@docknetwork/credential-sdk": "0.2.0",
+    "@docknetwork/dock-blockchain-api": "0.1.2",
+    "@docknetwork/dock-blockchain-modules": "0.2.0"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",

diff --git a/packages/cheqd-blockchain-api/CHANGELOG.md b/packages/cheqd-blockchain-api/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @docknetwork/cheqd-blockchain-api
 
+## 0.1.2
+
+### Patch Changes
+
+- Change `DIDDocument` modification behaviour to throw error on attempt to add key/service/controller with duplicate id.
+
 ## 0.1.1
 
 ### Minor Changes

diff --git a/packages/cheqd-blockchain-api/package.json b/packages/cheqd-blockchain-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/cheqd-blockchain-api",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "main": "./dist/esm/index.js",
   "type": "module",
@@ -27,6 +27,9 @@
   "engines": {
     "node": ">=20.0.0"
   },
+  "dependencies": {
+    "@cheqd/sdk": "^4.0.4"
+  },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
     "@babel/core": "^7.24.3",
@@ -78,11 +81,5 @@
     "watch": "rollup -c -w",
     "docs": "rm -rf out && mkdir out && touch out/.nojekyll && jsdoc src -r -c ../../.jsdoc -d out/reference",
     "type-check": "tsc --allowJs --checkJs --noEmit --moduleResolution node --resolveJsonModule --target ES6 --skipLibCheck true --allowSyntheticDefaultImports true"
-  },
-  "resolutions": {
-    "@polkadot/api": "10.12.4"
-  },
-  "dependencies": {
-    "@cheqd/sdk": "^4.0.4"
   }
 }
diff --git a/packages/cheqd-blockchain-modules/CHANGELOG.md b/packages/cheqd-blockchain-modules/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @docknetwork/cheqd-blockchain-modules
 
+## 0.2.0
+
+### Minor Changes
+
+- Change `DIDDocument` modification behaviour to throw error on attempt to add key/service/controller with duplicate id.
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.2.0
+
 ## 0.1.1
 
 ### Minor Changes

diff --git a/packages/cheqd-blockchain-modules/README.md b/packages/cheqd-blockchain-modules/README.md
@@ -1,6 +1,4 @@
-# @docknetwork/cheqd-blockchain-modules
-
-A JavaScript library created for managing credential SDK components such as DIDs and accumulators etc on the Cheqd blockchain.
+# Cheqd Blockchain Modules
 
 ## Setup
 
@@ -76,9 +74,6 @@ expect((await attestModule.getDocument(did)).attests.toJSON()).toEqual(iri);
 - Accumulator
 - Anchor
 - Blob
-- OffchainSignatures
-- BBS
-- BBSPlus
-- PS
+- OffchainSignatures params (BBS/BBSPlus/PS)
 - StatusListCredential
 - TrustRegistry
diff --git a/packages/cheqd-blockchain-modules/package.json b/packages/cheqd-blockchain-modules/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/cheqd-blockchain-modules",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/esm/index.js",
@@ -28,7 +28,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.1.1"
+    "@docknetwork/credential-sdk": "0.2.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
@@ -37,7 +37,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.1.1",
+    "@docknetwork/cheqd-blockchain-api": "0.1.2",
     "@rollup/plugin-alias": "^4.0.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^24.0.0",

diff --git a/packages/credential-sdk/CHANGELOG.md b/packages/credential-sdk/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @docknetwork/credential-sdk
 
+## 0.2.0
+
+### Minor Changes
+
+- Change `DIDDocument` modification behaviour to throw error on attempt to add key/service/controller with duplicate id.
+
 ## 0.1.1
 
 ### Minor Changes

diff --git a/packages/credential-sdk/package.json b/packages/credential-sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/credential-sdk",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "MIT",
   "type": "module",
   "files": [

diff --git a/packages/credential-sdk/src/types/did/document.js b/packages/credential-sdk/src/types/did/document.js
@@ -7,6 +7,7 @@ import {
   TypedBytes,
   TypedEnum,
   TypedNumber,
+  TypedSet,
   TypedString,
   TypedStruct,
   TypedTuple,
@@ -574,12 +575,18 @@ export class DIDDocument extends TypedStruct {
   }
 
   addController(controller) {
+    if (this.controller.some((ctrl) => ctrl.eq(controller))) {
+      throw new Error(`Controller \`${controller}\` already exists`);
+    }
     this.controller.push(controller);
 
     return this;
   }
 
   addServiceEndpoint(id, serviceEndpoint) {
+    if (this.service.some((service) => service.id.eq(id))) {
+      throw new Error(`Service endpoint with id \`${id}\` already exists`);
+    }
     this.service.push(Service.fromServiceEndpoint(id, serviceEndpoint));
 
     return this;
@@ -632,31 +639,30 @@ export class DIDDocument extends TypedStruct {
       assertionMethod,
       keyAgreement,
       capabilityInvocation,
-      capabilityDelegation,
     } = this;
 
-    if (capabilityDelegation && capabilityDelegation.length > 0) {
-      throw new Error('Capability delegation is not supported');
+    class VerificationMethodRefSet extends TypedSet {
+      static Class = VerificationMethodRef;
     }
 
-    const auth = new Set([...authentication].map(String));
-    const assertion = new Set([...assertionMethod].map(String));
-    const keyAgr = new Set([...keyAgreement].map(String));
-    const capInv = new Set([...capabilityInvocation].map(String));
+    const auth = new VerificationMethodRefSet(authentication);
+    const assertion = new VerificationMethodRefSet(assertionMethod);
+    const keyAgr = new VerificationMethodRefSet(keyAgreement);
+    const capInv = new VerificationMethodRefSet(capabilityInvocation);
 
     const keys = [...verificationMethod]
       .map((method) => {
         const verRels = new VerificationRelationship();
-        if (auth.has(String(method.id))) {
+        if (auth.has(method.id)) {
           verRels.setAuthentication();
         }
-        if (assertion.has(String(method.id))) {
+        if (assertion.has(method.id)) {
           verRels.setAssertion();
         }
-        if (keyAgr.has(String(method.id))) {
+        if (keyAgr.has(method.id)) {
           verRels.setKeyAgreement();
         }
-        if (capInv.has(String(method.id))) {
+        if (capInv.has(method.id)) {
           verRels.setCapabilityInvocation();
         }
 

diff --git a/packages/credential-sdk/src/utils/generic.js b/packages/credential-sdk/src/utils/generic.js
@@ -337,6 +337,8 @@ const Ignore = new Set([
   'find',
   'findIndex',
   'splice',
+  'some',
+  'find',
 ]);
 for (const member of Object.getOwnPropertyNames(Array.prototype)) {
   if (!Ignore.has(member) && typeof Array.prototype[member] === 'function') {

diff --git a/packages/dock-blockchain-api/CHANGELOG.md b/packages/dock-blockchain-api/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @docknetwork/dock-blockchain-api
 
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.2.0
+
 ## 0.1.1
 
 ### Minor Changes

diff --git a/packages/dock-blockchain-api/package.json b/packages/dock-blockchain-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/dock-blockchain-api",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "MIT",
   "main": "./dist/esm/index.js",
   "type": "module",
@@ -84,7 +84,7 @@
     "@polkadot/api": "10.12.4"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.1.1",
+    "@docknetwork/credential-sdk": "0.2.0",
     "@docknetwork/node-types": "^0.17.0",
     "@juanelas/base64": "^1.0.5",
     "@polkadot/api": "10.12.4",

diff --git a/packages/dock-blockchain-modules/CHANGELOG.md b/packages/dock-blockchain-modules/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @docknetwork/dock-blockchain-modules
 
+## 0.2.0
+
+### Minor Changes
+
+- Change `DIDDocument` modification behaviour to throw error on attempt to add key/service/controller with duplicate id.
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.2.0
+
 ## 0.1.1
 
 ### Minor Changes

diff --git a/packages/dock-blockchain-modules/package.json b/packages/dock-blockchain-modules/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/dock-blockchain-modules",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "license": "MIT",
   "type": "module",
   "main": "./dist/esm/index.js",
@@ -28,7 +28,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.1.1"
+    "@docknetwork/credential-sdk": "0.2.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",
@@ -37,7 +37,7 @@
     "@babel/plugin-syntax-import-attributes": "^7.25.6",
     "@babel/plugin-transform-modules-commonjs": "^7.24.1",
     "@babel/preset-env": "^7.24.3",
-    "@docknetwork/dock-blockchain-api": "0.1.1",
+    "@docknetwork/dock-blockchain-api": "0.1.2",
     "@rollup/plugin-alias": "^4.0.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^24.0.0",

diff --git a/packages/dock-blockchain-modules/src/did/module.js b/packages/dock-blockchain-modules/src/did/module.js
@@ -29,14 +29,24 @@ export default class DockDIDModule extends injectDock(AbstractDIDModule) {
 
     const keys = didDocument.didKeys();
     const {
-      controller, service, id, '@context': context,
+      controller,
+      service,
+      id,
+      '@context': context,
+      capabilityDelegation,
+      attests,
     } = document;
     if (service?.length) {
       throw new Error(
         '`service` is not supported in the `createDocument` transaction. Use `updateDocument` to add `service` to the existing document.',
       );
-    }
-    if (context.length !== 1 || context[0].value !== CONTEXT_URI) {
+    } else if (capabilityDelegation?.length) {
+      throw new Error('Capability delegation is not supported');
+    } else if (attests != null) {
+      throw new Error(
+        '`attests` are not supported in the `createDocument` transaction. Use `attest` module to attach `attests` to the existing document.',
+      );
+    } else if (context.length !== 1 || context[0].value !== CONTEXT_URI) {
       throw new Error(
         `Context must be equal to \`${[
           CONTEXT_URI,
@@ -63,6 +73,13 @@ export default class DockDIDModule extends injectDock(AbstractDIDModule) {
 
     if (modified.size) {
       throw new Error("Can't have modified verificationMethods");
+    } else if (
+      nextDocument.attests
+      && !nextDocument.attests.eq(currentDocument.attests)
+    ) {
+      throw new Error(
+        '`attests` modifications are not supported in the `updateDocument` transaction. Use `attest` module to attach `attests` to the existing document.',
+      );
     }
 
     if (