Trait sp_blockchain::Backend
source · pub trait Backend<Block: BlockT>: HeaderBackend<Block> + HeaderMetadata<Block, Error = Error> {
// Required methods
fn body(
&self,
hash: Block::Hash
) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>;
fn justifications(
&self,
hash: Block::Hash
) -> Result<Option<Justifications>>;
fn last_finalized(&self) -> Result<Block::Hash>;
fn leaves(&self) -> Result<Vec<Block::Hash>>;
fn displaced_leaves_after_finalizing(
&self,
block_number: NumberFor<Block>
) -> Result<Vec<Block::Hash>>;
fn children(&self, parent_hash: Block::Hash) -> Result<Vec<Block::Hash>>;
fn indexed_transaction(&self, hash: Block::Hash) -> Result<Option<Vec<u8>>>;
fn block_indexed_body(
&self,
hash: Block::Hash
) -> Result<Option<Vec<Vec<u8>>>>;
// Provided methods
fn best_containing(
&self,
target_hash: Block::Hash,
maybe_max_number: Option<NumberFor<Block>>,
import_lock: &RwLock<()>
) -> Result<Option<Block::Hash>> { ... }
fn has_indexed_transaction(&self, hash: Block::Hash) -> Result<bool> { ... }
}
Expand description
Blockchain database backend. Does not perform any validation.
Required Methods§
sourcefn body(
&self,
hash: Block::Hash
) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>
fn body( &self, hash: Block::Hash ) -> Result<Option<Vec<<Block as BlockT>::Extrinsic>>>
Get block body. Returns None
if block is not found.
sourcefn justifications(&self, hash: Block::Hash) -> Result<Option<Justifications>>
fn justifications(&self, hash: Block::Hash) -> Result<Option<Justifications>>
Get block justifications. Returns None
if no justification exists.
sourcefn last_finalized(&self) -> Result<Block::Hash>
fn last_finalized(&self) -> Result<Block::Hash>
Get last finalized block hash.
sourcefn leaves(&self) -> Result<Vec<Block::Hash>>
fn leaves(&self) -> Result<Vec<Block::Hash>>
Returns hashes of all blocks that are leaves of the block tree. in other words, that have no children, are chain heads. Results must be ordered best (longest, highest) chain first.
sourcefn displaced_leaves_after_finalizing(
&self,
block_number: NumberFor<Block>
) -> Result<Vec<Block::Hash>>
fn displaced_leaves_after_finalizing( &self, block_number: NumberFor<Block> ) -> Result<Vec<Block::Hash>>
Returns displaced leaves after the given block would be finalized.
The returned leaves do not contain the leaves from the same height as block_number
.
sourcefn children(&self, parent_hash: Block::Hash) -> Result<Vec<Block::Hash>>
fn children(&self, parent_hash: Block::Hash) -> Result<Vec<Block::Hash>>
Return hashes of all blocks that are children of the block with parent_hash
.
sourcefn indexed_transaction(&self, hash: Block::Hash) -> Result<Option<Vec<u8>>>
fn indexed_transaction(&self, hash: Block::Hash) -> Result<Option<Vec<u8>>>
Get single indexed transaction by content hash. Note that this will only fetch transactions
that are indexed by the runtime with storage_index_transaction
.
fn block_indexed_body(&self, hash: Block::Hash) -> Result<Option<Vec<Vec<u8>>>>
Provided Methods§
sourcefn best_containing(
&self,
target_hash: Block::Hash,
maybe_max_number: Option<NumberFor<Block>>,
import_lock: &RwLock<()>
) -> Result<Option<Block::Hash>>
fn best_containing( &self, target_hash: Block::Hash, maybe_max_number: Option<NumberFor<Block>>, import_lock: &RwLock<()> ) -> Result<Option<Block::Hash>>
Get the most recent block hash of the best (longest) chains
that contain block with the given target_hash
.
The search space is always limited to blocks which are in the finalized chain or descendents of it.
If maybe_max_block_number
is Some(max_block_number)
the search is limited to block numbers <= max_block_number
.
in other words as if there were no blocks greater max_block_number
.
Returns Ok(None)
if target_hash
is not found in search space.
TODO: document time complexity of this, see #1444
sourcefn has_indexed_transaction(&self, hash: Block::Hash) -> Result<bool>
fn has_indexed_transaction(&self, hash: Block::Hash) -> Result<bool>
Check if indexed transaction exists.