Struct EpochChangeCondition

pub struct EpochChangeCondition {
    pub min_round_count: u64,
    pub max_round_count: u64,
    pub target_duration_millis: u64,
}

Fields

min_round_count: u64

A minimum number of rounds that must happen in an epoch. The timestamp will not drive the epoch progression until at least this number of rounds is reached (i.e. if an actual number of rounds after [duration_millis] is less than this value, the epoch change will wait until this value is reached).

max_round_count: u64

A maximum number of rounds that can happen in an epoch. If an actual number of rounds reaches this value before [duration_millis], then the timestamp no longer drives the epoch progression (i.e. the epoch change will happen right away, to prevent more than [max_round_count] rounds).

target_duration_millis: u64

An “ideal” duration of an epoch, which should be applied if the number of epochs is within the min_round_count..max_round_count range. Note: the range exists in order to limit the amount of damage that can be done by semi-byzantine purposeful clock drift attacks.

Implementations

impl EpochChangeCondition

pub fn should_epoch_change( &self, effective_start: i64, current_time: i64, round: Round, ) -> EpochChangeOutcome

Determines whether this condition is met by the given actual state. See the condition’s field definitions for exact rules.

Trait Implementations

impl Categorize<ManifestCustomValueKind> for EpochChangeCondition

fn value_kind() -> ValueKind<ManifestCustomValueKind>

impl Categorize<ScryptoCustomValueKind> for EpochChangeCondition

fn value_kind() -> ValueKind<ScryptoCustomValueKind>

impl Clone for EpochChangeCondition

fn clone(&self) -> EpochChangeCondition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EpochChangeCondition

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

Formats the value using the given formatter.

impl<D> Decode<ManifestCustomValueKind, D> for EpochChangeCondition

where D: Decoder<ManifestCustomValueKind>,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ManifestCustomValueKind>, ) -> Result<EpochChangeCondition, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<D> Decode<ScryptoCustomValueKind, D> for EpochChangeCondition

where D: Decoder<ScryptoCustomValueKind>,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<ScryptoCustomValueKind>, ) -> Result<EpochChangeCondition, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl Default for EpochChangeCondition

fn default() -> EpochChangeCondition

Returns the “default value” for a type.

impl Describe<ScryptoCustomTypeKind> for EpochChangeCondition

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<ScryptoCustomTypeKind, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<ScryptoCustomTypeKind>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E> Encode<ManifestCustomValueKind, E> for EpochChangeCondition

where E: Encoder<ManifestCustomValueKind>,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl<E> Encode<ScryptoCustomValueKind, E> for EpochChangeCondition

where E: Encoder<ScryptoCustomValueKind>,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl PartialEq for EpochChangeCondition

fn eq(&self, other: &EpochChangeCondition) -> 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 SborTuple<ManifestCustomValueKind> for EpochChangeCondition

fn get_length(&self) -> usize

impl SborTuple<ScryptoCustomValueKind> for EpochChangeCondition

fn get_length(&self) -> usize

impl Eq for EpochChangeCondition

impl StructuralPartialEq for EpochChangeCondition