Class Mercury

Mercury is a powerful and flexible library for working with decentralized identifiers and secure communications protocols. Whether you are a developer looking to build a secure and private messaging app or a more complex decentralized system requiring trusted peer-to-peer connections, Mercury provides the tools and features you need to establish, manage, and secure your communications easily.

Export

Hierarchy

  • Mercury

Implements

Constructors

constructor

Properties

api castor protocol

Methods

getDIDCommDID getDIDCommURL makeRequest notDid packMessage prepareForwardMessage requiresForwarding sendMessage sendMessageParseMessage unpackMessage

Constructors

constructor

Properties

api

api: Api

castor

castor: Domain.Castor

protocol

protocol: DIDCommProtocol

Methods

Private getDIDCommDID

Private getDIDCommURL

Private makeRequest

  • Type Parameters

    • T

    Parameters

    • service: undefined | Service | URL
    • message: string

    Returns Promise<T>

Private notDid

packMessage

  • Asynchronously packs a given message object into a string representation. This function may throw an error if the message object is invalid.

    Parameters

    Returns Promise<string>

Private prepareForwardMessage

  • Parameters

    Returns ForwardMessage

Private requiresForwarding

sendMessage

  • Asynchronously sends a given message and returns the response data.

    Type Parameters

    • T

    Parameters

    Returns Promise<T>

    Async

sendMessageParseMessage

unpackMessage

  • Asynchronously unpacks a given string representation of a message into a message object. This function may throw an error if the string is not a valid message representation.

    Parameters

    • message: string

    Returns Promise<Message>

Settings

Member Visibility

Theme

On This Page