Struct BlockchainConfigParams

pub struct BlockchainConfigParams(/* private fields */);

A non-empty dictionary with blockchain config params.

Implementations

impl BlockchainConfigParams

pub fn from_raw(dict_root: Cell) -> Self

Creates a dictionary from a raw cell.

NOTE: Root is mandatory since the configs dictionary can’t be empty.

pub fn get_elector_address(&self) -> Result<HashBytes, Error>

Returns the elector account address (in masterchain).

Uses ConfigParam1.

pub fn set_elector_address( &mut self, address: &HashBytes, ) -> Result<bool, Error>

Updates the elector account address (in masterchain).

Uses ConfigParam1.

pub fn get_minter_address(&self) -> Result<HashBytes, Error>

Returns the minter account address (in masterchain).

Uses ConfigParam2 with a fallback to ConfigParam0 (config).

pub fn set_minter_address(&mut self, address: &HashBytes) -> Result<bool, Error>

Updates the minter account address (in masterchain).

Uses ConfigParam2.

pub fn get_burning_config(&self) -> Result<BurningConfig, Error>

Returns the burning config.

Uses ConfigParam5.

pub fn set_burning_config( &mut self, config: &BurningConfig, ) -> Result<bool, Error>

Updates the burning config.

Uses ConfigParam5.

pub fn get_fee_collector_address(&self) -> Result<HashBytes, Error>

Returns the fee collector account address (in masterchain).

Uses ConfigParam3 with a fallback to ConfigParam1 (elector).

pub fn set_fee_collector_address( &mut self, address: &HashBytes, ) -> Result<bool, Error>

Updates the fee collector address (in masterchain).

Uses ConfigParam3.

pub fn get_global_version(&self) -> Result<GlobalVersion, Error>

Returns the lowest supported block version and required capabilities.

Uses ConfigParam8.

pub fn set_global_version( &mut self, version: &GlobalVersion, ) -> Result<bool, Error>

Updates the global version.

Uses ConfigParam8.

pub fn get_mandatory_params(&self) -> Result<Dict<u32, ()>, Error>

Returns a list of params that must be present in config.

Uses ConfigParam9.

pub fn set_mandatory_params(&mut self, params: &[u32]) -> Result<bool, Error>

Updates a list of params that must be present in config.

Uses ConfigParam9.

pub fn get_critical_params(&self) -> Result<Dict<u32, ()>, Error>

Returns a list of params that have a different set of update requirements.

Uses ConfigParam10.

pub fn set_critical_params(&mut self, params: &[u32]) -> Result<bool, Error>

Updates a list of params that have a different set of update requirements.

Uses ConfigParam10.

pub fn get_workchains(&self) -> Result<Dict<i32, WorkchainDescription>, Error>

Returns a dictionary with workchain descriptions.

Uses ConfigParam12.

pub fn set_workchains( &mut self, workchains: &Dict<i32, WorkchainDescription>, ) -> Result<bool, Error>

Updates a list of workchain descriptions.

Uses ConfigParam12.

pub fn get_block_creation_reward( &self, masterchain: bool, ) -> Result<Tokens, Error>

Returns a block creation reward for the specified workchain in tokens.

Uses ConfigParam14.

pub fn get_block_creation_rewards(&self) -> Result<BlockCreationRewards, Error>

Returns a block creation rewards in tokens.

Uses ConfigParam14.

pub fn set_block_creation_rewards( &mut self, rewards: &BlockCreationRewards, ) -> Result<bool, Error>

Updates a block creation rewards in tokens.

Uses ConfigParam14.

pub fn get_election_timings(&self) -> Result<ElectionTimings, Error>

Returns election timings.

Uses ConfigParam15.

pub fn set_election_timings( &mut self, timings: &ElectionTimings, ) -> Result<bool, Error>

Updates election timings.

Uses ConfigParam15.

pub fn get_validator_count_params(&self) -> Result<ValidatorCountParams, Error>

Returns possible validator count.

Uses ConfigParam16.

pub fn set_validator_count_params( &mut self, params: &ValidatorCountParams, ) -> Result<bool, Error>

Updates possible validator count.

Uses ConfigParam16.

pub fn get_validator_stake_params(&self) -> Result<ValidatorStakeParams, Error>

Returns validator stake range and factor.

Uses ConfigParam17.

pub fn set_validator_stake_params( &mut self, params: &ValidatorStakeParams, ) -> Result<bool, Error>

Updates validator stake range and factor.

Uses ConfigParam17.

pub fn get_storage_prices(&self) -> Result<Dict<u32, StoragePrices>, Error>

Returns a list with a history of all storage prices.

Uses ConfigParam18.

pub fn set_storage_prices( &mut self, prices: &[StoragePrices], ) -> Result<bool, Error>

Updates a list with a history of all storage prices.

Uses ConfigParam18.

pub fn get_global_id(&self) -> Result<i32, Error>

Returns a global id.

pub fn set_global_id(&mut self, global_id: i32) -> Result<bool, Error>

Updates a global id.

pub fn get_gas_prices( &self, masterchain: bool, ) -> Result<GasLimitsPrices, Error>

Returns gas limits and prices.

Uses ConfigParam20 (for masterchain) or ConfigParam21 (for other workchains).

pub fn set_gas_prices( &mut self, masterchain: bool, prices: &GasLimitsPrices, ) -> Result<bool, Error>

Updates gas limits and prices.

Uses ConfigParam20 (for masterchain) or ConfigParam21 (for other workchains).

pub fn get_block_limits(&self, masterchain: bool) -> Result<BlockLimits, Error>

Returns block limits.

Uses ConfigParam22 (for masterchain) or ConfigParam23 (for other workchains).

pub fn set_block_limits( &mut self, masterchain: bool, limits: &BlockLimits, ) -> Result<bool, Error>

Updates block limits.

Uses ConfigParam22 (for masterchain) or ConfigParam23 (for other workchains).

pub fn get_msg_forward_prices( &self, masterchain: bool, ) -> Result<MsgForwardPrices, Error>

Returns message forwarding prices.

Uses ConfigParam24 (for masterchain) or ConfigParam25 (for other workchains).

pub fn set_msg_forward_prices( &mut self, masterchain: bool, prices: &MsgForwardPrices, ) -> Result<bool, Error>

Updates message forwarding prices.

Uses ConfigParam24 (for masterchain) or ConfigParam25 (for other workchains).

pub fn get_catchain_config(&self) -> Result<CatchainConfig, Error>

Returns a catchain config.

Uses ConfigParam28.

pub fn set_catchain_config( &mut self, config: &CatchainConfig, ) -> Result<bool, Error>

Updates a catchain config.

Uses ConfigParam28.

pub fn get_consensus_config(&self) -> Result<ConsensusConfig, Error>

Returns a consensus config.

Uses ConfigParam29.

pub fn set_consensus_config( &mut self, config: &ConsensusConfig, ) -> Result<bool, Error>

Updates a consensus config.

Uses ConfigParam29.

pub fn get_fundamental_addresses(&self) -> Result<Dict<HashBytes, ()>, Error>

Returns a list of fundamental account addresses (in masterchain).

Uses ConfigParam31.

pub fn set_fundamental_addresses( &mut self, addresses: &[HashBytes], ) -> Result<bool, Error>

Updates a list of fundamental account addresses (in masterchain).

Uses ConfigParam31.

pub fn contains_prev_validator_set(&self) -> Result<bool, Error>

Returns true if the config contains info about the previous validator set.

Uses ConfigParam32 or ConfigParam33.

pub fn contains_next_validator_set(&self) -> Result<bool, Error>

Returns true if the config contains info about the next validator set.

Uses ConfigParam36 or ConfigParam37.

pub fn get_previous_validator_set(&self) -> Result<Option<ValidatorSet>, Error>

Returns the previous validator set.

Uses ConfigParam33 (temp prev validators) or ConfigParam32 (prev validators).

pub fn get_current_validator_set(&self) -> Result<ValidatorSet, Error>

Returns the current validator set.

Uses ConfigParam35 (temp validators) or ConfigParam34 (current validators).

pub fn get_next_validator_set(&self) -> Result<Option<ValidatorSet>, Error>

Returns the next validator set.

Uses ConfigParam37 (temp next validators) or ConfigParam36 (next validators).

pub fn get_size_limits(&self) -> Result<SizeLimitsConfig, Error>

Returns size limits.

pub fn set_size_limits( &mut self, size_limits: &SizeLimitsConfig, ) -> Result<bool, Error>

Updates a global id.

pub fn contains<'a, T: KnownConfigParam<'a>>(&'a self) -> Result<bool, Error>

Returns true if the config contains a param for the specified id.

pub fn contains_raw(&self, id: u32) -> Result<bool, Error>

Returns true if the config contains a param for the specified id.

pub fn get<'a, T: KnownConfigParam<'a>>( &'a self, ) -> Result<Option<T::Value>, Error>

Tries to get a parameter from the blockchain config.

pub fn set<'a, T: KnownConfigParam<'a>>( &'a mut self, value: &T::Value, ) -> Result<bool, Error>

Tries to update a parameter in the blockchain config.

pub fn get_raw(&self, id: u32) -> Result<Option<CellSlice<'_>>, Error>

Tries to get a raw parameter from the blockchain config (as slice).

pub fn get_raw_cell(&self, id: u32) -> Result<Option<Cell>, Error>

Tries to get a raw parameter from the blockchain config (as cell).

pub fn get_raw_cell_ref(&self, id: u32) -> Result<Option<&DynCell>, Error>

Tries to get a raw parameter from the blockchain config (as cell ref).

pub fn set_raw(&mut self, id: u32, value: Cell) -> Result<bool, Error>

Tries to set a parameter in the blockchain config.

NOTE: Use with caution, as it doesn’t check the value structure.

pub fn remove(&mut self, id: u32) -> Result<Option<Cell>, Error>

Removes a parameter from the blockchain config.

NOTE: Removing a zero parameter successfully does nothing and returns None as it is required and externaly managed.

pub fn as_dict(&self) -> &Dict<u32, Cell>

Returns a reference to the underlying dictionary.

Trait Implementations

impl Clone for BlockchainConfigParams

fn clone(&self) -> BlockchainConfigParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockchainConfigParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlockchainConfigParams

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> Load<'a> for BlockchainConfigParams

fn load_from(slice: &mut CellSlice<'a>) -> Result<Self, Error>

Tries to load itself from a cell slice.

impl PartialEq for BlockchainConfigParams

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

Tests for self and other values to be equal, and is used by ==.

const 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 Serialize for BlockchainConfigParams

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Store for BlockchainConfigParams

fn store_into( &self, builder: &mut CellBuilder, _: &dyn CellContext, ) -> Result<(), Error>

Tries to store itself into the cell builder.

impl Eq for BlockchainConfigParams

impl StructuralPartialEq for BlockchainConfigParams