Type alias DidRegistrationMetadata

DidRegistrationMetadata: {
    error?: string;
    [key: string]: any;
}

Represents metadata related to the result of a DID registration operation.

This type includes fields that provide information about the outcome of a DID registration process (e.g., create, update, deactivate), including any errors that occurred.

This metadata typically changes between invocations of the create, update, and deactivate functions, as it represents data about the registration process itself.

Type declaration

  • [key: string]: any
  • Optional error?: string

    An error code indicating issues encountered during the DID registration process.

    While the DID Core specification does not define a specific set of error codes for the result returned by the create, update, or deactivate functions, it is recommended to use the error codes defined in the DID Specification Registries for DID Resolution Metadata.

    Recommended error codes include:

    • internalError: An unexpected error occurred during DID registration process.
    • invalidDid: The provided DID is invalid.
    • invalidDidDocument: The provided DID document does not conform to valid syntax.
    • invalidDidDocumentLength: The byte length of the provided DID document does not match the expected value.
    • invalidSignature: Verification of a signature failed.
    • methodNotSupported: The DID method specified is not supported.
    • Custom error codes can also be provided as strings.

Settings

Member Visibility

Theme