Struct LiteSVM 

pub struct LiteSVM { /* private fields */ }

Implementations

impl LiteSVM

pub fn new() -> LiteSVM

Creates the basic test environment.

pub fn with_compute_budget(self, compute_budget: ComputeBudget) -> LiteSVM

Sets the compute budget.

pub fn with_sigverify(self, sigverify: bool) -> LiteSVM

Enables or disables sigverify.

pub fn with_blockhash_check(self, check: bool) -> LiteSVM

Enables or disables the blockhash check.

pub fn with_sysvars(self) -> LiteSVM

Includes the default sysvars.

pub fn with_feature_set(self, feature_set: FeatureSet) -> LiteSVM

Set the FeatureSet used by the VM instance.

pub fn with_feature_accounts(self) -> LiteSVM

pub fn with_builtins(self) -> LiteSVM

Changes the default builtins.

pub fn with_lamports(self, lamports: u64) -> LiteSVM

Changes the initial lamports in LiteSVM’s airdrop account.

pub fn with_default_programs(self) -> LiteSVM

Includes the standard SPL programs.

pub fn with_transaction_history(self, capacity: usize) -> LiteSVM

Changes the capacity of the transaction history. Set this to 0 to disable transaction history and allow duplicate transactions.

pub fn with_log_bytes_limit(self, limit: Option<usize>) -> LiteSVM

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

Returns minimum balance required to make an account with specified data length rent exempt.

pub fn get_account(&self, address: &Address) -> Option<Account>

Returns all information associated with the account of the provided pubkey.

pub fn set_account( &mut self, address: Address, data: Account, ) -> Result<(), LiteSVMError>

Sets all information associated with the account of the provided pubkey.

pub fn accounts_db(&self) -> &AccountsDb

⚠️ ADVANCED USE ONLY ⚠️

Returns a reference to the internal accounts database.

This provides read-only access to the accounts database for advanced inspection. Use get_account for normal account retrieval.

Examples

use litesvm::LiteSVM;

let svm = LiteSVM::new();

// Read-only access to accounts database
let accounts_db = svm.accounts_db();
// ... inspect internal state if needed

pub fn get_balance(&self, address: &Address) -> Option<u64>

Gets the balance of the provided account pubkey.

pub fn latest_blockhash(&self) -> Hash

Gets the latest blockhash.

pub fn set_sysvar<T>(&mut self, sysvar: &T)

where T: Sysvar + SysvarId + SysvarSerialize,

Sets the sysvar to the test environment.

pub fn get_sysvar<T>(&self) -> T

where T: Sysvar + SysvarId + DeserializeOwned,

Gets a sysvar from the test environment.

pub fn get_transaction( &self, signature: &Signature, ) -> Option<&Result<TransactionMetadata, FailedTransactionMetadata>>

Gets a transaction from the transaction history.

pub fn airdrop_pubkey(&self) -> Address

Returns the pubkey of the internal airdrop account.

pub fn airdrop( &mut self, address: &Address, lamports: u64, ) -> Result<TransactionMetadata, FailedTransactionMetadata>

Airdrops the account with the lamports specified.

pub fn add_builtin( &mut self, program_id: Address, entrypoint: fn(*mut EbpfVm<'_, InvokeContext<'static, 'static>>, u64, u64, u64, u64, u64), )

Adds a builtin program to the test environment.

pub fn add_program_from_file( &mut self, program_id: impl Into<Address>, path: impl AsRef<Path>, ) -> Result<(), LiteSVMError>

Adds an SBF program to the test environment from the file specified.

pub fn add_program( &mut self, program_id: impl Into<Address>, program_bytes: &[u8], ) -> Result<(), LiteSVMError>

Adds an SBF program to the test environment.

Uses BPFLoaderUpgradeable by default for the loader.

pub fn add_program_with_loader( &mut self, program_id: impl Into<Address>, program_bytes: &[u8], loader_id: Address, ) -> Result<(), LiteSVMError>

Adds an SBF program with a specific loader to match mainnet CU behavior.

Use bpf_loader::id() for BPFLoader2, bpf_loader_deprecated::id() for BPFLoader1, or bpf_loader_upgradeable::id() for the upgradeable loader.

pub fn send_transaction( &mut self, tx: impl Into<VersionedTransaction>, ) -> Result<TransactionMetadata, FailedTransactionMetadata>

Submits a signed transaction.

pub fn simulate_transaction( &self, tx: impl Into<VersionedTransaction>, ) -> Result<SimulatedTransactionInfo, FailedTransactionMetadata>

Simulates a transaction.

pub fn expire_blockhash(&mut self)

Expires the current blockhash.

pub fn warp_to_slot(&mut self, slot: u64)

Warps the clock to the specified slot.

pub fn get_compute_budget(&self) -> Option<ComputeBudget>

Gets the current compute budget.

pub fn get_sigverify(&self) -> bool

pub fn with_custom_syscall( self, name: &str, syscall: fn(*mut EbpfVm<'_, InvokeContext<'static, 'static>>, u64, u64, u64, u64, u64), ) -> LiteSVM

Registers a custom syscall in both program runtime environments (v1 and v2).

Must be called after with_builtins() (which recreates the environments from scratch) and before with_default_programs() (which clones the environment Arcs into program cache entries, preventing further mutation).

Panics if the runtime environments cannot be mutated or if registration fails. This is intentional — a misconfigured syscall should fail loudly rather than silently.

Trait Implementations

impl AssertionHelpers for LiteSVM

fn assert_account_closed(&self, pubkey: &Pubkey)

Assert that an account is closed (doesn’t exist or has 0 lamports and 0 data)

fn assert_account_exists(&self, pubkey: &Pubkey)

Assert that an account exists

fn assert_token_balance(&self, token_account: &Pubkey, expected: u64)

Assert token account balance

fn assert_sol_balance(&self, pubkey: &Pubkey, expected: u64)

Assert SOL balance

fn assert_mint_supply(&self, mint: &Pubkey, expected: u64)

Assert token mint supply

fn assert_account_owner(&self, account: &Pubkey, expected_owner: &Pubkey)

Assert that an account is owned by a specific program

fn assert_account_data_len(&self, account: &Pubkey, expected_len: usize)

Assert that an account has a specific data length

impl Clone for LiteSVM

fn clone(&self) -> LiteSVM

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for LiteSVM

fn default() -> LiteSVM

Returns the “default value” for a type.

impl InvokeContextCallback for LiteSVM

Available on non-crate feature precompiles only.

fn get_epoch_stake(&self) -> u64

Returns the total current epoch stake for the network.

fn get_epoch_stake_for_vote_account(&self, _vote_address: &Address) -> u64

Returns the current epoch stake for the given vote account.

fn is_precompile(&self, _program_id: &Address) -> bool

Returns true if the program_id corresponds to a precompiled program

fn process_precompile( &self, _program_id: &Address, _data: &[u8], _instruction_datas: Vec<&[u8]>, ) -> Result<(), PrecompileError>

Calls the precompiled program corresponding to the given program ID.

impl ProgramTestExt for LiteSVM

fn deploy_program(&mut self, program_id: Pubkey, program_bytes: &[u8])

Deploy a program to this LiteSVM instance

impl TestHelpers for LiteSVM

fn create_funded_account( &mut self, lamports: u64, ) -> Result<Keypair, Box<dyn Error>>

Create a new funded keypair

fn create_funded_accounts( &mut self, count: usize, lamports: u64, ) -> Result<Vec<Keypair>, Box<dyn Error>>

Create multiple funded keypairs

fn create_token_mint( &mut self, authority: &Keypair, decimals: u8, ) -> Result<Keypair, Box<dyn Error>>

Create and initialize a token mint

fn create_token_account( &mut self, mint: &Pubkey, owner: &Keypair, ) -> Result<Keypair, Box<dyn Error>>

Create a token account for a mint

fn create_associated_token_account( &mut self, mint: &Pubkey, owner: &Keypair, ) -> Result<Pubkey, Box<dyn Error>>

Create an associated token account

fn mint_to( &mut self, mint: &Pubkey, account: &Pubkey, authority: &Keypair, amount: u64, ) -> Result<(), Box<dyn Error>>

Mint tokens to an account

fn derive_pda(&self, seeds: &[&[u8]], program_id: &Pubkey) -> (Pubkey, u8)

Derive a program-derived address

fn get_current_slot(&self) -> u64

Get the current slot

fn advance_slot(&mut self, slots: u64)

Advance the slot by a specified amount

fn get_pda(&self, seeds: &[&[u8]], program_id: &Pubkey) -> Pubkey

Get a program-derived address (convenience wrapper for Pubkey::find_program_address)

fn get_pda_with_bump( &self, seeds: &[&[u8]], program_id: &Pubkey, ) -> (Pubkey, u8)

Get a program-derived address with bump (alias for derive_pda for consistency)

impl TransactionHelpers for LiteSVM

fn send_instruction( &mut self, instruction: Instruction, signers: &[&Keypair], ) -> Result<TransactionResult, TransactionError>

Send a single instruction and return a wrapped result

fn send_instructions( &mut self, instructions: &[Instruction], signers: &[&Keypair], ) -> Result<TransactionResult, TransactionError>

Send multiple instructions in a single transaction

fn send_transaction_result( &mut self, transaction: Transaction, ) -> Result<TransactionResult, TransactionError>

Send a transaction and return a wrapped result