Struct SurfnetSvmLocker

pub struct SurfnetSvmLocker(pub Arc<RwLock<SurfnetSvm>>);

Tuple Fields

0: Arc<RwLock<SurfnetSvm>>

Implementations

impl SurfnetSvmLocker

Functions for reading and writing to the underlying SurfnetSvm instance

pub fn with_svm_reader<T, F>(&self, reader: F) -> T

where F: Fn(&SurfnetSvm) -> T + Send + Sync,

Executes a read-only operation on the underlying SurfnetSvm by acquiring a blocking read lock. Accepts a closure that receives a shared reference to SurfnetSvm and returns a value.

Returns

The result produced by the closure.

pub fn with_svm_writer<T, F>(&self, writer: F) -> T

where F: Fn(&mut SurfnetSvm) -> T + Send + Sync, T: Send + 'static,

Executes a write operation on the underlying SurfnetSvm by acquiring a blocking write lock. Accepts a closure that receives a mutable reference to SurfnetSvm and returns a value.

Returns

The result produced by the closure.

impl SurfnetSvmLocker

Functions for creating and initializing the underlying SurfnetSvm instance

pub fn new(svm: SurfnetSvm) -> Self

Constructs a new SurfnetSvmLocker wrapping the given SurfnetSvm instance.

pub async fn initialize( &self, remote_ctx: &Option<SurfnetRemoteClient>, ) -> SurfpoolResult<EpochInfo>

Initializes the locked SurfnetSvm by fetching or defaulting epoch info, then calling its initialize method. Returns the epoch info on success.

impl SurfnetSvmLocker

Functions for getting accounts from the underlying SurfnetSvm instance or remote client

pub fn get_account_local( &self, pubkey: &Pubkey, ) -> SvmAccessContext<GetAccountResult>

Retrieves a local account from the SVM cache, returning a contextualized result.

pub async fn get_account_local_then_remote( &self, client: &SurfnetRemoteClient, pubkey: &Pubkey, commitment_config: CommitmentConfig, ) -> SurfpoolContextualizedResult<GetAccountResult>

Attempts local retrieval, then fetches from remote if missing, returning a contextualized result.

pub async fn get_account( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, pubkey: &Pubkey, factory: Option<AccountFactory>, ) -> SurfpoolContextualizedResult<GetAccountResult>

Retrieves an account, using local or remote based on context, applying a default factory if provided.

pub fn get_multiple_accounts_local( &self, pubkeys: &[Pubkey], ) -> SvmAccessContext<Vec<GetAccountResult>>

Retrieves multiple accounts from local cache, returning a contextualized result.

pub async fn get_multiple_accounts_local_then_remote( &self, client: &SurfnetRemoteClient, pubkeys: &[Pubkey], commitment_config: CommitmentConfig, ) -> SurfpoolContextualizedResult<Vec<GetAccountResult>>

Retrieves multiple accounts, fetching missing ones from remote, returning a contextualized result.

pub async fn get_multiple_accounts( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, pubkeys: &[Pubkey], factory: Option<AccountFactory>, ) -> SurfpoolContextualizedResult<Vec<GetAccountResult>>

Retrieves multiple accounts, using local or remote context and applying factory defaults if provided.

pub fn get_largest_accounts_local( &self, config: RpcLargestAccountsConfig, ) -> SvmAccessContext<Vec<RpcAccountBalance>>

Retrieves largest accounts from local cache, returning a contextualized result.

pub async fn get_largest_accounts_local_then_remote( &self, client: &SurfnetRemoteClient, config: RpcLargestAccountsConfig, commitment_config: CommitmentConfig, ) -> SurfpoolContextualizedResult<Vec<RpcAccountBalance>>

pub async fn get_largest_accounts( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, config: RpcLargestAccountsConfig, ) -> SurfpoolContextualizedResult<Vec<RpcAccountBalance>>

pub fn account_to_rpc_keyed_account<T: ReadableAccount + Send + Sync>( &self, pubkey: &Pubkey, account: &T, config: &RpcAccountInfoConfig, token_mint: Option<Pubkey>, ) -> RpcKeyedAccount

impl SurfnetSvmLocker

Get signatures for Addresses

pub fn get_signatures_for_address_local( &self, pubkey: &Pubkey, config: Option<RpcSignaturesForAddressConfig>, ) -> SvmAccessContext<Vec<RpcConfirmedTransactionStatusWithSignature>>

pub async fn get_signatures_for_address_local_then_remote( &self, client: &SurfnetRemoteClient, pubkey: &Pubkey, config: Option<RpcSignaturesForAddressConfig>, ) -> SurfpoolContextualizedResult<Vec<RpcConfirmedTransactionStatusWithSignature>>

pub async fn get_signatures_for_address( &self, remote_ctx: &Option<(SurfnetRemoteClient, ())>, pubkey: &Pubkey, config: Option<RpcSignaturesForAddressConfig>, ) -> SurfpoolContextualizedResult<Vec<RpcConfirmedTransactionStatusWithSignature>>

impl SurfnetSvmLocker

Functions for getting transactions from the underlying SurfnetSvm instance or remote client

pub async fn get_transaction( &self, remote_ctx: &Option<SurfnetRemoteClient>, signature: &Signature, config: RpcTransactionConfig, ) -> SurfpoolResult<GetTransactionResult>

Retrieves a transaction by signature, using local or remote based on context.

pub fn get_transaction_local( &self, signature: &Signature, config: &RpcTransactionConfig, ) -> SurfpoolResult<GetTransactionResult>

Retrieves a transaction from local cache, returning a contextualized result.

pub async fn get_transaction_local_then_remote( &self, client: &SurfnetRemoteClient, signature: &Signature, config: RpcTransactionConfig, ) -> SurfpoolResult<GetTransactionResult>

Retrieves a transaction locally then from remote if missing, returning a contextualized result.

impl SurfnetSvmLocker

Functions for simulating and processing transactions in the underlying SurfnetSvm instance

pub fn simulate_transaction( &self, transaction: VersionedTransaction, sigverify: bool, ) -> Result<SimulatedTransactionInfo, FailedTransactionMetadata>

Simulates a transaction on the SVM, returning detailed info or failure metadata.

pub async fn process_transaction( &self, remote_ctx: &Option<SurfnetRemoteClient>, transaction: VersionedTransaction, status_tx: Sender<TransactionStatusEvent>, skip_preflight: bool, ) -> SurfpoolContextualizedResult<()>

Processes a transaction: verifies signatures, preflight sim, sends to SVM, and enqueues status events.

impl SurfnetSvmLocker

Functions for writing account updates to the underlying SurfnetSvm instance

pub fn write_account_update(&self, account_update: GetAccountResult)

Writes a single account update into the SVM state if present.

pub fn write_multiple_account_updates( &self, account_updates: &[GetAccountResult], )

Writes multiple account updates into the SVM state when any are present.

impl SurfnetSvmLocker

Token account related functions

pub async fn get_token_accounts_by_owner( &self, remote_ctx: &Option<SurfnetRemoteClient>, owner: Pubkey, filter: &TokenAccountsFilter, config: &RpcAccountInfoConfig, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

Fetches all token accounts for an owner, returning remote results and missing pubkeys contexts.

pub fn get_token_accounts_by_owner_local( &self, owner: Pubkey, filter: &TokenAccountsFilter, config: &RpcAccountInfoConfig, ) -> SvmAccessContext<Vec<RpcKeyedAccount>>

pub async fn get_token_accounts_by_owner_local_then_remote( &self, owner: Pubkey, filter: &TokenAccountsFilter, remote_client: &SurfnetRemoteClient, config: &RpcAccountInfoConfig, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

pub async fn get_token_accounts_by_delegate( &self, remote_ctx: &Option<SurfnetRemoteClient>, delegate: Pubkey, filter: &TokenAccountsFilter, config: &RpcAccountInfoConfig, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

impl SurfnetSvmLocker

Token account by delegate related functions

pub fn get_token_accounts_by_delegate_local( &self, delegate: Pubkey, filter: &TokenAccountsFilter, config: &RpcAccountInfoConfig, ) -> SvmAccessContext<Vec<RpcKeyedAccount>>

pub async fn get_token_accounts_by_delegate_local_then_remote( &self, delegate: Pubkey, filter: &TokenAccountsFilter, remote_client: &SurfnetRemoteClient, config: &RpcAccountInfoConfig, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

impl SurfnetSvmLocker

Get largest account related account

pub fn get_token_largest_accounts_local( &self, mint: &Pubkey, ) -> SvmAccessContext<Vec<RpcTokenAccountBalance>>

pub async fn get_token_largest_accounts_local_then_remote( &self, client: &SurfnetRemoteClient, mint: &Pubkey, commitment_config: CommitmentConfig, ) -> SurfpoolContextualizedResult<Vec<RpcTokenAccountBalance>>

pub async fn get_token_largest_accounts( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, mint: &Pubkey, ) -> SurfpoolContextualizedResult<Vec<RpcTokenAccountBalance>>

Fetches the largest token accounts for a specific mint, returning contextualized results.

impl SurfnetSvmLocker

Address lookup table related functions

pub fn get_pubkeys_from_message( &self, message: &VersionedMessage, loaded_addresses: Option<LoadedAddresses>, ) -> Vec<Pubkey>

Extracts pubkeys from a VersionedMessage, resolving address lookup tables as needed.

pub async fn get_loaded_addresses( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, message: &VersionedMessage, ) -> SurfpoolResult<Option<LoadedAddresses>>

Gets addresses loaded from on-chain lookup tables from a VersionedMessage.

pub async fn get_lookup_table_addresses( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, address_table_lookup: &MessageAddressTableLookup, ) -> SurfpoolContextualizedResult<LoadedAddresses>

Retrieves loaded addresses from a lookup table account, validating owner and indices.

impl SurfnetSvmLocker

Profiling helper functions

pub fn estimate_compute_units( &self, transaction: &VersionedTransaction, ) -> SvmAccessContext<ComputeUnitsEstimationResult>

Estimates compute units for a transaction via contextualized simulation.

pub async fn profile_transaction( &self, remote_ctx: &Option<SurfnetRemoteClient>, transaction: VersionedTransaction, encoding: Option<UiAccountEncoding>, tag: Option<String>, ) -> SurfpoolContextualizedResult<ProfileResult>

pub fn get_profile_result( &self, signature_or_uuid: UuidOrSignature, ) -> SurfpoolResult<Option<ProfileResult>>

Returns the profile result for a given signature or UUID, and whether it exists in the SVM.

pub fn get_profile_results_by_tag( &self, tag: String, ) -> SurfpoolResult<Option<Vec<ProfileResult>>>

Returns the profile results for a given tag.

impl SurfnetSvmLocker

Program account related functions

pub async fn clone_program_account( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, source_program_id: &Pubkey, destination_program_id: &Pubkey, ) -> SurfpoolContextualizedResult<()>

Clones a program account from source to destination, handling upgradeable loader state.

pub async fn set_program_authority( &self, remote_ctx: &Option<(SurfnetRemoteClient, CommitmentConfig)>, program_id: Pubkey, new_authority: Option<Pubkey>, ) -> SurfpoolContextualizedResult<()>

pub async fn get_program_accounts( &self, remote_ctx: &Option<SurfnetRemoteClient>, program_id: &Pubkey, account_config: RpcAccountInfoConfig, filters: Option<Vec<RpcFilterType>>, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

pub fn get_program_accounts_local( &self, program_id: &Pubkey, account_config: RpcAccountInfoConfig, filters: Option<Vec<RpcFilterType>>, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

Retrieves program accounts from the local SVM cache, returning a contextualized result.

pub async fn get_program_accounts_local_then_remote( &self, client: &SurfnetRemoteClient, program_id: &Pubkey, account_config: RpcAccountInfoConfig, filters: Option<Vec<RpcFilterType>>, ) -> SurfpoolContextualizedResult<Vec<RpcKeyedAccount>>

Retrieves program accounts from the local cache and remote client, combining results.

impl SurfnetSvmLocker

pub fn get_first_local_slot(&self) -> Option<Slot>

pub async fn get_block( &self, remote_ctx: &Option<SurfnetRemoteClient>, slot: &Slot, config: &RpcBlockConfig, ) -> SurfpoolContextualizedResult<Option<UiConfirmedBlock>>

pub fn get_block_local( &self, slot: &Slot, config: &RpcBlockConfig, ) -> SurfpoolResult<Option<UiConfirmedBlock>>

pub fn get_genesis_hash_local(&self) -> SvmAccessContext<Hash>

pub async fn get_genesis_hash( &self, remote_ctx: &Option<SurfnetRemoteClient>, ) -> SurfpoolContextualizedResult<Hash>

impl SurfnetSvmLocker

Pass through functions for accessing the underlying SurfnetSvm instance

pub fn simnet_events_tx(&self) -> Sender<SimnetEvent>

Returns a sender for simulation events from the underlying SVM.

pub fn get_epoch_info(&self) -> EpochInfo

Retrieves the latest epoch info from the underlying SVM.

pub fn get_latest_absolute_slot(&self) -> Slot

Retrieves the latest absolute slot from the underlying SVM.

pub fn get_latest_blockhash(&self, config: &CommitmentConfig) -> Option<Hash>

Retrieves the latest blockhash for the given commitment config from the underlying SVM.

pub fn get_slot_for_commitment(&self, commitment: &CommitmentConfig) -> Slot

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

Executes an airdrop via the underlying SVM.

pub fn airdrop_pubkeys(&self, lamports: u64, addresses: &[Pubkey])

Executes a batch airdrop via the underlying SVM.

pub fn confirm_current_block(&self) -> SurfpoolResult<()>

Confirms the current block on the underlying SVM, returning Ok(()) or an error.

pub fn subscribe_for_signature_updates( &self, signature: &Signature, subscription_type: SignatureSubscriptionType, ) -> Receiver<(Slot, Option<TransactionError>)>

Subscribes for signature updates (confirmed/finalized) and returns a receiver of events.

pub fn subscribe_for_account_updates( &self, account_pubkey: &Pubkey, encoding: Option<UiAccountEncoding>, ) -> Receiver<UiAccount>

Subscribes for account updates and returns a receiver of account updates.

pub fn subscribe_for_slot_updates(&self) -> Receiver<SlotInfo>

Subscribes for slot updates and returns a receiver of slot updates.

pub fn subscribe_for_logs_updates( &self, commitment_level: &CommitmentLevel, filter: &RpcTransactionLogsFilter, ) -> Receiver<(Slot, RpcLogsResponse)>

Subscribes for logs updates and returns a receiver of logs updates.

Trait Implementations

impl Clone for SurfnetSvmLocker

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.