Struct jormungandr::blockchain::Ref

pub struct Ref {
    ledger: Ref<Ledger>,
    time_frame: Arc<TimeFrame>,
    epoch_leadership_schedule: Arc<Leadership>,
    epoch_rewards_info: Option<Arc<EpochRewardsInfo>>,
    header: Header,
    previous_epoch_state: Option<Arc<Ref>>,
}

a reference to a block in the blockchain

Fields

ledger: Ref<Ledger>

Reference holder for the object in the Multiverse<Ledger>.

time_frame: Arc<TimeFrame>

the time frame applicable in the current branch of the blockchain

epoch_leadership_schedule: Arc<Leadership>

the leadership used to validate the current header’s leader

this object will be shared between different Ref of the same epoch

epoch_rewards_info: Option<Arc<EpochRewardsInfo>>

If present, this is the rewards info distributed at the beginning of the epoch. Useful to follow up on the reward distribution history

header: Header

keep the Block header in memory, this will avoid retrieving the data from the storage if needs be

previous_epoch_state: Option<Arc<Ref>>

holder to the previous epoch state or more precisely the previous epoch’s last Ref. Every time there is a transition this value will be filled with the parent Ref. Otherwise it will be copied from Ref to Ref.

Implementations

impl Ref

pub fn new( ledger: Ref<Ledger>, time_frame: Arc<TimeFrame>, epoch_leadership_schedule: Arc<Leadership>, epoch_rewards_info: Option<Arc<EpochRewardsInfo>>, header: Header, previous_epoch_state: Option<Arc<Ref>> ) -> Self

create a new Ref

pub fn hash(&self) -> HeaderHash

retrieve the header hash of the Ref

pub fn block_parent_hash(&self) -> HeaderHash

access the reference’s parent hash

pub fn block_date(&self) -> BlockDate

retrieve the block date of the Ref

pub fn chain_length(&self) -> ChainLength

retrieve the chain length, the number of blocks created between the block0 and this block. This is useful to compare the density of 2 branches.

pub fn header(&self) -> &Header

access the Header of the block pointed by this Ref

pub fn ledger(&self) -> Arc<Ledger>

pub fn time_frame(&self) -> &Arc<TimeFrame>

get the time frame in application in the current branch of the blockchain

pub fn epoch_leadership_schedule(&self) -> &Arc<Leadership>

pub fn epoch_rewards_info(&self) -> Option<&Arc<EpochRewardsInfo>>

access the rewards info that were distributed at the end of the previous epoch (and that are accessible/visible from this epoch only).

pub fn last_ref_previous_epoch(&self) -> Option<&Arc<Ref>>

pub fn slot(&self) -> Slot

get the chain_time’s Slot. This allows to compute an accurate block time via a given time_frame or a precise block time

pub fn time(&self) -> SystemTime

retrieve the time of the associated block.

pub fn elapsed(&self) -> Result<Duration, SystemTimeError>

retrieve the time of the slot of the block. If the block is set in the future, this function will return an error.

pub fn active_vote_plans(&self) -> Vec<VotePlanStatus>

clone all active vote plans at this given state

this includes, votes to be voted on, on going votes, votes to be resolved and votes to result into a change on the ledger

Trait Implementations

impl Clone for Ref

fn clone(&self) -> Ref

Returns a copy of the value.

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

Performs copy-assignment from source.