Trait sp_mmr_primitives::MmrApi

pub trait MmrApi<Block: BlockT, Hash: Codec, BlockNumber: Codec>: Core<Block> {
    // Provided methods
    fn mmr_root(
        &self,
        __runtime_api_at_param__: &BlockId<Block>
    ) -> Result<Result<Hash, Error>, ApiError> { ... }
    fn mmr_root_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext
    ) -> Result<Result<Hash, Error>, ApiError> { ... }
    fn mmr_leaf_count(
        &self,
        __runtime_api_at_param__: &BlockId<Block>
    ) -> Result<Result<LeafIndex, Error>, ApiError> { ... }
    fn mmr_leaf_count_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext
    ) -> Result<Result<LeafIndex, Error>, ApiError> { ... }
    fn generate_proof(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        block_numbers: Vec<BlockNumber>,
        best_known_block_number: Option<BlockNumber>
    ) -> Result<Result<(Vec<EncodableOpaqueLeaf>, Proof<Hash>), Error>, ApiError> { ... }
    fn generate_proof_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext,
        block_numbers: Vec<BlockNumber>,
        best_known_block_number: Option<BlockNumber>
    ) -> Result<Result<(Vec<EncodableOpaqueLeaf>, Proof<Hash>), Error>, ApiError> { ... }
    fn verify_proof(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        leaves: Vec<EncodableOpaqueLeaf>,
        proof: Proof<Hash>
    ) -> Result<Result<(), Error>, ApiError> { ... }
    fn verify_proof_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext,
        leaves: Vec<EncodableOpaqueLeaf>,
        proof: Proof<Hash>
    ) -> Result<Result<(), Error>, ApiError> { ... }
    fn verify_proof_stateless(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        root: Hash,
        leaves: Vec<EncodableOpaqueLeaf>,
        proof: Proof<Hash>
    ) -> Result<Result<(), Error>, ApiError> { ... }
    fn verify_proof_stateless_with_context(
        &self,
        __runtime_api_at_param__: &BlockId<Block>,
        context: ExecutionContext,
        root: Hash,
        leaves: Vec<EncodableOpaqueLeaf>,
        proof: Proof<Hash>
    ) -> Result<Result<(), Error>, ApiError> { ... }
}

API to interact with MMR pallet.

Provided Methods

fn mmr_root( &self, __runtime_api_at_param__: &BlockId<Block> ) -> Result<Result<Hash, Error>, ApiError>

Return the on-chain MMR root hash.

fn mmr_root_with_context( &self, __runtime_api_at_param__: &BlockId<Block>, context: ExecutionContext ) -> Result<Result<Hash, Error>, ApiError>

Return the on-chain MMR root hash.

fn mmr_leaf_count( &self, __runtime_api_at_param__: &BlockId<Block> ) -> Result<Result<LeafIndex, Error>, ApiError>

Return the number of MMR blocks in the chain.

fn mmr_leaf_count_with_context( &self, __runtime_api_at_param__: &BlockId<Block>, context: ExecutionContext ) -> Result<Result<LeafIndex, Error>, ApiError>

Return the number of MMR blocks in the chain.

fn generate_proof( &self, __runtime_api_at_param__: &BlockId<Block>, block_numbers: Vec<BlockNumber>, best_known_block_number: Option<BlockNumber> ) -> Result<Result<(Vec<EncodableOpaqueLeaf>, Proof<Hash>), Error>, ApiError>

Generate MMR proof for a series of block numbers. If best_known_block_number = Some(n), use historical MMR state at given block height n. Else, use current MMR state.

fn generate_proof_with_context( &self, __runtime_api_at_param__: &BlockId<Block>, context: ExecutionContext, block_numbers: Vec<BlockNumber>, best_known_block_number: Option<BlockNumber> ) -> Result<Result<(Vec<EncodableOpaqueLeaf>, Proof<Hash>), Error>, ApiError>

Generate MMR proof for a series of block numbers. If best_known_block_number = Some(n), use historical MMR state at given block height n. Else, use current MMR state.

fn verify_proof( &self, __runtime_api_at_param__: &BlockId<Block>, leaves: Vec<EncodableOpaqueLeaf>, proof: Proof<Hash> ) -> Result<Result<(), Error>, ApiError>

Verify MMR proof against on-chain MMR for a batch of leaves.

Note this function will use on-chain MMR root hash and check if the proof matches the hash. Note, the leaves should be sorted such that corresponding leaves and leaf indices have the same position in both the leaves vector and the leaf_indices vector contained in the Proof

fn verify_proof_with_context( &self, __runtime_api_at_param__: &BlockId<Block>, context: ExecutionContext, leaves: Vec<EncodableOpaqueLeaf>, proof: Proof<Hash> ) -> Result<Result<(), Error>, ApiError>

Verify MMR proof against on-chain MMR for a batch of leaves.

Note this function will use on-chain MMR root hash and check if the proof matches the hash. Note, the leaves should be sorted such that corresponding leaves and leaf indices have the same position in both the leaves vector and the leaf_indices vector contained in the Proof

fn verify_proof_stateless( &self, __runtime_api_at_param__: &BlockId<Block>, root: Hash, leaves: Vec<EncodableOpaqueLeaf>, proof: Proof<Hash> ) -> Result<Result<(), Error>, ApiError>

Verify MMR proof against given root hash for a batch of leaves.

Note this function does not require any on-chain storage - the proof is verified against given MMR root hash.

Note, the leaves should be sorted such that corresponding leaves and leaf indices have the same position in both the leaves vector and the leaf_indices vector contained in the Proof

fn verify_proof_stateless_with_context( &self, __runtime_api_at_param__: &BlockId<Block>, context: ExecutionContext, root: Hash, leaves: Vec<EncodableOpaqueLeaf>, proof: Proof<Hash> ) -> Result<Result<(), Error>, ApiError>

Verify MMR proof against given root hash for a batch of leaves.

Note this function does not require any on-chain storage - the proof is verified against given MMR root hash.

Note, the leaves should be sorted such that corresponding leaves and leaf indices have the same position in both the leaves vector and the leaf_indices vector contained in the Proof

Trait Implementations

impl<Block: BlockT, Hash: Codec, BlockNumber: Codec> RuntimeApiInfo for dyn MmrApi<Block, Hash, BlockNumber>

const ID: [u8; 8] = _

The identifier of the runtime api.

const VERSION: u32 = 1u32

The version of the runtime api.

Implementors