@hyperledger/identus-edge-agent-sdk / Exports / DIDCommWrapper

Class: DIDCommWrapper

Implements

• DIDCommProtocol

Table of contents

Constructors

• constructor

Properties

• apollo
• castor
• didResolver
• pluto
• secretsResolver
• didcomm

Methods

• doesRequireReturnRoute
• packEncrypted
• parseAttachment
• parseAttachmentData
• parseAttachmentDataToDomain
• parseAttachmentToDomain
• parseAttachments
• parseAttachmentsToDomain
• unpack
• getDIDComm

Constructors

constructor

• new DIDCommWrapper(apollo, castor, pluto): DIDCommWrapper

Parameters

Name	Type
apollo	Apollo
castor	Castor
pluto	Pluto

Returns

DIDCommWrapper

Defined in

src/mercury/didcomm/Wrapper.ts:26

Properties

apollo

• Readonly apollo: Apollo

Defined in

src/mercury/didcomm/Wrapper.ts:27

---

castor

• Readonly castor: Castor

Defined in

src/mercury/didcomm/Wrapper.ts:28

---

didResolver

• Private Readonly didResolver: DIDResolver

Defined in

src/mercury/didcomm/Wrapper.ts:23

---

pluto

• Readonly pluto: Pluto

Defined in

src/mercury/didcomm/Wrapper.ts:29

---

secretsResolver

• Private Readonly secretsResolver: SecretsResolver

Defined in

src/mercury/didcomm/Wrapper.ts:24

---

didcomm

▪ Static didcomm: __module

Defined in

src/mercury/didcomm/Wrapper.ts:22

Methods

doesRequireReturnRoute

▸ doesRequireReturnRoute(type): boolean

Parameters

Name	Type
type	string

Returns

boolean

Defined in

src/mercury/didcomm/Wrapper.ts:44

---

packEncrypted

▸ packEncrypted(message, toDid, fromDid?): Promise<string>

Parameters

Name	Type
message	Message
toDid	DID
fromDid?	DID

Returns

Promise<string>

Implementation of

DIDCommProtocol.packEncrypted

Defined in

src/mercury/didcomm/Wrapper.ts:60

---

parseAttachment

▸ parseAttachment(attachment): Attachment

Parameters

Name	Type
attachment	AttachmentDescriptor

Returns

Attachment

Defined in

src/mercury/didcomm/Wrapper.ts:218

---

parseAttachmentData

▸ parseAttachmentData(data): AttachmentData

Parameters

Name	Type
data	AttachmentData

Returns

AttachmentData

Defined in

src/mercury/didcomm/Wrapper.ts:234

---

parseAttachmentDataToDomain

▸ parseAttachmentDataToDomain(data): AttachmentData

Parameters

Name	Type
data	AttachmentData

Returns

AttachmentData

Defined in

src/mercury/didcomm/Wrapper.ts:174

---

parseAttachmentToDomain

▸ parseAttachmentToDomain(attachment): AttachmentDescriptor

Parameters

Name	Type
attachment	Attachment

Returns

AttachmentDescriptor

Defined in

src/mercury/didcomm/Wrapper.ts:156

---

parseAttachments

▸ parseAttachments(attachments?): undefined | Attachment[]

Parameters

Name	Type
attachments?	AttachmentDescriptor[]

Returns

undefined | Attachment[]

Defined in

src/mercury/didcomm/Wrapper.ts:205

---

parseAttachmentsToDomain

▸ parseAttachmentsToDomain(attachments): AttachmentDescriptor[]

Parameters

Name	Type
attachments	Attachment[]

Returns

AttachmentDescriptor[]

Defined in

src/mercury/didcomm/Wrapper.ts:140

---

unpack

▸ unpack(message): Promise<Message>

Parameters

Name	Type
message	string

Returns

Promise<Message>

Implementation of

DIDCommProtocol.unpack

Defined in

src/mercury/didcomm/Wrapper.ts:102

---

getDIDComm

▸ getDIDComm(): Promise<__module>

Returns

Promise<__module>

Defined in

src/mercury/didcomm/Wrapper.ts:35