package rollkit.v1

Get desktop application:
View/edit binary Protocol Buffers messages

HealthService defines the RPC service for the health package

• rpc Livez (google.protobuf.Empty, GetHealthResponse)

  health.proto:13

  Livez returns the health status of the node

  message GetHealthResponse

  health.proto:29

  GetHealthResponse defines the response for retrieving health status

  • HealthStatus status = 1

    Health status

P2PService defines the RPC service for the P2P package

• rpc GetPeerInfo (google.protobuf.Empty, GetPeerInfoResponse)

  p2p_rpc.proto:13

  GetPeerInfo returns information about the connected peers

  message GetPeerInfoResponse

  p2p_rpc.proto:20

  GetPeerInfoResponse defines the response for retrieving peer information

  • repeated PeerInfo peers = 1

    List of connected peers

• rpc GetNetInfo (google.protobuf.Empty, GetNetInfoResponse)

  p2p_rpc.proto:16

  GetNetInfo returns network information

  message GetNetInfoResponse

  p2p_rpc.proto:25

  GetNetInfoResponse defines the response for retrieving network information

  • optional NetInfo net_info = 1

    Network information

The SignerService defines the RPCs to sign and to retrieve the public key.

• rpc Sign (SignRequest, SignResponse)

  signer.proto:28

  Sign signs the given message.

  message SignRequest

  signer.proto:8

  The SignRequest holds the bytes we want to sign.

  • bytes message = 1

  message SignResponse

  signer.proto:13

  The SignResponse returns the signature bytes.

  • bytes signature = 1

• rpc GetPublic (GetPublicRequest, GetPublicResponse)

  signer.proto:30

  GetPublic returns the public key.

  message GetPublicRequest

  signer.proto:18

  The GetPublicRequest is an empty request.

  (message has no fields)

  message GetPublicResponse

  signer.proto:21

  The GetPublicResponse returns the public key.

  • bytes public_key = 1

StoreService defines the RPC service for the store package

• rpc GetBlock (GetBlockRequest, GetBlockResponse)

  state_rpc.proto:13

  GetBlock returns a block by height or hash

  message GetBlockRequest

  state_rpc.proto:29

  GetBlockRequest defines the request for retrieving a block

  • oneof identifier

    The height or hash of the block to retrieve

    • uint64 height = 1

    • bytes hash = 2

  message GetBlockResponse

  state_rpc.proto:38

  GetBlockResponse defines the response for retrieving a block

  • optional Block block = 1

• rpc GetState (google.protobuf.Empty, GetStateResponse)

  state_rpc.proto:16

  GetState returns the current state

  message GetStateResponse

  state_rpc.proto:43

  GetStateResponse defines the response for retrieving the current state

  • optional State state = 1

• rpc GetMetadata (GetMetadataRequest, GetMetadataResponse)

  state_rpc.proto:19

  GetMetadata returns metadata for a specific key

  message GetMetadataRequest

  state_rpc.proto:48

  GetMetadataRequest defines the request for retrieving metadata by key

  • string key = 1

  message GetMetadataResponse

  state_rpc.proto:53

  GetMetadataResponse defines the response for retrieving metadata

  • bytes value = 1

Batch is a collection of transactions.

• repeated bytes txs = 1

Block contains all the components of a complete block

Used in: GetBlockResponse

• optional SignedHeader header = 1

• optional Data data = 2

Data is the data of a block in the blockchain.

Used in: Block

• optional Metadata metadata = 1

• repeated bytes txs = 2

  repeated bytes intermediate_state_roots = 2;

Header is the header of a block in the blockchain.

Used in: SignedHeader

• optional Version version = 1

  Block and App version

• uint64 height = 2

  Block height

• uint64 time = 3

  Block creation time

• bytes last_header_hash = 4

  Previous block info

• bytes last_commit_hash = 5

  Commit from aggregator(s) from the last block

• bytes data_hash = 6

  Block.Data root aka Transactions

• bytes consensus_hash = 7

  Consensus params for current block

• bytes app_hash = 8

  State after applying txs from the current block

• bytes last_results_hash = 9

  Root hash of all results from the txs from the previous block. This is ABCI specific but smart-contract chains require some way of committing to transaction receipts/results.

• bytes proposer_address = 10

  Original proposer of the block Note that the address can be derived from the pubkey which can be derived from the signature when using secp256k. We keep this in case users choose another signature format where the pubkey can't be recovered by the signature (e.g. ed25519).

• bytes validator_hash = 11

  validatorhash for compatibility with tendermint light client.

• string chain_id = 12

  Chain ID the block belongs to

HealthStatus defines the health status of the node

Used in: GetHealthResponse

• UNKNOWN = 0

  Unknown health status

• PASS = 1

  Healthy status (Healthy)

• WARN = 2

  Degraded but still serving

• FAIL = 3

  Hard fail

Metadata is the metadata of a block in the blockchain.

Used in: Data

• string chain_id = 1

  Rollup chain id

• uint64 height = 2

  Block height

• uint64 time = 3

  Block creation time

• bytes last_data_hash = 4

  Previous block info

NetInfo contains information about the network

Used in: GetNetInfoResponse

• string id = 1

  Network ID

• repeated string listen_addresses = 2

  Listen address

• repeated string connected_peers = 3

  List of connected peers

PeerInfo contains information about a connected peer

Used in: GetPeerInfoResponse

• string id = 1

  Peer ID

• string address = 2

  Peer address

SignedHeader is a header with a signature and a validator set.

Used in: Block

• optional Header header = 1

• bytes signature = 2

• optional Signer signer = 3

Signer is a signer of a block in the blockchain.

Used in: SignedHeader

• bytes address = 1

  Address of the signer

• bytes pub_key = 2

  Public key of the signer

State is the state of the blockchain.

Used in: GetStateResponse

• optional Version version = 1

• string chain_id = 2

• uint64 initial_height = 3

• uint64 last_block_height = 4

• optional google.protobuf.Timestamp last_block_time = 5

• uint64 da_height = 6

• bytes last_results_hash = 7

• bytes app_hash = 8

Version captures the consensus rules for processing a block in the blockchain, including all blockchain data structures and the rules of the application's state transition machine. This is equivalent to the tmversion.Consensus type in Tendermint.

Used in: Header, State

• uint64 block = 1

• uint64 app = 2

Vote is a vote for a block in the blockchain.

• string chain_id = 1

  Chain ID

• uint64 height = 2

  Block height

• optional google.protobuf.Timestamp timestamp = 3

  Timestamp

• bytes block_id_hash = 4

  Block ID hash

• bytes validator_address = 5

  Validator address