Merge pull request #496 from docknetwork/cheqd-serde

Serialization/deserialization tweaks for `cheqd`
docknetwork · Dec 18, 2024 · 0d07c3f · 0d07c3f
2 parents 23812ce + 0d44073
commit 0d07c3f
Show file tree

Hide file tree

Showing 40 changed files with 328 additions and 116 deletions.
diff --git a/examples/CHANGELOG.md b/examples/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @docknetwork/sdk-examples
 
+## 0.6.7
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.21.0
+  - @docknetwork/dock-blockchain-api@0.8.7
+  - @docknetwork/dock-blockchain-modules@0.11.2
+
 ## 0.6.6
 
 ### 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.6.6",
+  "version": "0.6.7",
   "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.20.0",
-    "@docknetwork/dock-blockchain-api": "0.8.6",
-    "@docknetwork/dock-blockchain-modules": "0.11.1"
+    "@docknetwork/credential-sdk": "0.21.0",
+    "@docknetwork/dock-blockchain-api": "0.8.7",
+    "@docknetwork/dock-blockchain-modules": "0.11.2"
   },
   "devDependencies": {
     "babel-eslint": "^10.1.0",

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "root",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "private": true,
   "workspaces": [
     "packages/*",

diff --git a/packages/cheqd-blockchain-api/CHANGELOG.md b/packages/cheqd-blockchain-api/CHANGELOG.md
@@ -1,5 +1,16 @@
 # @docknetwork/cheqd-blockchain-api
 
+## 0.15.0
+
+### Minor Changes
+
+- Serialization/deserialization tweaks for `cheqd`
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.21.0
+
 ## 0.14.5
 
 ### Patch 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.14.5",
+  "version": "0.15.0",
   "license": "MIT",
   "main": "./dist/esm/index.js",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@cheqd/sdk": "cjs",
-    "@docknetwork/credential-sdk": "0.20.0"
+    "@docknetwork/credential-sdk": "0.21.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.24.1",

diff --git a/packages/cheqd-blockchain-api/src/index.js b/packages/cheqd-blockchain-api/src/index.js
@@ -1,6 +1,5 @@
 import { AbstractApiProvider } from '@docknetwork/credential-sdk/modules/abstract/common';
 import {
-  maybeToJSON,
   maybeToJSONString,
   fmtIter,
   extendNull,
@@ -22,9 +21,17 @@ import {
   protobufPackage as resourceProtobufPackage,
 } from '@cheqd/ts-proto/cheqd/resource/v2/index.js';
 import {
-  DidRef, NamespaceDid, CheqdSetDidDocumentPayloadWithTypeUrlAndSignatures, CheqdCheqdDeactivateDidDocumentPayloadWithTypeUrlAndSignatures, CheqdCreateResourcePayloadWithTypeUrlAndSignatures,
+  DidRef,
+  NamespaceDid,
+  CheqdSetDidDocumentPayloadWithTypeUrlAndSignatures,
+  CheqdCheqdDeactivateDidDocumentPayloadWithTypeUrlAndSignatures,
+  CheqdCreateResourcePayloadWithTypeUrlAndSignatures,
+  CheqdCreateResource,
+  CheqdDIDDocument,
+  CheqdDeactivateDidDocument,
 } from '@docknetwork/credential-sdk/types';
 import { TypedEnum } from '@docknetwork/credential-sdk/types/generic';
+import { maybeToCheqdPayloadOrJSON } from '../../credential-sdk/src/utils';
 
 export class CheqdAPI extends AbstractApiProvider {
   /**
@@ -50,16 +57,20 @@ export class CheqdAPI extends AbstractApiProvider {
   });
 
   static Payloads = extendNull({
-    MsgCreateDidDoc: MsgCreateDidDocPayload,
-    MsgUpdateDidDoc: MsgUpdateDidDocPayload,
-    MsgDeactivateDidDoc: MsgDeactivateDidDocPayload,
-    MsgCreateResource: MsgCreateResourcePayload,
+    MsgCreateDidDoc: [CheqdDIDDocument, MsgCreateDidDocPayload],
+    MsgUpdateDidDoc: [CheqdDIDDocument, MsgUpdateDidDocPayload],
+    MsgDeactivateDidDoc: [
+      CheqdDeactivateDidDocument,
+      MsgDeactivateDidDocPayload,
+    ],
+    MsgCreateResource: [CheqdCreateResource, MsgCreateResourcePayload],
   });
 
   static PayloadWrappers = extendNull({
     MsgCreateDidDoc: CheqdSetDidDocumentPayloadWithTypeUrlAndSignatures,
     MsgUpdateDidDoc: CheqdSetDidDocumentPayloadWithTypeUrlAndSignatures,
-    MsgDeactivateDidDoc: CheqdCheqdDeactivateDidDocumentPayloadWithTypeUrlAndSignatures,
+    MsgDeactivateDidDoc:
+      CheqdCheqdDeactivateDidDocumentPayloadWithTypeUrlAndSignatures,
     MsgCreateResource: CheqdCreateResourcePayloadWithTypeUrlAndSignatures,
   });
 
@@ -123,13 +134,16 @@ export class CheqdAPI extends AbstractApiProvider {
    * @returns {Promise<Uint8Array>}
    */
   async stateChangeBytes(method, payload) {
-    const { [method]: Payload } = this.constructor.Payloads;
-    if (Payload == null) {
+    const { [method]: Payloads } = this.constructor.Payloads;
+    if (Payloads == null) {
       throw new Error(
         `Can't find payload constructor for the provided method \`${method}\``,
       );
     }
-    const jsonPayload = maybeToJSON(payload);
+    const [TypedPayload, Payload] = Payloads;
+
+    const typedPayload = TypedPayload.from(payload);
+    const jsonPayload = maybeToCheqdPayloadOrJSON(typedPayload);
     const sdkPayload = Payload.fromPartial(jsonPayload);
 
     try {
@@ -169,7 +183,9 @@ export class CheqdAPI extends AbstractApiProvider {
       payer: sender,
     };
 
-    const txJSON = PayloadWrapper.from(tx).toJSON();
+    const txJSON = maybeToCheqdPayloadOrJSON(
+      PayloadWrapper.from(JSON.parse(JSON.stringify(tx.toJSON()))),
+    );
     txJSON.typeUrl = `/${prefix}.${typeUrl}`;
 
     const res = await this.sdk.signer.signAndBroadcast(

diff --git a/packages/cheqd-blockchain-modules/CHANGELOG.md b/packages/cheqd-blockchain-modules/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @docknetwork/cheqd-blockchain-modules
 
+## 0.13.3
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.21.0
+
 ## 0.13.2
 
 ### Patch Changes

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.13.2",
+  "version": "0.13.3",
   "type": "module",
   "license": "MIT",
   "main": "./dist/esm/index.js",
@@ -33,7 +33,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.20.0"
+    "@docknetwork/credential-sdk": "0.21.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.14.5",
+    "@docknetwork/cheqd-blockchain-api": "0.15.0",
     "@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.21.0
+
+### Minor Changes
+
+- Serialization/deserialization tweaks for `cheqd`
+
 ## 0.20.0
 
 ### 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.20.0",
+  "version": "0.21.0",
   "license": "MIT",
   "type": "module",
   "files": [

diff --git a/packages/credential-sdk/src/types/accumulator/accumulator-id.js b/packages/credential-sdk/src/types/accumulator/accumulator-id.js
@@ -10,7 +10,12 @@ import {
 
 export class AccumulatorId extends withFrom(
   withQualifier(TypedEnum, true),
-  (value, from) => {
+  (valueWithUncheckedPrefix, from) => {
+    const value = typeof valueWithUncheckedPrefix === 'string'
+      && valueWithUncheckedPrefix.startsWith('dock:accumulator:')
+      ? `accumulator:dock:${valueWithUncheckedPrefix.slice(17)}`
+      : valueWithUncheckedPrefix;
+
     try {
       // eslint-disable-next-line no-use-before-define
       return from(DockAccumulatorIdValue.from(value));
@@ -20,10 +25,6 @@ export class AccumulatorId extends withFrom(
   },
 ) {
   static Qualifier = 'accumulator:';
-
-  toJSON() {
-    return String(this);
-  }
 }
 
 export class CheqdAccumulatorIdValue extends withQualifier(DidRef) {

diff --git a/packages/credential-sdk/src/types/did/document/ident-ref.js b/packages/credential-sdk/src/types/did/document/ident-ref.js
@@ -40,6 +40,10 @@ export default class IdentRef extends withQualifier(TypedTuple) {
     return `${did}#${value}`;
   }
 
+  toCheqdPayload() {
+    return this.toString();
+  }
+
   toJSON() {
     return this.toString();
   }

diff --git a/...ential-sdk/src/types/did/document/verification-method-ref-or-cheqd-verification-method.js b/...ential-sdk/src/types/did/document/verification-method-ref-or-cheqd-verification-method.js
@@ -1,20 +1,12 @@
 import VerificationMethodRef from './verification-method-ref';
-import { CheqdVerificationMethod } from './verification-method';
+import { CheqdVerificationMethodAssertion } from './verification-method';
 import { withFrom } from '../../generic';
 
 export default class VerificationMethodRefOrCheqdVerificationMethod extends withFrom(
   VerificationMethodRef,
   (value, from) => {
     try {
-      return class CheqdVerificationMethodToJSONString extends CheqdVerificationMethod {
-        toJSON() {
-          return JSON.stringify(JSON.stringify(super.toJSON()));
-        }
-
-        static from(obj) {
-          return typeof obj === 'string' ? super.fromJSON(JSON.parse(JSON.parse(obj))) : super.from(obj);
-        }
-      }.from(value);
+      return CheqdVerificationMethodAssertion.from(value);
     } catch {
       return from(value);
     }

diff --git a/packages/credential-sdk/src/types/did/document/verification-method-ref.js b/packages/credential-sdk/src/types/did/document/verification-method-ref.js
@@ -32,6 +32,10 @@ export default class VerificationMethodRef extends withQualifier(TypedTuple) {
     return `${did}#keys-${index}`;
   }
 
+  toCheqdPayload() {
+    return this.toEncodedString();
+  }
+
   toJSON() {
     return this.toEncodedString();
   }

diff --git a/packages/credential-sdk/src/types/did/document/verification-method.js b/packages/credential-sdk/src/types/did/document/verification-method.js
@@ -1,5 +1,10 @@
 import {
-  withFrom, TypedStruct, withBase58, TypedBytes, option, TypedString,
+  withFrom,
+  TypedStruct,
+  withBase58,
+  TypedBytes,
+  option,
+  TypedString,
 } from '../../generic';
 import {
   BBDT16PublicKey,
@@ -26,11 +31,18 @@ import {
   Bls12381PSDockVerKeyName,
   Bls12381BBDT16DockVerKeyName,
 } from '../../../vc/crypto';
-import { Ed25519Verification2018Method, Ed25519Verification2020Method, VerificationMethodType } from './verification-method-type';
+import {
+  Ed25519Verification2018Method,
+  Ed25519Verification2020Method,
+  VerificationMethodType,
+} from './verification-method-type';
 import VerificationMethodRef from './verification-method-ref';
 import { NamespaceDid } from '../onchain/typed-did';
 import {
-  fmtIter, valueBytes, filterObj,
+  fmtIter,
+  valueBytes,
+  filterObj,
+  maybeToCheqdPayloadOrJSON,
 } from '../../../utils';
 
 export class PublicKeyBase58 extends withBase58(TypedBytes) {}
@@ -152,3 +164,21 @@ export class CheqdVerificationMethod extends withFrom(
     );
   }
 }
+
+export class CheqdVerificationMethodAssertion extends CheqdVerificationMethod {
+  toCheqdPayload() {
+    return JSON.stringify(
+      JSON.stringify(this.apply(maybeToCheqdPayloadOrJSON)),
+    );
+  }
+
+  toJSON() {
+    return this.toCheqdPayload();
+  }
+
+  static from(obj) {
+    return typeof obj === 'string'
+      ? super.fromJSON(JSON.parse(JSON.parse(obj)))
+      : super.from(obj);
+  }
+}
diff --git a/packages/credential-sdk/src/types/did/offchain/service-endpoint.js b/packages/credential-sdk/src/types/did/offchain/service-endpoint.js
@@ -1,4 +1,4 @@
-import { maybeToNumber } from '../../../utils';
+import { maybeToJSONString, maybeToNumber } from '../../../utils';
 import {
   TypedStruct,
   TypedString,
@@ -17,7 +17,7 @@ const LinkedDomainsPlaceholder = createPlaceholder((value) => {
   ) {
     return 0b0001;
   } else {
-    throw new Error(`Unknown value \`${value}\``);
+    throw new Error(`Unknown value \`${maybeToJSONString(value)}\``);
   }
 });
 
@@ -42,6 +42,10 @@ export class LinkedDomains extends ServiceEndpointType {
   toJSON() {
     return this.constructor.Type;
   }
+
+  apply(fn) {
+    return fn(this.constructor.Type);
+  }
 }
 
 ServiceEndpointType.bindVariants(LinkedDomains);

diff --git a/packages/credential-sdk/src/types/did/onchain/typed-did/cheqd-did.js b/packages/credential-sdk/src/types/did/onchain/typed-did/cheqd-did.js
@@ -58,6 +58,10 @@ export class CheqdDid extends withQualifier(TypedEnum, true) {
   toJSON() {
     return String(this);
   }
+
+  toCheqdPayload() {
+    return String(this);
+  }
 }
 
 export class CheqdTestnetDid extends CheqdDid {