Enum hotshot_types::data::VidDisperse

pub enum VidDisperse<TYPES: NodeType> {
    V0(ADVZDisperse<TYPES>),
    V1(ADVZDisperse<TYPES>),
}

VID dispersal data

Like DaProposal.

TODO move to vid.rs?

Variants

V0(ADVZDisperse<TYPES>)

Disperse type for first VID version

V1(ADVZDisperse<TYPES>)

Place holder for VID upgrade

Implementations

impl<TYPES: NodeType> VidDisperse<TYPES>

pub async fn from_membership( view_number: TYPES::View, vid_disperse: JfVidDisperse<VidSchemeType>, membership: &Arc<RwLock<TYPES::Membership>>, target_epoch: Option<TYPES::Epoch>, data_epoch: Option<TYPES::Epoch>, data_epoch_payload_commitment: Option<VidCommitment>, ) -> Self

Create VID dispersal from a specified membership for the target epoch. Uses the specified function to calculate share dispersal Allows for more complex stake table functionality

pub async fn calculate_vid_disperse<V: Versions>( payload: &TYPES::BlockPayload, membership: &Arc<RwLock<TYPES::Membership>>, view: TYPES::View, target_epoch: Option<TYPES::Epoch>, data_epoch: Option<TYPES::Epoch>, _upgrade_lock: &UpgradeLock<TYPES, V>, ) -> Result<Self>

Calculate the vid disperse information from the payload given a view, epoch and membership, If the sender epoch is missing, it means it’s the same as the target epoch.

Errors

Returns an error if the disperse or commitment calculation fails

pub fn vid_common_ref(&self) -> &VidCommon

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

pub fn payload_commitment(&self) -> VidCommitment

Return the internal payload commitment TODO(Chengyu): rewrite this after VID upgrade

pub fn as_advz(self) -> ADVZDisperse<TYPES>

Unwrap self TODO(Chengyu): remove this after VID upgrade

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 VidDisperse<TYPES>

fn clone(&self) -> VidDisperse<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 VidDisperse<TYPES>

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

Formats the value using the given formatter.

impl<'de, TYPES> Deserialize<'de> for VidDisperse<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<ADVZDisperse<TYPES>> for VidDisperse<TYPES>

fn from(disperse: ADVZDisperse<TYPES>) -> Self

Converts to this type from the input type.

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

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

Returns Epoch

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

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

Returns the view number the type refers to.

impl<TYPES: Hash + NodeType> Hash for VidDisperse<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 VidDisperse<TYPES>

fn eq(&self, other: &VidDisperse<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 VidDisperse<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 VidDisperse<TYPES>

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