Enum cuprate_consensus::context::BlockChainContextRequest

pub enum BlockChainContextRequest {
    GetContext,
    GetCurrentRxVm,
    BatchGetDifficulties(Vec<(u64, HardFork)>),
    NewRXVM(([u8; 32], Arc<RandomXVm>)),
    Update(NewBlockData),
    PopBlocks {
        numb_blocks: usize,
    },
    ClearAltCache,
    AltChainContextCache {
        prev_id: [u8; 32],
        _token: AltChainRequestToken,
    },
    AltChainDifficultyCache {
        prev_id: [u8; 32],
        _token: AltChainRequestToken,
    },
    AltChainWeightCache {
        prev_id: [u8; 32],
        _token: AltChainRequestToken,
    },
    AltChainRxVM {
        height: usize,
        chain: Chain,
        _token: AltChainRequestToken,
    },
    AddAltChainContextCache {
        prev_id: [u8; 32],
        cache: Box<AltChainContextCache>,
        _token: AltChainRequestToken,
    },
}

A request to the blockchain context cache.

Variants

GetContext

Get the current blockchain context.

GetCurrentRxVm

Gets the current RandomX VM.

BatchGetDifficulties(Vec<(u64, HardFork)>)

Get the next difficulties for these blocks.

Inputs: a list of block timestamps and hfs

The number of difficulties returned will be one more than the number of timestamps/ hfs.

NewRXVM(([u8; 32], Arc<RandomXVm>))

Add a VM that has been created outside of the blockchain context service to the blockchain context. This is useful when batch calculating POW as you may need to create a new VM if you batch a lot of blocks together, it would be wasteful to then not give this VM to the context service to then use when it needs to init a VM with the same seed.

This should include the seed used to init this VM and the VM.

Update(NewBlockData)

A request to add a new block to the cache.

PopBlocks

Pop blocks from the cache to the specified height.

Fields

numb_blocks: usize

The number of blocks to pop from the top of the chain.

Panics

This will panic if the number of blocks will pop the genesis block.

ClearAltCache

Clear the alt chain context caches.

AltChainContextCache

A request for an alt chain context cache.

This variant is private and is not callable from outside this crate, the block verifier service will handle getting the alt cache.

Fields

prev_id: [u8; 32]

The previous block field in a BlockHeader.

_token: AltChainRequestToken

An internal token to prevent external crates calling this request.

AltChainDifficultyCache

A request for a difficulty cache of an alternative chin.

This variant is private and is not callable from outside this crate, the block verifier service will handle getting the difficulty cache of an alt chain.

Fields

prev_id: [u8; 32]

The previous block field in a BlockHeader.

_token: AltChainRequestToken

An internal token to prevent external crates calling this request.

AltChainWeightCache

A request for a block weight cache of an alternative chin.

This variant is private and is not callable from outside this crate, the block verifier service will handle getting the weight cache of an alt chain.

Fields

prev_id: [u8; 32]

The previous block field in a BlockHeader.

_token: AltChainRequestToken

An internal token to prevent external crates calling this request.

AltChainRxVM

A request for a RX VM for an alternative chin.

Response variant: BlockChainContextResponse::AltChainRxVM.

This variant is private and is not callable from outside this crate, the block verifier service will handle getting the randomX VM of an alt chain.

Fields

height: usize

The height the RandomX VM is needed for.

chain: Chain

The chain to look in for the seed.

_token: AltChainRequestToken

An internal token to prevent external crates calling this request.

AddAltChainContextCache

A request to add an alt chain context cache to the context cache.

This variant is private and is not callable from outside this crate, the block verifier service will handle returning the alt cache to the context service.

Fields

prev_id: [u8; 32]

The previous block field in a BlockHeader.

cache: Box<AltChainContextCache>

The cache.

_token: AltChainRequestToken

An internal token to prevent external crates calling this request.

Trait Implementations

impl Clone for BlockChainContextRequest

fn clone(&self) -> BlockChainContextRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockChainContextRequest

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

Formats the value using the given formatter.

impl Service<BlockChainContextRequest> for BlockChainContextService

type Response = BlockChainContextResponse

Responses given by the service.

type Error = Box<dyn Error + Sync + Send>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<BlockChainContextService as Service<BlockChainContextRequest>>::Response, <BlockChainContextService as Service<BlockChainContextRequest>>::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: BlockChainContextRequest) -> Self::Future

Process the request and return the response asynchronously.

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: 96 bytes

Size for each variant:

• GetContext: 0 bytes
• GetCurrentRxVm: 0 bytes
• BatchGetDifficulties: 24 bytes
• NewRXVM: 40 bytes
• Update: 96 bytes
• PopBlocks: 8 bytes
• ClearAltCache: 0 bytes
• AltChainContextCache: 32 bytes
• AltChainDifficultyCache: 32 bytes
• AltChainWeightCache: 32 bytes
• AltChainRxVM: 16 bytes
• AddAltChainContextCache: 40 bytes