Struct solana_runtime::bank::Bank

pub struct Bank {

    pub rc: BankRc,
    pub src: StatusCacheRc,
    pub ancestors: Ancestors,
    pub ns_per_slot: u128,
    pub last_vote_sync: AtomicU64,
    pub rewards: RwLock<Vec<(Pubkey, RewardInfo)>>,
    pub skip_drop: AtomicBool,
    pub cluster_type: Option<ClusterType>,
    pub lazy_rent_collection: AtomicBool,
    pub no_stake_rewrite: AtomicBool,
    pub rewards_pool_pubkeys: Arc<HashSet<Pubkey>>,
    pub transaction_log_collector_config: Arc<RwLock<TransactionLogCollectorConfig>>,
    pub transaction_log_collector: Arc<RwLock<TransactionLogCollector>>,
    pub feature_set: Arc<FeatureSet>,
    pub drop_callback: RwLock<OptionalDropCallback>,
    pub freeze_started: AtomicBool,
    // some fields omitted
}

Manager for the state of all accounts and programs after processing its entries. AbiExample is needed even without Serialize/Deserialize; actual (de-)serialization are implemented elsewhere for versioning

Fields

rc: BankRc

References to accounts, parent and signature status

src: StatusCacheRc

ancestors: Ancestors

The set of parents including this bank

ns_per_slot: u128

length of a slot in ns

last_vote_sync: AtomicU64

Last time when the cluster info vote listener has synced with this bank

rewards: RwLock<Vec<(Pubkey, RewardInfo)>>

Protocol-level rewards that were distributed by this bank

skip_drop: AtomicBool

cluster_type: Option<ClusterType>

lazy_rent_collection: AtomicBool

no_stake_rewrite: AtomicBool

rewards_pool_pubkeys: Arc<HashSet<Pubkey>>

transaction_log_collector_config: Arc<RwLock<TransactionLogCollectorConfig>>

transaction_log_collector: Arc<RwLock<TransactionLogCollector>>

feature_set: Arc<FeatureSet>

drop_callback: RwLock<OptionalDropCallback>

freeze_started: AtomicBool

Implementations

impl Bank

pub fn new(genesis_config: &GenesisConfig) -> Self

pub fn new_no_wallclock_throttle(genesis_config: &GenesisConfig) -> Self

pub fn new_with_paths(
    genesis_config: &GenesisConfig,
    paths: Vec<PathBuf>,
    frozen_account_pubkeys: &[Pubkey],
    debug_keys: Option<Arc<HashSet<Pubkey>>>,
    additional_builtins: Option<&Builtins>,
    account_indexes: AccountSecondaryIndexes,
    accounts_db_caching_enabled: bool
) -> Self

pub fn new_from_parent(
    parent: &Arc<Bank>,
    collector_id: &Pubkey,
    slot: Slot
) -> Self

Create a new bank that points to an immutable checkpoint of another bank.

pub fn new_from_parent_with_tracer(
    parent: &Arc<Bank>,
    collector_id: &Pubkey,
    slot: Slot,
    reward_calc_tracer: impl FnMut(&RewardCalculationEvent<'_, '_>)
) -> Self

pub fn set_callback(
    &self,
    callback: Option<Box<dyn DropCallback + Send + Sync>>
)

pub fn warp_from_parent(
    parent: &Arc<Bank>,
    collector_id: &Pubkey,
    slot: Slot
) -> Self

Like new_from_parent but additionally:

• Doesn’t assume that the parent is anywhere near slot, parent could be millions of slots in the past
• Adjusts the new bank’s tick height to avoid having to run PoH for millions of slots
• Freezes the new bank, assuming that the user will Bank::new_from_parent from this bank

pub fn collector_id(&self) -> &Pubkey

pub fn slot(&self) -> Slot

pub fn epoch(&self) -> Epoch

pub fn first_normal_epoch(&self) -> Epoch

pub fn freeze_lock(&self) -> RwLockReadGuard<'_, Hash>

pub fn hash(&self) -> Hash

pub fn is_frozen(&self) -> bool

pub fn freeze_started(&self) -> bool

pub fn status_cache_ancestors(&self) -> Vec<u64>

pub fn unix_timestamp_from_genesis(&self) -> i64

computed unix_timestamp at this slot height

pub fn get_unused_from_slot(rooted_slot: Slot, unused: u64) -> u64

Unused conversion

pub fn clock(&self) -> Clock

pub fn get_slot_history(&self) -> SlotHistory

pub fn epoch_duration_in_years(&self, prev_epoch: Epoch) -> f64

pub fn slot_in_year_for_inflation(&self) -> f64

pub fn update_recent_blockhashes(&self)

pub fn rehash(&self)

pub fn freeze(&self)

pub fn exhaustively_free_unused_resource(&self)

pub fn epoch_schedule(&self) -> &EpochSchedule

pub fn squash(&self)

squash the parent’s state up into this Bank, this Bank becomes a root

pub fn parent(&self) -> Option<Arc<Bank>>

Return the more recent checkpoint of this bank instance.

pub fn parent_slot(&self) -> Slot

pub fn parent_hash(&self) -> Hash

pub fn add_native_program(
    &self,
    name: &str,
    program_id: &Pubkey,
    must_replace: bool
)

pub fn set_rent_burn_percentage(&mut self, burn_percent: u8)

pub fn set_hashes_per_tick(&mut self, hashes_per_tick: Option<u64>)

pub fn last_blockhash(&self) -> Hash

Return the last block hash registered.

pub fn get_minimum_balance_for_rent_exemption(&self, data_len: usize) -> u64

pub fn last_blockhash_with_fee_calculator(&self) -> (Hash, FeeCalculator)

pub fn get_fee_calculator(&self, hash: &Hash) -> Option<FeeCalculator>

pub fn get_fee_rate_governor(&self) -> &FeeRateGovernor

pub fn get_blockhash_last_valid_slot(&self, blockhash: &Hash) -> Option<Slot>

pub fn get_blockhash_last_valid_block_height(
    &self,
    blockhash: &Hash
) -> Option<Slot>

pub fn confirmed_last_blockhash(&self) -> (Hash, FeeCalculator)

pub fn clear_signatures(&self)

Forget all signatures. Useful for benchmarking.

pub fn clear_slot_signatures(&self, slot: Slot)

pub fn can_commit(result: &Result<()>) -> bool

pub fn register_tick(&self, hash: &Hash)

Tell the bank which Entry IDs exist on the ledger. This function assumes subsequent calls correspond to later entries, and will boot the oldest ones once its internal cache is full. Once boot, the bank will reject transactions using that hash.

pub fn is_complete(&self) -> bool

pub fn is_block_boundary(&self, tick_height: u64) -> bool

pub fn demote_sysvar_write_locks(&self) -> bool

pub fn prepare_batch<'a, 'b>(
    &'a self,
    txs: impl Iterator<Item = &'b Transaction>
) -> TransactionBatch<'a, 'b>

pub fn prepare_hashed_batch<'a, 'b>(
    &'a self,
    hashed_txs: &'b [HashedTransaction<'_>]
) -> TransactionBatch<'a, 'b>

pub fn simulate_transaction(
    &self,
    transaction: &Transaction
) -> (Result<()>, TransactionLogMessages, Vec<AccountSharedData>)

Run transactions against a frozen bank without committing the results

pub fn unlock_accounts(&self, batch: &mut TransactionBatch<'_, '_>)

pub fn remove_unrooted_slot(&self, slot: Slot)

pub fn set_shrink_paths(&self, paths: Vec<PathBuf>)

pub fn check_hash_age(&self, hash: &Hash, max_age: usize) -> Option<bool>

pub fn check_tx_durable_nonce(
    &self,
    tx: &Transaction
) -> Option<(Pubkey, AccountSharedData)>

pub fn check_transactions(
    &self,
    hashed_txs: &[HashedTransaction<'_>],
    lock_results: &[Result<()>],
    max_age: usize,
    error_counters: &mut ErrorCounters
) -> Vec<TransactionCheckResult>

pub fn collect_balances(
    &self,
    batch: &TransactionBatch<'_, '_>
) -> TransactionBalances

pub fn remove_executor(&self, pubkey: &Pubkey)

Remove an executor from the bank’s cache

pub fn load_and_execute_transactions(
    &self,
    batch: &TransactionBatch<'_, '_>,
    max_age: usize,
    enable_cpi_recording: bool,
    enable_log_recording: bool,
    timings: &mut ExecuteTimings
) -> (Vec<TransactionLoadResult>, Vec<TransactionExecutionResult>, Vec<Option<InnerInstructionsList>>, Vec<TransactionLogMessages>, Vec<usize>, u64, u64)

pub fn commit_transactions(
    &self,
    hashed_txs: &[HashedTransaction<'_>],
    loaded_accounts: &mut [TransactionLoadResult],
    executed: &[TransactionExecutionResult],
    tx_count: u64,
    signature_count: u64,
    timings: &mut ExecuteTimings
) -> TransactionResults

pub fn cluster_type(&self) -> ClusterType

#[must_use]

pub fn load_execute_and_commit_transactions(
    &self,
    batch: &TransactionBatch<'_, '_>,
    max_age: usize,
    collect_balances: bool,
    enable_cpi_recording: bool,
    enable_log_recording: bool,
    timings: &mut ExecuteTimings
) -> (TransactionResults, TransactionBalancesSet, Vec<Option<InnerInstructionsList>>, Vec<TransactionLogMessages>)

Process a batch of transactions.

pub fn process_transaction(&self, tx: &Transaction) -> Result<()>

Process a Transaction. This is used for unit tests and simply calls the vector Bank::process_transactions method

#[must_use]

pub fn process_transactions(&self, txs: &[Transaction]) -> Vec<Result<()>>

pub fn transfer(
    &self,
    n: u64,
    keypair: &Keypair,
    to: &Pubkey
) -> Result<Signature>

Create, sign, and process a Transaction from keypair to to of n lamports where blockhash is the last Entry ID observed by the client.

pub fn read_balance(account: &AccountSharedData) -> u64

pub fn get_balance(&self, pubkey: &Pubkey) -> u64

Each program would need to be able to introspect its own state this is hard-coded to the Budget language

pub fn parents(&self) -> Vec<Arc<Bank>>

Compute all the parents of the bank in order

pub fn parents_inclusive(self: Arc<Self>) -> Vec<Arc<Bank>>

Compute all the parents of the bank including this bank itself

pub fn store_account(&self, pubkey: &Pubkey, account: &AccountSharedData)

pub fn force_flush_accounts_cache(&self)

pub fn flush_accounts_cache_if_needed(&self)

pub fn expire_old_recycle_stores(&self)

pub fn deposit(&self, pubkey: &Pubkey, lamports: u64) -> u64

pub fn accounts(&self) -> Arc<Accounts>

pub fn set_inflation(&self, inflation: Inflation)

pub fn set_bpf_compute_budget(
    &mut self,
    bpf_compute_budget: Option<BpfComputeBudget>
)

pub fn hard_forks(&self) -> Arc<RwLock<HardForks>>

pub fn get_account(&self, pubkey: &Pubkey) -> Option<AccountSharedData>

pub fn get_account_modified_slot(
    &self,
    pubkey: &Pubkey
) -> Option<(AccountSharedData, Slot)>

pub fn get_program_accounts(
    &self,
    program_id: &Pubkey
) -> Vec<(Pubkey, AccountSharedData)>

pub fn get_filtered_program_accounts<F: Fn(&AccountSharedData) -> bool>(
    &self,
    program_id: &Pubkey,
    filter: F
) -> Vec<(Pubkey, AccountSharedData)>

pub fn get_filtered_indexed_accounts<F: Fn(&AccountSharedData) -> bool>(
    &self,
    index_key: &IndexKey,
    filter: F
) -> Vec<(Pubkey, AccountSharedData)>

pub fn account_indexes_include_key(&self, key: &Pubkey) -> bool

pub fn get_all_accounts_with_modified_slots(
    &self
) -> Vec<(Pubkey, AccountSharedData, Slot)>

pub fn get_program_accounts_modified_since_parent(
    &self,
    program_id: &Pubkey
) -> Vec<(Pubkey, AccountSharedData)>

pub fn get_transaction_logs(
    &self,
    address: Option<&Pubkey>
) -> Option<Vec<TransactionLogInfo>>

pub fn get_all_accounts_modified_since_parent(
    &self
) -> Vec<(Pubkey, AccountSharedData)>

pub fn get_account_modified_since_parent(
    &self,
    pubkey: &Pubkey
) -> Option<(AccountSharedData, Slot)>

pub fn get_largest_accounts(
    &self,
    num: usize,
    filter_by_address: &HashSet<Pubkey>,
    filter: AccountAddressFilter
) -> Vec<(Pubkey, u64)>

pub fn transaction_count(&self) -> u64

pub fn transaction_error_count(&self) -> u64

pub fn transaction_entries_count(&self) -> u64

pub fn transactions_per_entry_max(&self) -> u64

pub fn signature_count(&self) -> u64

pub fn get_signature_status_processed_since_parent(
    &self,
    signature: &Signature
) -> Option<Result<()>>

pub fn get_signature_status_with_blockhash(
    &self,
    signature: &Signature,
    blockhash: &Hash
) -> Option<Result<()>>

pub fn get_signature_status_slot(
    &self,
    signature: &Signature
) -> Option<(Slot, Result<()>)>

pub fn get_signature_status(&self, signature: &Signature) -> Option<Result<()>>

pub fn has_signature(&self, signature: &Signature) -> bool

pub fn get_snapshot_storages(&self) -> SnapshotStorages

pub fn calculate_capitalization(&self) -> u64

pub fn calculate_and_verify_capitalization(&self) -> bool

pub fn set_capitalization(&self) -> u64

Forcibly overwrites current capitalization by actually recalculating accounts’ balances. This should only be used for developing purposes.

pub fn get_accounts_hash(&self) -> Hash

pub fn get_thread_pool(&self) -> &ThreadPool

pub fn update_accounts_hash_with_index_option(
    &self,
    use_index: bool,
    debug_verify: bool
) -> Hash

pub fn update_accounts_hash(&self) -> Hash

pub fn verify_snapshot_bank(&self) -> bool

A snapshot bank should be purged of 0 lamport accounts which are not part of the hash calculation and could shield other real accounts.

pub fn hashes_per_tick(&self) -> &Option<u64>

Return the number of hashes per tick

pub fn ticks_per_slot(&self) -> u64

Return the number of ticks per slot

pub fn slots_per_year(&self) -> f64

Return the number of slots per year

pub fn tick_height(&self) -> u64

Return the number of ticks since genesis.

pub fn inflation(&self) -> Inflation

Return the inflation parameters of the Bank

pub fn rent_collector(&self) -> RentCollector

pub fn capitalization(&self) -> u64

Return the total capitalization of the Bank

pub fn max_tick_height(&self) -> u64

Return this bank’s max_tick_height

pub fn block_height(&self) -> u64

Return the block_height of this bank

pub fn get_slots_in_epoch(&self, epoch: Epoch) -> u64

Return the number of slots per epoch for the given epoch

pub fn get_leader_schedule_epoch(&self, slot: Slot) -> Epoch

returns the epoch for which this bank’s leader_schedule_slot_offset and slot would need to cache leader_schedule

pub fn cloned_stake_delegations(&self) -> HashMap<Pubkey, Delegation>

current stake delegations for this bank

pub fn staked_nodes(&self) -> HashMap<Pubkey, u64>

pub fn vote_accounts(&self) -> Vec<(Pubkey, (u64, ArcVoteAccount))>

current vote accounts for this bank along with the stake attributed to each account Note: This clones the entire vote-accounts hashmap. For a single account lookup use get_vote_account instead.

pub fn get_vote_account(
    &self,
    vote_account: &Pubkey
) -> Option<(u64, ArcVoteAccount)>

Vote account for the given vote account pubkey along with the stake.

pub fn epoch_stakes(&self, epoch: Epoch) -> Option<&EpochStakes>

Get the EpochStakes for a given epoch

pub fn epoch_stakes_map(&self) -> &HashMap<Epoch, EpochStakes>

pub fn epoch_staked_nodes(&self, epoch: Epoch) -> Option<HashMap<Pubkey, u64>>

pub fn epoch_vote_accounts(
    &self,
    epoch: Epoch
) -> Option<&HashMap<Pubkey, (u64, ArcVoteAccount)>>

vote accounts for the specific epoch along with the stake attributed to each account

pub fn epoch_authorized_voter(&self, vote_account: &Pubkey) -> Option<&Pubkey>

Get the fixed authorized voter for the given vote account for the current epoch

pub fn epoch_vote_accounts_for_node_id(
    &self,
    node_id: &Pubkey
) -> Option<&NodeVoteAccounts>

Get the fixed set of vote accounts for the given node id for the current epoch

pub fn total_epoch_stake(&self) -> u64

Get the fixed total stake of all vote accounts for current epoch

pub fn epoch_vote_account_stake(&self, vote_account: &Pubkey) -> u64

Get the fixed stake of the given vote account for the current epoch

pub fn get_epoch_and_slot_index(&self, slot: Slot) -> (Epoch, SlotIndex)

given a slot, return the epoch and offset into the epoch this slot falls e.g. with a fixed number for slots_per_epoch, the calculation is simply:

( slot/slots_per_epoch, slot % slots_per_epoch )

pub fn get_epoch_info(&self) -> EpochInfo

pub fn is_empty(&self) -> bool

pub fn add_builtin(
    &mut self,
    name: &str,
    program_id: Pubkey,
    process_instruction_with_context: ProcessInstructionWithContext
)

Add an instruction processor to intercept instructions before the dynamic loader.

pub fn replace_builtin(
    &mut self,
    name: &str,
    program_id: Pubkey,
    process_instruction_with_context: ProcessInstructionWithContext
)

Replace a builtin instruction processor if it already exists

pub fn clean_accounts(&self, skip_last: bool)

pub fn shrink_all_slots(&self)

pub fn print_accounts_stats(&self)

pub fn process_stale_slot_with_budget(
    &self,
    consumed_budget: usize,
    budget_recovery_delta: usize
) -> usize

pub fn shrink_candidate_slots(&self) -> usize

pub fn secp256k1_program_enabled(&self) -> bool

pub fn no_overflow_rent_distribution_enabled(&self) -> bool

pub fn stake_program_v2_enabled(&self) -> bool

pub fn check_init_vote_data_enabled(&self) -> bool

pub fn check_duplicates_by_hash_enabled(&self) -> bool

pub fn should_bank_still_be_processing_txs(
    bank_creation_time: &Instant,
    max_tx_ingestion_nanos: u128
) -> bool

pub fn deactivate_feature(&mut self, id: &Pubkey)

pub fn activate_feature(&mut self, id: &Pubkey)

Trait Implementations

impl AbiExample for Bank

fn example() -> Self

impl Debug for Bank

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

Formats the value using the given formatter.

impl Default for Bank

fn default() -> Bank

Returns the “default value” for a type.

impl Drop for Bank

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Bank> for Bank

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.