package gossip

Get desktop application:
View/edit binary Protocol Buffers messages

Gossip

• rpc GossipStream (stream Envelope, stream Envelope)

  message.proto:18

  GossipStream is the gRPC stream used for sending and receiving messages

• rpc Ping (Empty, Empty)

  message.proto:21

  Ping is used to probe a remote node's aliveness

Used in: GossipMessage

• string error = 1

AliveMessage is sent to inform remote nodes of a node's existence and activity

Used in: GossipMessage

• optional Member membership = 1

• optional NodeTime timestamp = 2

• bytes identity = 4

ConnEstablish is the message used for the gossip handshake Whenever a node connects to another node, it handshakes with it by sending this message that proves its identity

Used in: GossipMessage

• bytes pki_id = 1

• bytes identity = 2

• bytes tls_cert_hash = 3

DataDigest is the message sent from the receiver node to the initator node and contains the data items it has

Used in: GossipMessage

• uint64 nonce = 1

• repeated string digests = 2

  Maybe change this to bitmap later on

• PullMsgType msg_type = 3

DataMessage is the message that contains a block

Used in: GossipMessage

• optional Payload payload = 1

DataRequest is a message used for a node to request certain data blocks from a remote node

Used in: GossipMessage

• uint64 nonce = 1

• repeated string digests = 2

• PullMsgType msg_type = 3

DataUpdate is the final message in the pull phase sent from the receiver to the initiator

Used in: GossipMessage

• uint64 nonce = 1

• repeated Envelope data = 2

• PullMsgType msg_type = 3

Empty is used for pinging and in tests

Used as request type in: Gossip.Ping

Used as response type in: Gossip.Ping

Used as field type in: GossipMessage

(message has no fields)

Envelope contains a marshalled GossipMessage and a signature over it. It may also contain a SecretEnvelope which is a marshalled Secret

Used as request type in: Gossip.GossipStream

Used as response type in: Gossip.GossipStream

Used as field type in: DataUpdate, MembershipRequest, MembershipResponse, StateInfoSnapshot

• bytes payload = 1

• bytes signature = 2

• optional SecretEnvelope secret_envelope = 3

GossipHello is the message that is used for the node to initiate a pull round with another node

Used in: GossipMessage

• uint64 nonce = 1

• bytes metadata = 2

• PullMsgType msg_type = 3

GossipMessage defines the message sent in a gossip network

• uint64 nonce = 1

  used mainly for testing, but will might be used in the future for ensuring message delivery by acking

• bytes group = 2

  The group of the message. Some GossipMessages may set this to nil, because they are cross-groups but some may not

• GossipMessage.Tag tag = 3

  determines to which nodes it is allowed to forward the message

• oneof content

  • AliveMessage alive_msg = 5

    Membership

  • MembershipRequest mem_req = 6

  • MembershipResponse mem_res = 7

  • DataMessage data_msg = 8

    Contains a ledger block

  • GossipHello hello = 9

    Used for push&pull

  • DataDigest data_dig = 10

  • DataRequest data_req = 11

  • DataUpdate data_update = 12

  • Empty empty = 13

    Empty message, used for pinging

  • ConnEstablish conn = 14

    ConnEstablish, used for establishing a connection

  • StateInfo state_info = 15

    Used for relaying information about state

  • StateInfoSnapshot state_snapshot = 16

    Used for sending sets of StateInfo messages

  • StateInfoPullRequest state_info_pull_req = 17

    Used for asking for StateInfoSnapshots

  • RemoteStateRequest state_request = 18

    Used to ask from a remote node a set of blocks

  • RemoteStateResponse state_response = 19

    Used to send a set of blocks to a remote node

  • LeadershipMessage leadership_msg = 20

    Used to indicate intent of node to become leader

  • NodeIdentity node_identity = 21

    Used to learn of a node's certificate

  • Acknowledgement ack = 22

  • RemotePvtDataRequest privateReq = 23

    Used to request private data

  • RemotePvtDataResponse privateRes = 24

    Used to respond to private data requests

  • PrivateDataMessage private_data = 25

    Encapsulates private data used to distribute private rwset after the endorsement

Used in: GossipMessage

• UNDEFINED = 0

• EMPTY = 1

• ORG_ONLY = 2

• CHAN_ONLY = 3

• CHAN_AND_ORG = 4

• CHAN_OR_ORG = 5

Leadership Message is sent during leader election to inform remote nodes about intent of node to proclaim itself as leader

Used in: GossipMessage

• bytes pki_id = 1

• optional NodeTime timestamp = 2

• bool is_declaration = 3

Member holds membership-related information about a node

Used in: AliveMessage

• string endpoint = 1

• bytes metadata = 2

• bytes pki_id = 3

MembershipRequest is used to ask membership information from a remote node

Used in: GossipMessage

• optional Envelope self_information = 1

• repeated bytes known = 2

MembershipResponse is used for replying to MembershipRequests

Used in: GossipMessage

• repeated Envelope alive = 1

• repeated Envelope dead = 2

NodeIdentity defines the identity of the node Used to make other nodes learn of the identity of a certain node

Used in: GossipMessage

• bytes pki_id = 1

• bytes cert = 2

• bytes metadata = 3

NodeTime defines the logical time of a node's life

Used in: AliveMessage, LeadershipMessage, StateInfo

• uint64 inc_num = 1

• uint64 seq_num = 2

Payload contains a block

Used in: DataMessage, RemoteStateResponse

• uint64 seq_num = 1

• bytes data = 2

• repeated bytes private_data = 3

PrivateDataMessage message which includes private data information to distributed once transaction has been endorsed

Used in: GossipMessage

• optional PrivatePayload payload = 1

PrivatePayload payload to encapsulate private data with collection name to enable routing based on collection partitioning

Used in: PrivateDataMessage

• string collection_name = 1

• string namespace = 2

• string tx_id = 3

• bytes private_rwset = 4

Used in: StateInfo

• uint64 ledger_height = 1

• bool left_group = 2

Used in: DataDigest, DataRequest, DataUpdate, GossipHello

• UNDEFINED = 0

• BLOCK_MSG = 1

• IDENTITY_MSG = 2

PvtDataDigest defines a digest of private data

Used in: PvtDataElement, RemotePvtDataRequest

• string tx_id = 1

• string namespace = 2

• string collection = 3

• uint64 block_seq = 4

• uint64 seq_in_block = 5

Used in: RemotePvtDataResponse

• optional PvtDataDigest digest = 1

• repeated bytes payload = 2

  the payload is a marshaled kvrwset.KVRWSet

PvtPayload augments private rwset data and tx index inside the block

• uint64 tx_seq_in_block = 1

• bytes payload = 2

  Encodes marhslaed bytes of rwset.TxPvtReadWriteSet defined in rwset.proto

RemotePrivateDataRequest message used to request missing private rwset

Used in: GossipMessage

• repeated PvtDataDigest digests = 1

RemotePrivateData message to response on private data replication request

Used in: GossipMessage

• repeated PvtDataElement elements = 1

RemoteStateRequest is used to ask a set of blocks from a remote node

Used in: GossipMessage

• uint64 start_seq_num = 1

• uint64 end_seq_num = 2

RemoteStateResponse is used to send a set of blocks to a remote node

Used in: GossipMessage

• repeated Payload payloads = 1

Secret is an entity that might be omitted from an Envelope when the remote node that is receiving the Envelope shouldn't know the secret's content.

• oneof content

  • string internalEndpoint = 1

SecretEnvelope is a marshalled Secret and a signature over it. The signature should be validated by the node that signed the Envelope the SecretEnvelope came with

Used in: Envelope

• bytes payload = 1

• bytes signature = 2

StateInfo is used for a node to relay its state information to other nodes

Used in: GossipMessage

• bytes metadata = 1

• optional NodeTime timestamp = 2

• bytes pki_id = 3

• bytes group_MAC = 4

  group_MAC is an authentication code that proves that the node that sent this message knows the name of the group.

• optional Properties properties = 5

StateInfoPullRequest is used to fetch a StateInfoSnapshot from a remote node

Used in: GossipMessage

• bytes group_MAC = 1

  group_MAC is an authentication code that proves that the node that sent this message knows the name of the group.

StateInfoSnapshot is an aggregation of StateInfo messages

Used in: GossipMessage

• repeated Envelope elements = 1