Enum hotshot_types::data::VidDisperseShare

pub enum VidDisperseShare<TYPES: NodeType> {
    V0(ADVZDisperseShare<TYPES>),
    V1(VidDisperseShare2<TYPES>),
}

VID share and associated metadata for a single node

Variants

V0(ADVZDisperseShare<TYPES>)

VID disperse share type for first version VID

V1(VidDisperseShare2<TYPES>)

VID disperse share type after epoch upgrade and VID upgrade

Implementations

impl<TYPES: NodeType> VidDisperseShare<TYPES>

pub fn from_vid_disperse(vid_disperse: VidDisperse<TYPES>) -> Vec<Self>

Create a vector of VidDisperseShare from VidDisperse

pub fn to_proposal( self, private_key: &<TYPES::SignatureKey as SignatureKey>::PrivateKey, ) -> Option<Proposal<TYPES, Self>>

Consume self and return a Proposal

pub fn to_vid_share_proposals( vid_disperse_proposal: Proposal<TYPES, VidDisperse<TYPES>>, ) -> Vec<Proposal<TYPES, Self>>

Split a VID share proposal into a proposal for each recipient.

pub fn recipient_key(&self) -> &TYPES::SignatureKey

Return the internal recipient_key

pub fn payload_commitment_ref(&self) -> &[u8]

Return a reference to the internal payload VID commitment

pub fn payload_commitment(&self) -> VidCommitment

Return the internal payload VID commitment TODO(Chengyu): restructure this, since payload commitment will have different types given different version.

pub fn data_epoch_payload_commitment(&self) -> Option<VidCommitment>

Return the internal data epoch payload VID commitment TODO(Chengyu): restructure this, since payload commitment will have different types given different version.

pub fn vid_common_ref(&self) -> &VidCommon

Return a reference to the internal VidCommon field. TODO(Chengyu): remove this after VID upgrade

pub fn target_epoch(&self) -> Option<<TYPES as NodeType>::Epoch>

Return the target epoch TODO(Chengyu): remove this?

pub fn verify_share(&self, total_nodes: usize) -> Result<(), ()>

Internally verify the share given necessary information

Errors

pub fn set_view_number(&mut self, view_number: <TYPES as NodeType>::View)

Set the view number

Trait Implementations

impl<TYPES: Clone + NodeType> Clone for VidDisperseShare<TYPES>

fn clone(&self) -> VidDisperseShare<TYPES>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES: Debug + NodeType> Debug for VidDisperseShare<TYPES>

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

Formats the value using the given formatter.

impl<'de, TYPES> Deserialize<'de> for VidDisperseShare<TYPES>

where TYPES: NodeType,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TYPES: NodeType> From<ADVZDisperseShare<TYPES>> for VidDisperseShare<TYPES>

fn from(share: ADVZDisperseShare<TYPES>) -> Self

Converts to this type from the input type.

impl<TYPES: NodeType> From<VidDisperseShare<TYPES>> for VidDisperseShare2<TYPES>

fn from(share: VidDisperseShare<TYPES>) -> VidDisperseShare2<TYPES>

Converts to this type from the input type.

impl<TYPES: NodeType> From<VidDisperseShare2<TYPES>> for VidDisperseShare<TYPES>

fn from(share: VidDisperseShare2<TYPES>) -> Self

Converts to this type from the input type.

impl<TYPES: NodeType> HasEpoch<TYPES> for VidDisperseShare<TYPES>

fn epoch(&self) -> Option<TYPES::Epoch>

Returns Epoch

impl<TYPES: NodeType> HasViewNumber<TYPES> for VidDisperseShare<TYPES>

fn view_number(&self) -> TYPES::View

Returns the view number the type refers to.

impl<TYPES: Hash + NodeType> Hash for VidDisperseShare<TYPES>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<TYPES: PartialEq + NodeType> PartialEq for VidDisperseShare<TYPES>

fn eq(&self, other: &VidDisperseShare<TYPES>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TYPES> Serialize for VidDisperseShare<TYPES>

where TYPES: NodeType,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<TYPES: Eq + NodeType> Eq for VidDisperseShare<TYPES>

impl<TYPES: NodeType> StructuralPartialEq for VidDisperseShare<TYPES>