package api.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Block data sent in the response.

Used in: BlockResponse

• bytes hash = 1

  Block header hash.

• bytes header = 2

  Block header if requested.

  optional

• repeated bytes body = 3

  Block body if requested.

  optional

• bytes receipt = 4

  Block receipt if requested.

  optional

• bytes message_queue = 5

  Block message queue if requested.

  optional

• bytes justification = 6

  Justification if requested.

  optional

• bool is_empty_justification = 7

  True if justification should be treated as present but empty. This hack is unfortunately necessary because shortcomings in the protobuf format otherwise doesn't make in possible to differentiate between a lack of justification and an empty justification.

  optional, false if absent

• bytes justifications = 8

  Justifications if requested. Unlike the field for a single justification, this field does not required an associated boolean to differentiate between the lack of justifications and empty justification(s). This is because empty justifications, like all justifications, are paired with a non-empty consensus engine ID.

  optional

• repeated bytes indexed_body = 9

  Indexed block body if requestd.

  optional

Request block data from a peer.

• uint32 fields = 1

  Bits of block data to request.

• oneof from_block

  Start from this block.

  • bytes hash = 2

    Start with given hash.

  • bytes number = 3

    Start with given block number.

• Direction direction = 5

  Sequence direction. If missing, should be interpreted as "Ascending".

• uint32 max_blocks = 6

  Maximum number of blocks to return. An implementation defined maximum is used when unspecified.

  optional

• bool support_multiple_justifications = 7

  Indicate to the receiver that we support multiple justifications. If the responder also supports this it will populate the multiple justifications field in `BlockData` instead of the single justification field.

  optional

Response to `BlockRequest`

• repeated BlockData blocks = 1

  Block data for the requested sequence.

Block enumeration direction.

Used in: BlockRequest

• Ascending = 0

  Enumerate in ascending order (from child to parent).

• Descending = 1

  Enumerate in descending order (from parent to canonical child).

A key value state.

Used in: StateResponse

• bytes state_root = 1

  Root of for this level, empty length bytes if top level.

• repeated StateEntry entries = 2

  A collection of keys-values.

• bool complete = 3

  Set to true when there are no more keys to return.

A key-value pair.

Used in: KeyValueStateEntry

• bytes key = 1

• bytes value = 2

Request storage data from a peer.

• bytes block = 1

  Block header hash.

• repeated bytes start = 2

  Start from this key. Multiple keys used for nested state start.

  optional

• bool no_proof = 3

  if 'true' indicates that response should contain raw key-values, rather than proof.

• repeated KeyValueStateEntry entries = 1

  A collection of keys-values states. Only populated if `no_proof` is `true`

• bytes proof = 2

  If `no_proof` is false in request, this contains proof nodes.