Enum BlockchainReadRequest

pub enum BlockchainReadRequest {
    BlockExtendedHeader(usize),
    BlockHash(usize, Chain),
    FindBlock([u8; 32]),
    FilterUnknownHashes(HashSet<[u8; 32]>),
    BlockExtendedHeaderInRange(Range<usize>, Chain),
    ChainHeight,
    GeneratedCoins(usize),
    Outputs(HashMap<u64, HashSet<u64>>),
    NumberOutputsWithAmount(Vec<u64>),
    KeyImagesSpent(HashSet<[u8; 32]>),
    CompactChainHistory,
    FindFirstUnknown(Vec<[u8; 32]>),
    AltBlocksInChain(ChainId),
    Block {
        height: usize,
    },
    BlockByHash([u8; 32]),
    TotalTxCount,
    DatabaseSize,
    OutputHistogram(OutputHistogramInput),
    CoinbaseTxSum {
        height: usize,
        count: u64,
    },
    AltChains,
    AltChainCount,
}

A read request to the blockchain database.

This pairs with BlockchainResponse, where each variant here matches in name with a BlockchainResponse variant. For example, the proper response for a BlockchainReadRequest::BlockHash would be a BlockchainResponse::BlockHash.

See Response for the expected responses per Request.

Variants

BlockExtendedHeader(usize)

Request a block’s extended header.

The input is the block’s height.

BlockHash(usize, Chain)

Request a block’s hash.

The input is the block’s height and the chain it is on.

FindBlock([u8; 32])

Request to check if we have a block and which Chain it is on.

The input is the block’s hash.

FilterUnknownHashes(HashSet<[u8; 32]>)

Removes the block hashes that are not in the main chain.

This should filter (remove) hashes in alt-blocks as well.

BlockExtendedHeaderInRange(Range<usize>, Chain)

Request a range of block extended headers.

The input is a range of block heights.

ChainHeight

Request the current chain height.

Note that this is not the top-block height.

GeneratedCoins(usize)

Request the total amount of generated coins (atomic units) at this height.

Outputs(HashMap<u64, HashSet<u64>>)

Request data for multiple outputs.

The input is a HashMap where:

• Key = output amount
• Value = set of amount indices

For pre-RCT outputs, the amount is non-zero, and the amount indices represent the wanted indices of duplicate amount outputs, i.e.:

// list of outputs with amount 10
[0, 1, 2, 3, 4, 5]
//  ^     ^
// we only want these two, so we would provide
// `amount: 10, amount_index: {1, 3}`

For RCT outputs, the amounts would be 0 and the amount indices would represent the global RCT output indices.

NumberOutputsWithAmount(Vec<u64>)

Request the amount of outputs with a certain amount.

The input is a list of output amounts.

KeyImagesSpent(HashSet<[u8; 32]>)

Check that all key images within a set are not spent.

Input is a set of key images.

CompactChainHistory

A request for the compact chain history.

FindFirstUnknown(Vec<[u8; 32]>)

A request to find the first unknown block ID in a list of block IDs.

Invariant

The Vec containing the block IDs must be sorted in chronological block order, or else the returned response is unspecified and meaningless, as this request performs a binary search.

AltBlocksInChain(ChainId)

A request for all alt blocks in the chain with the given ChainId.

Block

Get a Block by its height.

Fields

height: usize

BlockByHash([u8; 32])

Get a Block by its hash.

TotalTxCount

Get the total amount of non-coinbase transactions in the chain.

DatabaseSize

Get the current size of the database.

OutputHistogram(OutputHistogramInput)

Get an output histogram.

TODO: document fields after impl.

CoinbaseTxSum

Get the coinbase amount and the fees amount for N last blocks starting at particular height.

TODO: document fields after impl.

Fields

height: usize

count: u64

AltChains

Get information on all alternative chains.

AltChainCount

Get the amount of alternative chains that exist.

Trait Implementations

impl Clone for BlockchainReadRequest

fn clone(&self) -> BlockchainReadRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BlockchainReadRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for BlockchainReadRequest

fn eq(&self, other: &BlockchainReadRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BlockchainReadRequest

impl StructuralPartialEq for BlockchainReadRequest

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes

Size for each variant:

• BlockExtendedHeader: 16 bytes
• BlockHash: 24 bytes
• FindBlock: 40 bytes
• FilterUnknownHashes: 56 bytes
• BlockExtendedHeaderInRange: 32 bytes
• ChainHeight: 0 bytes
• GeneratedCoins: 16 bytes
• Outputs: 56 bytes
• NumberOutputsWithAmount: 32 bytes
• KeyImagesSpent: 56 bytes
• CompactChainHistory: 0 bytes
• FindFirstUnknown: 32 bytes
• AltBlocksInChain: 16 bytes
• Block: 16 bytes
• BlockByHash: 40 bytes
• TotalTxCount: 0 bytes
• DatabaseSize: 0 bytes
• OutputHistogram: 56 bytes
• CoinbaseTxSum: 24 bytes
• AltChains: 0 bytes
• AltChainCount: 0 bytes