Struct massa_final_state::final_state::FinalState

pub struct FinalState {
    pub(crate) config: FinalStateConfig,
    pub ledger: Box<dyn LedgerController>,
    pub async_pool: AsyncPool,
    pub deferred_call_registry: DeferredCallRegistry,
    pub pos_state: PoSFinalState,
    pub executed_ops: ExecutedOps,
    pub executed_denunciations: ExecutedDenunciations,
    pub mip_store: MipStore,
    pub last_start_period: u64,
    pub last_slot_before_downtime: Option<Slot>,
    pub db: ShareableMassaDBController,
}

Represents a final state (ledger, async pool, executed_ops, executed_de and the state of the PoS)

Fields

config: FinalStateConfig

execution state configuration

ledger: Box<dyn LedgerController>

final ledger associating addresses to their balance, executable bytecode and data

async_pool: AsyncPool

asynchronous pool containing messages sorted by priority and their data

deferred_call_registry: DeferredCallRegistry

deferred calls

pos_state: PoSFinalState

proof of stake state containing cycle history and deferred credits

executed_ops: ExecutedOps

executed operations

executed_denunciations: ExecutedDenunciations

executed denunciations

mip_store: MipStore

MIP store

last_start_period: u64

last_start_period

• If start new network: set to 0
• If from snapshot: retrieve from args
• If from bootstrap: set during bootstrap

last_slot_before_downtime: Option<Slot>

last_slot_before_downtime

• None if start new network
• If from snapshot: retrieve from the slot attached to the snapshot
• If from bootstrap: set during bootstrap

db: ShareableMassaDBController

the RocksDB instance used to write every final_state struct on disk

Implementations

impl FinalState

pub fn new( db: ShareableMassaDBController, config: FinalStateConfig, ledger: Box<dyn LedgerController>, selector: Box<dyn SelectorController>, mip_store: MipStore, reset_final_state: bool ) -> Result<Self, FinalStateError>

Initializes a new FinalState

Arguments

• config: the configuration of the final state to use for initialization
• ledger: the instance of the ledger on disk. Used to apply changes to the ledger.
• selector: the pos selector. Used to send draw inputs when a new cycle is completed.
• reset_final_state: if true, we only keep the ledger, and we reset the other fields of the final state

fn interpolate_downtime(&mut self) -> Result<(), FinalStateError>

Once we created a FinalState from a snapshot, we need to edit it to attach at the end_slot and handle the downtime. This basically recreates the history of the final_state, without executing the slots.

fn interpolate_single_cycle( &mut self, current_slot: Slot, end_slot: Slot ) -> Result<(), FinalStateError>

This helper function is to be called if the downtime does not span over multiple cycles

fn interpolate_multiple_cycles( &mut self, current_slot: Slot, end_slot: Slot, current_slot_cycle: u64, end_slot_cycle: u64 ) -> Result<(), FinalStateError>

This helper function is to be called if the downtime spans over multiple cycles

fn feed_cycle_hash_and_selector_for_interpolation( &mut self, cycle: u64 ) -> Result<(), FinalStateError>

Used during interpolation, when a new cycle is set as completed

fn _finalize(&mut self, slot: Slot, changes: StateChanges) -> AnyResult<()>

fn _is_db_valid(&self) -> AnyResult<()>

Internal function called by is_db_valid

pub fn new_derived_from_snapshot( db: ShareableMassaDBController, config: FinalStateConfig, ledger: Box<dyn LedgerController>, selector: Box<dyn SelectorController>, mip_store: MipStore, last_start_period: u64 ) -> Result<Self, FinalStateError>

Initializes a FinalState from a snapshot.

Arguments

• db: A type that implements the MassaDBController trait. Used to read and write to the database.
• config: the configuration of the final state to use for initialization
• ledger: the instance of the ledger on disk. Used to apply changes to the ledger.
• selector: the pos selector. Used to send draw inputs when a new cycle is completed.
• last_start_period: at what period we should attach the final_state

Trait Implementations

impl FinalStateController for FinalState

fn compute_initial_draws(&mut self) -> Result<(), FinalStateError>

Performs the initial draws.

fn finalize(&mut self, slot: Slot, changes: StateChanges)

Applies changes to the execution state at a given slot, and settles that slot forever. Once this is called, the state is attached at the output of the provided slot.

fn get_execution_trail_hash(&self) -> Hash

Gets the hash of the execution trail

fn get_fingerprint(&self) -> Hash

Get the fingerprint (hash) of the final state. Note that only one atomic write per final slot occurs, so this can be safely queried at any time.

fn get_slot(&self) -> Slot

Get the slot at the end of which the final state is attached

fn init_execution_trail_hash_to_batch(&mut self, batch: &mut DBBatch)

Initialize the execution trail hash to zero.

fn is_db_valid(&self) -> bool

Deserialize the entire DB and check the data. Useful to check after bootstrap.

fn recompute_caches(&mut self)

After bootstrap or load from disk, recompute all the caches.

fn reset(&mut self)

Reset the final state to the initial state.

fn get_ledger(&self) -> &Box<dyn LedgerController>

Get ledger

fn get_ledger_mut(&mut self) -> &mut Box<dyn LedgerController>

Get ledger mut

fn get_async_pool(&self) -> &AsyncPool

Get async pool

fn get_pos_state(&self) -> &PoSFinalState

Get pos state

fn get_pos_state_mut(&mut self) -> &mut PoSFinalState

Get pos state mut

fn executed_ops_contains(&self, op_id: &OperationId) -> bool

check if an operation is in the executed ops

fn get_ops_exec_status(&self, batch: &[OperationId]) -> Vec<Option<bool>>

Get the executed status ops

fn get_executed_denunciations(&self) -> &ExecutedDenunciations

Get executed denunciations

fn get_database(&self) -> &ShareableMassaDBController

Get the database

fn get_last_start_period(&self) -> u64

Get last start period

fn set_last_start_period(&mut self, last_start_period: u64)

Set last start period

fn get_last_slot_before_downtime(&self) -> &Option<Slot>

Get last slot before downtime

fn set_last_slot_before_downtime( &mut self, last_slot_before_downtime: Option<Slot> )

Set last slot before downtime

fn get_mip_store_mut(&mut self) -> &mut MipStore

Get mutable reference to MIP Store

fn get_mip_store(&self) -> &MipStore

Get MIP Store

fn get_deferred_call_registry(&self) -> &DeferredCallRegistry

Get deferred call registry