jleony/nanoreth
1
0
Fork 0
mirror of https://github.com/hl-archive-node/nanoreth.git synced 2025-12-06 10:59:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(interfaces): better document BlockchainTreeError (#4693)

Browse Source
This commit is contained in:
Thomas Coratger
2023-09-20 23:39:10 +02:00
committed by GitHub
parent 0a17bc66ff
commit b870a4ef01
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
crates/interfaces/src/blockchain_tree/error.rs
View File

@ -22,15 +22,30 @@ pub enum BlockchainTreeError {
/// The internal identifier for the side chain. /// The internal identifier for the side chain.
chain_id: u64, chain_id: u64,
}, },
/// Thrown if a canonical chain header cannot be found.
#[error("Canonical chain header #{block_hash} can't be found ")] #[error("Canonical chain header #{block_hash} can't be found ")]
CanonicalChain { block_hash: BlockHash }, CanonicalChain {
/// The block hash of the missing canonical chain header.
block_hash: BlockHash,
},
/// Thrown if a block number cannot be found in the blockchain tree chain.
#[error("Block number #{block_number} not found in blockchain tree chain")] #[error("Block number #{block_number} not found in blockchain tree chain")]
BlockNumberNotFoundInChain { block_number: BlockNumber }, BlockNumberNotFoundInChain {
/// The block number that could not be found.
block_number: BlockNumber,
},
/// Thrown if a block hash cannot be found in the blockchain tree chain.
#[error("Block hash {block_hash} not found in blockchain tree chain")] #[error("Block hash {block_hash} not found in blockchain tree chain")]
BlockHashNotFoundInChain { block_hash: BlockHash }, BlockHashNotFoundInChain {
/// The block hash that could not be found.
block_hash: BlockHash,
},
// Thrown if the block failed to buffer // Thrown if the block failed to buffer
#[error("Block with hash {block_hash:?} failed to buffer")] #[error("Block with hash {block_hash:?} failed to buffer")]
BlockBufferingFailed { block_hash: BlockHash }, BlockBufferingFailed {
/// The block hash of the block that failed to buffer.
block_hash: BlockHash,
},
} }
/// Result alias for `CanonicalError` /// Result alias for `CanonicalError`