Enum cuprate_consensus::BCReadRequest

pub enum BCReadRequest {
    BlockExtendedHeader(u64),
    BlockHash(u64),
    FilterUnknownHashes(HashSet<[u8; 32]>),
    BlockExtendedHeaderInRange(Range<u64>),
    ChainHeight,
    GeneratedCoins,
    Outputs(HashMap<u64, HashSet<u64>>),
    NumberOutputsWithAmount(Vec<u64>),
    KeyImagesSpent(HashSet<[u8; 32]>),
}

A read request to the blockchain database.

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

See Response for the expected responses per Request.

Variants

BlockExtendedHeader(u64)

Request a block’s extended header.

The input is the block’s height.

BlockHash(u64)

Request a block’s hash.

The input is the block’s height.

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<u64>)

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

Request the total amount of generated coins (atomic units) so far.

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 arer not spent.

Input is a set of key images.

Trait Implementations

impl Clone for BCReadRequest

fn clone(&self) -> BCReadRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BCReadRequest

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

Formats the value using the given formatter.

impl PartialEq for BCReadRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for BCReadRequest

impl StructuralPartialEq for BCReadRequest

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: 8 bytes
• BlockHash: 8 bytes
• FilterUnknownHashes: 48 bytes
• BlockExtendedHeaderInRange: 16 bytes
• ChainHeight: 0 bytes
• GeneratedCoins: 0 bytes
• Outputs: 48 bytes
• NumberOutputsWithAmount: 24 bytes
• KeyImagesSpent: 48 bytes