Struct CheatsConfig

pub struct CheatsConfig {

    pub ffi: bool,
    pub always_use_create_2_factory: bool,
    pub prompt_timeout: Duration,
    pub rpc_storage_caching: StorageCachingConfig,
    pub no_storage_caching: bool,
    pub rpc_endpoints: ResolvedRpcEndpoints,
    pub paths: ProjectPathsConfig,
    pub fs_permissions: FsPermissions,
    pub root: PathBuf,
    pub broadcast: PathBuf,
    pub allowed_paths: Vec<PathBuf>,
    pub evm_opts: EvmOpts,
    pub labels: AddressHashMap<String>,
    pub available_artifacts: Option<ContractsByArtifact>,
    pub running_contract: Option<String>,
    pub running_version: Option<Version>,
    pub assertions_revert: bool,
    pub seed: Option<U256>,
}

Additional, configurable context the Cheatcodes inspector has access to

This is essentially a subset of various Config settings Cheatcodes needs to know.

Fields

ffi: bool

Whether the FFI cheatcode is enabled.

always_use_create_2_factory: bool

Use the create 2 factory in all cases including tests and non-broadcasting scripts.

prompt_timeout: Duration

Sets a timeout for vm.prompt cheatcodes

rpc_storage_caching: StorageCachingConfig

RPC storage caching settings determines what chains and endpoints to cache

no_storage_caching: bool

Disables storage caching entirely.

rpc_endpoints: ResolvedRpcEndpoints

All known endpoints and their aliases

paths: ProjectPathsConfig

Project’s paths as configured

fs_permissions: FsPermissions

Filesystem permissions for cheatcodes like writeFile, readFile

root: PathBuf

Project root

broadcast: PathBuf

Absolute Path to broadcast dir i.e project_root/broadcast

allowed_paths: Vec<PathBuf>

Paths (directories) where file reading/writing is allowed

evm_opts: EvmOpts

How the evm was configured by the user

labels: AddressHashMap<String>

Address labels from config

available_artifacts: Option<ContractsByArtifact>

Artifacts which are guaranteed to be fresh (either recompiled or cached). If Some, vm.getDeployedCode invocations are validated to be in scope of this list. If None, no validation is performed.

running_contract: Option<String>

Name of the script/test contract which is currently running.

running_version: Option<Version>

Version of the script/test contract which is currently running.

assertions_revert: bool

Whether to enable legacy (non-reverting) assertions.

seed: Option<U256>

Optional seed for the RNG algorithm.

Implementations

impl CheatsConfig

pub fn new( config: &Config, evm_opts: EvmOpts, available_artifacts: Option<ContractsByArtifact>, running_contract: Option<String>, running_version: Option<Version>, ) -> Self

Extracts the necessary settings from the Config

pub fn normalized_path(&self, path: impl AsRef<Path>) -> PathBuf

Attempts to canonicalize (see std::fs::canonicalize) the path.

Canonicalization fails for non-existing paths, in which case we just normalize the path.

pub fn is_path_allowed( &self, path: impl AsRef<Path>, kind: FsAccessKind, ) -> bool

Returns true if the given path is allowed, if any path allowed_paths is an ancestor of the path

We only allow paths that are inside allowed paths. To prevent path traversal (“../../etc/passwd”) we canonicalize/normalize the path first. We always join with the configured root directory.

fn is_normalized_path_allowed(&self, path: &Path, kind: FsAccessKind) -> bool

pub fn ensure_path_allowed( &self, path: impl AsRef<Path>, kind: FsAccessKind, ) -> Result<PathBuf>

Returns an error if no access is granted to access path, See also Self::is_path_allowed

Returns the normalized version of path, see CheatsConfig::normalized_path

pub fn is_foundry_toml(&self, path: impl AsRef<Path>) -> bool

Returns true if the given path is the project’s foundry.toml file

Note: this should be called with normalized path

pub fn ensure_not_foundry_toml(&self, path: impl AsRef<Path>) -> Result<()>

Same as Self::is_foundry_toml but returns an Err if Self::is_foundry_toml returns true

pub fn rpc_url(&self, url_or_alias: &str) -> Result<String>

Returns the RPC to use

If url_or_alias is a known alias in the ResolvedRpcEndpoints then it returns the corresponding URL of that alias. otherwise this assumes url_or_alias is itself a URL if it starts with a http or ws scheme.

If the url is a path to an existing file, it is also considered a valid RPC URL, IPC path.

Errors

• Returns an error if url_or_alias is a known alias but references an unresolved env var.
• Returns an error if url_or_alias is not an alias but does not start with a http or ws scheme and is not a path to an existing file

pub fn rpc_urls(&self) -> Result<Vec<Rpc>>

Returns all the RPC urls and their alias.

Trait Implementations

impl Clone for CheatsConfig

fn clone(&self) -> CheatsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CheatsConfig

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

Formats the value using the given formatter.

impl Default for CheatsConfig

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 976 bytes