Expand description
Queries for HotShot chain state.
The availability API provides an objective view of the HotShot blockchain. It provides access only to normative data: that is, data which is agreed upon by all honest consensus nodes and which is immutable. This means access to core consensus data structures including leaves, blocks, and headers, where each query is pure and idempotent. This also means that it is possible for a client to verify all of the information provided by this API, by running a HotShot light client and downloading the appropriate evidence with each query.
This API does not provide any queries which represent only the current state of the chain or may change over time, and it does not provide information for which there is not (yet) agreement of a supermajority of consensus nodes. For information about the current dynamic state of consensus and uncommitted state, try the status API. For information about the chain which is tabulated by this specific node and not subject to full consensus agreement, try the node API.
Modules§
- data_
source 🔒 - fetch 🔒
- query_
data 🔒
Structs§
- ADVZ
Common Query Data - The old VidCommonQueryData, associated with ADVZ VID Scheme.
- ADVZ
Payload Query Data - Block
Info - Information about a block.
- Block
Query Data - Block
Summary Query Data - Block
With Transaction - Custom
Snafu - SNAFU context selector for the
Error::Customvariant - Fetch
Block Snafu - SNAFU context selector for the
Error::FetchBlockvariant - Fetch
Header Snafu - SNAFU context selector for the
Error::FetchHeadervariant - Fetch
Leaf Snafu - SNAFU context selector for the
Error::FetchLeafvariant - Fetch
State Cert Snafu - SNAFU context selector for the
Error::FetchStateCertvariant - Fetch
Transaction Snafu - SNAFU context selector for the
Error::FetchTransactionvariant - Header
Query Data - Inconsistent
Leaf Error - Inconsistent
Leaf Legacy Error - Invalid
Transaction Index Snafu - SNAFU context selector for the
Error::InvalidTransactionIndexvariant - Leaf1
Query Data - Leaf
Query Data - Leaf
Query Data Legacy - Limits
- Namespace
Info - Options
- Payload
Metadata - A summary of a payload without all the data.
- Payload
Query Data - Query
Snafu - SNAFU context selector for the
Error::Queryvariant - Range
Limit Snafu - SNAFU context selector for the
Error::RangeLimitvariant - Request
Snafu - SNAFU context selector for the
Error::Requestvariant - Transaction
Index - Transaction
Query Data - Transaction
Summary Query Data - Transaction
With Proof Query Data - VidCommon
Metadata - A summary of a VID payload without all the data.
- VidCommon
Query Data
Enums§
Traits§
- Availability
Data Source - An interface for querying a HotShot blockchain.
- Queryable
Header - Queryable
Payload - A block payload whose contents (e.g. individual transactions) can be examined.
- Update
Availability Data - Verifiable
Inclusion - The proof system and the statement which is proved will vary by application, with different
applications proving stronger or weaker statements depending on the trust assumptions at
play. Some may prove a very strong statement (for example, a shared sequencer proving that
the transaction belongs not only to the block but to a section of the block dedicated to a
specific rollup), otherwise may prove something substantially weaker (for example, a trusted
query service may use
()for the proof).
Functions§
- define_
api - downgrade_
leaf 🔒 - downgrade_
leaf_ 🔒query_ data - downgrade_
vid_ 🔒common_ query_ data - enforce_
range_ 🔒limit - get_
leaf_ 🔒handler - get_
leaf_ 🔒range_ handler - get_
transaction 🔒 - get_
vid_ 🔒common_ handler
Type Aliases§
- Block
Hash - A block hash is the hash of the block header.
- Fetch
Stream - Leaf
Hash - Leaf
Hash Legacy - Namespace
Id - Namespace
Index - Namespace
Map - QcHash
- Timestamp
- Transaction
Hash - Transaction
Inclusion Proof