Skip to main content

CredentialIssuerLD class

A Veramo plugin that implements the ICredentialIssuerLD methods.

Signature:

export declare class CredentialIssuerLD implements IAgentPlugin

Implements: IAgentPlugin

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the CredentialIssuerLD class

Properties

PropertyModifiersTypeDescription
methodsreadonlyICredentialIssuerLD
schemareadonly{ components: { schemas: { ICreateVerifiableCredentialLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string[]; additionalProperties: { description: string; }; description: string; }; CredentialPayload: { type: string; properties: { issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string[]; description: string; }; IssuerType: { anyOf: ({ type: string; properties: { id: { type: string; }; }; required: string[]; } | { type: string; properties?: undefined; required?: undefined; })[]; description: string; }; CredentialSubject: { type: string; properties: { id: { type: string; }; }; description: string; }; ContextType: { anyOf: ({ type: string; items?: undefined; } | { type: string; items: { anyOf: { type: string; }[]; }; })[]; description: string; }; DateType: { type: string; description: string; }; CredentialStatusReference: { type: string; properties: { id: { type: string; }; type: { type: string; }; }; required: string[]; description: string; }; VerifiableCredential: { type: string; properties: { proof: { $ref: string; }; issuer: { $ref: string; }; credentialSubject: { $ref: string; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })[]; }; "@context": { $ref: string; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; credentialStatus: { $ref: string; }; id: { type: string; }; }; required: string[]; description: string; }; ProofType: { type: string; properties: { type: { type: string; }; }; description: string; }; ICreateVerifiablePresentationLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; keyRef: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string[]; additionalProperties: { description: string; }; description: string; }; PresentationPayload: { type: string; properties: { holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { type: string; items: { type: string; }; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { $ref: string; }; expirationDate: { $ref: string; }; id: { type: string; }; }; required: string[]; description: string; }; W3CVerifiableCredential: { anyOf: { $ref: string; }[]; description: string; }; CompactJWT: { type: string; description: string; }; VerifiablePresentation: { type: string; properties: { proof: { $ref: string; }; holder: { type: string; }; verifiableCredential: { type: string; items: { $ref: string; }; }; type: { anyOf: ({ type: string; items: { type: string; }; } | { type: string; items?: undefined; })[]; }; "@context": { $ref: string; }; verifier: { type: string; items: { type: string; }; }; issuanceDate: { type: string; }; expirationDate: { type: string; }; id: { type: string; }; }; required: string[]; description: string; }; IVerifyCredentialLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; credential: { $ref: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string[]; additionalProperties: { description: string; }; description: string; }; IVerifyPresentationLDArgs: { type: string; properties: { resolutionOptions: { type: string; properties: { publicKeyFormat: { type: string; }; accept: { type: string; }; }; description: string; }; presentation: { $ref: string; description: string; }; challenge: { type: string; description: string; }; domain: { type: string; description: string; }; fetchRemoteContexts: { type: string; description: string; }; }; required: string[]; additionalProperties: { description: string; }; description: string; }; }; methods: { createVerifiableCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; createVerifiablePresentationLD: { description: string; arguments: { $ref: string; }; returnType: { $ref: string; }; }; verifyCredentialLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; verifyPresentationLD: { description: string; arguments: { $ref: string; }; returnType: { type: string; }; }; }; }; }

Methods

MethodModifiersDescription
createVerifiableCredentialLD(args, context)Creates a Verifiable Credential. The payload, signer and format are chosen based on the args parameter.
createVerifiablePresentationLD(args, context)Creates a Verifiable Presentation. The payload, signer and format are chosen based on the args parameter.
verifyCredentialLD(args, context)Verifies a Verifiable Credential JWT or LDS Format.
verifyPresentationLD(args, context)Verifies a Verifiable Presentation JWT or LDS Format.