Struct Sample 

pub struct Sample {
    pub proof_type: AxisType,
    pub share: Share,
    pub proof: NamespaceProof,
}

Represents Sample, with proof of its inclusion

Fields

proof_type: AxisType

Indication whether proving was done row or column-wise

share: Share

Share that is being sampled

proof: NamespaceProof

Proof of the inclusion of the share

Implementations

impl Sample

pub fn new( row_index: u16, column_index: u16, proof_type: AxisType, eds: &ExtendedDataSquare, ) -> Result<Self>

Create a new Sample for the given index of the ExtendedDataSquare in a block.

row_index and column_index specifies the Share position in EDS. proof_type determines whether proof of inclusion of the Share should be constructed for its row or column.

Errors

This function will return an error, if:

• row_index/column_index falls outside the provided ExtendedDataSquare.
• ExtendedDataSquare is incorrect (either data shares don’t have their namespace prefixed, or Shares aren’t namespace ordered)
• Block height is zero

Example

use celestia_types::AxisType;
use celestia_types::sample::{Sample, SampleId};

let block_height = 15;
let eds = get_extended_data_square(block_height);
let header = get_extended_header(block_height);

let sample_id = SampleId::new(2, 3, block_height).unwrap();
let sample = Sample::new(2, 3, AxisType::Row, &eds).unwrap();

sample.verify(sample_id, &header.dah).unwrap();

pub fn verify(&self, id: SampleId, dah: &DataAvailabilityHeader) -> Result<()>

verify sample with root hash from ExtendedHeader

pub fn encode(&self, bytes: &mut BytesMut)

Encode Sample into the raw binary representation.

pub fn decode(id: SampleId, buffer: &[u8]) -> Result<Self>

Decode Sample from the binary representation.

Errors

This function will return an error if protobuf deserialization fails and propagate errors from Sample::from_raw.

pub fn from_raw(id: SampleId, sample: RawSample) -> Result<Self>

Recover Sample from it’s raw representation.

Errors

This function will return error if proof is missing or invalid shares are not in the expected namespace, and will propagate errors from Share construction.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sample

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Sample> for RawSample

fn from(sample: Sample) -> RawSample

Converts to this type from the input type.

impl Serialize for Sample

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.