Skip to main content

DIDComm

@hyperledger/identus-sdk v8.0.0


@hyperledger/identus-sdk / plugins/internal/didcomm

plugins/internal/didcomm

This export contains the DIDComm plugin for the Identus SDK

Enumerations

EnumerationDescription
InvitationTypes-

Classes

ClassDescription
BasicMessage-
CreateOOBOfferTask class for creating out-of-band (OOB) credential offer invitations.
CreateOOBPresentationRequestTask class for creating out-of-band (OOB) presentation request invitations.
DIDCommConnectionDefine the structure of a Connection
IssueCredential-
MediationKeysUpdateList-
MediationRequest-
MediatorConnectionDefine the structure of a Connection
OfferCredential-
OutOfBandInvitation-
ParseInvitationTask class for parsing different types of invitations.
ParseOOBInvitation-
ParsePrismInvitation-
PickupReceived-
PickupRequest-
PrismOnboardingInvitation-
ProblemReport-
ProposeCredential-
RequestCredential-
Send-
StartFetchingMessages-
StartMediator-

Interfaces

InterfaceDescription
Attribute-
BasicMessageBodySpecification: https://didcomm.org/basicmessage/2.0/
CreateOOBOfferArgsArguments for creating an out-of-band (OOB) offer invitation
CreateOOBPresentationRequestArgsArguments for creating an out-of-band (OOB) presentation request invitation
CredentialFormatSpecification: https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential#request-credential
CredentialPreviewSpecification: https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential#preview-credential
IssueCredentialBodySpecification: https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential#issue-credential
MediationKeysUpdateListBodySpecification: https://didcomm.org/coordinate-mediation/2.0/
OfferCredentialBodySpecification: https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential#offer-credential
OutOfBandInvitationBody-
ParseInvitationArgsArguments for parsing an invitation
ParseOOBInvitationArgsparse OOB invitation
ParsePrismInvitationArgsparse a prismOnboarding invitation
PickupReceivedBodySpecification: https://didcomm.org/messagepickup/3.0/
PickupRequestBodySpecification: https://didcomm.org/messagepickup/3.0/
PrismOnboardingInvitationBody-
ProblemReportBodySpecification: https://identity.foundation/didcomm-messaging/spec/#problem-reports
ProposeCredentialBodySpecification: https://github.com/decentralized-identity/waci-didcomm/tree/main/issue_credential#propose-credential
RequestCredentialBody-
SendArgsattempt to deliver a Message across a Connection
StartFetchingMessagesArgsHandle the setup of fetching messages from the Mediator
StartMediatorArgsHandle existing mediator logic either reconnects existing mediator or tries to establish new connection

Type Aliases

Type AliasDescription
Context-
InvitationType-

Variables

VariableDescription
plugin-
ProtocolIds-

Functions

FunctionDescription
validateCredentialPreview-