@did-btcr2/method 0.15.0 → 0.17.0

package/src/core/crud/read.ts

@@ -24,7 +24,7 @@ import {
   UnixTimestamp
 } from '@did-btcr2/common';
 import { Cryptosuite, DataIntegrityProof, SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { PublicKey } from '@did-btcr2/keypair';
+import { CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
 import { bytesToHex } from '@noble/hashes/utils';
 import { DidBtcr2 } from '../../did-btcr2.js';
 import { DidResolutionOptions } from '../../interfaces/crud.js';
@@ -136,8 +136,8 @@ export class Resolve {
     // Deconstruct the components
     const { network, genesisBytes } = identifierComponents;
 
-    // Construct a new PublicKey and deconstruct the publicKey and publicKeyMultibase
-    const { compressed: publicKey, multibase: publicKeyMultibase } = new PublicKey(genesisBytes);
+    // Construct a new CompressedSecp256k1PublicKey and deconstruct the publicKey and publicKeyMultibase
+    const { compressed: publicKey, multibase: publicKeyMultibase } = new CompressedSecp256k1PublicKey(genesisBytes);
 
     // Generate the service field for the DID Document
     const service = BeaconUtils.generateBeaconServices({
@@ -154,7 +154,7 @@ export class Resolve {
         id                 : `${identifier}#initialKey`,
         type               : 'Multikey',
         controller         : identifier,
-        publicKeyMultibase : publicKeyMultibase.address
+        publicKeyMultibase : publicKeyMultibase.encoded
       }],
       service
     });
@@ -353,7 +353,7 @@ export class Resolve {
 
     // 10. Set targetDocument to the result of calling the Traverse Bitcoin Blockchain History algorithm
     // passing in contemporaryDIDDocument, contemporaryBlockheight, currentVersionId, targetVersionId,
-    // targetTime, didDocumentHistory, btc1UpdateHashHistory, signalsMetadata, and network.
+    // targetTime, didDocumentHistory, updateHashHistory, signalsMetadata, and network.
     const targetDocument = this.traverseBlockchainHistory({
       contemporaryDidDocument : initialDocument,
       contemporaryBlockHeight : 0,
@@ -361,7 +361,7 @@ export class Resolve {
       targetVersionId,
       targetTime,
       didDocumentHistory      : new Array(),
-      btc1UpdateHashHistory   : new Array(),
+      updateHashHistory       : new Array(),
       signalsMetadata,
       network
     });
@@ -396,7 +396,7 @@ export class Resolve {
    * @param {UnixTimestamp} params.targetTime The timestamp used to target specific historical states of a DID document.
    *    Only Beacon Signals included in the Bitcoin blockchain before the targetTime are processed.
    * @param {boolean} params.didDocumentHistory An array of DID documents ordered ascensing by version (1...N).
-   * @param {boolean} params.btc1UpdateHashHistory An array of SHA256 hashes of BTCR2 Updates ordered by version that are
+   * @param {boolean} params.updateHashHistory An array of SHA256 hashes of BTCR2 Updates ordered by version that are
    *    applied to the DID document in order to construct the contemporaryDIDDocument.
    * @param {SignalsMetadata} params.signalsMetadata See {@link SignalsMetadata} for details.
    * @param {string} params.network The bitcoin network to connect to (mainnet, signet, testnet, regtest).
@@ -409,7 +409,7 @@ export class Resolve {
     targetVersionId,
     targetTime,
     didDocumentHistory,
-    btc1UpdateHashHistory,
+    updateHashHistory,
     signalsMetadata,
     network
   }: {
@@ -419,7 +419,7 @@ export class Resolve {
     targetVersionId?: number;
     targetTime: number;
     didDocumentHistory: DidDocument[];
-    btc1UpdateHashHistory: string[];
+    updateHashHistory: string[];
     signalsMetadata: SignalsMetadata;
     network: string;
   }): Promise<DidDocument> {
@@ -463,8 +463,8 @@ export class Resolve {
       // 10.1. If update.targetVersionId is less than or equal to currentVersionId, run Algorithm Confirm Duplicate
       //      Update passing in update, documentHistory, and contemporaryHash.
       if (updateTargetVersionId <= currentVersionId) {
-        btc1UpdateHashHistory.push(contemporaryHash);
-        await this.confirmDuplicateUpdate({ update, updateHashHistory: btc1UpdateHashHistory });
+        updateHashHistory.push(contemporaryHash);
+        await this.confirmDuplicateUpdate({ update, updateHashHistory: updateHashHistory });
 
         //  10.2. If update.targetVersionId equals currentVersionId + 1:
       } else if (updateTargetVersionId === currentVersionId + 1) {
@@ -498,8 +498,8 @@ export class Resolve {
         // 10.2.7 Set updateHash to the result of passing unsecuredUpdate into the JSON Canonicalization and Hash algorithm.
         const updateHash = await JSON.canonicalization.process(update, 'base58');
 
-        // 10.2.8. Push updateHash onto btc1UpdateHashHistory.
-        btc1UpdateHashHistory.push(updateHash as string);
+        // 10.2.8. Push updateHash onto updateHashHistory.
+        updateHashHistory.push(updateHash as string);
 
         // 10.2.9. Set contemporaryHash to result of passing contemporaryDIDDocument into the JSON Canonicalization and Hash algorithm.
         contemporaryHash = await JSON.canonicalization.process(contemporaryDidDocument, 'base58');
@@ -796,19 +796,19 @@ export class Resolve {
     // Establish a Beacon instance using the service and sidecar
     const beacon = BeaconFactory.establish(service, sidecar);
 
-    // 2.5 Set btc1Update to null.
-    const btc1Update = await beacon.processSignal(signalTx, signalsMetadata) ?? null;
+    // 2.5 Set didUpdate to null.
+    const didUpdate = await beacon.processSignal(signalTx, signalsMetadata) ?? null;
 
     // If the updates is null, throw an error
-    if (!btc1Update) {
-      throw new MethodError('No btc1Update for beacon', 'PROCESS_BEACON_SIGNALS_ERROR', { tx, signalsMetadata });
+    if (!didUpdate) {
+      throw new MethodError('No didUpdate for beacon', 'PROCESS_BEACON_SIGNALS_ERROR', { tx, signalsMetadata });
     }
 
-    // 2.9 If btc1Update is not null, push btc1Update to updates.
-    updates.push(btc1Update);
+    // 2.9 If didUpdate is not null, push didUpdate to updates.
+    updates.push(didUpdate);
 
     // 3. Return updates.
-    return btc1Update;
+    return didUpdate;
   }
 
   /**
@@ -824,7 +824,7 @@ export class Resolve {
    * @param {DidUpdatePayload} params.update The DID Update Payload to confirm.
    * @param {Array<string>} params.updateHashHistory The history of hashes for previously applied updates.
    * @returns {Promise<void>} A promise that resolves if the update is a duplicate, otherwise throws an error.
-   * @throws {DidBtc1Error} if the update hash does not match the historical hash.
+   * @throws {ResolveError} if the update hash does not match the historical hash.
    */
   public static async confirmDuplicateUpdate({ update, updateHashHistory }: {
     update: DidUpdatePayload;

package/src/core/crud/update.ts

@@ -12,7 +12,7 @@ import {
   ProofOptions
 } from '@did-btcr2/common';
 import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { SchnorrKeyPair, SecretKey } from '@did-btcr2/keypair';
+import { SchnorrKeyPair, Secp256k1SecretKey } from '@did-btcr2/keypair';
 import type { DidService } from '@web5/dids';
 import { BeaconService } from '../../interfaces/ibeacon.js';
 import { SignalsMetadata } from '../../types/crud.js';
@@ -21,6 +21,18 @@ import { DidDocument, DidVerificationMethod } from '../../utils/did-document.js'
 import { BeaconFactory } from '../beacon/factory.js';
 import { KeyManager } from '../key-manager/index.js';
 
+export interface ConstructUpdateParams {
+    identifier: string;
+    sourceDocument: DidDocument;
+    sourceVersionId: number;
+    patch: PatchOperation[];
+}
+
+export interface UpdateParams extends ConstructUpdateParams {
+    verificationMethodId: string;
+    beaconIds: string[];
+}
+
 export type InvokePayloadParams = {
   identifier: string;
   didUpdatePayload: DidUpdatePayload;
@@ -158,7 +170,7 @@ export class Update {
           id,
           controller,
           keys : new SchnorrKeyPair({
-            secretKey : SecretKey.decode(secretKeyMultibase)
+            secretKey : Secp256k1SecretKey.decode(secretKeyMultibase)
           })
         });
 

package/src/core/key-manager/index.ts

@@ -10,7 +10,7 @@ import {
   SignatureBytes
 } from '@did-btcr2/common';
 import { SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { PublicKey, SchnorrKeyPair } from '@did-btcr2/keypair';
+import { CompressedSecp256k1PublicKey, SchnorrKeyPair } from '@did-btcr2/keypair';
 import { sha256 } from '@noble/hashes/sha2';
 import { KeyValueStore, MemoryStore } from '@web5/common';
 import { KeyIdentifier } from '@web5/crypto';
@@ -104,11 +104,11 @@ export class KeyManager implements IKeyManager, CryptoSigner, BitcoinSigner  {
   }
 
   /**
-   * Gets the key pair from the key store and returns a PublicKey.
+   * Gets the key pair from the key store and returns a CompressedSecp256k1PublicKey.
    * @param {KeyIdentifier} keyUri The URI of the key to get the public key for.
-   * @returns {Promise<PublicKey>} The public key associated with the key URI.
+   * @returns {Promise<CompressedSecp256k1PublicKey>} The public key associated with the key URI.
    */
-  public async getPublicKey(keyUri?: KeyIdentifier): Promise<PublicKey> {
+  public async getPublicKey(keyUri?: KeyIdentifier): Promise<CompressedSecp256k1PublicKey> {
     // Use the active key URI if not provided
     const key = await this.getKey(keyUri);
 
@@ -264,13 +264,13 @@ export class KeyManager implements IKeyManager, CryptoSigner, BitcoinSigner  {
 
   /**
    * Computes a multibase-compliant URI from a key.
-   * @param key A SchnorrKeyPair, PublicKey, or multibase string
+   * @param key A SchnorrKeyPair, CompressedSecp256k1PublicKey, or multibase string
    * @returns {string} A multibase URI (e.g. 'urn:mb:zQ3s...')
    */
-  public static toMultibaseUri(data: SchnorrKeyPair | PublicKey | Multibase<'zQ3s'>): string {
+  public static toMultibaseUri(data: SchnorrKeyPair | CompressedSecp256k1PublicKey | Multibase<'zQ3s'>): string {
     const multibase = data instanceof SchnorrKeyPair
       ? data.publicKey.multibase
-      : data instanceof PublicKey
+      : data instanceof CompressedSecp256k1PublicKey
         ? data.multibase
         : data;
 

package/src/core/key-manager/interface.ts

@@ -1,6 +1,6 @@
 import { HashBytes, Hex, SignatureBytes } from '@did-btcr2/common';
 import { Multikey, SchnorrMultikey } from '@did-btcr2/cryptosuite';
-import { SchnorrKeyPair, PublicKey } from '@did-btcr2/keypair';
+import { SchnorrKeyPair, CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
 import { KeyValueStore } from '@web5/common';
 
 export type KeyManagerOptions = {
@@ -77,9 +77,9 @@ export interface IKeyManager {
     /**
      * Gets the public key of a key pair.
      * @param {KeyIdentifier} keyUri The URI of the key to get the public key for.
-     * @returns {Promise<PublicKey>} The public key of the key pair.
+     * @returns {Promise<CompressedSecp256k1PublicKey>} The public key of the key pair.
      */
-    getPublicKey(keyUri: KeyIdentifier): Promise<PublicKey>;
+    getPublicKey(keyUri: KeyIdentifier): Promise<CompressedSecp256k1PublicKey>;
 
     /**
      * Imports a key pair into the key store.

package/src/did-btcr2.ts

@@ -1,9 +1,9 @@
 import {
-  MethodError,
-  IdentifierTypes,
-  INVALID_DID,
+  DocumentBytes,
   INVALID_DID_DOCUMENT,
+  KeyBytes,
   METHOD_NOT_SUPPORTED,
+  MethodError,
   PatchOperation,
   W3C_DID_RESOLUTION_V1
 } from '@did-btcr2/common';
@@ -17,7 +17,6 @@ import {
 } from '@web5/dids';
 import { initEccLib } from 'bitcoinjs-lib';
 import * as tinysecp from 'tiny-secp256k1';
-import { Create, CreateParams, CreateResponse } from './core/crud/create.js';
 import { Resolve } from './core/crud/read.js';
 import { Update } from './core/crud/update.js';
 import { DidResolutionOptions } from './interfaces/crud.js';
@@ -25,6 +24,15 @@ import { Appendix } from './utils/appendix.js';
 import { DidDocument, DidVerificationMethod } from './utils/did-document.js';
 import { Identifier } from './utils/identifier.js';
 
+export type Btcr2Identifier = string;
+
+export interface DidCreateOptions {
+  /** DID BTCR2 Version Number */
+  version?: number;
+  /** Bitcoin Network */
+  network?: string;
+}
+
 /** Initialize tiny secp256k1 */
 initEccLib(tinysecp);
 
@@ -37,7 +45,7 @@ initEccLib(tinysecp);
  *
  * @class DidBtcr2
  * @type {DidBtcr2}
- *
+ * @implements {DidMethod}
  */
 export class DidBtcr2 implements DidMethod {
   /** @type {string} Name of the DID method, as defined in the DID BTCR2 specification */
@@ -61,30 +69,21 @@ export class DidBtcr2 implements DidMethod {
    * @returns {Promise<CreateResponse>} Promise resolving to a CreateResponse object.
    * @throws {DidBtcr2Error} if any of the checks fail
    */
-  public static async create(params: CreateParams): Promise<CreateResponse> {
+  public static async create(params: {
+    idType: 'KEY' | 'EXTERNAL';
+    genesisBytes: KeyBytes | DocumentBytes;
+    options?: DidCreateOptions;
+  }): Promise<Btcr2Identifier> {
     // Deconstruct the idType and options from the params
     const { idType, options = {} } = params;
 
-    // If idType is key, call Create.deterministic
-    if(idType === IdentifierTypes.KEY) {
-      // Deconstruct the pubKeyBytes from the params
-      const { pubKeyBytes } = params;
+    // Deconstruct the version and network from the options, setting defaults if not given
+    const { version = 1, network = 'bitcoin' } = options;
 
-      // Return call to Create.deterministic
-      return Create.deterministic({ pubKeyBytes, options });
-    }
-
-    // If idType is external, call Create.external
-    if(idType === IdentifierTypes.EXTERNAL) {
-      // Deconstruct the intermediateDocument from the params
-      const { intermediateDocument } = params;
-
-      // Return call to Create.external
-      return await Create.external({ intermediateDocument, options });
-    }
+    // Set the genesisBytes from the params
+    const genesisBytes = params.genesisBytes;
 
-    // Throw error if idType is not key or external
-    throw new MethodError('Invalid idType: expected "KEY" or "EXTERNAL"', INVALID_DID, params);
+    return Identifier.encode({ idType, genesisBytes, version, network });
   }
 
   /**
@@ -176,7 +175,7 @@ export class DidBtcr2 implements DidMethod {
    * @param {string} params.identifier The btcr2 identifier to be updated.
    * @param {DidDocument} params.sourceDocument The DID document being updated.
    * @param {string} params.sourceVersionId The versionId of the source document.
-   * @param {Btc1DocumentPatch} params.documentPatch The JSON patch to be applied to the source document.
+   * @param {PatchOperation} params.documentPatch The JSON patch to be applied to the source document.
    * @param {string} params.verificationMethodId The verificationMethod ID to sign the update
    * @param {string[]} params.beaconIds The beacon IDs to announce the update
    * @returns {Promise<void>} Promise resolving to void

package/src/index.ts

@@ -3,7 +3,6 @@ export * from './core/beacon/factory.js';
 export * from './core/beacon/singleton.js';
 export * from './core/beacon/smt-aggregate.js';
 
-export * from './core/crud/create.js';
 export * from './core/crud/deactivate.js';
 export * from './core/crud/read.js';
 export * from './core/crud/update.js';

package/src/interfaces/crud.ts

@@ -1,4 +1,3 @@
-import { BitcoinCoreRpcClient } from '@did-btcr2/bitcoin';
 import { UnixTimestamp } from '@did-btcr2/common';
 import { DidResolutionOptions as IDidResolutionOptions } from '@web5/dids';
 import { SidecarData } from '../types/crud.js';
@@ -8,7 +7,6 @@ import { DidDocument } from '../utils/did-document.js';
  * Options for resolving a DID Document
  * @param {?number} versionId The versionId for resolving the DID Document
  * @param {?UnixTimestamp} versionTime The versionTime for resolving the DID Document
- * @param {?BitcoinCoreRpcClient} rpc BitcoinCoreRpcClient client connection
  * @param {?SidecarData} sidecarData The sidecar data for resolving the DID Document
  */
 export interface DidResolutionOptions extends IDidResolutionOptions {
@@ -16,9 +14,8 @@ export interface DidResolutionOptions extends IDidResolutionOptions {
   versionTime?: UnixTimestamp;
   sidecarData?: SidecarData;
   network?: string;
-  rpc?: BitcoinCoreRpcClient;
 }
-export interface Btc1RootCapability {
+export interface RootCapability {
     '@context': string;
     id: string;
     controller: string;

package/src/types/crud.ts

@@ -8,23 +8,23 @@ export type FindNextSignals = {
   beacons: BeaconService[]
 };
 export type Metadata = {
-  btc1Update: DidUpdatePayload;
+  didUpdate: DidUpdatePayload;
   proofs?: string;
 };
 export type SignalSidecarData = Metadata;
-export interface Btc1SidecarData {
+export interface Sidecar {
   did: string;
 }
 export type SignalsMetadata = { [signalId: string]: Metadata; };
-export interface SingletonSidecar extends Btc1SidecarData {
+export interface SingletonSidecar extends Sidecar {
   signalsMetadata: SignalsMetadata;
 }
-export interface CIDAggregateSidecar extends Btc1SidecarData {
+export interface CIDAggregateSidecar extends Sidecar {
   initialDocument: DidDocument;
   signalsMetadata: SignalsMetadata;
   cidUpdates: Array<string>;
 }
-export interface SMTAggregateSidecar extends Btc1SidecarData {
+export interface SMTAggregateSidecar extends Sidecar {
   initialDocument: DidDocument;
   signalsMetadata: SignalsMetadata;
   smtProof: ProofBytes;

package/src/utils/appendix.ts

@@ -10,7 +10,7 @@ import {
 import { createHelia } from 'helia';
 import { CID } from 'multiformats';
 import { create as createDigest } from 'multiformats/hashes/digest';
-import { Btc1RootCapability } from '../interfaces/crud.js';
+import { RootCapability } from '../interfaces/crud.js';
 import { DidVerificationMethod } from './did-document.js';
 
 export interface DidComponents {
@@ -97,7 +97,7 @@ export class Appendix {
 
 
   /**
-   * Implements {@link https://dcdpr.github.io/did-btcr2/#derive-root-capability-from-didbtc1-identifier | 9.4.1 Derive Root Capability from did:btcr2 Identifier}.
+   * Implements {@link https://dcdpr.github.io/did-btcr2/#derive-root-capability-from-didbtcr2-identifier | 9.4.1 Derive Root Capability from did:btcr2 Identifier }.
    *
    * The Derive Root Capability algorithm deterministically generates a ZCAP-LD root capability from a given did:btcr2
    * identifier. Each root capability is unique to the identifier. This root capability is defined and understood by the
@@ -105,7 +105,7 @@ export class Appendix {
    * document. It takes in a did:btcr2 identifier and returns a rootCapability object. It returns the root capability.
    *
    * @param {string} identifier The did-btcr2 identifier to derive the root capability from
-   * @returns {Btc1RootCapability} The root capability object
+   * @returns {RootCapability} The root capability object
    * @example Root capability for updating the DID document for
    * did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u
    * ```
@@ -117,9 +117,9 @@ export class Appendix {
    * }
    * ```
    */
-  public static deriveRootCapability(identifier: string): Btc1RootCapability {
+  public static deriveRootCapability(identifier: string): RootCapability {
     // 1. Define rootCapability as an empty object.
-    const rootCapability = {} as Btc1RootCapability;
+    const rootCapability = {} as RootCapability;
 
     // 2. Set rootCapability.@context to ‘https://w3id.org/zcap/v1’.
     rootCapability['@context'] = W3C_ZCAP_V1;
@@ -148,7 +148,7 @@ export class Appendix {
    * capability object.
    *
    * @param {string} capabilityId The root capability identifier to dereference.
-   * @returns {Btc1RootCapability} The root capability object.
+   * @returns {RootCapability} The root capability object.
    * @example a didUpdatePayload with an invoked ZCAP-LD capability containing a patch defining how the DID document
    * for did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u SHOULD be mutated.
    * ```
@@ -174,16 +174,16 @@ export class Appendix {
    *    "cryptosuite": "schnorr-secp256k1-jcs-2025",
    *    "verificationMethod": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u#initialKey",
    *    "invocationTarget": "did:btcr2:k1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
-   *    "capability": "urn:zcap:root:did%3Abtc1%3Ak1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
+   *    "capability": "urn:zcap:root:did%3Abtcr2%3Ak1q0rnnwf657vuu8trztlczvlmphjgc6q598h79cm6sp7c4fgqh0fkc0vzd9u",
    *    "capabilityAction": "Write",
    *    "proofPurpose": "assertionMethod",
    *    "proofValue": "z381yXYmxU8NudZ4HXY56DfMN6zfD8syvWcRXzT9xD9uYoQToo8QsXD7ahM3gXTzuay5WJbqTswt2BKaGWYn2hHhVFKJLXaDz"
    *   }
    * }
    */
-  public static derefernceRootCapabilityIdentifier(capabilityId: string): Btc1RootCapability {
+  public static derefernceRootCapabilityIdentifier(capabilityId: string): RootCapability {
     // 1. Set rootCapability to an empty object.
-    const rootCapability = {} as Btc1RootCapability;
+    const rootCapability = {} as RootCapability;
 
     // 2. Set components to the result of capabilityId.split(":").
     const [urn, zcap, root, did] = capabilityId.split(':') ?? [];

package/src/utils/did-document-builder.ts

@@ -2,7 +2,7 @@ import { DidDocumentError, INVALID_DID_DOCUMENT } from '@did-btcr2/common';
 import { BeaconService } from '../interfaces/ibeacon.js';
 import { DidDocument, DidVerificationMethod } from './did-document.js';
 
-export class Btc1DidDocumentBuilder {
+export class DidDocumentBuilder {
   private document: Partial<DidDocument> = {};
 
   constructor(initialDocument: Partial<DidDocument>) {

package/src/utils/did-document.ts

@@ -1,20 +1,23 @@
+import { getNetwork } from '@did-btcr2/bitcoin';
 import {
   BTCR2_DID_DOCUMENT_CONTEXT,
-  IdentifierTypes,
   DidDocumentError,
   ID_PLACEHOLDER_VALUE,
+  IdentifierTypes,
   INVALID_DID_DOCUMENT,
   JSONObject,
+  KeyBytes,
   Logger
 } from '@did-btcr2/common';
-import { DidService, DidVerificationMethod as IIDidVerificationMethod, DidDocument as IIDidDocument } from '@web5/dids';
+import { CompressedSecp256k1PublicKey } from '@did-btcr2/keypair';
+import { DidService, DidDocument as IIDidDocument, DidVerificationMethod as IIDidVerificationMethod } from '@web5/dids';
 import { BeaconService } from '../interfaces/ibeacon.js';
 import { Appendix } from './appendix.js';
 import { BeaconUtils } from './beacons.js';
 import { Identifier } from './identifier.js';
 
 export const BECH32M_CHARS = '';
-export const BTC1_DID_REGEX = /did:btcr2:(x1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*)/g;
+export const DID_REGEX = /did:btcr2:(x1[qpzry9x8gf2tvdw0s3jn54khce6mua7l]*)/g;
 
 export type ExternalData = {
   id: string,
@@ -120,6 +123,7 @@ export class DidDocument implements IDidDocument {
   service: Array<BeaconService>;
 
   constructor(document: IDidDocument) {
+    console.log('Constructing DidDocument with document:', document);
     // Set the ID and ID type
     const idType = document.id.includes('k1')
       ? IdentifierTypes.KEY
@@ -388,7 +392,7 @@ export class DidDocument implements IDidDocument {
    * Validate the IntermediateDidDocument.
    * @returns {boolean} True if the IntermediateDidDocument is valid.
    */
-  public validateIntermediate(): void {
+  public validateIntermediate(): boolean {
     // Validate the id
     if(this.id !== ID_PLACEHOLDER_VALUE) {
       throw new DidDocumentError('Invalid IntermediateDidDocument ID', INVALID_DID_DOCUMENT, this);
@@ -409,6 +413,8 @@ export class DidDocument implements IDidDocument {
       // Return true if all validations pass
       throw new DidDocumentError('Invalid IntermediateDidDocument assertionMethod', INVALID_DID_DOCUMENT, this);
     }
+
+    return true;
   }
 
   /**
@@ -431,9 +437,30 @@ export class DidDocument implements IDidDocument {
  * @extends {DidDocument}
  */
 export class IntermediateDidDocument extends DidDocument {
-  constructor(document: IDidDocument) {
-    const intermediateDocument = JSON.cloneReplace(document, BTC1_DID_REGEX, ID_PLACEHOLDER_VALUE) as IDidDocument;
-    super(intermediateDocument);
+  constructor(document: JSONObject) {
+    super(document as IDidDocument);
+  }
+
+  /**
+   * Convert the IntermediateDidDocument to a DidDocument by replacing the placeholder value with the provided DID.
+   * @param did The DID to replace the placeholder value in the document.
+   * @returns {DidDocument} A new DidDocument with the placeholder value replaced by the provided DID.
+   */
+  public toDidDocument(did: string): DidDocument {
+    const stringThis = JSON.stringify(this).replaceAll(ID_PLACEHOLDER_VALUE, did);
+    const parseThis = JSON.parse(stringThis) as IDidDocument;
+    return new DidDocument(parseThis);
+  }
+
+
+  /**
+   * Create an IntermediateDidDocument from a DidDocument by replacing the DID with a placeholder value.
+   * @param {DidDocument} didDocument The DidDocument to convert.
+   * @returns {IntermediateDidDocument} The IntermediateDidDocument representation of the DidDocument.
+   */
+  public static fromDidDocument(didDocument: DidDocument): IntermediateDidDocument {
+    const intermediateDocument = JSON.cloneReplace(didDocument, DID_REGEX, ID_PLACEHOLDER_VALUE) as IDidDocument;
+    return new IntermediateDidDocument(intermediateDocument);
   }
 
   /**
@@ -453,22 +480,51 @@ export class IntermediateDidDocument extends DidDocument {
   }
 
   /**
-   * Convert the IntermediateDidDocument to a DidDocument by replacing the placeholder value with the provided DID.
-   * @param did The DID to replace the placeholder value in the document.
-   * @returns {DidDocument} A new DidDocument with the placeholder value replaced by the provided DID.
+   * Create a minimal IntermediateDidDocument from a public key.
+   * @param {KeyBytes} publicKey The public key in bytes format.
+   * @returns {IntermediateDidDocument} A new IntermediateDidDocument with the placeholder ID.
    */
-  public toDidDocument(did: string): DidDocument {
-    const stringThis = JSON.stringify(this).replaceAll(ID_PLACEHOLDER_VALUE, did);
-    const parseThis = JSON.parse(stringThis) as IDidDocument;
-    return new DidDocument(parseThis);
+  public static fromPublicKey(publicKey: KeyBytes, network: string): IntermediateDidDocument {
+    const pk = new CompressedSecp256k1PublicKey(publicKey);
+    const id = ID_PLACEHOLDER_VALUE;
+    const service = BeaconUtils.generateBeaconService({
+      id          : `${id}#key-0`,
+      publicKey   : pk.compressed,
+      network     : getNetwork(network),
+      addressType : 'p2pkh',
+      type        : 'SingletonBeacon',
+    });
+
+    const relationships = {
+      authentication       : [`${id}#key-0`],
+      assertionMethod      : [`${id}#key-0`],
+      capabilityInvocation : [`${id}#key-0`],
+      capabilityDelegation : [`${id}#key-0`]
+    };
+    const verificationMethod = [
+      {
+        id                 : `${id}#key-0`,
+        type               : 'Multikey',
+        controller         : id,
+        publicKeyMultibase : pk.multibase.encoded,
+      }
+    ];
+
+    return IntermediateDidDocument.create(verificationMethod, relationships, [service]);
   }
 
   /**
-   * Create a DidDocument from a JSON object.
+   * Taken an object, convert it to an IntermediateDocuemnt and then to a DidDocument.
    * @param {JSONObject} object The JSON object to convert.
    * @returns {DidDocument} The created DidDocument.
    */
-  public static from(object: JSONObject): DidDocument {
-    return new IntermediateDidDocument(object as IDidDocument).toDidDocument(object.id as string);
+  public static fromJSON(object: JSONObject): IntermediateDidDocument {
+    return new IntermediateDidDocument(object as IDidDocument);
+  }
+}
+
+export class Document {
+  public static isValid(didDocument: DidDocument | IntermediateDidDocument): boolean {
+    return new DidDocument(didDocument).validateIntermediate();
   }
 }

package/src/utils/identifier.ts

@@ -1,5 +1,5 @@
 import { BitcoinNetworkNames, MethodError, IdentifierTypes, Bytes, INVALID_DID, METHOD_NOT_SUPPORTED } from '@did-btcr2/common';
-import { PublicKey, SchnorrKeyPair } from '@did-btcr2/keypair';
+import { CompressedSecp256k1PublicKey, SchnorrKeyPair } from '@did-btcr2/keypair';
 import { bech32m } from '@scure/base';
 import { DidComponents } from './appendix.js';
 
@@ -16,7 +16,7 @@ import { DidComponents } from './appendix.js';
  */
 export class Identifier {
   /**
-   * Implements {@link https://dcdpr.github.io/did-btcr2/#didbtc1-identifier-encoding | 3.2 did:btcr2 Identifier Encoding}.
+   * Implements {@link https://dcdpr.github.io/did-btcr2/#didbtcr2-identifier-encoding | 3.2 did:btcr2 Identifier Encoding}.
    *
    * A did:btcr2 DID consists of a did:btcr2 prefix, followed by an id-bech32 value, which is a Bech32m encoding of:
    *  - the specification version;
@@ -61,7 +61,7 @@ export class Identifier {
     // 5. If idType is “key” and genesisBytes is not a valid compressed secp256k1 public key, raise invalidDid error.
     if (idType === 'KEY') {
       try {
-        new PublicKey(genesisBytes);
+        new CompressedSecp256k1PublicKey(genesisBytes);
       } catch {
         throw new MethodError(
           'Expected "genesisBytes" to be a valid compressed secp256k1 public key',
@@ -125,7 +125,7 @@ export class Identifier {
   }
 
   /**
-   * Implements {@link https://dcdpr.github.io/did-btcr2/#didbtc1-identifier-decoding | 3.3 did:btcr2 Identifier Decoding}.
+   * Implements {@link https://dcdpr.github.io/did-btcr2/#didbtcr2-identifier-decoding | 3.3 did:btcr2 Identifier Decoding}.
    * @param {string} identifier The BTCR2 DID to be parsed
    * @returns {DidComponents} The parsed identifier components. See {@link DidComponents} for details.
    * @throws {DidError} if an error occurs while parsing the identifier
@@ -248,7 +248,7 @@ export class Identifier {
     // 19. If idType is “key” and genesisBytes is not a valid compressed secp256k1 public key, raise invalidDid error.
     if (idType === 'KEY') {
       try {
-        new PublicKey(genesisBytes);
+        new CompressedSecp256k1PublicKey(genesisBytes);
       } catch {
         throw new MethodError(`Invalid genesisBytes: ${genesisBytes}`, INVALID_DID, { identifier });
       }