credential-ld package

Provides a plugin for the Agent that implements ICredentialIssuerLD interface.

This plugin adds support for working with JSON-LD credentials. When installed, this plugin will be automatically used by CredentialPlugin if the user requests the credential to be signed by one of the installed signature suites.

Classes

ClassDescription
CredentialIssuerLDA Veramo plugin that implements the ICredentialIssuerLD methods.

Interfaces

InterfaceDescription
ICreateVerifiableCredentialLDArgs(BETA) Encapsulates the parameters required to create a W3C Verifiable CredentialThis API may change without a BREAKING CHANGE notice.
ICreateVerifiablePresentationLDArgs(BETA) Encapsulates the parameters required to create a W3C Verifiable PresentationThis API may change without a BREAKING CHANGE notice.
ICredentialIssuerLD(BETA) The interface definition for a plugin that can issue and verify Verifiable Credentials and Presentations that use JSON-LD format (also called Data Integrity Proofs).
IVerifyCredentialLDArgs(BETA) Encapsulates the parameters required to verify a W3C Verifiable CredentialThis API may change without a BREAKING CHANGE notice
IVerifyPresentationLDArgs(BETA) Encapsulates the parameters required to verify a W3C Verifiable PresentationThis API may change without a BREAKING CHANGE notice.

Variables

VariableDescription
LdDefaultContexts(BETA) Provides a hardcoded map of common Linked Data @context definitions.You can use this to bootstrap the @context definitions used by CredentialIssuerLD with these common context definitions.This API may change without a BREAKING CHANGE notice.
schema(BETA) The parameter and return types schemas for the CredentialIssuerLD plugin methods.This API may change without a BREAKING CHANGE notice.

Type Aliases

Type AliasDescription
ContextDoc(BETA) Describes a document with a @context property.This API may change without a BREAKING CHANGE notice.
IRequiredContext(BETA) Represents the requirements that this plugin has. The agent that is using this plugin is expected to provide these methods.This interface can be used for static type checks, to make sure your application is properly initialized.This API may change without a BREAKING CHANGE notice.