Allow to create keypairs from private keys, conversion tweaks (#507)

* Allow to create keypairs from private keys, conversion tweaks * More tests * Tweak * Improvements * Naming * Comments * Add `dock` method * Update DID mapping
docknetwork · Jan 23, 2025 · cfc66a8 · cfc66a8
1 parent 99ae5cd
commit cfc66a8
Show file tree

Hide file tree

Showing 28 changed files with 6,620 additions and 3,195 deletions.
diff --git a/examples/CHANGELOG.md b/examples/CHANGELOG.md
@@ -1,5 +1,18 @@
 # @docknetwork/sdk-examples
 
+## 0.11.0
+
+### Minor Changes
+
+- Allow to create keypairs from private keys, conversion tweaks
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/dock-blockchain-modules@0.17.0
+  - @docknetwork/dock-blockchain-api@0.13.0
+  - @docknetwork/credential-sdk@0.28.0
+
 ## 0.10.0
 
 ### Minor Changes

diff --git a/examples/anchor.js b/examples/anchor.js
@@ -51,15 +51,15 @@ async function main() {
   const docHashes = [
     utf8('{"example": "document"}'),
     utf8('{"example": 2}'),
-    randomAsU8a(),
+    randomAsU8a(Math.floor(Math.random() * 64)),
     utf8('{"example": 4}'),
   ].map((bytes) => Anchor.hash(bytes).bytes);
   const proofs = await anchorBatched(anchor, docHashes);
   assert((await checkBatched(anchor, docHashes[0], proofs[0])) !== null);
   assert((await checkBatched(anchor, docHashes[0], proofs[1])) === null);
 
   // single
-  const single = Anchor.hash(randomAsU8a()).bytes;
+  const single = Anchor.hash(randomAsU8a(Math.floor(Math.random() * 64))).bytes;
   assert((await checkBatched(anchor, single, [])) === null);
   await anchorBatched(anchor, [single]);
   assert((await checkBatched(anchor, single, [])) !== null);
@@ -96,7 +96,7 @@ function benchSingleProofCreation(count) {
   /* eslint-disable no-unused-vars */
   const data = Array(count)
     .fill(undefined)
-    .map((_, __) => randomAsU8a());
+    .map((_, __) => randomAsU8a(Math.floor(Math.random() * 64)));
   const start = new Date().getTime();
   const hashes = data.map((bytes) => Anchor.hash(bytes).bytes);
   const pl = pack32(hashes);
@@ -118,7 +118,7 @@ function timeProofGeneration(count) {
   /* eslint-disable no-unused-vars */
   const data = Array(count)
     .fill(undefined)
-    .map((_, __) => randomAsU8a());
+    .map((_, __) => randomAsU8a(Math.floor(Math.random() * 64)));
   const start = new Date().getTime();
   const hashes = data.map((bytes) => Anchor.hash(bytes).bytes);
   const [root, proofs] = buildMerkleTreeAndProofs(hashes);

diff --git a/examples/package.json b/examples/package.json
@@ -2,7 +2,7 @@
   "name": "@docknetwork/sdk-examples",
   "private": true,
   "type": "module",
-  "version": "0.10.0",
+  "version": "0.11.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.27.0",
-    "@docknetwork/dock-blockchain-api": "0.12.0",
-    "@docknetwork/dock-blockchain-modules": "0.16.0"
+    "@docknetwork/credential-sdk": "0.28.0",
+    "@docknetwork/dock-blockchain-api": "0.13.0",
+    "@docknetwork/dock-blockchain-modules": "0.17.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,16 @@
 # @docknetwork/cheqd-blockchain-api
 
+## 0.22.0
+
+### Minor Changes
+
+- Allow to create keypairs from private keys, conversion tweaks
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.28.0
+
 ## 0.21.0
 
 ### 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.21.0",
+  "version": "0.22.0",
   "license": "MIT",
   "main": "./dist/esm/index.js",
   "type": "module",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@cheqd/sdk": "cjs",
-    "@docknetwork/credential-sdk": "0.27.0"
+    "@docknetwork/credential-sdk": "0.28.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
@@ -51,6 +51,8 @@ import {
   CheqdTestnetAccumulator,
   CheqdMainnetAccumulator,
   DockDidOrDidMethodKey,
+  CheqdMainnetVerificationMethodSignature,
+  CheqdTestnetVerificationMethodSignature,
 } from '@docknetwork/credential-sdk/types';
 import { TypedEnum } from '@docknetwork/credential-sdk/types/generic';
 
@@ -107,6 +109,7 @@ export class CheqdAPI extends AbstractApiProvider {
       OffchainSignatureKeyRef: CheqdTestnetOffchainSignatureKeyRef,
       BlobId: CheqdTestnetBlobId,
       StatusListCredentialId: CheqdTestnetStatusListCredentialId,
+      VerificationMethodSignature: CheqdTestnetVerificationMethodSignature,
     }),
     [CheqdNetwork.Mainnet]: extendNull({
       Did: CheqdMainnetDid,
@@ -119,6 +122,7 @@ export class CheqdAPI extends AbstractApiProvider {
       OffchainSignatureKeyRef: CheqdMainnetOffchainSignatureKeyRef,
       BlobId: CheqdMainnetBlobId,
       StatusListCredentialId: CheqdMainnetStatusListCredentialId,
+      VerificationMethodSignature: CheqdMainnetVerificationMethodSignature,
     }),
   });
 
@@ -263,7 +267,7 @@ export class CheqdAPI extends AbstractApiProvider {
   }
 
   methods() {
-    return ['cheqd'];
+    return ['cheqd', 'dock'];
   }
 
   // eslint-disable-next-line

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.19.0
+
+### Minor Changes
+
+- Allow to create keypairs from private keys, conversion tweaks
+
+### Patch Changes
+
+- Updated dependencies
+  - @docknetwork/credential-sdk@0.28.0
+
 ## 0.18.0
 
 ### Minor 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.18.0",
+  "version": "0.19.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/esm/index.js",
@@ -33,7 +33,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@docknetwork/credential-sdk": "0.27.0"
+    "@docknetwork/credential-sdk": "0.28.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.21.0",
+    "@docknetwork/cheqd-blockchain-api": "0.22.0",
     "@rollup/plugin-alias": "^4.0.2",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^24.0.0",

diff --git a/packages/cheqd-blockchain-modules/src/common/create-internal-cheqd-module.js b/packages/cheqd-blockchain-modules/src/common/create-internal-cheqd-module.js
@@ -1,4 +1,3 @@
-import { VerificationMethodSignature } from '@docknetwork/credential-sdk/types';
 import { ensureInstanceOf } from '@docknetwork/credential-sdk/utils';
 import { TypedUUID } from '@docknetwork/credential-sdk/types/generic';
 import CheqdApiProvider from './cheqd-api-provider';
@@ -21,7 +20,10 @@ const createDIDMethodTx = (fnName) => {
 
       const signatures = []
         .concat(didKeypairs)
-        .map((didKeypair) => VerificationMethodSignature.fromDidKeypair(didKeypair, bytes));
+        .map((didKeypair) => root.types.VerificationMethodSignature.fromDidKeypair(
+          didKeypair,
+          bytes,
+        ));
 
       const value = {
         payload,

diff --git a/packages/credential-sdk/CHANGELOG.md b/packages/credential-sdk/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @docknetwork/credential-sdk
 
+## 0.28.0
+
+### Minor Changes
+
+- Allow to create keypairs from private keys, conversion tweaks
+
 ## 0.27.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.27.0",
+  "version": "0.28.0",
   "license": "MIT",
   "type": "module",
   "files": [

diff --git a/packages/credential-sdk/src/keypairs/did-keypair.js b/packages/credential-sdk/src/keypairs/did-keypair.js
@@ -1,4 +1,4 @@
-import DockKeypair from './keypair';
+import DockKeypair from './dock-keypair';
 import { DidKey } from '../types/did/onchain/did-key';
 import VerificationMethodRefOrIdentRef from '../types/did/document/verification-method-ref-or-ident-ref';
 import { ensureInstanceOf } from '../utils';

diff --git a/...es/credential-sdk/src/keypairs/keypair.js → ...edential-sdk/src/keypairs/dock-keypair.js b/...es/credential-sdk/src/keypairs/keypair.js → ...edential-sdk/src/keypairs/dock-keypair.js
@@ -5,21 +5,51 @@ import {
 import { randomAsHex } from '../utils/bytes';
 
 /**
- * Wrapped keypair used to sign byte sequences of arbitrary size.
+ * Abstract keypair used to sign byte sequences of arbitrary size.
  */
 class DockKeypair {
   /**
-   * Wraps supplied keypair into a `DockKeypair`.
+   * Instantiates new `DockKeypair` with the provided underlying keypair.
    *
    * @param {*} keyPair
    */
   constructor(keyPair) {
     this.keyPair = keyPair;
   }
 
+  /**
+   * Generates `DockKeypair` from the supplied entropy.
+   * @param {Uint8Array} entropy
+   * @returns {DockKeypair}
+   */
+  static fromEntropy(entropy) {
+    // eslint-disable-next-line no-underscore-dangle
+    return new this(entropy, 'entropy');
+  }
+
+  /**
+   * Generates `DockKeypair` from the supplied seed.
+   * @param {Uint8Array} seed
+   * @returns {DockKeypair}
+   */
+  static fromSeed(seed) {
+    // eslint-disable-next-line no-underscore-dangle
+    return new this(seed, 'seed');
+  }
+
+  /**
+   * Generates `DockKeypair` from the supplied private key.
+   * @param {Uint8Array} privateKey
+   * @returns {DockKeypair}
+   */
+  static fromPrivateKey(privateKey) {
+    // eslint-disable-next-line no-underscore-dangle
+    return new this(privateKey, 'private');
+  }
+
   /**
    * Generates random `DockKeypair`.
-   * @returns {}
+   * @returns {DockKeypair}
    */
   static random() {
     return new this(randomAsHex(this.SeedSize));
@@ -87,7 +117,7 @@ class DockKeypair {
 export default withExtendedPrototypeProperties(
   ['privateKey', '_publicKey', '_sign'],
   withExtendedStaticProperties(
-    ['Signature', 'VerKeyType', 'SeedSize', 'verify'],
+    ['Signature', 'VerKeyType', 'SeedSize', 'verify', 'constructor'],
     DockKeypair,
   ),
 );
diff --git a/packages/credential-sdk/src/keypairs/index.js b/packages/credential-sdk/src/keypairs/index.js
@@ -1,4 +1,4 @@
-export { default as DockKeypair } from './keypair';
+export { default as DockKeypair } from './dock-keypair';
 export { default as Ed25519Keypair } from './keypair-ed25519';
 export { default as Secp256k1Keypair } from './keypair-secp256k1';
 export { default as DidKeypair } from './did-keypair';
diff --git a/packages/credential-sdk/src/keypairs/keypair-ed25519.js b/packages/credential-sdk/src/keypairs/keypair-ed25519.js
@@ -1,8 +1,13 @@
-import { generateKeyPairFromSeed, sign, verify } from '@stablelib/ed25519';
+import {
+  generateKeyPairFromSeed,
+  sign,
+  verify,
+  extractPublicKeyFromSecretKey,
+} from '@stablelib/ed25519';
 import { SignatureEd25519 } from '../types/signatures';
 import { Ed25519VerKeyName } from '../vc/crypto/constants';
 import { normalizeToU8a, valueBytes } from '../utils';
-import DockKeypair from './keypair';
+import DockKeypair from './dock-keypair';
 
 export default class Ed25519Keypair extends DockKeypair {
   static Signature = SignatureEd25519;
@@ -11,8 +16,35 @@ export default class Ed25519Keypair extends DockKeypair {
 
   static SeedSize = 32;
 
-  constructor(seed) {
-    super(generateKeyPairFromSeed(normalizeToU8a(seed)));
+  /**
+   *
+   * Instantiates new `Ed25519Keypair` from the provided source.
+   * It can have one of two types: "seed" or "private".
+   *
+   * @param {Uint8Array} seedOrPrivate
+   * @param {"seed"|"private"} sourceType
+   */
+  constructor(seedOrPrivate, sourceType = 'seed') {
+    let kp;
+    switch (sourceType) {
+      case 'seed':
+        kp = generateKeyPairFromSeed(normalizeToU8a(seedOrPrivate));
+        break;
+      case 'private': {
+        const secretKey = normalizeToU8a(seedOrPrivate);
+        kp = {
+          secretKey,
+          publicKey: extractPublicKeyFromSecretKey(secretKey),
+        };
+        break;
+      }
+      default:
+        throw new Error(
+          `Unsupported source type: \`${sourceType}\`, it must be either "seed" or "private"`,
+        );
+    }
+
+    super(kp);
   }
 
   _publicKey() {