pub struct ReedSolomon<H> { /* private fields */ }Expand description
A SIMD-optimized Reed-Solomon coder that emits chunks that can be proven against a bmt.
§Behavior
The encoder takes input data, splits it into k data shards, and generates m recovery
shards using Reed-Solomon encoding.
All n = k + m shards are then used to build a bmt, producing a single root hash. Each shard
is packaged as a chunk containing the shard data, its index, and a Merkle proof against the bmt root.
§Encoding
+--------------------------------------+
| Original Data (Bytes) |
+--------------------------------------+
|
v
+--------------------------------------+
| [Length Prefix | Original Data...] |
+--------------------------------------+
|
v
+----------+ +----------+ +-----------+
| Shard 0 | | Shard 1 | .. | Shard k-1 | (Data Shards)
+----------+ +----------+ +-----------+
| | |
| | |
+------------+-------------+
|
v
+------------------+
| Reed-Solomon |
| Encoder (k, m) |
+------------------+
|
v
+----------+ +----------+ +-----------+
| Shard k | | Shard k+1| .. | Shard n-1 | (Recovery Shards)
+----------+ +----------+ +-----------+§Merkle Tree Construction
All n shards (data and recovery) are hashed and used as leaves to build a bmt.
Shards: [Shard 0, Shard 1, ..., Shard n-1]
| | |
v v v
Hashes: [H(S_0), H(S_1), ..., H(S_n-1)]
\ / \ /
\ / \ /
+---+ +---+
| |
\ /
\ /
+-----+
|
v
+----------+
| Root |
+----------+The final output is the bmt root and a set of n chunks.
(Root, [Chunk 0, Chunk 1, ..., Chunk n-1])
Each chunk contains:
shard: The shard data (original or recovery).index: The shard’s original index (0 to n-1).proof: A Merkle proof of the shard’s inclusion in the bmt.
§Decoding and Verification
The decoder requires any k chunks to reconstruct the original data.
- Each chunk’s Merkle proof is verified against the bmt root.
- The shards from the valid chunks are used to reconstruct the original
kdata shards. - To ensure consistency, the recovered data shards are re-encoded, and a new bmt root is generated. This new root MUST match the original bmt root. This prevents attacks where an adversary provides a valid set of chunks that decode to different data.
- If the roots match, the original data is extracted from the reconstructed data shards.
Trait Implementations§
Source§impl<H: Clone> Clone for ReedSolomon<H>
impl<H: Clone> Clone for ReedSolomon<H>
Source§fn clone(&self) -> ReedSolomon<H>
fn clone(&self) -> ReedSolomon<H>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<H> Debug for ReedSolomon<H>
impl<H> Debug for ReedSolomon<H>
Source§impl<H: Hasher> Scheme for ReedSolomon<H>
impl<H: Hasher> Scheme for ReedSolomon<H>
Source§type Commitment = <H as Hasher>::Digest
type Commitment = <H as Hasher>::Digest
A commitment attesting to the shards of data.
Source§type ReShard = Chunk<H>
type ReShard = Chunk<H>
A shard shared with other participants, to aid them in reconstruction. Read more
Source§type CheckedShard = Chunk<H>
type CheckedShard = Chunk<H>
A shard that has been checked for inclusion in the commitment. Read more
Source§type CheckingData = ()
type CheckingData = ()
Data which can assist in checking shards.
type Error = Error
Source§fn encode(
config: &Config,
data: impl Buf,
) -> Result<(Self::Commitment, Vec<Self::Shard>), Self::Error>
fn encode( config: &Config, data: impl Buf, ) -> Result<(Self::Commitment, Vec<Self::Shard>), Self::Error>
Encode a piece of data, returning a commitment, along with shards, and proofs. Read more
Source§fn reshard(
_config: &Config,
commitment: &Self::Commitment,
index: u16,
shard: Self::Shard,
) -> Result<(Self::CheckingData, Self::CheckedShard, Self::ReShard), Self::Error>
fn reshard( _config: &Config, commitment: &Self::Commitment, index: u16, shard: Self::Shard, ) -> Result<(Self::CheckingData, Self::CheckedShard, Self::ReShard), Self::Error>
Take your own shard, check it, and produce a Scheme::ReShard to forward to others. Read more
Source§fn check(
_config: &Config,
commitment: &Self::Commitment,
_checking_data: &Self::CheckingData,
index: u16,
reshard: Self::ReShard,
) -> Result<Self::CheckedShard, Self::Error>
fn check( _config: &Config, commitment: &Self::Commitment, _checking_data: &Self::CheckingData, index: u16, reshard: Self::ReShard, ) -> Result<Self::CheckedShard, Self::Error>
Check the integrity of a reshard, producing a checked shard. Read more
Source§fn decode(
config: &Config,
commitment: &Self::Commitment,
_checking_data: Self::CheckingData,
shards: &[Self::CheckedShard],
) -> Result<Vec<u8>, Self::Error>
fn decode( config: &Config, commitment: &Self::Commitment, _checking_data: Self::CheckingData, shards: &[Self::CheckedShard], ) -> Result<Vec<u8>, Self::Error>
Decode the data from shards received from other participants. Read more
impl<H: Copy> Copy for ReedSolomon<H>
Auto Trait Implementations§
impl<H> Freeze for ReedSolomon<H>
impl<H> RefUnwindSafe for ReedSolomon<H>where
H: RefUnwindSafe,
impl<H> Send for ReedSolomon<H>where
H: Send,
impl<H> Sync for ReedSolomon<H>where
H: Sync,
impl<H> Unpin for ReedSolomon<H>where
H: Unpin,
impl<H> UnwindSafe for ReedSolomon<H>where
H: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more