Module explorer

Modules

currency 🔒

data_source 🔒

errors 🔒

monetary_value 🔒

query_data 🔒

traits 🔒

Structs

BlockDetail

BlockDetail is a struct that represents the details of a specific block for use in a Block Explorer.

BlockDetailResponse

BlockDetailResponse is a struct that represents the response from the get_block_detail endpoint.

BlockRange

BlockRange is a struct that represents a range for a specific set of blocks, starting at the given BlockIdentifier.

BlockSummary

BlockSummary is a struct that represents a summary overview of a specific block. It does not have all of the details of a BlockDetail, but it is useful for displaying information in a list of Blocks.

BlockSummaryResponse

BlockSummaryResponse is a struct that represents the response from the get_block_summaries endpoint.

CurrencyMismatchError

CurrencyMismatchError is an error that occurs when two different currencies are attempted to be combined in any way that would result in an invalid state.

ExplorerHistograms

ExplorerHistograms provides a series of data points that can be used to draw simple histograms for the Block Explorer. The data returned is meant to be an optimal packing of the values being returned.

ExplorerSummary

ExplorerSummary is a struct that represents an at-a-glance snapshot of the Block Chain. It contains some helpful information that can be used to display a simple health check of the Block Chain.

ExplorerSummaryResponse

ExplorerSummaryResponse is a struct that represents the response from the get_explorer_summary endpoint.

FeeAttribution

FeeAttribution represents a specific attribution of fees for a specific purpose.

GenesisOverview

GenesisOverview provides a summary overview of the block chain since it’s genesis. At a high level it includes the total number of unique rollups, transactions, and blocks that are in the block chain.

GetBlockSummariesRequest

GetBlockSummariesRequest is a struct that represents an incoming request for Block Summaries. This isn’t sent on the line, but an endpoint will be mapped to this struct in order for the request to be processed.

GetTransactionSummariesRequest

GetTransactionSummariesRequest is a struct that represents an incoming request for Transaction Summaries. This isn’t sent on the line, but an endpoint will be mapped to this struct in order for the request to be processed.

InvalidCurrencyCodeError

InvalidCurrencyCodeError is an error that occurs when an invalid currency code representation is encountered. This should only occur when the currency is being decoded from a string representation.

MonetaryValue

MonetaryValues is a struct that paris a CurrencyCode with a value. This structure is able to represent both positive and negative currencies.

SearchResult

SearchResult is a struct that represents the results of executing a search query against the chain. It contains a list of blocks and transactions that match the search query.

SearchResultResponse

SearchResultResponse is a struct that represents the response from the get_search_result endpoint.

Timestamp

Timestamp represents a specific point in time that has a possible offset.

TransactionDetail

TransactionDetail is a struct that represents the details of a specific transaction / payload contained within a Block.

TransactionDetailResponse

TransactionDetailResponse is a struct that represents the response from the get_transaction_detail endpoint.

TransactionDetailResponse

TransactionDetailResponse is a struct that represents the information returned concerning a request for a Transaction Detail. It contains the data payloads separately from the details of the Transaction itself.

TransactionRange

TransactionRange is a struct that represents a range for a specific set of transactions, starting at the given TransactionIdentifier.

TransactionSummariesResponse

TransactionSummariesResponse is a struct that represents the response from the get_transaction_summaries endpoint.

TransactionSummary

TransactionSummary is a struct that represents a summary overview of a specific transaction / payload contained within a Block. It does not have all of the details of a TransactionDetail, but it is useful for displaying information in a list of Transactions.

Enums

BlockIdentifier

BlockIdentifier is an enum that represents multiple ways of referring to a specific Block. These use cases are specific to a Block Explorer and can be used to reference a specific individual block.

CurrencyCode

CurrencyCode represents an enumeration of all representable currency codes that are supported by the API.

Error

Error is an enum that represents the various errors that can be returned from the Explorer API.

GetBlockDetailError

GetBlockDetailError represents an error that has occurred in response to the get_block_detail request.

GetBlockSummariesError

GetBlockSummariesError represents an error that has occurred in response to the GetBlockSummariesRequest request.

GetExplorerSummaryError

GetExplorerSummaryError represents an error that has occurred in response to the get_explorer_summary request.

GetSearchResultsError

GetSearchResultsError represents an error that has occurred in response to the get_search_results request.

GetTransactionDetailError

GetTransactionDetailError represents an error that has occurred in response to the get_transaction_detail request.

GetTransactionSummariesError

GetTransactionSummariesError represents an error that has occurred in response to the GetTransactionSummariesRequest request.

TimestampConversionError

TimestampConversionError represents an error that has occurred when attempting to convert a timestamp from a specific format to another. It is primarily used when attempting to deserialize a Timestamp from its serialized string representation.

TransactionIdentifier

TransactionIdentifier is an enum that represents multiple ways of of identifying a specific Transaction. These use cases are specific to a Block Explorer and can be used to ideally uniquely identify a Transaction within the Block Chain.

TransactionSummaryFilter

TransactionSummaryFilter represents the various filters that can be applied when retrieving a list of TransactionSummary entries.

Traits

ExplorerDataSource

An interface for querying Data and Statistics from the HotShot Blockchain.

ExplorerHeader

ExplorerHeader is a trait that represents certain extensions to the [BlockHeader] that are specific to the Block Explorer API. This trait allows for the explorer module to be defined and provide an API for any consuming Block Explorer.

ExplorerTransaction

ExplorerTransaction is a trait that allows the Explorer API to be able to retrieve a namespace id from a transaction. This is necessary for the Explorer API to be able to display the namespace id for a TransactionSummary.

Functions

define_api

define_api is a function that defines the API endpoints for the Explorer module of the HotShot Query Service. It implements the specification defined in the explorer.toml file.

validate_limit 🔒

Type Aliases

BalanceAmount

ProposerId

WalletAddress