Struct ProtocolUpgrader

pub struct ProtocolUpgrader<S>
where
    S: StateProvider,
{ /* private fields */ }

The system upgrader deals with conducting an actual protocol upgrade.

Implementations

impl<S> ProtocolUpgrader<S>

where S: StateProvider,

pub fn new( config: ProtocolUpgradeConfig, protocol_upgrade_config_hash: Digest, tracking_copy: TrackingCopy<<S as StateProvider>::Reader>, ) -> Self

Creates new system upgrader instance.

pub fn upgrade( self, pre_state_hash: Digest, ) -> Result<TrackingCopy<<S as StateProvider>::Reader>, ProtocolUpgradeError>

Apply a protocol upgrade.

pub fn check_next_protocol_version_validity( &self, ) -> Result<(), ProtocolUpgradeError>

Determine if the next protocol version is a legitimate semver progression.

pub fn handle_system_hashes( &mut self, ) -> Result<SystemHashAddresses, ProtocolUpgradeError>

Handle system entities.

pub fn migrate_or_refresh_system_entities( &mut self, system_entity_addresses: &SystemHashAddresses, ) -> Result<(), ProtocolUpgradeError>

Bump major version and/or update the entry points for system contracts.

pub fn refresh_system_contracts( &mut self, system_entity_addresses: &SystemHashAddresses, ) -> Result<(), ProtocolUpgradeError>

Bump major version and/or update the entry points for system contracts.

pub fn migrate_system_account( &mut self, pre_state_hash: Digest, ) -> Result<(), ProtocolUpgradeError>

Migrate the system account to addressable entity if necessary.

pub fn create_accumulation_purse_if_required( &mut self, handle_payment_hash: &HashAddr, fee_handling: FeeHandling, ) -> Result<(), ProtocolUpgradeError>

Creates an accumulation purse in the handle payment system contract if its not present.

This can happen on older networks that did not have support for FeeHandling::Accumulate at the genesis. In such cases we have to check the state of handle payment contract and create an accumulation purse.

pub fn create_accumulation_purse_if_required_by_contract( &mut self, handle_payment_hash: &HashAddr, fee_handling: FeeHandling, ) -> Result<(), ProtocolUpgradeError>

Creates an accumulation purse in the handle payment system contract if its not present.

This can happen on older networks that did not have support for FeeHandling::Accumulate at the genesis. In such cases we have to check the state of handle payment contract and create an accumulation purse.

pub fn handle_payment_purse_check( &mut self, handle_payment: HashAddr, mint: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Check payment purse balance.

pub fn handle_new_gas_hold_config( &mut self, mint: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Upsert gas hold interval to mint named keys.

pub fn handle_new_validator_slots( &mut self, auction: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Handle new validator slots.

pub fn handle_new_auction_delay( &mut self, auction: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Applies the necessary changes if a new auction delay is part of the upgrade.

pub fn handle_new_locked_funds_period_millis( &mut self, auction: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Applies the necessary changes if a new locked funds period is part of the upgrade.

pub fn handle_new_unbonding_delay( &mut self, auction: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Applies the necessary changes if a new unbonding delay is part of the upgrade.

pub fn handle_new_round_seigniorage_rate( &mut self, mint: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Applies the necessary changes if a new round seigniorage rate is part of the upgrade.

pub fn handle_unbonds_migration(&mut self) -> Result<(), ProtocolUpgradeError>

Handle unbonds migration.

pub fn handle_bids_migration( &mut self, validator_minimum: u64, delegation_minimum: u64, delegation_maximum: u64, ) -> Result<(), ProtocolUpgradeError>

Handle bids migration.

pub fn handle_era_info_migration(&mut self) -> Result<(), ProtocolUpgradeError>

Handle era info migration.

pub fn handle_seignorage_snapshot_migration( &mut self, auction: HashAddr, ) -> Result<(), ProtocolUpgradeError>

Handle seignorage snapshot migration to new version.

pub fn handle_global_state_updates(&mut self)

Handle global state updates.