Use @digitalbazaar/did-method-key@5.

Author: dlongley

CHANGELOG.md

@@ -1,5 +1,11 @@
 # bedrock-app-identity ChangeLog
 
+## 3.1.0 - 2025-09-dd
+
+### Changed
+- Update dependencies:
+  - `@digitalbazaar/did-method-key@5`.
+
 ## 3.0.1 - 2022-05-21
 
 ### Fixed

lib/index.js

@@ -1,17 +1,28 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2025 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
-import {createRequire} from 'node:module';
+import * as Ed25519Multikey from '@digitalbazaar/ed25519-multikey';
 import {decodeSecretKeySeed} from 'bnid';
+import {driver} from '@digitalbazaar/did-method-key';
 import {logger} from './logger.js';
-const require = createRequire(import.meta.url);
-const {driver} = require('@digitalbazaar/did-method-key');
+import {
+  X25519KeyAgreementKey2020
+} from '@digitalbazaar/x25519-key-agreement-key-2020';
 
 import './config.js';
 
 const {config, util: {BedrockError}} = bedrock;
+
 const didKeyDriver = driver();
+didKeyDriver.use({
+  multibaseMultikeyHeader: 'z6Mk',
+  fromMultibase: Ed25519Multikey.from
+});
+didKeyDriver.use({
+  multibaseMultikeyHeader: 'z6LS',
+  fromMultibase: X25519KeyAgreementKey2020.from
+});
 
 let APPLICATION_IDENTITY;
 const SERVICE_IDENTITIES = new Map();
@@ -122,27 +133,37 @@ async function _generateKeys({seedMultibase}) {
   // convert multibase seed to Uint8Array
   const seed = decodeSecretKeySeed({secretKeySeed: seedMultibase});
 
-  // initialize key after bedrock configuration stage is complete
-  const didKey = await didKeyDriver.generate({seed});
-
-  const {didDocument: {
-    authentication, assertionMethod, capabilityDelegation, capabilityInvocation,
-    keyAgreement, id
-  }} = didKey;
-
-  const authenticationKey = didKey.keyPairs.get(authentication[0]);
-  const assertionMethodKey = didKey.keyPairs.get(assertionMethod[0]);
-  const capabilityDelegationKey = didKey.keyPairs.get(capabilityDelegation[0]);
-  const capabilityInvocationKey = didKey.keyPairs.get(capabilityInvocation[0]);
-  const keyAgreementKey = didKey.keyPairs.get(keyAgreement[0].id);
+  // initialize `did:key` DID after bedrock configuration stage is complete
+  const verificationKeyPair = await Ed25519Multikey.generate({seed});
+  const {
+    didDocument: {id}, methodFor
+  } = await didKeyDriver.fromKeyPair({verificationKeyPair});
+
+  // update verification key pair with `id` and `controller`
+  verificationKeyPair.id = methodFor({purpose: 'authentication'}).id;
+  verificationKeyPair.controller = id;
+  // for backwards compatibility, use legacy type `Ed25519VerificationKey2020`;
+  // to be replaced with `Multikey` in next major release
+  verificationKeyPair.type = 'Ed25519VerificationKey2020';
+
+  // for backwards compatibility, import key agreement key; to be removed
+  // in next major release
+  const keyAgreementKey = X25519KeyAgreementKey2020
+    .fromEd25519VerificationKey2020({
+      keyPair: {
+        ...verificationKeyPair,
+        privateKeyMultibase: verificationKeyPair.secretKeyMultibase
+      }
+    });
+  keyAgreementKey.id = `${id}#${keyAgreementKey.publicKeyMultibase}`;
 
   return {
     id,
     keys: {
-      authenticationKey,
-      assertionMethodKey,
-      capabilityDelegationKey,
-      capabilityInvocationKey,
+      authenticationKey: verificationKeyPair,
+      assertionMethodKey: verificationKeyPair,
+      capabilityDelegationKey: verificationKeyPair,
+      capabilityInvocationKey: verificationKeyPair,
       keyAgreementKey
     }
   };

package.json

@@ -25,8 +25,12 @@
   },
   "homepage": "https://github.com/digitalbazaar/bedrock-app-identity",
   "dependencies": {
-    "@digitalbazaar/did-method-key": "^2.0.0",
-    "bnid": "^3.0.0"
+    "@digitalbazaar/did-method-key": "^5.2.0",
+    "@digitalbazaar/ed25519-multikey": "^1.3.1",
+    "@digitalbazaar/ed25519-signature-2020": "^5.4.0",
+    "@digitalbazaar/x25519-key-agreement-key-2020": "^3.0.1",
+    "bnid": "^3.0.0",
+    "eslint-plugin-unicorn": "^56.0.1"
   },
   "peerDependencies": {
     "@bedrock/core": "^6.0.0"
@@ -35,10 +39,9 @@
     "lib": "./lib"
   },
   "devDependencies": {
-    "eslint": "^8.12.0",
-    "eslint-config-digitalbazaar": "^2.8.0",
-    "eslint-plugin-jsdoc": "^37.9.7",
-    "jsdoc-to-markdown": "^7.1.1"
+    "eslint": "^8.57.1",
+    "eslint-config-digitalbazaar": "^5.2.0",
+    "eslint-plugin-jsdoc": "^50.8.0"
   },
   "engines": {
     "node": ">=14"

test/mocha/10-api.js

@@ -1,13 +1,13 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2025 Digital Bazaar, Inc. All rights reserved.
  */
 import * as bedrock from '@bedrock/core';
 import {
-  getAppIdentity,
-  getServiceIdentities,
-  _resetApplicationIdentity,
   _generateApplicationIdentity,
-  _generateServiceIdentity
+  _generateServiceIdentity,
+  _resetApplicationIdentity,
+  getAppIdentity,
+  getServiceIdentities
 } from '@bedrock/app-identity';
 
 describe('bedrock-app-identity API', () => {

util/generate-seed.js

@@ -1,17 +1,23 @@
 /*!
- * Copyright (c) 2020-2022 Digital Bazaar, Inc. All rights reserved.
+ * Copyright (c) 2020-2025 Digital Bazaar, Inc. All rights reserved.
  */
-import {createRequire} from 'module';
-import {generateSecretKeySeed, decodeSecretKeySeed} from 'bnid';
-const require = createRequire(import.meta.url);
-const {driver} = require('@digitalbazaar/did-method-key');
+import * as Ed25519Multikey from '@digitalbazaar/ed25519-multikey';
+import {decodeSecretKeySeed, generateSecretKeySeed} from 'bnid';
+import {driver} from '@digitalbazaar/did-method-key';
 
 const didKeyDriver = driver();
+didKeyDriver.use({
+  multibaseMultikeyHeader: 'z6Mk',
+  fromMultibase: Ed25519Multikey.from
+});
 
 // generate a random seed
 const secretKeySeed = await generateSecretKeySeed();
 const seedBytes = await decodeSecretKeySeed({secretKeySeed});
-const didKey = await didKeyDriver.generate({seed: seedBytes});
 
-console.log('PUBLIC DID', didKey.didDocument.id);
+// generate `did:key` DID
+const verificationKeyPair = await Ed25519Multikey.generate({seed: seedBytes});
+const {didDocument} = await didKeyDriver.fromKeyPair({verificationKeyPair});
+
+console.log('PUBLIC DID', didDocument.id);
 console.log(`SECRET seedMultibase: ${secretKeySeed}`);