@cheqd/sdk-esm 5.3.4-develop.2

package/build/modules/did.js

@@ -0,0 +1,1013 @@
+import { createPagination, createProtobufRpcClient } from '@cosmjs/stargate';
+import { AbstractCheqdSDKModule } from './_.js';
+import { ISignInputs, VerificationMethods, } from '../types.js';
+import { MsgCreateDidDoc, MsgCreateDidDocPayload, MsgCreateDidDocResponse, MsgDeactivateDidDoc, MsgDeactivateDidDocPayload, MsgDeactivateDidDocResponse, MsgUpdateDidDoc, MsgUpdateDidDocPayload, MsgUpdateDidDocResponse, protobufPackage, QueryClientImpl, VerificationMethod, } from '@cheqd/ts-proto/cheqd/did/v2/index.js';
+import { v4 } from 'uuid';
+import { assert } from '@cosmjs/utils';
+import { denormalizeService, normalizeAuthentication, normalizeController, normalizeService } from '../utils.js';
+/** Default extension key for DID-related query operations */
+export const defaultDidExtensionKey = 'did';
+/**
+ * Standard W3C and DID-related context URIs used in DID documents.
+ * These contexts define the semantic meaning of properties in DID documents.
+ */
+export const contexts = {
+    /** W3C DID Core v1 context */
+    W3CDIDv1: 'https://www.w3.org/ns/did/v1',
+    /** Ed25519 Signature Suite 2020 context */
+    W3CSuiteEd255192020: 'https://w3id.org/security/suites/ed25519-2020/v1',
+    /** Ed25519 Signature Suite 2018 context */
+    W3CSuiteEd255192018: 'https://w3id.org/security/suites/ed25519-2018/v1',
+    /** JSON Web Signature Suite 2020 context */
+    W3CSuiteJws2020: 'https://w3id.org/security/suites/jws-2020/v1',
+    /** Linked Domains context for domain verification */
+    LinkedDomainsContext: 'https://identity.foundation/.well-known/did-configuration/v1',
+};
+/**
+ * Protobuf message type literals for DID operations.
+ * Used for consistent message type identification across the module.
+ */
+export const protobufLiterals = {
+    /** Create DID document message type */
+    MsgCreateDidDoc: 'MsgCreateDidDoc',
+    /** Create DID document response message type */
+    MsgCreateDidDocResponse: 'MsgCreateDidDocResponse',
+    /** Update DID document message type */
+    MsgUpdateDidDoc: 'MsgUpdateDidDoc',
+    /** Update DID document response message type */
+    MsgUpdateDidDocResponse: 'MsgUpdateDidDocResponse',
+    /** Deactivate DID document message type */
+    MsgDeactivateDidDoc: 'MsgDeactivateDidDoc',
+    /** Deactivate DID document response message type */
+    MsgDeactivateDidDocResponse: 'MsgDeactivateDidDocResponse',
+};
+/** Type URL for MsgCreateDidDoc messages */
+export const typeUrlMsgCreateDidDoc = `/${protobufPackage}.${protobufLiterals.MsgCreateDidDoc}`;
+/** Type URL for MsgCreateDidDocResponse messages */
+export const typeUrlMsgCreateDidDocResponse = `/${protobufPackage}.${protobufLiterals.MsgCreateDidDocResponse}`;
+/** Type URL for MsgUpdateDidDoc messages */
+export const typeUrlMsgUpdateDidDoc = `/${protobufPackage}.${protobufLiterals.MsgUpdateDidDoc}`;
+/** Type URL for MsgUpdateDidDocResponse messages */
+export const typeUrlMsgUpdateDidDocResponse = `/${protobufPackage}.${protobufLiterals.MsgUpdateDidDocResponse}`;
+/** Type URL for MsgDeactivateDidDoc messages */
+export const typeUrlMsgDeactivateDidDoc = `/${protobufPackage}.${protobufLiterals.MsgDeactivateDidDoc}`;
+/** Type URL for MsgDeactivateDidDocResponse messages */
+export const typeUrlMsgDeactivateDidDocResponse = `/${protobufPackage}.${protobufLiterals.MsgDeactivateDidDocResponse}`;
+/**
+ * Type guard function to check if an object is a MsgCreateDidDocEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgCreateDidDocEncodeObject
+ */
+export function isMsgCreateDidDocEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgCreateDidDoc;
+}
+/**
+ * Type guard function to check if an object is a MsgUpdateDidDocEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgUpdateDidDocEncodeObject
+ */
+export function isMsgUpdateDidDocEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgUpdateDidDoc;
+}
+/**
+ * Type guard function to check if an object is a MsgDeactivateDidDocEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgDeactivateDidDocEncodeObject
+ */
+export function isMsgDeactivateDidDocEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgDeactivateDidDoc;
+}
+/**
+ * Type guard function to check if an object is a MsgCreateDidDocResponseEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgCreateDidDocResponseEncodeObject
+ */
+export function MsgCreateDidDocResponseEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgCreateDidDocResponse;
+}
+/**
+ * Type guard function to check if an object is a MsgUpdateDidDocEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgUpdateDidDocEncodeObject
+ */
+export function MsgUpdateDidDocEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgUpdateDidDoc;
+}
+/**
+ * Type guard function to check if an object is a MsgUpdateDidDocResponseEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgUpdateDidDocResponseEncodeObject
+ */
+export function MsgUpdateDidDocResponseEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgUpdateDidDocResponse;
+}
+/**
+ * Type guard function to check if an object is a MsgDeactivateDidDocEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgDeactivateDidDocEncodeObject
+ */
+export function MsgDeactivateDidDocEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgDeactivateDidDoc;
+}
+/**
+ * Type guard function to check if an object is a MsgDeactivateDidDocResponseEncodeObject.
+ *
+ * @param obj - EncodeObject to check
+ * @returns True if the object is a MsgDeactivateDidDocResponseEncodeObject
+ */
+export function MsgDeactiveDidDocResponseEncodeObject(obj) {
+    return obj.typeUrl === typeUrlMsgUpdateDidDocResponse;
+}
+/**
+ * Sets up the DID extension for the querier client.
+ * Creates and configures the DID-specific query methods.
+ *
+ * @param base - Base QueryClient to extend
+ * @returns Configured DID extension with query methods
+ */
+export const setupDidExtension = (base) => {
+    const rpc = createProtobufRpcClient(base);
+    const queryService = new QueryClientImpl(rpc);
+    return {
+        [defaultDidExtensionKey]: {
+            didDoc: async (id) => {
+                const { value } = await queryService.DidDoc({ id });
+                assert(value);
+                return value;
+            },
+            didDocVersion: async (id, versionId) => {
+                const { value } = await queryService.DidDocVersion({ id, version: versionId });
+                assert(value);
+                return value;
+            },
+            allDidDocVersionsMetadata: async (id, paginationKey) => {
+                const response = await queryService.AllDidDocVersionsMetadata({
+                    id,
+                    pagination: createPagination(paginationKey),
+                });
+                return response;
+            },
+        },
+    };
+};
+/**
+ * DID Module class providing comprehensive DID document management functionality.
+ * Handles creation, updates, deactivation, and querying of DID documents on the Cheqd blockchain.
+ */
+export class DIDModule extends AbstractCheqdSDKModule {
+    // @ts-expect-error underlying type `GeneratedType` is intentionally wider
+    static registryTypes = [
+        [typeUrlMsgCreateDidDoc, MsgCreateDidDoc],
+        [typeUrlMsgCreateDidDocResponse, MsgCreateDidDocResponse],
+        [typeUrlMsgUpdateDidDoc, MsgUpdateDidDoc],
+        [typeUrlMsgUpdateDidDocResponse, MsgUpdateDidDocResponse],
+        [typeUrlMsgDeactivateDidDoc, MsgDeactivateDidDoc],
+        [typeUrlMsgDeactivateDidDocResponse, MsgDeactivateDidDocResponse],
+    ];
+    /** Base denomination for Cheqd network transactions */
+    static baseMinimalDenom = 'ncheq';
+    /**
+     * Standard fee amounts for DID operations.
+     * These represent the default costs for different DID document operations.
+     */
+    static fees = {
+        /** Default fee for creating a new DID document */
+        DefaultCreateDidDocFee: { amount: '50000000000', denom: DIDModule.baseMinimalDenom },
+        /** Default fee for updating an existing DID document */
+        DefaultUpdateDidDocFee: { amount: '25000000000', denom: DIDModule.baseMinimalDenom },
+        /** Default fee for deactivating a DID document */
+        DefaultDeactivateDidDocFee: { amount: '10000000000', denom: DIDModule.baseMinimalDenom },
+    };
+    /** Querier extension setup function for DID operations */
+    static querierExtensionSetup = setupDidExtension;
+    /** Querier instance with DID extension capabilities */
+    querier;
+    /**
+     * Constructs a new DID module instance.
+     *
+     * @param signer - Signing client for blockchain transactions
+     * @param querier - Querier client with DID extension for data retrieval
+     */
+    constructor(signer, querier) {
+        super(signer, querier);
+        this.querier = querier;
+        this.methods = {
+            createDidDocTx: this.createDidDocTx.bind(this),
+            updateDidDocTx: this.updateDidDocTx.bind(this),
+            deactivateDidDocTx: this.deactivateDidDocTx.bind(this),
+            queryDidDoc: this.queryDidDoc.bind(this),
+            queryDidDocVersion: this.queryDidDocVersion.bind(this),
+            queryAllDidDocVersionsMetadata: this.queryAllDidDocVersionsMetadata.bind(this),
+        };
+    }
+    /**
+     * Gets the registry types for DID message encoding/decoding.
+     *
+     * @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
+     */
+    getRegistryTypes() {
+        return DIDModule.registryTypes;
+    }
+    /**
+     * Gets the querier extension setup for DID operations.
+     *
+     * @returns Query extension setup function for DID functionality
+     */
+    getQuerierExtensionSetup() {
+        return DIDModule.querierExtensionSetup;
+    }
+    /**
+     * Creates a new DID document transaction on the blockchain.
+     * Validates the DID payload and authentication before submission.
+     *
+     * @param signInputs - Signing inputs or pre-computed signatures for the transaction
+     * @param didPayload - DID document payload to create
+     * @param address - Address of the account submitting the transaction
+     * @param fee - Transaction fee configuration or 'auto' for automatic calculation
+     * @param memo - Optional transaction memo
+     * @param versionId - Optional version identifier for the DID document
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the transaction response
+     * @throws Error if DID payload is not spec compliant or authentication is invalid
+     */
+    async createDidDocTx(signInputs, didPayload, address, fee, memo, versionId, context) {
+        if (!this._signer) {
+            this._signer = context.sdk.signer;
+        }
+        if (!this.querier) {
+            this.querier = context.sdk.querier;
+        }
+        if (!versionId || versionId === '') {
+            versionId = v4();
+        }
+        const { valid, error, protobufVerificationMethod, protobufService } = await DIDModule.validateSpecCompliantPayload(didPayload);
+        if (!valid) {
+            throw new Error(`DID payload is not spec compliant: ${error}`);
+        }
+        const { valid: authenticationValid, error: authenticationError } = await DIDModule.validateAuthenticationAgainstSignatures(didPayload, signInputs, this.querier);
+        if (!authenticationValid) {
+            throw new Error(`DID authentication is not valid: ${authenticationError}`);
+        }
+        const payload = MsgCreateDidDocPayload.fromPartial({
+            context: didPayload?.['@context'],
+            id: didPayload.id,
+            controller: didPayload.controller,
+            verificationMethod: protobufVerificationMethod,
+            authentication: didPayload.authentication,
+            assertionMethod: didPayload.assertionMethod,
+            capabilityInvocation: didPayload.capabilityInvocation,
+            capabilityDelegation: didPayload.capabilityDelegation,
+            keyAgreement: didPayload.keyAgreement,
+            service: protobufService,
+            alsoKnownAs: didPayload.alsoKnownAs,
+            versionId: versionId,
+        });
+        let signatures;
+        if (ISignInputs.isSignInput(signInputs)) {
+            signatures = await this._signer.signCreateDidDocTx(signInputs, payload);
+        }
+        else {
+            signatures = signInputs;
+        }
+        const value = {
+            payload,
+            signatures,
+        };
+        const createDidMsg = {
+            typeUrl: typeUrlMsgCreateDidDoc,
+            value,
+        };
+        if (address === '') {
+            address = (await context.sdk.options.wallet.getAccounts())[0].address;
+        }
+        if (!fee) {
+            fee = await DIDModule.generateCreateDidDocFees(address);
+        }
+        return this._signer.signAndBroadcast(address, [createDidMsg], fee, memo);
+    }
+    /**
+     * Updates an existing DID document transaction on the blockchain.
+     * Validates the updated DID payload and handles key rotation scenarios.
+     *
+     * @param signInputs - Signing inputs or pre-computed signatures for the transaction
+     * @param didPayload - Updated DID document payload
+     * @param address - Address of the account submitting the transaction
+     * @param fee - Transaction fee configuration or 'auto' for automatic calculation
+     * @param memo - Optional transaction memo
+     * @param versionId - Optional version identifier for the updated DID document
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the transaction response
+     * @throws Error if DID payload is not spec compliant or authentication is invalid
+     */
+    async updateDidDocTx(signInputs, didPayload, address, fee, memo, versionId, context) {
+        if (!this._signer) {
+            this._signer = context.sdk.signer;
+        }
+        if (!this.querier) {
+            this.querier = context.sdk.querier;
+        }
+        if (!versionId || versionId === '') {
+            versionId = v4();
+        }
+        const { valid, error, protobufVerificationMethod, protobufService } = await DIDModule.validateSpecCompliantPayload(didPayload);
+        if (!valid) {
+            throw new Error(`DID payload is not spec compliant: ${error}`);
+        }
+        const { valid: authenticationValid, error: authenticationError, externalControllersDocuments, previousDidDocument, } = await DIDModule.validateAuthenticationAgainstSignaturesKeyRotation(didPayload, signInputs, this.querier);
+        if (!authenticationValid) {
+            throw new Error(`DID authentication is not valid: ${authenticationError}`);
+        }
+        const payload = MsgUpdateDidDocPayload.fromPartial({
+            context: didPayload?.['@context'],
+            id: didPayload.id,
+            controller: didPayload.controller,
+            verificationMethod: protobufVerificationMethod,
+            authentication: didPayload.authentication,
+            assertionMethod: didPayload.assertionMethod,
+            capabilityInvocation: didPayload.capabilityInvocation,
+            capabilityDelegation: didPayload.capabilityDelegation,
+            keyAgreement: didPayload.keyAgreement,
+            service: protobufService,
+            alsoKnownAs: didPayload.alsoKnownAs,
+            versionId: versionId,
+        });
+        let signatures;
+        if (ISignInputs.isSignInput(signInputs)) {
+            signatures = await this._signer.signUpdateDidDocTx(signInputs, payload, externalControllersDocuments, previousDidDocument);
+        }
+        else {
+            signatures = signInputs;
+        }
+        const value = {
+            payload,
+            signatures,
+        };
+        const updateDidMsg = {
+            typeUrl: typeUrlMsgUpdateDidDoc,
+            value,
+        };
+        if (address === '') {
+            address = (await context.sdk.options.wallet.getAccounts())[0].address;
+        }
+        if (!fee) {
+            fee = await DIDModule.generateUpdateDidDocFees(address);
+        }
+        return this._signer.signAndBroadcast(address, [updateDidMsg], fee, memo);
+    }
+    /**
+     * Deactivates an existing DID document transaction on the blockchain.
+     * Validates authentication and creates a deactivation transaction.
+     *
+     * @param signInputs - Signing inputs or pre-computed signatures for the transaction
+     * @param didPayload - DID document payload containing the ID to deactivate
+     * @param address - Address of the account submitting the transaction
+     * @param fee - Transaction fee configuration or 'auto' for automatic calculation
+     * @param memo - Optional transaction memo
+     * @param versionId - Optional version identifier for the deactivation
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the transaction response
+     * @throws Error if DID payload is not spec compliant or authentication is invalid
+     */
+    async deactivateDidDocTx(signInputs, didPayload, address, fee, memo, versionId, context) {
+        if (!this._signer) {
+            this._signer = context.sdk.signer;
+        }
+        if (!versionId || versionId === '') {
+            versionId = v4();
+        }
+        const { valid, error, protobufVerificationMethod } = await DIDModule.validateSpecCompliantPayload(didPayload);
+        if (!valid) {
+            throw new Error(`DID payload is not spec compliant: ${error}`);
+        }
+        const { valid: authenticationValid, error: authenticationError } = await DIDModule.validateAuthenticationAgainstSignatures(didPayload, signInputs, this.querier);
+        if (!authenticationValid) {
+            throw new Error(`DID authentication is not valid: ${authenticationError}`);
+        }
+        const payload = MsgDeactivateDidDocPayload.fromPartial({
+            id: didPayload.id,
+            versionId: versionId,
+        });
+        let signatures;
+        if (ISignInputs.isSignInput(signInputs)) {
+            signatures = await this._signer.signDeactivateDidDocTx(signInputs, payload, protobufVerificationMethod);
+        }
+        else {
+            signatures = signInputs;
+        }
+        const value = {
+            payload,
+            signatures,
+        };
+        const deactivateDidMsg = {
+            typeUrl: typeUrlMsgDeactivateDidDoc,
+            value,
+        };
+        if (address === '') {
+            address = (await context.sdk.options.wallet.getAccounts())[0].address;
+        }
+        if (!fee) {
+            fee = await DIDModule.generateDeactivateDidDocFees(address);
+        }
+        return this._signer.signAndBroadcast(address, [deactivateDidMsg], fee, memo);
+    }
+    /**
+     * Queries a DID document by its identifier.
+     * Retrieves the latest version of the DID document with metadata.
+     *
+     * @param id - DID identifier to query
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the DID document with metadata
+     */
+    async queryDidDoc(id, context) {
+        if (!this.querier) {
+            this.querier = context.sdk.querier;
+        }
+        const { didDoc, metadata } = await this.querier[defaultDidExtensionKey].didDoc(id);
+        return {
+            didDocument: await DIDModule.toSpecCompliantPayload(didDoc),
+            didDocumentMetadata: await DIDModule.toSpecCompliantMetadata(metadata),
+        };
+    }
+    /**
+     * Queries a specific version of a DID document by its identifier and version ID.
+     *
+     * @param id - DID identifier to query
+     * @param versionId - Specific version identifier to retrieve
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to the DID document version with metadata
+     */
+    async queryDidDocVersion(id, versionId, context) {
+        if (!this.querier) {
+            this.querier = context.sdk.querier;
+        }
+        const { didDoc, metadata } = await this.querier[defaultDidExtensionKey].didDocVersion(id, versionId);
+        return {
+            didDocument: await DIDModule.toSpecCompliantPayload(didDoc),
+            didDocumentMetadata: await DIDModule.toSpecCompliantMetadata(metadata),
+        };
+    }
+    /**
+     * Queries metadata for all versions of a DID document.
+     * Retrieves version history information for a specific DID.
+     *
+     * @param id - DID identifier to query version metadata for
+     * @param context - Optional SDK context for accessing clients
+     * @returns Promise resolving to array of version metadata and pagination info
+     */
+    async queryAllDidDocVersionsMetadata(id, context) {
+        if (!this.querier) {
+            this.querier = context.sdk.querier;
+        }
+        const { versions, pagination } = await this.querier[defaultDidExtensionKey].allDidDocVersionsMetadata(id);
+        return {
+            didDocumentVersionsMetadata: await Promise.all(versions.map(async (m) => await DIDModule.toSpecCompliantMetadata(m))),
+            pagination,
+        };
+    }
+    /**
+     * Validates a DID document against the Cheqd specification requirements.
+     * Ensures all required fields are present and verification methods are supported.
+     *
+     * @param didDocument - DID document to validate
+     * @returns Promise resolving to validation result with protobuf conversion or error details
+     */
+    static async validateSpecCompliantPayload(didDocument) {
+        // id is required, validated on both compile and runtime
+        if (!didDocument?.id)
+            return { valid: false, error: 'id is required' };
+        // verificationMethod is required
+        if (!didDocument?.verificationMethod)
+            return { valid: false, error: 'verificationMethod is required' };
+        // verificationMethod must be an array
+        if (!Array.isArray(didDocument?.verificationMethod))
+            return { valid: false, error: 'verificationMethod must be an array' };
+        // verificationMethod types must be supported
+        const protoVerificationMethod = didDocument.verificationMethod.map((vm) => {
+            switch (vm?.type) {
+                case VerificationMethods.Ed255192020:
+                    if (!vm?.publicKeyMultibase)
+                        throw new Error('publicKeyMultibase is required');
+                    return VerificationMethod.fromPartial({
+                        id: vm.id,
+                        controller: vm.controller,
+                        verificationMethodType: VerificationMethods.Ed255192020,
+                        verificationMaterial: vm.publicKeyMultibase,
+                    });
+                case VerificationMethods.JWK:
+                    if (!vm?.publicKeyJwk)
+                        throw new Error('publicKeyJwk is required');
+                    return VerificationMethod.fromPartial({
+                        id: vm.id,
+                        controller: vm.controller,
+                        verificationMethodType: VerificationMethods.JWK,
+                        verificationMaterial: JSON.stringify(vm.publicKeyJwk),
+                    });
+                case VerificationMethods.Ed255192018:
+                    if (!vm?.publicKeyBase58)
+                        throw new Error('publicKeyBase58 is required');
+                    return VerificationMethod.fromPartial({
+                        id: vm.id,
+                        controller: vm.controller,
+                        verificationMethodType: VerificationMethods.Ed255192018,
+                        verificationMaterial: vm.publicKeyBase58,
+                    });
+                default:
+                    throw new Error('Unsupported verificationMethod type');
+            }
+        });
+        const protoService = normalizeService(didDocument);
+        return {
+            valid: true,
+            protobufVerificationMethod: protoVerificationMethod,
+            protobufService: protoService,
+        };
+    }
+    /**
+     * Converts a protobuf DID document to a specification-compliant DID document format.
+     * Handles context inclusion, verification method formatting, and service denormalization.
+     *
+     * @param protobufDidDocument - Protobuf DID document to convert
+     * @returns Promise resolving to a spec-compliant DID document
+     */
+    static async toSpecCompliantPayload(protobufDidDocument) {
+        const verificationMethod = protobufDidDocument.verificationMethod.map((vm) => {
+            switch (vm.verificationMethodType) {
+                case VerificationMethods.Ed255192020:
+                    if (!protobufDidDocument.context.includes(contexts.W3CSuiteEd255192020))
+                        protobufDidDocument.context = [...protobufDidDocument.context, contexts.W3CSuiteEd255192020];
+                    return {
+                        id: vm.id,
+                        type: vm.verificationMethodType,
+                        controller: vm.controller,
+                        publicKeyMultibase: vm.verificationMaterial,
+                    };
+                case VerificationMethods.JWK:
+                    if (!protobufDidDocument.context.includes(contexts.W3CSuiteJws2020))
+                        protobufDidDocument.context = [...protobufDidDocument.context, contexts.W3CSuiteJws2020];
+                    return {
+                        id: vm.id,
+                        type: vm.verificationMethodType,
+                        controller: vm.controller,
+                        publicKeyJwk: JSON.parse(vm.verificationMaterial),
+                    };
+                case VerificationMethods.Ed255192018:
+                    if (!protobufDidDocument.context.includes(contexts.W3CSuiteEd255192018))
+                        protobufDidDocument.context = [...protobufDidDocument.context, contexts.W3CSuiteEd255192018];
+                    return {
+                        id: vm.id,
+                        type: vm.verificationMethodType,
+                        controller: vm.controller,
+                        publicKeyBase58: vm.verificationMaterial,
+                    };
+                default:
+                    throw new Error('Unsupported verificationMethod type'); // should never happen
+            }
+        });
+        const service = denormalizeService(protobufDidDocument);
+        const context = (function () {
+            if (protobufDidDocument.context.includes(contexts.W3CDIDv1))
+                return protobufDidDocument.context;
+            return [contexts.W3CDIDv1, ...protobufDidDocument.context];
+        })();
+        const assertionMethod = protobufDidDocument.assertionMethod.map((am) => {
+            try {
+                // Check if the assertionMethod is a DID URL
+                if (!am.startsWith('did:cheqd:')) {
+                    // Parse once if it's a stringified JSON
+                    const parsedAm = JSON.parse(am);
+                    if (typeof parsedAm === 'string') {
+                        // Parse again only if necessary
+                        return JSON.parse(parsedAm);
+                    }
+                    return parsedAm;
+                }
+                return am;
+            }
+            catch (error) {
+                throw new Error(`Unsupported assertionMethod type: ${am}`);
+            }
+        });
+        const specCompliant = {
+            '@context': context,
+            id: protobufDidDocument.id,
+            controller: protobufDidDocument.controller,
+            verificationMethod: verificationMethod,
+            authentication: protobufDidDocument.authentication,
+            assertionMethod: assertionMethod,
+            capabilityInvocation: protobufDidDocument.capabilityInvocation,
+            capabilityDelegation: protobufDidDocument.capabilityDelegation,
+            keyAgreement: protobufDidDocument.keyAgreement,
+            service: service,
+            alsoKnownAs: protobufDidDocument.alsoKnownAs,
+        };
+        if (!protobufDidDocument.authentication?.length)
+            delete specCompliant.authentication;
+        if (!protobufDidDocument.assertionMethod?.length)
+            delete specCompliant.assertionMethod;
+        if (!protobufDidDocument.capabilityInvocation?.length)
+            delete specCompliant.capabilityInvocation;
+        if (!protobufDidDocument.capabilityDelegation?.length)
+            delete specCompliant.capabilityDelegation;
+        if (!protobufDidDocument.keyAgreement?.length)
+            delete specCompliant.keyAgreement;
+        if (!protobufDidDocument.service?.length)
+            delete specCompliant.service;
+        if (!protobufDidDocument.alsoKnownAs?.length)
+            delete specCompliant.alsoKnownAs;
+        return specCompliant;
+    }
+    /**
+     * Converts protobuf metadata to specification-compliant DID document metadata format.
+     * Handles date formatting and optional field normalization.
+     *
+     * @param protobufDidDocument - Protobuf metadata to convert
+     * @returns Promise resolving to spec-compliant DID document metadata
+     */
+    static async toSpecCompliantMetadata(protobufDidDocument) {
+        return {
+            created: protobufDidDocument.created?.toISOString(),
+            updated: protobufDidDocument.updated?.toISOString(),
+            deactivated: protobufDidDocument.deactivated,
+            versionId: protobufDidDocument.versionId,
+            nextVersionId: protobufDidDocument?.nextVersionId,
+            previousVersionId: protobufDidDocument?.previousVersionId,
+        };
+    }
+    /**
+     * Validates that provided signatures match the authentication requirements in a DID document.
+     * Checks signature count, authentication presence, and controller authorization.
+     *
+     * @param didDocument - DID document containing authentication requirements
+     * @param signatures - Array of signatures to validate against authentication
+     * @param querier - Optional querier for retrieving external controller documents
+     * @param externalControllersDidDocuments - Optional pre-loaded external controller documents
+     * @returns Promise resolving to validation result with error details if invalid
+     */
+    static async validateAuthenticationAgainstSignatures(didDocument, signatures, querier, externalControllersDidDocuments) {
+        // validate signatures - case: no signatures
+        if (!signatures || !signatures.length)
+            return { valid: false, error: 'signatures are required' };
+        // validate authentication - case: no authentication when at least one verificationMethod
+        if ((!didDocument.authentication || !didDocument.authentication.length) &&
+            didDocument.verificationMethod?.length)
+            return { valid: false, error: 'authentication is required' };
+        const normalizedAuthentication = normalizeAuthentication(didDocument);
+        // define unique authentication
+        const uniqueAuthentication = new Set(normalizedAuthentication);
+        // validate authentication - case: authentication contains duplicates
+        if (uniqueAuthentication.size < normalizedAuthentication.length)
+            return {
+                valid: false,
+                error: `authentication contains duplicate key references: duplicate key reference ${Array.from(uniqueAuthentication).find((a) => normalizeAuthentication(didDocument).filter((aa) => aa === a).length > 1)}`,
+            };
+        // define unique signatures - shallow, only verificationMethodId, no signature
+        const uniqueSignatures = new Set(signatures.map((s) => s.verificationMethodId));
+        // validate signatures - case: signatures contain duplicates
+        if (uniqueSignatures.size < signatures.length)
+            return {
+                valid: false,
+                error: `signatures contain duplicates: duplicate signature for key reference ${Array.from(uniqueSignatures).find((s) => signatures.filter((ss) => ss.verificationMethodId === s).length > 1)}`,
+            };
+        // validate authentication - case: authentication contains invalid key references
+        if (!Array.from(uniqueAuthentication).every((a) => didDocument.verificationMethod?.some((vm) => vm.id === a)))
+            return {
+                valid: false,
+                error: `authentication contains invalid key references: invalid key reference ${Array.from(uniqueAuthentication).find((a) => !didDocument.verificationMethod?.some((vm) => vm.id === a))}`,
+            };
+        // define whether external controller or not
+        const externalController = normalizeController(didDocument).some((c) => c !== didDocument.id);
+        // validate authentication - case: authentication matches signatures, unique, if no external controller
+        if (!Array.from(uniqueAuthentication).every((a) => uniqueSignatures.has(a)) && !externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueAuthentication).find((a) => !uniqueSignatures.has(a))} is missing`,
+            };
+        // validate signatures - case: authentication matches signatures, unique, excessive signatures, no external controller
+        if (!Array.from(uniqueSignatures).every((s) => uniqueAuthentication.has(s)) && !externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignatures).find((s) => !uniqueAuthentication.has(s))} is not required`,
+            };
+        // return, if no external controller
+        if (!externalController)
+            return { valid: true };
+        // require querier
+        if (!querier)
+            throw new Error('querier is required for external controller validation');
+        // get external controllers
+        const externalControllers = normalizeController(didDocument).filter((c) => c !== didDocument.id);
+        // get external controllers' documents
+        const externalControllersDocuments = await Promise.all(externalControllers?.map(async (c) => {
+            // compute index of external controller's document, if provided
+            const externalControllerDocumentIndex = externalControllersDidDocuments?.findIndex((d) => d.id === c);
+            // get external controller's document, if provided
+            if (externalControllerDocumentIndex !== undefined && externalControllerDocumentIndex !== -1)
+                return externalControllersDidDocuments?.[externalControllerDocumentIndex];
+            // fetch external controller's document
+            const protobufDocument = await querier[defaultDidExtensionKey].didDoc(c);
+            // throw, if not found
+            if (!protobufDocument || !protobufDocument.didDoc)
+                throw new Error(`Document for controller ${c} not found`);
+            // convert to spec compliant payload
+            return await DIDModule.toSpecCompliantPayload(protobufDocument.didDoc);
+        }));
+        // define unique required signatures
+        const uniqueRequiredSignatures = new Set(externalControllersDocuments.concat(didDocument).flatMap((d) => (d ? normalizeAuthentication(d) : [])));
+        // validate authentication - case: authentication matches signatures, unique, if external controller
+        if (!Array.from(uniqueRequiredSignatures).every((a) => uniqueSignatures.has(a)))
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueRequiredSignatures).find((a) => !uniqueSignatures.has(a))} is missing`,
+            };
+        // validate authentication - case: authentication matches signatures, unique, excessive signatures, if external controller
+        if (uniqueRequiredSignatures.size < uniqueSignatures.size)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignatures).find((s) => !uniqueRequiredSignatures.has(s))} is not required`,
+            };
+        // return valid
+        return { valid: true };
+    }
+    /**
+     * Validates authentication against signatures for key rotation scenarios.
+     * Handles validation during DID document updates where keys may have changed.
+     *
+     * @param didDocument - Updated DID document to validate
+     * @param signatures - Array of signatures to validate
+     * @param querier - Querier for retrieving previous DID document and controllers
+     * @param previousDidDocument - Optional previous version of the DID document
+     * @param externalControllersDidDocuments - Optional pre-loaded external controller documents
+     * @returns Promise resolving to validation result with controller documents and previous document
+     */
+    static async validateAuthenticationAgainstSignaturesKeyRotation(didDocument, signatures, querier, previousDidDocument, externalControllersDidDocuments) {
+        // validate signatures - case: no signatures
+        if (!signatures || !signatures.length)
+            return { valid: false, error: 'signatures are required' };
+        // validate authentication - case: no authentication when at least one verificationMethod
+        if ((!didDocument.authentication || !didDocument.authentication.length) &&
+            didDocument.verificationMethod?.length)
+            return { valid: false, error: 'authentication is required' };
+        // define unique authentication
+        const authentication = normalizeAuthentication(didDocument);
+        const uniqueAuthentication = new Set(authentication);
+        // validate authentication - case: authentication contains duplicates
+        if (uniqueAuthentication.size < authentication.length)
+            return {
+                valid: false,
+                error: `authentication contains duplicate key references: duplicate key reference ${Array.from(uniqueAuthentication).find((a) => normalizeAuthentication(didDocument).filter((aa) => aa === a).length > 1)}`,
+            };
+        // define unique signatures
+        const uniqueSignatures = new Set(signatures.map((s) => s.verificationMethodId));
+        // validate authentication - case: authentication contains invalid key references
+        if (!Array.from(uniqueAuthentication).every((a) => didDocument.verificationMethod?.some((vm) => vm.id === a)))
+            return {
+                valid: false,
+                error: `authentication contains invalid key references: invalid key reference ${Array.from(uniqueAuthentication).find((a) => !didDocument.verificationMethod?.some((vm) => vm.id === a))}`,
+            };
+        // lookup previous document
+        if (!previousDidDocument) {
+            // get previous document
+            const previousDocument = await querier[defaultDidExtensionKey].didDoc(didDocument.id);
+            // throw, if not found
+            if (!previousDocument || !previousDocument.didDoc)
+                throw new Error('Previous did document not found');
+            previousDidDocument = await DIDModule.toSpecCompliantPayload(previousDocument.didDoc);
+        }
+        const controllers = normalizeController(didDocument);
+        const previousControllers = normalizeController(previousDidDocument);
+        // define whether external controller or not
+        const externalController = controllers.concat(previousControllers).some((c) => c !== didDocument.id);
+        // define whether key rotation or not (same ID, different material)
+        const keyRotation = !!didDocument.verificationMethod?.some((vm) => previousDidDocument?.verificationMethod?.some((pvm) => pvm.id === vm.id &&
+            (pvm.publicKeyBase58 !== vm.publicKeyBase58 ||
+                pvm.publicKeyMultibase !== vm.publicKeyMultibase ||
+                pvm.publicKeyJwk?.x !== vm.publicKeyJwk?.x)));
+        // define whether key replacement or not (different IDs in authentication)
+        const currentAuthenticationIds = new Set(normalizeAuthentication(didDocument));
+        const previousAuthenticationIds = new Set(normalizeAuthentication(previousDidDocument));
+        const removedKeys = Array.from(previousAuthenticationIds).filter((id) => !currentAuthenticationIds.has(id));
+        const addedKeys = Array.from(currentAuthenticationIds).filter((id) => !previousAuthenticationIds.has(id));
+        const keyReplacement = removedKeys.length > 0 && addedKeys.length > 0;
+        // define controller rotation
+        const controllerRotation = !controllers.every((c) => previousControllers.includes(c)) ||
+            !previousControllers.every((c) => controllers.includes(c));
+        // define rotated controllers
+        const rotatedControllers = controllerRotation
+            ? previousControllers.filter((c) => !controllers.includes(c))
+            : [];
+        // define unique union of authentication
+        const previousAuthentication = normalizeAuthentication(previousDidDocument);
+        const uniqueUnionAuthentication = new Set([...uniqueAuthentication, ...previousAuthentication]);
+        // validate authentication - case: authentication matches signatures, unique, if no external controller, no key rotation, no key replacement
+        if (!Array.from(uniqueUnionAuthentication).every((a) => uniqueSignatures.has(a)) &&
+            !externalController &&
+            !keyRotation &&
+            !keyReplacement)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueAuthentication).find((a) => !uniqueSignatures.has(a))} is missing`,
+            };
+        // define rotated keys
+        const rotatedKeys = keyRotation
+            ? didDocument.verificationMethod?.filter((vm) => previousDidDocument?.verificationMethod?.some((pvm) => pvm.id === vm.id &&
+                (pvm.publicKeyBase58 !== vm.publicKeyBase58 ||
+                    pvm.publicKeyMultibase !== vm.publicKeyMultibase ||
+                    pvm.publicKeyJwk?.x !== vm.publicKeyJwk?.x)))
+            : [];
+        // define unique union of signatures required, including key replacement logic
+        let uniqueUnionSignaturesRequired = new Set();
+        if (keyRotation) {
+            // Existing key rotation logic (same ID, different material)
+            uniqueUnionSignaturesRequired = new Set([
+                ...authentication.filter((a) => rotatedKeys?.find((rk) => a === rk.id)).map((a) => `${a}(document0)`),
+                ...previousAuthentication.map((a) => `${a}(document1)`),
+            ]);
+        }
+        else if (keyReplacement) {
+            // For key replacement, we need signatures from:
+            // 1. The new keys (from current document)
+            // 2. The old keys that are being replaced (from previous document)
+            const newKeySignatures = addedKeys.map((keyId) => `${keyId}(document0)`);
+            const oldKeySignatures = removedKeys
+                .filter((keyId) => previousAuthentication.includes(keyId)) // Only if they were in authentication
+                .map((keyId) => `${keyId}(document1)`);
+            uniqueUnionSignaturesRequired = new Set([...newKeySignatures, ...oldKeySignatures]);
+        }
+        else {
+            // No rotation or replacement
+            uniqueUnionSignaturesRequired = new Set([...authentication.map((a) => `${a}(document0)`)]);
+        }
+        // define frequency of unique union of signatures required
+        const uniqueUnionSignaturesRequiredFrequency = new Map([...uniqueUnionSignaturesRequired].map((s) => [s.replace(new RegExp(/\(document\d+\)/), ''), 0]));
+        // count frequency of unique union of signatures required
+        uniqueUnionSignaturesRequired.forEach((s) => {
+            // define key
+            const key = s.replace(new RegExp(/\(document\d+\)/), '');
+            // increment frequency
+            uniqueUnionSignaturesRequiredFrequency.set(key, uniqueUnionSignaturesRequiredFrequency.get(key) + 1);
+        });
+        // define frequency of signatures provided
+        const uniqueSignaturesFrequency = new Map(signatures.map((s) => [s.verificationMethodId, 0]));
+        // count frequency of signatures provided
+        signatures.forEach((s) => {
+            // increment frequency
+            uniqueSignaturesFrequency.set(s.verificationMethodId, uniqueSignaturesFrequency.get(s.verificationMethodId) + 1);
+        });
+        // validate signatures - case: authentication matches signatures, unique, excessive signatures, no external controller
+        if (Array.from(uniqueSignaturesFrequency).filter(([k, f]) => uniqueUnionSignaturesRequiredFrequency.get(k) === undefined ||
+            (uniqueUnionSignaturesRequiredFrequency.get(k) &&
+                uniqueUnionSignaturesRequiredFrequency.get(k) < f)).length &&
+            !externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignaturesFrequency).find(([k, f]) => uniqueUnionSignaturesRequiredFrequency.get(k) === undefined || uniqueUnionSignaturesRequiredFrequency.get(k) < f)?.[0]} is not required`,
+            };
+        // validate signatures - case: authentication matches signatures, unique, missing signatures, no external controller
+        if (Array.from(uniqueSignaturesFrequency).filter(([k, f]) => uniqueUnionSignaturesRequiredFrequency.get(k) && uniqueUnionSignaturesRequiredFrequency.get(k) > f).length &&
+            !externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignaturesFrequency).find(([k, f]) => uniqueUnionSignaturesRequiredFrequency.get(k) > f)?.[0]} is missing`,
+            };
+        // return, if no external controller
+        if (!externalController)
+            return { valid: true };
+        // require querier
+        if (!querier)
+            throw new Error('querier is required for external controller validation');
+        // get external controllers
+        // Only include rotated controllers if they are external (not the current DID itself)
+        const externalRotatedControllers = rotatedControllers.filter((c) => c !== didDocument.id);
+        const externalControllers = controllers?.filter((c) => c !== didDocument.id).concat(externalRotatedControllers);
+        // get external controllers' documents
+        const externalControllersDocuments = await Promise.all(externalControllers?.map(async (c) => {
+            // compute index of external controller's document, if provided
+            const externalControllerDocumentIndex = externalControllersDidDocuments?.findIndex((d) => d.id === c);
+            // get external controller's document, if provided
+            if (externalControllerDocumentIndex !== undefined && externalControllerDocumentIndex !== -1)
+                return externalControllersDidDocuments[externalControllerDocumentIndex];
+            // fetch external controller's document
+            const protobufDocument = await querier[defaultDidExtensionKey].didDoc(c);
+            // throw, if not found
+            if (!protobufDocument || !protobufDocument.didDoc)
+                throw new Error(`Document for controller ${c} not found`);
+            // convert to spec compliant payload
+            return await DIDModule.toSpecCompliantPayload(protobufDocument.didDoc);
+        }));
+        // define unique required signatures, delimited, with external controllers
+        const uniqueUnionSignaturesRequiredWithExternalControllers = new Set([
+            ...uniqueUnionSignaturesRequired,
+            ...externalControllersDocuments
+                .flatMap((d) => normalizeAuthentication(d))
+                .map((a) => `${a}(document${externalControllersDocuments.findIndex((d) => normalizeAuthentication(d).includes(a))})`),
+        ]);
+        // add rotated controller keys to unique required signatures, if any
+        if (controllerRotation) {
+            // walk through rotated controllers
+            rotatedControllers.forEach((c) => {
+                // get rotated controller's document index
+                const rotatedControllerDocumentIndex = externalControllersDocuments.findIndex((d) => d?.id === c);
+                // early return, if no document
+                if (rotatedControllerDocumentIndex === -1)
+                    return;
+                // get rotated controller's document
+                const rotatedControllerDocument = externalControllersDocuments[rotatedControllerDocumentIndex];
+                // add rotated controller's authentication to unique required signatures
+                rotatedControllerDocument.authentication?.forEach((a) => uniqueUnionSignaturesRequiredWithExternalControllers.add(`${a}(document${rotatedControllerDocumentIndex})`));
+            });
+        }
+        // define frequency of unique union of signatures required, with external controllers
+        const uniqueUnionSignaturesRequiredWithExternalControllersFrequency = new Map([...uniqueUnionSignaturesRequiredWithExternalControllers].map((s) => [
+            s.replace(new RegExp(/\(document\d+\)/), ''),
+            0,
+        ]));
+        // count frequency of unique union of signatures required, with external controllers
+        uniqueUnionSignaturesRequiredWithExternalControllers.forEach((s) => {
+            // define key
+            const key = s.replace(new RegExp(/\(document\d+\)/), '');
+            // increment frequency
+            uniqueUnionSignaturesRequiredWithExternalControllersFrequency.set(key, uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(key) + 1);
+        });
+        // define frequency of signatures provided, with external controllers
+        const uniqueSignaturesFrequencyWithExternalControllers = new Map(signatures.map((s) => [s.verificationMethodId, 0]));
+        // count frequency of signatures provided, with external controllers
+        signatures.forEach((s) => {
+            // increment frequency
+            uniqueSignaturesFrequencyWithExternalControllers.set(s.verificationMethodId, uniqueSignaturesFrequencyWithExternalControllers.get(s.verificationMethodId) + 1);
+        });
+        // validate signatures - case: authentication matches signatures, unique, excessive signatures, with external controllers
+        if (Array.from(uniqueSignaturesFrequencyWithExternalControllers).filter(([k, f]) => uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) === undefined ||
+            (uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) &&
+                uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) < f)).length &&
+            externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignaturesFrequencyWithExternalControllers).find(([k, f]) => uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) === undefined || uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) < f)?.[0]} is not required`,
+            };
+        // validate signatures - case: authentication matches signatures, unique, missing signatures, with external controllers
+        if (Array.from(uniqueSignaturesFrequencyWithExternalControllers).filter(([k, f]) => uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) &&
+            uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) > f).length &&
+            externalController)
+            return {
+                valid: false,
+                error: `authentication does not match signatures: signature from key ${Array.from(uniqueSignaturesFrequencyWithExternalControllers).find(([k, f]) => uniqueUnionSignaturesRequiredWithExternalControllersFrequency.get(k) > f)?.[0]} is missing`,
+            };
+        // return valid
+        return { valid: true, previousDidDocument, externalControllersDocuments };
+    }
+    /**
+     * Generates standard fees for creating a DID document.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for DID document creation
+     */
+    static async generateCreateDidDocFees(feePayer, granter) {
+        return {
+            amount: [DIDModule.fees.DefaultCreateDidDocFee],
+            gas: '360000',
+            payer: feePayer,
+            granter: granter,
+        };
+    }
+    /**
+     * Generates fee configuration for DID document update transactions.
+     * Uses default update fees and gas requirements.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for DID document updates
+     */
+    static async generateUpdateDidDocFees(feePayer, granter) {
+        return {
+            amount: [DIDModule.fees.DefaultUpdateDidDocFee],
+            gas: '360000',
+            payer: feePayer,
+            granter: granter,
+        };
+    }
+    /**
+     * Generates fee configuration for DID document deactivation transactions.
+     * Uses default deactivation fees and gas requirements.
+     *
+     * @param feePayer - Address of the account that will pay the transaction fees
+     * @param granter - Optional address of the account granting fee payment permissions
+     * @returns Promise resolving to the fee configuration for DID document deactivation
+     */
+    static async generateDeactivateDidDocFees(feePayer, granter) {
+        return {
+            amount: [DIDModule.fees.DefaultDeactivateDidDocFee],
+            gas: '360000',
+            payer: feePayer,
+            granter: granter,
+        };
+    }
+}
+//# sourceMappingURL=did.js.map