package rpc.v1

Get desktop application:
View/edit binary Protocol Buffers messages

A service run by the Proxy which listens for incoming connections from workers and then notifies clients.

• rpc Notify (Notification, google.protobuf.Empty)

  rpc.proto:10

  Notify a client that there has been an update for a `ChainId`.

How to communicate with a validator or a local node.

• rpc HandleBlockProposal (BlockProposal, ChainInfoResult)

  rpc.proto:47

  Propose a new block.

• rpc HandleLiteCertificate (LiteCertificate, ChainInfoResult)

  rpc.proto:50

  Process a certificate without value.

• rpc HandleConfirmedCertificate (HandleConfirmedCertificateRequest, ChainInfoResult)

  rpc.proto:52

• rpc HandleValidatedCertificate (HandleValidatedCertificateRequest, ChainInfoResult)

  rpc.proto:54

• rpc HandleTimeoutCertificate (HandleTimeoutCertificateRequest, ChainInfoResult)

  rpc.proto:56

• rpc HandleChainInfoQuery (ChainInfoQuery, ChainInfoResult)

  rpc.proto:59

  Handle information queries for this chain.

• rpc Subscribe (SubscriptionRequest, stream Notification)

  rpc.proto:62

  Subscribe to notifications for a set of Chain Ids.

  message SubscriptionRequest

  rpc.proto:130

  A request for client to subscribe to notifications for a given `ChainId`

  • repeated ChainId chain_ids = 1

• rpc GetVersionInfo (google.protobuf.Empty, VersionInfo)

  rpc.proto:65

  Request the node's version info.

  message VersionInfo

  rpc.proto:114

  Information about the version of Linera the validator is running

  • optional CrateVersion crate_version = 1

  • string git_commit = 2

  • bool git_dirty = 3

  • string rpc_hash = 4

  • string graphql_hash = 5

  • string wit_hash = 6

• rpc GetNetworkDescription (google.protobuf.Empty, NetworkDescription)

  rpc.proto:68

  Request the network description seen by this node.

  message NetworkDescription

  rpc.proto:123

  • string name = 1

  • optional CryptoHash genesis_config_hash = 2

  • uint64 genesis_timestamp = 3

• rpc DownloadBlob (BlobId, BlobContent)

  rpc.proto:71

  Download a blob.

• rpc DownloadPendingBlob (PendingBlobRequest, PendingBlobResult)

  rpc.proto:74

  Download a blob that belongs to a pending block on the given chain.

• rpc HandlePendingBlob (HandlePendingBlobRequest, ChainInfoResult)

  rpc.proto:77

  Handle a blob that belongs to a pending block on the given chain.

• rpc UploadBlob (BlobContent, BlobId)

  rpc.proto:81

  Upload a blob. Returns an error if the validator has not seen a certificate using this blob.

• rpc DownloadCertificate (CryptoHash, Certificate)

  rpc.proto:84

  Download a certificate.

• rpc DownloadCertificates (CertificatesBatchRequest, CertificatesBatchResponse)

  rpc.proto:87

  Download a batch of certificates.

  message CertificatesBatchRequest

  rpc.proto:97

  A request for a batch of certificates.

  • repeated CryptoHash hashes = 1

  message CertificatesBatchResponse

  rpc.proto:102

  A batch of certificates.

  • repeated Certificate certificates = 1

• rpc BlobLastUsedBy (BlobId, CryptoHash)

  rpc.proto:90

  Return the hash of the `Certificate` that last used a blob.

• rpc MissingBlobIds (BlobIds, BlobIds)

  rpc.proto:93

  Return the `BlobId`s that are not contained as `Blob`.

  message BlobIds

  rpc.proto:365

  Content-addressed blob IDs i.e. the hashes of the `BlobContent`s.

  • repeated bytes bytes = 1

Interface provided by each physical shard (aka "worker") of a validator or a local node. * All commands return either the current chain info or an error. * Repeating commands produces no changes and returns no error. * Some handlers may return cross-chain requests, that is, messages to be communicated to other workers of the same validator.

• rpc HandleBlockProposal (BlockProposal, ChainInfoResult)

  rpc.proto:20

  Propose a new block.

• rpc HandleLiteCertificate (LiteCertificate, ChainInfoResult)

  rpc.proto:23

  Process a certificate without value.

• rpc HandleConfirmedCertificate (HandleConfirmedCertificateRequest, ChainInfoResult)

  rpc.proto:25

• rpc HandleValidatedCertificate (HandleValidatedCertificateRequest, ChainInfoResult)

  rpc.proto:27

• rpc HandleTimeoutCertificate (HandleTimeoutCertificateRequest, ChainInfoResult)

  rpc.proto:29

• rpc HandleChainInfoQuery (ChainInfoQuery, ChainInfoResult)

  rpc.proto:32

  Handle information queries for this chain.

• rpc DownloadPendingBlob (PendingBlobRequest, PendingBlobResult)

  rpc.proto:35

  Download a blob that belongs to a pending block on the given chain.

• rpc HandlePendingBlob (HandlePendingBlobRequest, ChainInfoResult)

  rpc.proto:38

  Handle a blob that belongs to a pending block on the given chain.

• rpc HandleCrossChainRequest (CrossChainRequest, google.protobuf.Empty)

  rpc.proto:41

  Handle a (trusted!) cross-chain request.

  message CrossChainRequest

  rpc.proto:150

  An internal request between chains within a validator.

  • oneof inner

    • UpdateRecipient update_recipient = 1

    • ConfirmUpdatedRecipient confirm_updated_recipient = 2

Used in: BlockProposal, ChainInfoQuery

• bytes bytes = 1

/ Public key of a Linera account. / Corresponding private key is used to sign block proposals.

Used in: BlockProposal

• bytes bytes = 1

/ Signature created by a Linera account.

Used in: BlockProposal

• bytes bytes = 1

A blob of binary data.

Used as request type in: ValidatorNode.UploadBlob

Used as response type in: ValidatorNode.DownloadBlob

Used as field type in: HandlePendingBlobRequest, PendingBlobResult

• bytes bytes = 1

A content-addressed blob ID i.e. the hash of the `BlobContent`.

Used as request type in: ValidatorNode.BlobLastUsedBy, ValidatorNode.DownloadBlob

Used as response type in: ValidatorNode.UploadBlob

Used as field type in: PendingBlobRequest

• bytes bytes = 1

Used in: ChainInfoQuery, ConfirmUpdatedRecipient

• uint64 height = 1

An authenticated proposal for a new block.

Used as request type in: ValidatorNode.HandleBlockProposal, ValidatorWorker.HandleBlockProposal

• optional ChainId chain_id = 1

  The ID of the chain (used for routing).

• bytes content = 2

  bincode-encoded content

• optional AccountPublicKey public_key = 3

  Byte-encoded public key

• optional AccountOwner owner = 4

  Byte-encoded owner

• optional AccountSignature signature = 5

  Signature by chain owner

• optional bytes validated_block_certificate = 6

  A lite certificate for a validated block that justifies the proposal in this round.

A certified statement from the committee.

Used as response type in: ValidatorNode.DownloadCertificate

Used as field type in: CertificatesBatchResponse, HandleConfirmedCertificateRequest, HandleTimeoutCertificateRequest, HandleValidatedCertificateRequest

• bytes value = 1

  The certified value

• bytes round = 2

  The round in which the value was certified.

• bytes signatures = 3

  Signatures on the value hash and round

• CertificateKind kind = 4

  The kind of certificate serialized in `value` field.

Used in: Certificate, LiteCertificate

• Timeout = 0

  Certificate for a timeout vote.

• Validated = 1

  Certificate for a validated block.

• Confirmed = 2

  Certificate for a confirmed block.

Used in: BlockProposal, ChainInfoQuery, ConfirmUpdatedRecipient, HandleConfirmedCertificateRequest, HandlePendingBlobRequest, HandleTimeoutCertificateRequest, HandleValidatedCertificateRequest, LiteCertificate, Notification, PendingBlobRequest, SubscriptionRequest, UpdateRecipient

• bytes bytes = 1

Request information on a chain.

Used as request type in: ValidatorNode.HandleChainInfoQuery, ValidatorWorker.HandleChainInfoQuery

• optional ChainId chain_id = 1

  The chain ID

• optional BlockHeight test_next_block_height = 2

  Optionally test that the block height is as expected

• bool request_committees = 3

  Query the current committees

• bool request_pending_message_bundles = 4

  Query the received messages that are waiting to be picked in the next block.

• optional bytes request_sent_certificate_hashes_in_range = 5

  Query a range of certificates hashes sent from the chain.

• optional uint64 request_received_log_excluding_first_n = 6

  Query new certificate removed from the chain.

• bool request_manager_values = 7

  Query values from the chain manager, not just votes.

• bool request_leader_timeout = 8

  Request a signed vote for a leader timeout.

• optional AccountOwner request_owner_balance = 9

  Query the balance of a given owner.

• bool request_fallback = 10

  Request a signed vote for fallback mode.

Response to `ChainInfoQuery`

Used in: ChainInfoResult

• bytes chain_info = 1

  bincode-encoded chain info

• optional ValidatorSignature signature = 2

  Optional validator signature for the response.

A wrapper around ChainInfoResponse which contains a serialized error variant

Used as response type in: ValidatorNode.HandleBlockProposal, ValidatorNode.HandleChainInfoQuery, ValidatorNode.HandleConfirmedCertificate, ValidatorNode.HandleLiteCertificate, ValidatorNode.HandlePendingBlob, ValidatorNode.HandleTimeoutCertificate, ValidatorNode.HandleValidatedCertificate, ValidatorWorker.HandleBlockProposal, ValidatorWorker.HandleChainInfoQuery, ValidatorWorker.HandleConfirmedCertificate, ValidatorWorker.HandleLiteCertificate, ValidatorWorker.HandlePendingBlob, ValidatorWorker.HandleTimeoutCertificate, ValidatorWorker.HandleValidatedCertificate

• oneof inner

  • ChainInfoResponse chain_info_response = 1

  • bytes error = 2

    a bincode wrapper around `NodeError`

Acknowledge the height of the highest confirmed blocks communicated with `UpdateRecipient`.

Used in: CrossChainRequest

• optional ChainId sender = 1

• optional ChainId recipient = 2

• optional BlockHeight latest_height = 3

Information about the Linera crate version the validator is running

Used in: VersionInfo

• uint32 major = 1

• uint32 minor = 2

• uint32 patch = 3

Used as request type in: ValidatorNode.DownloadCertificate

Used as response type in: ValidatorNode.BlobLastUsedBy

Used as field type in: CertificatesBatchRequest, NetworkDescription

• bytes bytes = 1

A certified statement from the committee, together with other certificates required for execution.

Used as request type in: ValidatorNode.HandleConfirmedCertificate, ValidatorWorker.HandleConfirmedCertificate

• optional ChainId chain_id = 1

  The ID of the chain (used for routing).

• optional Certificate certificate = 2

  A certified statement from the committee.

• bool wait_for_outgoing_messages = 3

  Wait until all outgoing cross-chain messages from this certificate have been received by the target chains.

A request to handle a pending blob.

Used as request type in: ValidatorNode.HandlePendingBlob, ValidatorWorker.HandlePendingBlob

• optional ChainId chain_id = 1

• optional BlobContent blob = 2

A certified statement from the committee, together with other certificates required for execution.

Used as request type in: ValidatorNode.HandleTimeoutCertificate, ValidatorWorker.HandleTimeoutCertificate

• optional ChainId chain_id = 1

  The ID of the chain (used for routing).

• optional Certificate certificate = 4

  A certified statement from the committee.

A certified statement from the committee, together with other certificates required for execution.

Used as request type in: ValidatorNode.HandleValidatedCertificate, ValidatorWorker.HandleValidatedCertificate

• optional ChainId chain_id = 1

  The ID of the chain (used for routing).

• optional Certificate certificate = 2

  A certified statement from the committee.

A certified statement from the committee, without the value.

Used as request type in: ValidatorNode.HandleLiteCertificate, ValidatorWorker.HandleLiteCertificate

• optional ChainId chain_id = 1

  The ID of the chain the value belongs to.

• bytes hash = 2

  The certified value's hash

• bytes round = 3

  The round in which the value was certified.

• bytes signatures = 4

  Signatures on the value hash and round

• bool wait_for_outgoing_messages = 5

  Wait until all outgoing cross-chain messages from this certificate have been received by the target chains.

• CertificateKind kind = 6

Notify that a chain has a new certified block or a new message.

Used as request type in: NotifierService.Notify

Used as response type in: ValidatorNode.Subscribe

• optional ChainId chain_id = 1

• bytes reason = 2

A request for a pending blob.

Used as request type in: ValidatorNode.DownloadPendingBlob, ValidatorWorker.DownloadPendingBlob

• optional ChainId chain_id = 1

• optional BlobId blob_id = 2

A requested pending blob, or an error.

Used as response type in: ValidatorNode.DownloadPendingBlob, ValidatorWorker.DownloadPendingBlob

• oneof inner

  • BlobContent blob = 1

  • bytes error = 2

    a bincode wrapper around `NodeError`

Communicate a number of messages from the sender to the recipient. Messages must be given by increasing block height.

Used in: CrossChainRequest

• optional ChainId sender = 1

• optional ChainId recipient = 2

• bytes bundles = 3

/ Public key of a validator.

• bytes bytes = 1

/ Signature created by a validator.

Used in: ChainInfoResponse

• bytes bytes = 1