Struct BlockchainManager

pub struct BlockchainManager {
    blockchain_write_handle: BlockchainWriteHandle,
    blockchain_read_handle: BlockchainReadHandle,
    txpool_write_handle: TxpoolWriteHandle,
    blockchain_context_service: BlockChainContextService,
    cached_blockchain_context: RawBlockChainContext,
    block_verifier_service: BlockVerifierService<BlockChainContextService, TxVerifierService<MapErr<BlockchainReadHandle, fn(_: RuntimeError) -> BoxError>>, MapErr<BlockchainReadHandle, fn(_: RuntimeError) -> BoxError>>,
    stop_current_block_downloader: Arc<Notify>,
    broadcast_svc: BroadcastSvc<ClearNet>,
}

The blockchain manager.

This handles all mutation of the blockchain, anything that changes the state of the blockchain must go through this.

Other parts of Cuprate can interface with this by using the functions in interface.

Fields

blockchain_write_handle: BlockchainWriteHandle

The BlockchainWriteHandle, this is the only part of Cuprate where a BlockchainWriteHandle is held.

blockchain_read_handle: BlockchainReadHandle

A BlockchainReadHandle.

txpool_write_handle: TxpoolWriteHandle

A TxpoolWriteHandle.

blockchain_context_service: BlockChainContextService

The blockchain context cache, this caches the current state of the blockchain to quickly calculate/retrieve values without needing to go to a BlockchainReadHandle.

cached_blockchain_context: RawBlockChainContext

A cached context representing the current state.

block_verifier_service: BlockVerifierService<BlockChainContextService, TxVerifierService<MapErr<BlockchainReadHandle, fn(_: RuntimeError) -> BoxError>>, MapErr<BlockchainReadHandle, fn(_: RuntimeError) -> BoxError>>

The block verifier service, to verify incoming blocks.

stop_current_block_downloader: Arc<Notify>

A Notify to tell the syncer that we want to cancel this current download attempt.

broadcast_svc: BroadcastSvc<ClearNet>

The broadcast service, to broadcast new blocks.

Implementations

impl BlockchainManager

pub async fn handle_command(&mut self, command: BlockchainManagerCommand)

Handle an incoming command from another part of Cuprate.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

async fn broadcast_block( &mut self, block_bytes: Bytes, blockchain_height: usize, )

Broadcast a valid block to the network.

pub async fn handle_incoming_block( &mut self, block: Block, prepared_txs: HashMap<[u8; 32], TransactionVerificationData>, ) -> Result<IncomingBlockOk, Error>

Handle an incoming Block.

This function will route to Self::handle_incoming_alt_block if the block does not follow the top of the main chain.

Otherwise, this function will validate and add the block to the main chain.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

pub async fn handle_incoming_block_batch(&mut self, batch: BlockBatch)

Handle an incoming BlockBatch.

This function will route to Self::handle_incoming_block_batch_main_chain or Self::handle_incoming_block_batch_alt_chain depending on if the first block in the batch follows from the top of our chain.

Panics

This function will panic if the batch is empty or if any internal service returns an unexpected error that we cannot recover from or if the incoming batch contains no blocks.

async fn handle_incoming_block_batch_main_chain(&mut self, batch: BlockBatch)

Handles an incoming BlockBatch that follows the main chain.

This function will handle validating the blocks in the batch and adding them to the blockchain database and context cache.

This function will also handle banning the peer and canceling the block downloader if the block is invalid.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from or if the incoming batch contains no blocks.

async fn handle_incoming_block_batch_alt_chain(&mut self, batch: BlockBatch)

Handles an incoming BlockBatch that does not follow the main-chain.

This function will handle validating the alt-blocks to add them to our cache and reorging the chain if the alt-chain has a higher cumulative difficulty.

This function will also handle banning the peer and canceling the block downloader if the alt block is invalid or if a reorg fails.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

async fn handle_incoming_alt_block( &mut self, block: Block, prepared_txs: HashMap<[u8; 32], TransactionVerificationData>, ) -> Result<AddAltBlock, Error>

Handles an incoming alt Block.

This function will do some pre-validation of the alt block, then if the cumulative difficulty of the alt chain is higher than the main chain it will attempt a reorg otherwise it will add the alt block to the alt block cache.

Errors

This will return an Err if:

• The alt block was invalid.
• An attempt to reorg the chain failed.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

async fn try_do_reorg( &mut self, top_alt_block: AltBlockInformation, ) -> Result<(), Error>

Attempt a re-org with the given top block of the alt-chain.

This function will take a write lock on REORG_LOCK and then set up the blockchain database and context cache to verify the alt-chain. It will then attempt to verify and add each block in the alt-chain to the main-chain. Releasing the lock on REORG_LOCK when finished.

Errors

This function will return an Err if the re-org was unsuccessful, if this happens the chain will be returned back into its state it was at when then function was called.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

async fn verify_add_alt_blocks_to_main_chain( &mut self, alt_blocks: Vec<AltBlockInformation>, ) -> Result<(), Error>

Verify and add a list of AltBlockInformations to the main-chain.

This function assumes the first AltBlockInformation is the next block in the blockchain for the blockchain database and the context cache, or in other words that the blockchain database and context cache have already had the top blocks popped to where the alt-chain meets the main-chain.

Errors

This function will return an Err if the alt-blocks were invalid, in this case the re-org should be aborted and the chain should be returned to its previous state.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

pub async fn add_valid_block_to_main_chain( &mut self, verified_block: VerifiedBlockInformation, )

Adds a VerifiedBlockInformation to the main-chain.

This function will update the blockchain database and the context cache, it will also update Self::cached_blockchain_context.

Panics

This function will panic if any internal service returns an unexpected error that we cannot recover from.

impl BlockchainManager

pub async fn run( self, block_batch_rx: Receiver<BlockBatch>, command_rx: Receiver<BlockchainManagerCommand>, )

The BlockchainManager task.

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