Class Dwn

Index

Methods

close open processMessage validateMessageIntegrity validateTenant create

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/dwn.ts:152

open

open(): Promise<void>
Initializes the DWN instance and opens the connection to it.

Returns Promise<void>
- Defined in src/dwn.ts:142

processMessage

processMessage(tenant, rawMessage): Promise<MessagesQueryReply>
Processes the given DWN message and returns with a reply.
Parameters
- tenant: string
  The tenant DID to route the given message to.
- rawMessage: MessagesQueryMessage
Returns Promise<MessagesQueryReply>
- Defined in src/dwn.ts:164
processMessage(tenant, rawMessage, options?): Promise<MessagesSubscribeReply>
Parameters
- tenant: string
- rawMessage: MessagesSubscribeMessage
- Optionaloptions: MessagesSubscribeMessageOptions
Returns Promise<MessagesSubscribeReply>
- Defined in src/dwn.ts:165
processMessage(tenant, rawMessage): Promise<MessagesReadReply>
Parameters
- tenant: string
- rawMessage: MessagesReadMessage
Returns Promise<MessagesReadReply>
- Defined in src/dwn.ts:167
processMessage(tenant, rawMessage): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: ProtocolsConfigureMessage
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:168
processMessage(tenant, rawMessage): Promise<ProtocolsQueryReply>
Parameters
- tenant: string
- rawMessage: ProtocolsQueryMessage
Returns Promise<ProtocolsQueryReply>
- Defined in src/dwn.ts:169
processMessage(tenant, rawMessage): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: RecordsDeleteMessage
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:170
processMessage(tenant, rawMessage): Promise<RecordsQueryReply>
Parameters
- tenant: string
- rawMessage: RecordsQueryMessage
Returns Promise<RecordsQueryReply>
- Defined in src/dwn.ts:171
processMessage(tenant, rawMessage, options): Promise<RecordsSubscribeReply>
Parameters
- tenant: string
- rawMessage: RecordsSubscribeMessage
- options: RecordsSubscribeMessageOptions
Returns Promise<RecordsSubscribeReply>
- Defined in src/dwn.ts:172
processMessage(tenant, rawMessage): Promise<RecordsReadReply>
Parameters
- tenant: string
- rawMessage: RecordsReadMessage
Returns Promise<RecordsReadReply>
- Defined in src/dwn.ts:174
processMessage(tenant, rawMessage, options?): Promise<GenericMessageReply>
Parameters
- tenant: string
- rawMessage: RecordsWriteMessage
- Optionaloptions: RecordsWriteMessageOptions
Returns Promise<GenericMessageReply>
- Defined in src/dwn.ts:175
processMessage(tenant, rawMessage, options?): Promise<UnionMessageReply>
Parameters
- tenant: string
- rawMessage: unknown
- Optionaloptions: MessageOptions
Returns Promise<UnionMessageReply>
- Defined in src/dwn.ts:176

validateMessageIntegrity

validateMessageIntegrity(rawMessage): Promise<undefined | GenericMessageReply>
Validates structure of DWN message
Parameters
- rawMessage: any
Returns Promise<undefined | GenericMessageReply>
GenericMessageReply if the message has an integrity error, otherwise undefined.
- Defined in src/dwn.ts:219

validateTenant

validateTenant(tenant): Promise<undefined | GenericMessageReply>
Checks tenant gate to see if tenant is allowed.
Parameters
- tenant: string
  The tenant DID to route the given message to.
Returns Promise<undefined | GenericMessageReply>
GenericMessageReply if the message has an integrity error, otherwise undefined.
- Defined in src/dwn.ts:201

`Static`create

create(config): Promise<Dwn>
Creates an instance of the DWN.
Parameters
- config: DwnConfig
Returns Promise<Dwn>
- Defined in src/dwn.ts:127

Class Dwn

Index

Methods

Methods

close

Returns Promise<void>

open

Returns Promise<void>

processMessage

Parameters

Returns Promise<MessagesQueryReply>

Parameters

Returns Promise<MessagesSubscribeReply>

Parameters

Returns Promise<MessagesReadReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<ProtocolsQueryReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<RecordsQueryReply>

Parameters

Returns Promise<RecordsSubscribeReply>

Parameters

Returns Promise<RecordsReadReply>

Parameters

Returns Promise<GenericMessageReply>

Parameters

Returns Promise<UnionMessageReply>

validateMessageIntegrity

Parameters

Returns Promise<undefined | GenericMessageReply>

validateTenant

Parameters

Returns Promise<undefined | GenericMessageReply>

Staticcreate

Parameters

Returns Promise<Dwn>

Settings

On This Page

`Static`create