Expand description
The v2 API contract, generated by build.rs from the proto files in proto/: message types,
the tonic server traits, and the protoJSON Serialize/Deserialize impls that define the
HTTP wire encoding. render builds these messages from consensus types.
Modules§
- advz_
merkle_ node - Nested message and enum types in
AdvzMerkleNode. - availability_
service_ server - Generated server implementations.
- catchup_
service_ server - Generated server implementations.
- config_
service_ server - Generated server implementations.
- database_
service_ server - Generated server implementations.
- explorer_
service_ server - Generated server implementations.
- fee_
merkle_ proof - Nested message and enum types in
FeeMerkleProof. - finality_
proof - Nested message and enum types in
FinalityProof. - header_
response - Nested message and enum types in
HeaderResponse. - light_
client_ service_ server - Generated server implementations.
- merklized_
state_ service_ server - Generated server implementations.
- node_
service_ server - Generated server implementations.
- ns_
proof - Nested message and enum types in
NsProof. - resolvable_
chain_ config - Nested message and enum types in
ResolvableChainConfig. - reward_
merkle_ proof - Nested message and enum types in
RewardMerkleProof. - reward_
state_ service_ server - Generated server implementations.
- stake_
table_ event - Nested message and enum types in
StakeTableEvent. - state_
signature_ service_ server - Generated server implementations.
- status_
service_ server - Generated server implementations.
- submit_
service_ server - Generated server implementations.
- token_
service_ server - Generated server implementations.
- tx_
proof - Nested message and enum types in
TxProof. - vid_
common - Nested message and enum types in
VidCommon. - vid_
share_ response - Nested message and enum types in
VidShareResponse. - view_
change_ evidence2 - Nested message and enum types in
ViewChangeEvidence2.
Structs§
- Advz
Common - Parameters of the legacy ADVZ scheme, with the two commitments exactly as v1 renders them
- Advz
Merkle Node - One node of a jellyfish Merkle proof. v1 spells the third arm
ForgettenSubtree, which is upstream’s misspelling; only the wire name here is corrected. - Advz
Merkle Node Branch - Advz
Merkle Node Empty - A missing subtree. The arm is present and its object empty
- Advz
Merkle Node Forgotten Subtree - Advz
Merkle Node Leaf - Advz
Merkle Proof - Advz
NsProof - Legacy ADVZ namespace proof
- Advz
TxProof - Legacy ADVZ inclusion proof, with the index and table entries in v1’s byte encodings
- Advz
VidShare - Legacy ADVZ share, which only a 0.1 or 0.2 block carries
- ApiModules
- Which API modules the node serves. A module that is off answers 404 for every route it owns, so a client can tell a disabled module from a missing one
- Avidm
BadEncoding NsProof - Avidm
BadEncoding Proof - Evidence that an AvidM disperser encoded a namespace incorrectly: the polynomial recovered from the shares, and the shares’ Merkle proofs against the commitment that does not match it
- Avidm
Common - The two AvidM schemes’ parameters and transaction proofs have the same shape today but are separate messages, since the field numbers freeze per scheme and the schemes are versioned independently
- Avidm
Gf2Common - Avidm
Gf2Namespace - Avidm
Gf2Param - Avidm
Gf2Tx Proof - Avidm
Gf2Vid Share - Avidm
Share Content - Avidm
TxProof - Avidm
VidShare - Both AvidM schemes disperse per namespace, so a share carries one entry per namespace of the block rather than one for the whole payload. The per-namespace lists line up only for a share that passed VID verification, which this endpoint does not repeat.
- Block
Height Response - Block
Range Response - Block
Response - Block
Reward Response - Block
Summary Range Response - Block
Summary Response - BlsPublic
Key - Bn254
G1Point - Coordinates are
0x-prefixed hex, as v1 serves them - Bn254
G2Point - Coordinates are
0x-prefixed hex, as v1 serves them - Builder
Signature - Catchup
Chain Config Response - Catchup
Leaf Chain Response - Cert2
Response - Certificate2
- The new protocol’s phase-2 certificate, which finalizes a leaf
- Certificate
Pair - A QC, paired with the next epoch’s QC for the same leaf when the leaf hands over an epoch
- Chain
Config - Circulating
Supply Ethereum Response - Circulating
Supply Response - Combined
Network Config - Never served: kept so
combined_network_configkeeps its type - Commission
Updated - Consensus
Keys Updated - Consensus
Keys Updated V2 - Consensus
Pruning Config - Retention policy for consensus storage
- Delegated
- Delegator
- EdOn
Bn254 Point - Coordinates are
0x-prefixed hex, as v1 serves them - EnvResponse
- EnvVar
- Explorer
Block Detail - A block the explorer describes in full
- Explorer
Block Detail Response - Explorer
Block Summaries Response - Explorer
Block Summary - A block as it appears in a list, without the fee recipient or the reward
- Explorer
FeeAttribution - Fees attributed to one layer, such as the sequencer or the DA layer
- Explorer
Genesis Overview - Explorer
Histogram Point - One block’s point in the explorer’s histograms
- Explorer
Search Response - Explorer
Summary Response - Explorer
Transaction Detail - Explorer
Transaction Detail Response - Explorer
Transaction Summaries Response - Explorer
Transaction Summary - A transaction as it appears in a list
- FeeAccount
Proof - FeeAccount
Proof Response - FeeBalance
Response - FeeInfo
- FeeMerkle
Proof - Mirrors the tree’s own presence or absence proof. Exactly one arm is set
- FeeMerkle
Tree Response - Finality
Assumption - The client already trusts the leaf at the requested finalized height, whose parent is the last leaf of the chain
- Finality
Proof - Evidence that the last leaf of a leaf chain is finalized. The arm names the commit rule
- Follower
Module - FsStorage
- GetAll
Validators Request - GetBlock
Height Request - GetBlock
Range Request - GetBlock
Ranges Request - GetBlock
Request - GetBlock
Reward Request - GetBlock
State Path Request - GetBlock
Summary Range Request - GetBlock
Summary Request - GetCatchup
Blocks Frontier Request - GetCatchup
Cert2 Request - GetCatchup
Chain Config Request - GetCatchup
FeeAccount Request - GetCatchup
FeeAccounts Request - GetCatchup
Leaf Chain Request - GetCatchup
Reward Account Request - GetCatchup
Reward Account V2Request - GetCatchup
Reward Accounts Request - GetCatchup
Reward Merkle Tree V2Request - GetCatchup
State Cert Request - GetCert2
Request - GetCirculating
Supply Ethereum Request - GetCirculating
Supply Request - GetEnv
Request - GetExplorer
Block Detail Request - GetExplorer
Block Summaries Request - GetExplorer
Search Request - GetExplorer
Summary Request - GetExplorer
Transaction Detail Request - GetExplorer
Transaction Summaries Request - GetFee
State Path Request - GetHeader
Range Request - GetHeader
Request - GetHeader
Window Request - GetHotshot
Config Request - GetIncorrect
Encoding Proof Request - GetLatest
FeeBalance Request - GetLeaf
Range Request - GetLeaf
Ranges Request - GetLeaf
Request - GetLight
Client Header Proof Request - GetLight
Client Leaf Proof Request - GetLight
Client Namespace Proof Range Request - GetLight
Client Namespace Proof Request - GetLight
Client Namespaces Proof Range Request - GetLight
Client Payload Proof Range Request - GetLight
Client Payload Proof Ranges Request - GetLight
Client Payload Proof Request - GetLight
Client Stake Table Request - GetLimits
Request - GetMigration
Status Request - GetNamespace
Proof Range Request - GetNamespace
Proof Request - GetNode
Block Height Request - GetNode
Keys Request - GetNode
Limits Request - GetPayload
Range Request - GetPayload
Request - GetPayload
Size Request - GetProposal
Participation Request - GetReward
Account Proof Request - GetReward
Amounts Request - GetReward
Balance Request - GetReward
Claim Input Request - GetReward
Merkle Tree V2Request - GetRuntime
Config Request - GetStake
Table Request - GetState
Cert Request - GetState
Cert V2Request - GetState
Height Request - GetState
Signature Request - GetSuccess
Rate Request - GetSync
Status Request - GetTable
Sizes Request - GetTime
Since Last Decide Request - GetTotal
Issued Supply Request - GetTotal
Minted Supply Request - GetTotal
Reward Distributed Request - GetTransaction
Count Request - GetTransaction
Proof Request - GetTransaction
Request - GetValidators
Request - GetVid
Common Range Request - GetVid
Common Ranges Request - GetVid
Common Request - GetVid
Share Request - GetVote
Participation Request - Header
Range Response - Header
Response - The arm names the protocol version that produced the header. Versions sharing a shape share a message: 0.2 uses the 0.1 shape and 0.6 and 0.7 the 0.5 shape
- Header
V1 - The header shape introduced in protocol version 0.1, also used by 0.2
- Header
V3 - The header shape introduced in protocol version 0.3, which added the reward merkle tree
- Header
V4 - The header shape introduced in protocol version 0.4, which moved to the second reward merkle tree and added millisecond timestamps, distributed rewards and the next stake table hash
- Header
V5 - The header shape introduced in protocol version 0.5, which added leader counts. Also used by 0.6 and 0.7
- Header
Window Response - Height
Range - A half-open range of heights, one entry of a batch request’s body
- HotStuff2
Finality - A 2-chain of QCs under the HotStuff2 commit rule
- HotStuff
Finality - A 3-chain of QCs under the original HotStuff commit rule
- Hotshot
Config Response - The consensus parameters this node runs with.
- Http
Module - Incorrect
Encoding Proof Response - L1Block
Info - Large
Range Proof - A jellyfish range proof over a namespace’s bytes, as v1 encodes it
- Leaf2
- Leaf
Range Response - Leaf
Response - Libp2p
Bootstrap Node - Never served: kept so
libp2p_configkeeps its type - Libp2p
Network Config - Never served: kept so
libp2p_configkeeps its type - Light
Client DbOptions - Light
Client Header Proof Response - Light
Client Leaf Proof Response - Light
Client Module Options - Light
Client Namespace Proof Contents - Light
Client Namespace Proof Range Response - Light
Client Namespace Proof Response - Light
Client Namespaces Proof - Light
Client Namespaces Proof Range Response - Light
Client Payload Proof Range Response - Light
Client Payload Proof Response - Light
Client Stake Table Response - Limits
Response - Lock
View - A lock, ordered by epoch, then view
- Merkle
Path Response - Migration
Status - Migration
Status Response - Namespace
Info - Namespace
Proof Range Response - Namespace
Proof Response - NewProtocol
Finality - A phase-2 certificate under the new protocol
- Node
Block Height Response - Node
Identity - Node
Keys Response - Node
Limits Response - Node
Storage fsandsqlfollowbackend, and both are absent when the default filesystem backend was never given a path- NsProof
- The arm names the VID scheme, and v1_incorrect_encoding is an AvidM block whose disperser cheated
- NsProof
Payload - A namespace’s proof against the payload commitment, for the AvidM and AvidmGf2 schemes
- NsTable
- P2pAddr
Updated - Participation
Entry - Participation
Response - Payload
- Payload
Range Response - Payload
Response - Payload
Size Response - Peer
Config - Peer
Connect Info - Protocol
Version - Pruning
Config - Retention policy for the archival tables. Durations are whole milliseconds, rounded down
- Query
Module - Quorum
Certificate2 - A certificate is its voted data plus the signatures over the commitment of that data. One message per data type, the shape is otherwise the same
- Quorum
Data2 - Quorum
Signatures - The aggregate signature on a certificate and who contributed to it
- Resolvable
Chain Config - A header carries either the chain config itself or a commitment the caller resolves elsewhere
- Resource
Sync Status - Reward
Account Proof - Reward
Account Proof Response - Reward
Amount Pair - Reward
Amounts Response - Reward
Balance Response - Reward
Claim Input Response - Reward
Merkle Proof - Mirrors the tree’s own presence or absence proof. Exactly one arm is set
- Reward
Merkle Tree V1Response - Reward
Merkle Tree V2Response - Runtime
Config Response - The node’s effective runtime configuration: CLI flags, environment and defaults merged. The genesis and the catchup, proposal-fetcher and L1 tuning stay on v1. No credential this node holds is served, but a URL an operator configured with userinfo is served as given, as v1 serves it
- Schnorr
Public Key - Shard
Range - Half-open range of shard indices this share holds in the encoded payload. Its length is the storage node’s VID weight
- Small
Range Proof - A jellyfish range proof over a few payload bytes, as v1 encodes it
- SqlStorage
- Durations are whole milliseconds, rounded down
- Stake
Table Entry - Stake
Table Event - One stake table contract event. The arm names the event and its version
- Stake
Table Response - State
Cert V1Response - The certificate a light client uses to advance past an epoch boundary, first form
- State
Cert V2Response - The certificate a light client uses to advance past an epoch boundary, with the LCV2 and LCV3 signatures side by side
- State
Height Response - State
Signature Response - This node’s signature over the light client state at one block, in the form the state relay server receives it. A node keeps these only for recent blocks, so an older height is a 404
- State
Signature V1 - State
Signature V2 - Stream
Blocks Request - Stream
Headers Request - Stream
Leaves Request - Stream
Namespace Proofs Request - Stream
Payloads Request - Stream
Transactions Request - Stream
VidCommon Request - Submit
Transaction Request - Submit
Transaction Response - Success
Rate Response - Sync
Status Range - Sync
Status Response - Table
Size - Table
Sizes Response - Time
Since Last Decide Response - Timeout
Certificate2 - Timeout
Certificate3 - The timeout certificate the new protocol carries, whose epoch is always known.
Every signer signs the lock it holds; the certificate’s lock is the latest, and
is that of
lock_cert. - Timeout
Data2 - Timeout
Data3 - Timeout
Signatures - The signers of a timeout certificate that hold the same lock, earlier than the certificate’s
- Total
Issued Supply Response - Total
Minted Supply Response - Total
Reward Distributed Response - Transaction
- Transaction
Count Response - Transaction
Response - Transaction
With Proof Response - TxProof
- The arm names the VID scheme the block was disseminated with
- Undelegated
- Undelegated
V2 - Upgrade
Certificate - Upgrade
Proposal Data - Validator
- Validator
Exit - Validator
Exit V2 - Validator
Registered - Validator
Registered V2 - Validator
Registered V3 - Validators
Response - Versioned
DaCommittee - VidCommon
- VidCommon
Range Response - VidCommon
Response - VidShare
Response - The arm names the VID scheme the block was disseminated with
- View
Change Evidence2 - Why a proposal’s justify QC is not from the immediately preceding view
- View
Sync Finalize Certificate2 - View
Sync Finalize Data2 - Vote2
Data - X25519
KeyUpdated
Enums§
- Builder
Type - Storage
Backend - Sync
Status - Whether this node stores an object, still has to fetch it, or deleted it on purpose