package iohk.chain.node

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Handshake (HandshakeRequest, HandshakeResponse)

  node.proto:111

  Initial handshake and authentication of the server node.

  message HandshakeRequest

  node.proto:9

  Request message for method Handshake.

  • bytes nonce = 1

    Nonce for the server to authenticate its node ID with.

  message HandshakeResponse

  node.proto:15

  Response message for method Handshake.

  • uint32 version = 1

    Version of the protocol implemented by the server.

  • bytes block0 = 2

    The identifier of the genesis block. This can be used by the client to determine if the server node runs the expected blockchain.

  • bytes node_id = 3

    Node ID of the server, the public key of a key pair.

  • bytes signature = 4

    Signature of the client's nonce using the private key in the server's key pair.

  • bytes nonce = 5

    Nonce for the client to authenticate its node ID with.

• rpc ClientAuth (ClientAuthRequest, ClientAuthResponse)

  node.proto:115

  Optional authentication of the client node. Called after Handshake.

  message ClientAuthRequest

  node.proto:31

  Request message for method ClientAuth.

  • bytes node_id = 1

    Node ID of the client, the public key of a key pair.

  • bytes signature = 2

    Signature of the server's nonce sent in HandshakeResponse, using the private key in the client's key pair.

  message ClientAuthResponse

  node.proto:40

  Response message for method ClientAuth.

  (message has no fields)

• rpc Tip (TipRequest, TipResponse)

  node.proto:117

  message TipRequest

  node.proto:43

  Request message for method Tip.

  (message has no fields)

  message TipResponse

  node.proto:46

  Response message for method Tip.

  • bytes block_header = 1

    Serialized content of the tip block header.

• rpc Peers (PeersRequest, PeersResponse)

  node.proto:120

  Requests for some peers

  message PeersRequest

  node.proto:52

  Request for peers

  • uint32 limit = 1

  message PeersResponse

  node.proto:55

  Responses as a bunch of peers, similar to Gossip

  • repeated bytes peers = 2

• rpc GetBlocks (types.BlockIds, stream types.Block)

  node.proto:122

• rpc GetHeaders (types.BlockIds, stream types.Header)

  node.proto:125

• rpc GetFragments (types.FragmentIds, stream types.Fragment)

  node.proto:128

• rpc PullHeaders (PullHeadersRequest, stream types.Header)

  node.proto:136

  Requests headers of blocks in the chain in the chronological order, given a selection of possible starting blocks known by the requester, and the identifier of the end block to be included in the returned sequence.

• rpc PullBlocks (PullBlocksRequest, stream types.Block)

  node.proto:143

  Requests blocks in the chain in the chronological order, given a selection of possible starting blocks known by the requester, and the identifier of the end block to be included in the returned sequence.

  message PullBlocksRequest

  node.proto:75

  Request message for method PullBlocks

  • repeated bytes from = 1

    The identifiers of blocks to consider as the starting point in order of appearance.

  • bytes to = 2

    The identifier of the end block

• rpc PullBlocksToTip (PullBlocksToTipRequest, stream types.Block)

  node.proto:147

  message PullBlocksToTipRequest

  node.proto:68

  Request message for method PullBlocksToTip.

  • repeated bytes from = 1

    The identifiers of blocks to consider as the starting point, in order of appearance.

• rpc PushHeaders (stream types.Header, PushHeadersResponse)

  node.proto:152

  Sends headers of blocks to the service in response to a `missing` item received from the BlockSubscription response stream. The headers are streamed the in chronological order of the chain.

  message PushHeadersResponse

  node.proto:84

  Response message for method PushHeaders.

  (message has no fields)

• rpc UploadBlocks (stream types.Block, UploadBlocksResponse)

  node.proto:156

  Uploads blocks to the service in response to a `solicit` item received from the BlockSubscription response stream.

  message UploadBlocksResponse

  node.proto:87

  Response message for method UploadBlocks.

  (message has no fields)

• rpc BlockSubscription (stream types.Header, stream BlockEvent)

  node.proto:160

  Establishes a bidirectional stream to exchange information on new blocks created or accepted by the peers.

  message BlockEvent

  node.proto:96

  Element of the subscription stream returned by BlockSubscription.

  • oneof item

    • types.Header announce = 1

      Announcement of a new block, carrying the block's header.

    • types.BlockIds solicit = 2

      Solicitation to upload identified blocks with an UploadBlocks method call.

    • PullHeadersRequest missing = 3

      Solicitation to push the chain of block headers with a PushHeaders method call.

• rpc FragmentSubscription (stream types.Fragment, stream types.Fragment)

  node.proto:164

  Establishes a bidirectional stream to exchange information on new block fragments created or accepted by the peers.

• rpc GossipSubscription (stream Gossip, stream Gossip)

  node.proto:169

  Establishes a bidirectional stream to exchange information on new network peers.

  message Gossip

  node.proto:90

  Gossip message with information on nodes in the network.

  • repeated bytes nodes = 2

    Serialized descriptions of nodes.

Request message for method PullHeaders. This message can also be send by the service as a BlockEvent variant.

Used as request type in: Node.PullHeaders

Used as field type in: BlockEvent

• repeated bytes from = 1

  The identifiers of blocks to consider as the starting point, in order of appearance.

• bytes to = 2

  The identifier of the end block.