Struct diem_sdk::types::waypoint::Waypoint

pub struct Waypoint { /* private fields */ }

Waypoint keeps information about the LedgerInfo on a given version, which provides an off-chain mechanism to verify the sync process right after the restart. At high level, a trusted waypoint verifies the LedgerInfo for a certain epoch change. For more information, please refer to the Waypoints documentation.

Implementations

impl Waypoint

pub fn new_any(ledger_info: &LedgerInfo) -> Waypoint

Generate a new waypoint given any LedgerInfo.

pub fn new_epoch_boundary(ledger_info: &LedgerInfo) -> Result<Waypoint, Error>

Generates a new waypoint given the epoch change LedgerInfo.

pub fn version(&self) -> u64

pub fn value(&self) -> HashValue

pub fn verify(&self, ledger_info: &LedgerInfo) -> Result<(), Error>

Errors in case the given ledger info does not match the waypoint.

Trait Implementations

impl Arbitrary for Waypoint

type Parameters = (<u64 as Arbitrary>::Parameters, <HashValue as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<(<u64 as Arbitrary>::Strategy, <HashValue as Arbitrary>::Strategy), fn(_: (u64, HashValue)) -> Waypoint>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( _top: <Waypoint as Arbitrary>::Parameters ) -> <Waypoint as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Waypoint

fn clone(&self) -> Waypoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Waypoint

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

Formats the value using the given formatter.

impl Default for Waypoint

fn default() -> Waypoint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Waypoint

fn deserialize<D>( deserializer: D ) -> Result<Waypoint, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Waypoint

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

Formats the value using the given formatter.

impl FromStr for Waypoint

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Waypoint, Error>

Parses a string s to return a value of this type.

impl PartialEq<Waypoint> for Waypoint

fn eq(&self, other: &Waypoint) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Waypoint

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl Verifier for Waypoint

fn verify(&self, ledger_info: &LedgerInfoWithSignatures) -> Result<(), Error>

Verify if the ledger_info is trust worthy.

fn epoch_change_verification_required(&self, _epoch: u64) -> bool

Returns true in case the given epoch is larger than the existing verifier can support. In this case the EpochChangeProof should be verified and the verifier updated.

fn is_ledger_info_stale(&self, ledger_info: &LedgerInfo) -> bool

Returns true if the given LedgerInfo is stale and probably in our trusted prefix.

impl Copy for Waypoint

impl Eq for Waypoint

impl StructuralEq for Waypoint

impl StructuralPartialEq for Waypoint