tycho-simulation 0.255.1

Provides tools for interacting with protocol states, calculating spot prices, and quoting token swaps.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

use std::collections::HashMap;

use alloy::primitives::{Address, U256};
use revm::{state::AccountInfo, DatabaseRef};
use tycho_client::feed::BlockHeader;

pub trait EngineDatabaseInterface: DatabaseRef + Send + Sync {
    type Error;

    /// Sets up a single account
    ///
    /// Full control over setting up an accounts. Allows to set up EOAs as
    /// well as smart contracts.
    ///
    /// # Arguments
    ///
    /// * `address` - Address of the account
    /// * `account` - The account information
    /// * `permanent_storage` - Storage to init the account with this storage can only be updated
    ///   manually.
    /// * `mocked` - Whether this account should be considered mocked. For mocked accounts, nothing
    ///   is downloaded from a node; all data must be inserted manually.
    fn init_account(
        &self,
        address: Address,
        account: AccountInfo,
        permanent_storage: Option<HashMap<U256, U256>>,
        mocked: bool,
    ) -> Result<(), <Self as EngineDatabaseInterface>::Error>;

    fn clear_temp_storage(&mut self) -> Result<(), <Self as EngineDatabaseInterface>::Error>;

    /// Gets the block header that this database is operating at.
    ///
    /// # Returns
    ///
    /// * `Option<BlockHeader>` - The current block header, or None if no block is set
    fn get_current_block(&self) -> Option<BlockHeader>;
}