Struct celestia_types::sample::Sample

pub struct Sample {
    pub id: SampleId,
    pub proof_type: AxisType,
    pub share: Vec<u8>,
    pub proof: NamespaceProof,
}

Represents Sample, with proof of its inclusion and location on EDS

Fields

id: SampleId

Location of the sample in the EDS and associated block height

proof_type: AxisType

Indication whether sampling was done row or column-wise

share: Vec<u8>

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, block_height: u64, ) -> 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;

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

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

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

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

verify sample with root hash from ExtendedHeader

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy 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<'de> Deserialize<'de> for Sample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Sample> for Sample

fn from(sample: Sample) -> RawSample

Converts to this type from the input type.

impl Protobuf<Sample> for Sample

fn encode<B>(&self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(&self) -> Result<Vec<u8>, Infallible>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(&self) -> Result<Vec<u8>, Infallible>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

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.

impl TryFrom<Sample> for Sample

type Error = Error

The type returned in the event of a conversion error.

fn try_from(sample: RawSample) -> Result<Sample, Self::Error>

Performs the conversion.