Crate pallet_mmr[−][src]
Merkle Mountain Range
Overview
Details on Merkle Mountain Ranges (MMRs) can be found here: https://github.com/mimblewimble/grin/blob/master/doc/mmr.md
The MMR pallet constructs a MMR from leaf data obtained on every block from
LeafDataProvider. MMR nodes are stored both in:
- on-chain storage - hashes only; not full leaf content)
- off-chain storage - via Indexing API we push full leaf content (and all internal nodes as
well) to the Off-chain DB, so that the data is available for Off-chain workers.
Hashing used for MMR is configurable independently from the rest of the runtime (i.e. not using
frame_system::Hashing) so something compatible with external chains can be used (like Keccak256 for Ethereum compatibility).
Depending on the usage context (off-chain vs on-chain) the pallet is able to:
- verify MMR leaf proofs (on-chain)
- generate leaf proofs (off-chain)
See primitives::Compact documentation for how you can optimize proof size for leafs that are composed from multiple elements.
What for?
Primary use case for this pallet is to generate MMR root hashes, that can latter on be used by BEEFY protocol (see https://github.com/paritytech/grandpa-bridge-gadget). MMR root hashes along with BEEFY will make it possible to build Super Light Clients (SLC) of Substrate-based chains. The SLC will be able to follow finality and can be shown proofs of more details that happened on the source chain. In that case the chain which contains the pallet generates the Root Hashes and Proofs, which are then presented to another chain acting as a light client which can verify them.
Secondary use case is to archive historical data, but still be able to retrieve them on-demand if needed. For instance if parent block hashes are stored in the MMR it's possible at any point in time to provide a MMR proof about some past block hash, while this data can be safely pruned from on-chain storage.
NOTE This pallet is experimental and not proven to work in production.
Re-exports
pub use pallet_mmr_primitives as primitives; |
pub use $crate::traits::GetPalletVersion as _; |
Structs
| DefaultInstance | Default module instance |
| Instance0 | Module instance |
| Instance1 | Module instance |
| Instance2 | Module instance |
| Instance3 | Module instance |
| Instance4 | Module instance |
| Instance5 | Module instance |
| Instance6 | Module instance |
| Instance7 | Module instance |
| Instance8 | Module instance |
| Instance9 | Module instance |
| Instance10 | Module instance |
| Instance11 | Module instance |
| Instance12 | Module instance |
| Instance13 | Module instance |
| Instance14 | Module instance |
| Instance15 | Module instance |
| Module | A public part of the pallet. |
| Nodes | Hashes of the nodes in the MMR. |
| NumberOfLeaves | Current size of the MMR (number of leaves). |
| RootHash | Latest MMR Root hash. |
Enums
| Call | Dispatchable calls. |
Traits
| Config | This pallet's configuration trait |
| WeightInfo |
Functions
| verify_leaf_proof | Stateless MMR proof verification. |