feat(webvh): centralize metadata keys and improve update key lookup (#2798)

Signed-off-by: andres vallecilla <andresfelipe083195@hotmail.com>

Author: lotharking

packages/webvh/src/dids/WebVhDidRegistrar.ts

@@ -11,11 +11,20 @@ import type {
   VerificationMethod,
 } from '@credo-ts/core'
 
-import { DidDocument, DidDocumentRole, DidRecord, DidRepository, JsonTransformer, Kms } from '@credo-ts/core'
+import {
+  DidDocument,
+  DidDocumentRole,
+  DidRecord,
+  DidRepository,
+  getKmsKeyIdForVerifiacationMethod,
+  JsonTransformer,
+  Kms,
+} from '@credo-ts/core'
 import { createDID, type DIDLog, MultibaseEncoding, multibaseEncode, updateDID } from 'didwebvh-ts'
 
 import { WebVhDidCrypto } from './WebVhDidCrypto'
 import { WebVhDidCryptoSigner } from './WebVhDidCryptoSigner'
+import { WebVhDidRecordMetadataKeys } from './webVhDidRecordMetadataTypes'
 
 interface WebVhDidCreateOptions extends DidCreateOptions {
   domain: string
@@ -98,7 +107,7 @@ export class WebVhDidRegistrar implements DidRegistrar {
         role: DidDocumentRole.Created,
         keys,
       })
-      didRecord.metadata.set('log', log)
+      didRecord.metadata.set(WebVhDidRecordMetadataKeys.DidLog, log)
       didRecord.setTags({ domain: domainKey })
       await didRepository.save(agentContext, didRecord)
 
@@ -134,9 +143,13 @@ export class WebVhDidRegistrar implements DidRegistrar {
       })
       if (!didRecord) return this.handleError('DID not found')
 
-      const log = didRecord.metadata.get('log') as DIDLog
+      const log = didRecord.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as DIDLog
       const domain = didRecord.getTag('domain') as string
-      const keyId = didRecord.keys?.[0].kmsKeyId
+      const activeUpdateKey = log[log.length - 1]?.parameters?.updateKeys?.[0] ?? log[0]?.parameters?.updateKeys?.[0]
+      const vm = didRecord.didDocument?.verificationMethod?.find((v) => v.publicKeyMultibase === activeUpdateKey)
+      let keyId = vm ? getKmsKeyIdForVerifiacationMethod(vm, didRecord.keys) : undefined
+      if (!keyId && activeUpdateKey)
+        keyId = didRecord.metadata.get(WebVhDidRecordMetadataKeys.UpdateKeyKmsKeyIds)?.[activeUpdateKey]
 
       if (!log) return this.handleError('The log registry must be created before it can be edited.')
       if (!keyId) return this.handleError('The key ID must be present before the log can be edited.')
@@ -174,7 +187,7 @@ export class WebVhDidRegistrar implements DidRegistrar {
         keyAgreement: normalizeMethodArray(keyAgreement),
         services,
       })
-      didRecord.metadata.set('log', logResult)
+      didRecord.metadata.set(WebVhDidRecordMetadataKeys.DidLog, logResult)
       didRecord.didDocument = JsonTransformer.fromJSON(doc, DidDocument)
       await didRepository.update(agentContext, didRecord)
 

packages/webvh/src/dids/__tests__/WebVhDidRegistrar.boundary.test.ts

@@ -31,6 +31,7 @@ import type { WebVhDidLog, WebVhDidLogEntry } from '../../resources'
 import { parseResourceId } from '../../resources'
 import { WebVhDidCrypto } from '../WebVhDidCrypto'
 import { WebVhDidRegistrar } from '../WebVhDidRegistrar'
+import { WebVhDidRecordMetadataKeys } from '../webVhDidRecordMetadataTypes'
 
 // didwebvh-ts calls fetchWitnessProofs during resolve/update. In this offline unit-test
 // environment those HTTP requests fail (ENOTFOUND) and generate stderr noise even when
@@ -77,7 +78,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       const record = await repository.findSingleByQuery(agentContext, { did })
       expect(record).toBeDefined()
 
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
       expect(Array.isArray(log)).toBe(true)
       expect(log).toHaveLength(1)
 
@@ -98,7 +99,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       const did = result.didState.did
       if (!did) throw new Error('create failed')
       const record = await repository.findSingleByQuery(agentContext, { did })
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
 
       expect(Array.isArray(log[0].parameters.updateKeys)).toBe(true)
       expect(log[0].parameters.updateKeys?.length).toBeGreaterThan(0)
@@ -119,7 +120,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       expect(updateResult.didState.state).toBe('finished')
 
       const record = await repository.findSingleByQuery(agentContext, { did })
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
 
       expect(log).toHaveLength(2)
     })
@@ -135,7 +136,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       await registrar.update(agentContext, { did, didDocument })
 
       const record = await repository.findSingleByQuery(agentContext, { did })
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
 
       const indices = log.map((e) => parseInt(e.versionId.split('-')[0], 10))
       for (let i = 1; i < indices.length; i++) {
@@ -152,7 +153,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       if (!did) throw new Error('create failed')
 
       const record = await repository.findSingleByQuery(agentContext, { did })
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
 
       // Delegate directly to the upstream library — no Credo resolver involved.
       const verifier = new WebVhDidCrypto(agentContext)
@@ -176,7 +177,7 @@ describe('WebVhDidRegistrar boundary contracts', () => {
       expect(updateResult.didState.state).toBe('finished')
 
       const record = await repository.findSingleByQuery(agentContext, { did })
-      const log = record?.metadata.get('log') as WebVhDidLog
+      const log = record?.metadata.get(WebVhDidRecordMetadataKeys.DidLog) as WebVhDidLog
 
       const verifier = new WebVhDidCrypto(agentContext)
       const resolved = await resolveDIDFromLog(log, { verifier })

packages/webvh/src/dids/index.ts

@@ -2,3 +2,4 @@ export { WebVhDidCrypto } from './WebVhDidCrypto'
 export { WebVhDidCryptoSigner } from './WebVhDidCryptoSigner'
 export { WebVhDidRegistrar } from './WebVhDidRegistrar'
 export { WebVhDidResolver } from './WebVhDidResolver'
+export { type WebVhDidRecordMetadata, WebVhDidRecordMetadataKeys } from './webVhDidRecordMetadataTypes'

packages/webvh/src/dids/webVhDidRecordMetadataTypes.ts

@@ -0,0 +1,12 @@
+import type { WebVhDidLog } from '../resources'
+
+export enum WebVhDidRecordMetadataKeys {
+  // FIXME: refactor to '_internal/webvhDidLog' in next major release
+  DidLog = 'log',
+  UpdateKeyKmsKeyIds = '_internal/webvhUpdateKeyKmsKeyIds',
+}
+
+export type WebVhDidRecordMetadata = {
+  [WebVhDidRecordMetadataKeys.DidLog]: WebVhDidLog
+  [WebVhDidRecordMetadataKeys.UpdateKeyKmsKeyIds]: Record<string, string>
+}