Struct hotshot_types::message::UpgradeLock

pub struct UpgradeLock<TYPES: NodeType, V: Versions> {
    pub decided_upgrade_certificate: Arc<RwLock<Option<UpgradeCertificate<TYPES>>>>,
    pub _pd: PhantomData<V>,
}

A lock for an upgrade certificate decided by HotShot, which doubles as PhantomData for an instance of the Versions trait.

Fields

decided_upgrade_certificate: Arc<RwLock<Option<UpgradeCertificate<TYPES>>>>

a shared lock to an upgrade certificate decided by consensus

_pd: PhantomData<V>

phantom data for the Versions trait

Implementations

impl<TYPES: NodeType, V: Versions> UpgradeLock<TYPES, V>

pub fn new() -> Self

Create a new UpgradeLock for a fresh instance of HotShot

pub fn from_certificate(certificate: &Option<UpgradeCertificate<TYPES>>) -> Self

Create a new UpgradeLock from an optional upgrade certificate

pub async fn version(&self, view: TYPES::View) -> Result<Version>

Calculate the version applied in a view, based on the provided upgrade lock.

Errors

Returns an error if we do not support the version required by the decided upgrade certificate.

pub async fn version_infallible(&self, view: TYPES::View) -> Version

Calculate the version applied in a view, based on the provided upgrade lock.

This function does not fail, since it does not check that the version is supported.

pub async fn serialize<M: HasViewNumber<TYPES> + Serialize>( &self, message: &M, ) -> Result<Vec<u8>>

Serialize a message with a version number, using message.view_number() and an optional decided upgrade certificate to determine the message’s version.

Errors

Errors if serialization fails.

pub async fn deserialize<M: HasViewNumber<TYPES> + for<'a> Deserialize<'a>>( &self, message: &[u8], ) -> Result<M>

Deserialize a message with a version number, using message.view_number() to determine the message’s version. This function will fail on improperly versioned messages.

Errors

Errors if deserialization fails.

Trait Implementations

impl<TYPES: Clone + NodeType, V: Clone + Versions> Clone for UpgradeLock<TYPES, V>

fn clone(&self) -> UpgradeLock<TYPES, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TYPES: Debug + NodeType, V: Debug + Versions> Debug for UpgradeLock<TYPES, V>

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

Formats the value using the given formatter.