Module safe_network::messaging

The Safe Network messaging interface.

This modules defines the messages that can be handled by the Safe Network. In particular:

• This module contains types that are common across the messaging API.
• The serialisation module defines the wire format and message (de)serialization API.
• The data module defines the data messages that clients and nodes send, and their possible responses.
• The [node] module defines the messages that nodes can exchange on the network.
• The [section_info] module defines the queries and responses for section information – these may be sent by both clients and nodes.

Re-exports

pub use self::serialisation::MessageType;

pub use self::serialisation::NodeMsgAuthority;

Modules

data

Data messages that clients and nodes can send. Data messages and their possible responses.

serialisation

The wire format and message (de)serialization API.

signature_aggregator

BLS Signature aggregator

system

Operational Messages that can be exchanged on the network.

Structs

AuthorityProof

Verified authority.

BlsShareAuth

Authority of a single peer that uses it’s BLS Keyshare to sign the message.

EndUser

An EndUser is represented by a name which is mapped to

MessageId

Unique ID for messages.

NodeAuth

Authority of a single peer.

SectionAuth

Authority of a whole section.

SectionAuthorityProvider

Details of section authority.

ServiceAuth

Authority of a network peer.

WireMsg

In order to send a message over the wire, it needs to be serialized along with a header (WireMsgHeader) which contains the information needed by the recipient to properly deserialize it. The WireMsg struct provides the utilities to serialize and deserialize messages.

Enums

DstLocation

Message destination location.

Error

Errors that can occur when interacting with messaging APIs.

MsgKind

Source authority of a message.

SrcLocation

Message source location.

Constants

MESSAGE_ID_LEN

Constant byte length of MessageId.

Traits

VerifyAuthority

Verify authority.

Type Definitions

Result

A specialised Result type for messaging APIs.