@did-btcr2/method 0.19.0 → 0.22.0

package/src/utils/did-document.ts

@@ -1,7 +1,9 @@
 import { getNetwork } from '@did-btcr2/bitcoin';
 import {
   BTCR2_DID_DOCUMENT_CONTEXT,
+  Canonicalization,
   DidDocumentError,
+  HashBytes,
   IdentifierTypes,
   INVALID_DID_DOCUMENT,
   JSONObject,
@@ -9,12 +11,12 @@ import {
   KeyBytes
 } from '@did-btcr2/common';
 import { CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
-import { DidService, DidDocument as IIDidDocument, DidVerificationMethod as IIDidVerificationMethod } from '@web5/dids';
+import { DidDocument as W3CDidDocument, DidVerificationMethod as W3CDidVerificationMethod } from '@web5/dids';
+import { payments } from 'bitcoinjs-lib';
 import { BeaconService } from '../core/beacon/interfaces.js';
 import { BeaconUtils } from '../core/beacon/utils.js';
 import { Identifier } from '../core/identifier.js';
 import { Appendix } from './appendix.js';
-import { payments } from 'bitcoinjs-lib';
 
 export const ID_PLACEHOLDER_VALUE = 'did:btcr2:_';
 export const BECH32M_CHARS = '';
@@ -36,7 +38,11 @@ export type VerificationRelationships = {
   capabilityDelegation?: Array<string | DidVerificationMethod>;
 }
 
-export interface IDidVerificationMethod extends IIDidVerificationMethod {
+/** Loose type for unvalidated DID / Genesis document-like input objects. */
+export type DidDocumentLike = Partial<Btcr2DidDocument>;
+export type GenesisDocumentLike = Partial<Btcr2DidDocument>;
+
+export interface Btcr2VerificationMethod extends W3CDidVerificationMethod {
   id: string;
   type: string;
   controller: string;
@@ -50,14 +56,14 @@ export interface IDidVerificationMethod extends IIDidVerificationMethod {
  * @type {DidVerificationMethod}
  *
  */
-export class DidVerificationMethod implements IDidVerificationMethod {
+export class DidVerificationMethod implements Btcr2VerificationMethod {
   id: string;
   type: string;
   controller: string;
   publicKeyMultibase: string;
   secretKeyMultibase?: string | undefined;
 
-  constructor({ id, type, controller, publicKeyMultibase, secretKeyMultibase }: IDidVerificationMethod) {
+  constructor({ id, type, controller, publicKeyMultibase, secretKeyMultibase }: Btcr2VerificationMethod) {
     this.id = id;
     this.type = type;
     this.controller = controller;
@@ -72,11 +78,10 @@ export class DidVerificationMethod implements IDidVerificationMethod {
 
 /**
  * BTCR2 DID Document Interface
- * @interface IDidDocument
- * @type {IDidDocument}
- * @extends {IIDidDocument}
+ * @interface Btcr2DidDocument
+ * @type {Btcr2DidDocument}
+ * @extends {W3CDidDocument}
  * @property {string} id - The identifier of the DID Document.
- * @property {Array<string>} [controller] - The controller of the DID Document.
  * @property {Array<string | JSONObject>} ['@context'] - The context of the DID Document.
  * @property {Array<DidVerificationMethod>} verificationMethod - The verification methods of the DID Document.
  * @property {Array<string | DidVerificationMethod>} [authentication] - The authentication methods of the DID Document.
@@ -85,9 +90,8 @@ export class DidVerificationMethod implements IDidVerificationMethod {
  * @property {Array<string | DidVerificationMethod>} [capabilityDelegation] - The capability delegation methods of the DID Document.
  * @property {Array<BeaconService>} service - The services of the DID Document.
  */
-export interface IDidDocument extends IIDidDocument {
+export interface Btcr2DidDocument extends W3CDidDocument {
   id: string;
-  controller?: Array<string>;
   '@context'?: Array<string | JSONObject>;
   verificationMethod: Array<DidVerificationMethod>;
   authentication?: Array<string | DidVerificationMethod>;
@@ -101,9 +105,8 @@ export interface IDidDocument extends IIDidDocument {
  * BTCR2 DID Document extends the DidDocument class adding helper methods and properties
  * @class DidDocument
  * @type {DidDocument}
- * @implements {IDidDocument}
+ * @implements {Btcr2DidDocument}
  * @property {string} id - The identifier of the DID Document.
- * @property {Array<string>} [controller] - The controller of the DID Document.
  * @property {Array<string | JSONObject>} ['@context'] - The context of the DID Document.
  * @property {Array<DidVerificationMethod>} verificationMethod - The verification methods of the DID Document.
  * @property {Array<string | DidVerificationMethod>} [authentication] - The authentication methods of the DID Document.
@@ -112,10 +115,12 @@ export interface IDidDocument extends IIDidDocument {
  * @property {Array<string | DidVerificationMethod>} [capabilityDelegation] - The capability delegation methods of the DID Document.
  * @property {Array<BeaconService>} service - The services of the DID Document.
  */
-export class DidDocument implements IDidDocument {
+export class DidDocument implements Btcr2DidDocument {
   id: string;
-  controller?: Array<string>;
-  '@context'?: Array<string | JSONObject> = BTCR2_DID_DOCUMENT_CONTEXT;
+  '@context'?: Array<string | JSONObject> = [
+    'https://www.w3.org/TR/did-1.1',
+    'https://btcr2.dev/context/v1'
+  ];
   verificationMethod: Array<DidVerificationMethod>;
   authentication?: Array<string | DidVerificationMethod>;
   assertionMethod?: Array<string | DidVerificationMethod>;
@@ -124,9 +129,14 @@ export class DidDocument implements IDidDocument {
   service: Array<BeaconService>;
   deactivated?: boolean;
 
-  constructor(document: IDidDocument) {
+  constructor(document: DidDocumentLike) {
+    // Ensure document has an id
+    if(!document.id) {
+      throw new DidDocumentError('DID Document must have an id', INVALID_DID_DOCUMENT, document);
+    }
+
     // Set the ID and ID type
-    const idType = document.id.includes('k')
+    const idType = document.id.includes('k1')
       ? IdentifierTypes.KEY
       : IdentifierTypes.EXTERNAL;
 
@@ -134,16 +144,13 @@ export class DidDocument implements IDidDocument {
     const isGenesis = document.id === ID_PLACEHOLDER_VALUE;
 
     // Deconstruct the document parts for validation
-    const { id, controller, verificationMethod: vm, service } = document;
+    const { id, verificationMethod: vm, service } = document;
 
     // If not genesis, validate core properties
     if (!isGenesis) {
       if (!DidDocument.isValidId(id)) {
         throw new DidDocumentError(`Invalid id: ${id}`, INVALID_DID_DOCUMENT, document);
       }
-      if(!DidDocument.isValidController(controller ?? [id])) {
-        throw new DidDocumentError(`Invalid controller: ${controller}`, INVALID_DID_DOCUMENT, document);
-      }
       if (!DidDocument.isValidVerificationMethods(vm)) {
         throw new DidDocumentError('Invalid verificationMethod: ' + vm, INVALID_DID_DOCUMENT, document);
       }
@@ -154,10 +161,12 @@ export class DidDocument implements IDidDocument {
 
     // Set core properties
     this.id = document.id;
-    this.verificationMethod = document.verificationMethod;
-    this.service = document.service;
-    this['@context'] = document['@context'] || BTCR2_DID_DOCUMENT_CONTEXT;
-    this.controller = document.controller || [this.id];
+    this.verificationMethod = document.verificationMethod || [];
+    this.service = document.service || [];
+    this['@context'] = document['@context'] || [
+      'https://www.w3.org/TR/did-1.1',
+      'https://btcr2.dev/context/v1'
+    ];
 
     // Relationships logic based on idType
     if (idType === IdentifierTypes.KEY) {
@@ -177,11 +186,12 @@ export class DidDocument implements IDidDocument {
 
     // Sanitize the DID Document
     DidDocument.sanitize(this);
+
     // If the DID Document is not an intermediateDocument, validate it
-    if (!isGenesis) {
-      DidDocument.validate(this);
-    } else {
+    if (isGenesis) {
       this.validateGenesis();
+    } else {
+      DidDocument.validate(this);
     }
   }
 
@@ -189,7 +199,7 @@ export class DidDocument implements IDidDocument {
    * Convert the DidDocument to a JSON object.
    * @returns {DidDocument} The JSON representation of the DidDocument.
    */
-  public json(): DidDocument {
+  public json(): object {
     return Object.fromEntries(Object.entries(this)) as DidDocument;
   }
 
@@ -218,7 +228,7 @@ export class DidDocument implements IDidDocument {
         })
       ],
       service
-    } as IDidDocument;
+    } as Btcr2DidDocument;
     return new DidDocument(document);
   }
 
@@ -228,7 +238,7 @@ export class DidDocument implements IDidDocument {
    * @returns {DidDocument} A new DidDocument.
    */
   public static fromExternalIdentifier(data: ExternalData): DidDocument {
-    return new DidDocument(data as IDidDocument);
+    return new DidDocument(data as Btcr2DidDocument);
   }
 
 
@@ -251,7 +261,7 @@ export class DidDocument implements IDidDocument {
    * @returns {boolean} True if the DID document is valid.
    * @throws {DidDocumentError} If any validation check fails.
    */
-  public static isValid(didDocument: DidDocument): boolean {
+  public static isValid(didDocument: DidDocumentLike): boolean {
     if (!this.isValidContext(didDocument?.['@context'])) {
       throw new DidDocumentError('Invalid "@context"', INVALID_DID_DOCUMENT, didDocument);
     }
@@ -276,7 +286,7 @@ export class DidDocument implements IDidDocument {
    * @param {DidDocument['@context']} context The context to validate.
    * @returns {boolean} True if the context is valid.
    */
-  private static isValidContext(context: DidDocument['@context']): boolean {
+  private static isValidContext(context: unknown): boolean {
     if(!context) return false;
     if(!Array.isArray(context)) return false;
     if(!context.every(ctx => typeof ctx === 'string' && BTCR2_DID_DOCUMENT_CONTEXT.includes(ctx))) return false;
@@ -289,7 +299,8 @@ export class DidDocument implements IDidDocument {
    * @param {string} id The id to validate.
    * @returns {boolean} True if the id is valid.
    */
-  private static isValidId(id: string): boolean {
+  private static isValidId(id: unknown): boolean {
+    if (typeof id !== 'string') return false;
     try {
       Identifier.decode(id);
       return true;
@@ -316,7 +327,7 @@ export class DidDocument implements IDidDocument {
    * @param {DidVerificationMethod[]} verificationMethod The verification methods to validate.
    * @returns {boolean} True if the verification methods are valid.
    */
-  private static isValidVerificationMethods(verificationMethod: IIDidVerificationMethod[]): boolean {
+  private static isValidVerificationMethods(verificationMethod: unknown): boolean {
     return Array.isArray(verificationMethod) && verificationMethod.every(Appendix.isDidVerificationMethod);
   }
 
@@ -326,7 +337,7 @@ export class DidDocument implements IDidDocument {
    * @param {DidService[]} service The services to validate.
    * @returns {boolean} True if the services are valid.
    */
-  private static isValidServices(service: DidService[]): boolean {
+  private static isValidServices(service: unknown): boolean {
     return Array.isArray(service) && service.every(BeaconUtils.isBeaconService);
   }
 
@@ -336,33 +347,25 @@ export class DidDocument implements IDidDocument {
    * @param {DidDocument} didDocument The DID Document to validate.
    * @returns {boolean} True if the verification relationships are valid.
    */
-  public static isValidVerificationRelationships(didDocument: DidDocument): boolean {
-    // Define the available verification relationships
-    const possibleVerificationRelationships: (keyof DidDocument)[] = [
+  public static isValidVerificationRelationships(didDocument: DidDocumentLike): boolean {
+    const possibleVerificationRelationships = [
       'authentication',
       'assertionMethod',
       'capabilityInvocation',
       'capabilityDelegation'
-    ];
-
-    // Get the DID Document keys
-    const verificationRelationships = Object.keys(didDocument) as Array<keyof DidDocument>;
-
-    // Filter the DID Document keys to only those that are in the available verification relationships
-    const availableVerificationRelationships = possibleVerificationRelationships.filter(
-      key => verificationRelationships.includes(key as keyof DidDocument)
-    ) as (keyof DidDocument)[];
-
-    // Check if all available verification relationships are valid
-    return availableVerificationRelationships.every((key) =>
-      // Check if the key exists in the DID Document
-      didDocument[key] &&
-      // Check if the key is an array
-      Array.isArray(didDocument[key]) &&
-      // Check that every value in the array is a string or DidVerificationMethod
-      didDocument[key].every(
-        entry => typeof entry === 'string' || Appendix.isDidVerificationMethod(entry)
-      ));
+    ] as const;
+
+    const keys = Object.keys(didDocument);
+    const availableKeys = possibleVerificationRelationships.filter(key => keys.includes(key));
+
+    return availableKeys.every((key) => {
+      const value = didDocument[key];
+      return value &&
+        Array.isArray(value) &&
+        value.every(
+          (entry) => typeof entry === 'string' || Appendix.isDidVerificationMethod(entry)
+        );
+    });
   }
 
   /**
@@ -370,7 +373,7 @@ export class DidDocument implements IDidDocument {
    * @returns {DidDocument} Validated DID Document.
    * @throws {DidDocumentError} If the DID Document is invalid.
    */
-  public static validate(didDocument: DidDocument | GenesisDocument): DidDocument {
+  public static validate(didDocument: any): DidDocument {
     // Validate the DID Document
     if (didDocument.id === ID_PLACEHOLDER_VALUE) {
       (didDocument as GenesisDocument).validateGenesis();
@@ -390,10 +393,6 @@ export class DidDocument implements IDidDocument {
     if(this.id !== ID_PLACEHOLDER_VALUE) {
       throw new DidDocumentError('Invalid GenesisDocument ID', INVALID_DID_DOCUMENT, this);
     }
-    // Validate the controller
-    if(!this.controller?.every(c => c === ID_PLACEHOLDER_VALUE)) {
-      throw new DidDocumentError('Invalid GenesisDocument controller', INVALID_DID_DOCUMENT, this);
-    }
     // Validate the verificationMethod
     if(!this.verificationMethod.every(vm => vm.id.includes(ID_PLACEHOLDER_VALUE) && vm.controller === ID_PLACEHOLDER_VALUE)) {
       throw new DidDocumentError('Invalid GenesisDocument verificationMethod', INVALID_DID_DOCUMENT, this);
@@ -437,8 +436,8 @@ export class Document {
  * @extends {DidDocument}
  */
 export class GenesisDocument extends DidDocument {
-  constructor(document: object | DidDocument) {
-    super(document as DidDocument);
+  constructor(document: DidDocumentLike) {
+    super(document);
   }
 
   /**
@@ -448,7 +447,7 @@ export class GenesisDocument extends DidDocument {
    */
   public toDidDocument(did: string): DidDocument {
     const stringThis = JSON.stringify(this).replaceAll(ID_PLACEHOLDER_VALUE, did);
-    const parseThis = JSON.parse(stringThis) as IDidDocument;
+    const parseThis = JSON.parse(stringThis) as Btcr2DidDocument;
     return new DidDocument(parseThis);
   }
 
@@ -459,7 +458,7 @@ export class GenesisDocument extends DidDocument {
    * @returns {GenesisDocument} The GenesisDocument representation of the DidDocument.
    */
   public static fromDidDocument(didDocument: DidDocument): GenesisDocument {
-    const intermediateDocument = JSONUtils.cloneReplace(didDocument, DID_REGEX, ID_PLACEHOLDER_VALUE) as IDidDocument;
+    const intermediateDocument = JSONUtils.cloneReplace(didDocument, DID_REGEX, ID_PLACEHOLDER_VALUE) as Btcr2DidDocument;
     return new GenesisDocument(intermediateDocument);
   }
 
@@ -475,8 +474,7 @@ export class GenesisDocument extends DidDocument {
     relationships: VerificationRelationships,
     service: Array<BeaconService>
   ): GenesisDocument {
-    const id = ID_PLACEHOLDER_VALUE;
-    return new GenesisDocument({ id, ...relationships, verificationMethod, service, });
+    return new GenesisDocument({ id: ID_PLACEHOLDER_VALUE, ...relationships, verificationMethod, service, });
   }
 
   /**
@@ -489,7 +487,7 @@ export class GenesisDocument extends DidDocument {
     const id = ID_PLACEHOLDER_VALUE;
     const address = payments.p2pkh({ pubkey: pk.compressed, network: getNetwork(network) })?.address;
     const services = [{
-      id              : `${id}#key-0`,
+      id              : `${id}#service-0`,
       serviceEndpoint : `bitcoin:${address}`,
       type            : 'SingletonBeacon',
     }];
@@ -518,6 +516,15 @@ export class GenesisDocument extends DidDocument {
    * @returns {DidDocument} The created DidDocument.
    */
   public static fromJSON(object: object | DidDocument): GenesisDocument {
-    return new GenesisDocument(object as IDidDocument);
+    return new GenesisDocument(object as Btcr2DidDocument);
+  }
+
+  /**
+   * Convert a GenesisDocument to genesis bytes.
+   * @param {GenesisDocument} genesisDocument The GenesisDocument to convert.
+   * @returns {Bytes} The genesis bytes.
+   */
+  static toGenesisBytes(genesisDocument: GenesisDocumentLike): HashBytes {
+    return Canonicalization.andHash(genesisDocument);
   }
 }