Struct SharedBackend

pub struct SharedBackend { /* private fields */ }

A cloneable backend type that shares access to the backend data with all its clones.

This backend type is connected to the BackendHandler via a mpsc unbounded channel. The BackendHandler is spawned on a tokio task and listens for incoming commands on the receiver half of the channel. A SharedBackend holds a sender for that channel, which is Clone, so there can be multiple SharedBackends communicating with the same BackendHandler, hence this Backend type is thread safe.

All Backend trait functions are delegated as a BackendRequest via the channel to the BackendHandler. All BackendRequest variants include a sender half of an additional channel that is used by the BackendHandler to send the result of an executed BackendRequest back to SharedBackend.

The BackendHandler holds a Provider to look up missing accounts or storage slots from remote (e.g. infura). It detects duplicate requests from multiple SharedBackends and bundles them together, so that always only one provider request is executed. For example, there are two SharedBackends, A and B, both request the basic account info of account 0xasd9sa7d... at the same time. After the BackendHandler receives the request from A, it sends a new provider request to the provider’s endpoint, then it reads the identical request from B and simply adds it as an additional listener for the request already in progress, instead of sending another one. So that after the provider returns the response all listeners (A and B) get notified.

Implementations

impl SharedBackend

pub async fn spawn_backend<T, P>( provider: P, db: BlockchainDb, pin_block: Option<BlockId>, ) -> Self

where T: Transport + Clone + Unpin, P: Provider<T, AnyNetwork> + Unpin + 'static + Clone,

Spawns a new BackendHandler on a tokio::task that listens for requests from any SharedBackend. Missing values get inserted in the db.

The spawned BackendHandler finishes once the last SharedBackend connected to it is dropped.

NOTE: this should be called with Arc<Provider>

pub fn spawn_backend_thread<T, P>( provider: P, db: BlockchainDb, pin_block: Option<BlockId>, ) -> Self

where T: Transport + Clone + Unpin, P: Provider<T, AnyNetwork> + Unpin + 'static + Clone,

Same as Self::spawn_backend but spawns the BackendHandler on a separate std::thread in its own tokio::Runtime

pub fn new<T, P>( provider: P, db: BlockchainDb, pin_block: Option<BlockId>, ) -> (Self, BackendHandler<T, P>)

where T: Transport + Clone + Unpin, P: Provider<T, AnyNetwork> + Unpin + 'static + Clone,

Returns a new SharedBackend and the BackendHandler

pub fn with_blocking_mode(&self, mode: BlockingMode) -> Self

Returns a new SharedBackend and the BackendHandler with a specific blocking mode

pub fn set_pinned_block(&self, block: impl Into<BlockId>) -> Result<()>

Updates the pinned block to fetch data from

pub fn get_full_block( &self, block: impl Into<BlockId>, ) -> DatabaseResult<AnyRpcBlock>

Returns the full block for the given block identifier

pub fn get_transaction( &self, tx: B256, ) -> DatabaseResult<WithOtherFields<Transaction<AnyTxEnvelope>>>

Returns the transaction for the hash

pub fn insert_or_update_address( &self, address_data: AddressHashMap<AccountInfo>, )

Inserts or updates data for multiple addresses

pub fn insert_or_update_storage( &self, storage_data: AddressHashMap<StorageInfo>, )

Inserts or updates data for multiple storage slots

pub fn insert_or_update_block_hashes( &self, block_hash_data: HashMap<U256, B256>, )

Inserts or updates data for multiple block hashes

pub fn do_any_request<T, F>(&mut self, fut: F) -> DatabaseResult<T>

where F: Future<Output = Result<T, Report>> + Send + 'static, T: Debug + Send + 'static,

Returns any arbitrary request on the provider

pub fn flush_cache(&self)

Flushes the DB to disk if caching is enabled

pub fn flush_cache_to(&self, cache_path: &Path)

Flushes the DB to a specific file

pub fn data(&self) -> Arc<MemDb>

Returns the DB

pub fn accounts(&self) -> AddressHashMap<AccountInfo>

Returns the DB accounts

pub fn accounts_len(&self) -> usize

Returns the DB accounts length

pub fn storage(&self) -> AddressHashMap<StorageInfo>

Returns the DB storage

pub fn storage_len(&self) -> usize

Returns the DB storage length

pub fn block_hashes(&self) -> HashMap<U256, B256>

Returns the DB block_hashes

pub fn block_hashes_len(&self) -> usize

Returns the DB block_hashes length

Trait Implementations

impl Clone for SharedBackend

fn clone(&self) -> SharedBackend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DatabaseRef for SharedBackend

type Error = DatabaseError

The database error type.

fn basic_ref( &self, address: Address, ) -> Result<Option<AccountInfo>, Self::Error>

Get basic account information.

fn code_by_hash_ref(&self, hash: B256) -> Result<Bytecode, Self::Error>

Get account code by its hash.

fn storage_ref( &self, address: Address, index: U256, ) -> Result<U256, Self::Error>

Get storage value of address at index.

fn block_hash_ref(&self, number: u64) -> Result<B256, Self::Error>

Get block hash by block number.

impl Debug for SharedBackend

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

Formats the value using the given formatter.