verixyz DIDComm

Provides a plugin for the Agent that implements IDIDComm interface. Provides a plugin for the MessageHandler that decrypts messages.

Classes

AbstractDIDCommTransport

(BETA) Abstract implementation of IDIDCommTransport .

DIDComm

(BETA) DID Comm plugin for Agent This plugin provides a method of creating an encrypted message according to the initial DIDComm-js implementation.

DIDCommHttpTransport

(BETA) Implementation of IDIDCommTransport to provide a simple transport based on HTTP(S) requests.

DIDCommMessageHandler

(BETA) A plugin for the MessageHandler that decrypts DIDComm messages.

Enumerations

DIDCommMessageMediaType

(BETA) Represents different DIDComm v2 message encapsulation

Interfaces

IDIDComm

(BETA) DID Comm plugin interface for Agent

IDIDCommMessage

(BETA) The DIDComm message structure. See https://identity.foundation/didcomm-messaging/spec/#plaintext-message-structure

IDIDCommMessageMetaData

(BETA) Metadata resulting from unpacking a DIDComm v2 message

IDIDCommTransport

(BETA) Common interface for transports that can be used in the DIDComm module.

IDIDCommTransportResult

(BETA) Result interface for sending DIDComm messages through IDIDCommTransport.send() .

IPackDIDCommMessageArgs

(BETA) The input to the DIDComm.packDIDCommMessage() method. When packing is authcrypt or jws, a keyRef MUST be provided.

IPackedDIDCommMessage

(BETA) The result of packing a DIDComm v2 message. The message is always serialized as string.

ISendMessageDIDCommAlpha1Args (BETA)

IUnpackedDIDCommMessage

(BETA) The result of unpacking a DIDComm v2 message

Variables

• schema

Type Aliases

DIDCommMessagePacking

(BETA) The possible types of message packing.authcrypt, anoncrypt, anoncrypt+authcrypt, and anoncrypt+jws will produce DIDCommMessageMediaType.ENCRYPTED messages.jws will produce DIDCommMessageMediaType.SIGNED messages.none will produce DIDCommMessageMediaType.PLAIN messages.

IUnpackDIDCommMessageArgs

(BETA) The input to the DIDComm.unpackDIDCommMessage() method.