Struct cfx_executor::state::State

pub struct State {
    pub cache: RwLock<HashMap<AddressWithSpace, AccountEntryWithWarm>>,
    pub committed_cache: HashMap<AddressWithSpace, AccountEntry>,
    /* private fields */
}

A caching and checkpoint layer built upon semantically meaningful database interfaces, providing interfaces and logics for managing accounts and global statistics to the execution engine.

Fields

cache: RwLock<HashMap<AddressWithSpace, AccountEntryWithWarm>>

Caches for the account entries

WARNING: Don’t delete cache entries outside of State::commit, unless you are familiar with checkpoint maintenance.

committed_cache: HashMap<AddressWithSpace, AccountEntry>

Implementations

impl State

pub fn new_contract_with_admin( &mut self, contract: &AddressWithSpace, admin: &Address, balance: U256, storage_layout: Option<StorageLayout>, cip107: bool ) -> DbResult<()>

pub fn remove_contract(&mut self, address: &AddressWithSpace) -> DbResult<()>

Kill a contract

pub fn genesis_special_remove_account( &mut self, address: &Address ) -> DbResult<()>

A special implementation to achieve the backward compatible for the genesis (incorrect) behaviour.

impl State

pub fn exists(&self, address: &AddressWithSpace) -> DbResult<bool>

pub fn touch(&self, address: &AddressWithSpace) -> DbResult<()>

Touch an account to mark it as warm

pub fn exists_and_not_null(&self, address: &AddressWithSpace) -> DbResult<bool>

pub fn balance(&self, address: &AddressWithSpace) -> DbResult<U256>

pub fn add_balance( &mut self, address: &AddressWithSpace, by: &U256 ) -> DbResult<()>

pub fn sub_balance( &mut self, address: &AddressWithSpace, by: &U256 ) -> DbResult<()>

pub fn transfer_balance( &mut self, from: &AddressWithSpace, to: &AddressWithSpace, by: &U256 ) -> DbResult<()>

pub fn nonce(&self, address: &AddressWithSpace) -> DbResult<U256>

pub fn inc_nonce(&mut self, address: &AddressWithSpace) -> DbResult<bool>

pub fn set_nonce( &mut self, address: &AddressWithSpace, nonce: &U256 ) -> DbResult<()>

pub fn is_contract_with_code( &self, address: &AddressWithSpace ) -> DbResult<bool>

pub fn is_eip684_empty(&self, address: &AddressWithSpace) -> DbResult<bool>

pub fn is_eip158_empty(&self, address: &AddressWithSpace) -> DbResult<bool>

pub fn code_hash(&self, address: &AddressWithSpace) -> DbResult<H256>

pub fn has_no_code(&self, address: &AddressWithSpace) -> DbResult<bool>

pub fn code_size(&self, address: &AddressWithSpace) -> DbResult<usize>

pub fn code_owner(&self, address: &AddressWithSpace) -> DbResult<Address>

pub fn code(&self, address: &AddressWithSpace) -> DbResult<Option<Arc<Vec<u8>>>>

pub fn code_with_hash_on_call( &self, address: &AddressWithSpace ) -> DbResult<(Option<Arc<Vec<u8>>>, H256)>

pub fn init_code( &mut self, address: &AddressWithSpace, code: Bytes, owner: Address, transaction_hash: H256 ) -> DbResult<()>

pub fn created_at_transaction( &self, address: &AddressWithSpace, transaction_hash: H256 ) -> DbResult<bool>

pub fn set_authorization( &mut self, authority: &AddressWithSpace, address: &Address ) -> DbResult<()>

pub fn admin(&self, address: &Address) -> DbResult<Address>

pub fn set_admin( &mut self, contract_address: &Address, admin: &Address ) -> DbResult<()>

impl State

pub fn write_account_lock( &self, address: &AddressWithSpace ) -> DbResult<MappedRwLockWriteGuard<'_, OverlayAccount>>

A convenience function of write_account_ext_lock

impl State

pub fn no_checkpoint(&self) -> bool

impl State

pub fn collateral_for_storage(&self, address: &Address) -> DbResult<U256>

pub fn token_collateral_for_storage(&self, address: &Address) -> DbResult<U256>

pub fn available_storage_points_for_collateral( &self, address: &Address ) -> DbResult<U256>

pub fn add_collateral_for_storage( &mut self, address: &Address, by: &U256 ) -> DbResult<U256>

Caller should make sure that staking_balance for this account is sufficient enough.

pub fn sub_collateral_for_storage( &mut self, address: &Address, by: &U256 ) -> DbResult<U256>

pub fn check_storage_limit( &self, original_sender: &Address, storage_limit: &U256, dry_run: bool ) -> DbResult<Result<(), CollateralCheckError>>

pub fn storage_point_prop(&self) -> DbResult<U256>

impl State

pub fn commit( self, epoch_id: EpochId, debug_record: Option<&mut ComputeEpochDebugRecord> ) -> DbResult<StateCommitResult>

Commit everything to the storage.

pub fn compute_state_root_for_genesis( &mut self, debug_record: Option<&mut ComputeEpochDebugRecord> ) -> DbResult<StateRootWithAuxInfo>

Commit to the statedb and compute state root. Only called in the genesis

pub fn apply_changes_to_statedb( &mut self, debug_record: Option<&mut ComputeEpochDebugRecord> ) -> DbResult<Vec<Account>>

Apply changes for the accounts and global variables to the statedb.

impl State

pub fn commit_cache(&mut self, retain_transient_storage: bool)

impl State

pub fn total_issued_tokens(&self) -> U256

pub fn add_total_issued(&mut self, v: U256)

Maintain total_issued_tokens.

pub fn sub_total_issued(&mut self, v: U256)

Maintain total_issued_tokens. This is only used in the extremely unlikely case that there are a lot of partial invalid blocks.

pub fn add_total_pos_staking(&mut self, v: U256)

pub fn add_total_evm_tokens(&mut self, v: U256)

pub fn sub_total_evm_tokens(&mut self, v: U256)

pub fn total_staking_tokens(&self) -> U256

pub fn total_storage_tokens(&self) -> U256

pub fn total_espace_tokens(&self) -> U256

pub fn used_storage_points(&self) -> U256

pub fn converted_storage_points(&self) -> U256

pub fn total_pos_staking_tokens(&self) -> U256

pub fn sub_total_pos_staking(&mut self, v: U256)

pub fn total_circulating_tokens(&self) -> DbResult<U256>

pub fn add_converted_storage_point( &mut self, from_balance: U256, from_collateral: U256 )

impl State

pub fn is_warm_account(&self, address: &AddressWithSpace) -> bool

pub fn is_warm_storage_entry( &self, address: &AddressWithSpace, key: &H256 ) -> DbResult<bool>

pub fn set_tx_access_list( &mut self, space: Space, access_list: &[AccessListItem] )

pub fn touch_tx_addresses(&self, params: &ActionParams) -> DbResult<()>

pub fn clear_tx_access_list(&mut self)

pub fn update_state_post_tx_execution(&mut self, retain_transient_storage: bool)

impl State

pub fn inc_distributable_pos_interest( &mut self, current_block_number: u64 ) -> DbResult<()>

pub fn pos_locked_staking(&self, address: &Address) -> DbResult<U256>

pub fn add_pos_interest( &mut self, address: &Address, interest: &U256 ) -> DbResult<()>

impl State

pub fn save(&mut self) -> SavedState

pub fn restore(&mut self, saved: SavedState)

impl State

pub fn sponsor_info(&self, address: &Address) -> DbResult<Option<SponsorInfo>>

pub fn sponsor_for_gas(&self, address: &Address) -> DbResult<Option<Address>>

pub fn set_sponsor_for_gas( &self, address: &Address, sponsor: &Address, sponsor_balance: &U256, upper_bound: &U256 ) -> DbResult<()>

pub fn sponsor_balance_for_gas(&self, address: &Address) -> DbResult<U256>

pub fn add_sponsor_balance_for_gas( &mut self, address: &Address, by: &U256 ) -> DbResult<()>

pub fn sub_sponsor_balance_for_gas( &mut self, address: &Address, by: &U256 ) -> DbResult<()>

pub fn sponsor_gas_bound(&self, address: &Address) -> DbResult<U256>

pub fn sponsor_for_collateral( &self, address: &Address ) -> DbResult<Option<Address>>

pub fn set_sponsor_for_collateral( &mut self, address: &Address, sponsor: &Address, sponsor_balance: &U256, is_cip107: bool ) -> DbResult<U256>

pub fn sponsor_balance_for_collateral( &self, address: &Address ) -> DbResult<U256>

pub fn add_sponsor_balance_for_collateral( &mut self, address: &Address, by: &U256 ) -> DbResult<()>

pub fn sub_sponsor_balance_for_collateral( &mut self, address: &Address, by: &U256 ) -> DbResult<()>

pub fn check_contract_whitelist( &self, contract_address: &Address, user: &Address ) -> DbResult<bool>

pub fn add_to_contract_whitelist( &mut self, contract_address: Address, storage_owner: Address, user: Address, substate: &mut Substate ) -> DbResult<()>

pub fn remove_from_contract_whitelist( &mut self, contract_address: Address, storage_owner: Address, user: Address, substate: &mut Substate ) -> DbResult<()>

pub fn record_storage_and_whitelist_entries_release( &mut self, address: &Address, substate: &mut Substate, cip131: bool ) -> DbResult<()>

impl State

pub fn staking_balance(&self, address: &Address) -> DbResult<U256>

pub fn withdrawable_staking_balance( &self, address: &Address, current_block_number: u64 ) -> DbResult<U256>

pub fn locked_staking_balance_at_block_number( &self, address: &Address, block_number: u64 ) -> DbResult<U256>

pub fn vote_stake_list_length(&self, address: &Address) -> DbResult<usize>

pub fn vote_lock( &mut self, address: &Address, amount: &U256, unlock_block_number: u64 ) -> DbResult<()>

pub fn remove_expired_vote_stake_info( &mut self, address: &Address, current_block_number: u64 ) -> DbResult<()>

pub fn deposit_list_length(&self, address: &Address) -> DbResult<usize>

pub fn deposit( &mut self, address: &Address, amount: &U256, current_block_number: u64, cip_97: bool ) -> DbResult<()>

pub fn withdraw( &mut self, address: &Address, amount: &U256, cip_97: bool ) -> DbResult<U256>

impl State

pub fn get_system_storage(&self, key: &[u8]) -> DbResult<U256>

pub fn set_system_storage(&mut self, key: Vec<u8>, value: U256) -> DbResult<()>

pub fn set_eip2935_storage( &mut self, block_height: u64, block_hash: H256 ) -> DbResult<()>

pub fn storage_at( &self, address: &AddressWithSpace, key: &[u8] ) -> DbResult<U256>

pub fn origin_storage_at( &self, address: &AddressWithSpace, key: &[u8] ) -> DbResult<Option<U256>>

pub fn transient_storage_at( &self, address: &AddressWithSpace, key: &[u8] ) -> DbResult<U256>

pub fn storage_entry_at( &self, address: &AddressWithSpace, key: &[u8] ) -> DbResult<StorageValue>

pub fn set_storage( &mut self, address: &AddressWithSpace, key: Vec<u8>, value: U256, owner: Address, substate: &mut Substate ) -> DbResult<()>

pub fn transient_set_storage( &mut self, address: &AddressWithSpace, key: Vec<u8>, value: U256 ) -> DbResult<()>

pub fn is_fresh_storage(&self, address: &AddressWithSpace) -> DbResult<bool>

impl State

pub fn bump_block_number_accumulate_interest(&mut self)

Calculate the secondary reward for the next block number.

pub fn secondary_reward(&self) -> U256

pub fn pow_base_reward(&self) -> U256

pub fn distributable_pos_interest(&self) -> U256

pub fn last_distribute_block(&self) -> u64

pub fn reset_pos_distribute_info(&mut self, current_block_number: u64)

pub fn burn_by_cip1559(&mut self, by: U256)

pub fn get_base_price_prop(&self) -> U256

pub fn set_base_fee_prop(&mut self, val: U256)

pub fn burnt_gas_price(&self, base_price: U256) -> U256

impl State

Apply the state override to the state object, only used for rpc call eg eth_call, eth_estimateGas etc.

pub fn new_with_override( db: StateDb, state_override: &StateOverride, space: Space ) -> DbResult<Self>

impl State

pub fn new(db: StateDb) -> DbResult<Self>

pub fn prefetch_accounts( &mut self, addresses: BTreeSet<AddressWithSpace>, pool: &ThreadPool ) -> DbResult<()>