Struct ScConfig

pub struct ScConfig {
    pub default_contract_config_name: String,
    pub contracts: Vec<ContractVariant>,
    pub proxy_configs: Vec<ProxyConfig>,
}

An entire project configuration.

It can contain one or several contract variants.

Fields

default_contract_config_name: String

contracts: Vec<ContractVariant>

proxy_configs: Vec<ProxyConfig>

Implementations

impl ScConfig

pub fn load_from_config( config: &ScConfigSerde, original_abi: &ContractAbi, ) -> Self

Assembles an ContractVariantConfig from a raw config object that was loaded via Serde.

In most cases the config will be loaded from a .toml file, use load_from_file for that.

impl ScConfig

pub fn default_config(original_abi: &ContractAbi) -> Self

Provides the config for the cases where no multicontract.toml file is available.

The default configuration contains a single main contract, with all endpoints.

pub fn load_from_file<P: AsRef<Path>>( path: P, original_abi: &ContractAbi, ) -> Option<Self>

Loads a contract configuration from file. Will return None if the file is not found.

pub fn load_from_files_or_default<I, P>( paths: I, original_abi: &ContractAbi, ) -> Self

where P: AsRef<Path>, I: Iterator<Item = P>,

The standard way of loading a multicontract.toml configuration: read the file if present, use the default config otherwise.

pub fn load_from_crate_or_default<P>( contract_crate_path: P, original_abi: &ContractAbi, ) -> Self

where P: AsRef<Path>,

The standard way of loading a multicontract.toml configuration: read the file if present, use the default config otherwise.

impl ScConfig

pub fn main_contract(&self) -> &ContractVariant

pub fn main_contract_mut(&mut self) -> &mut ContractVariant

pub fn secondary_contracts(&self) -> impl Iterator<Item = &ContractVariant>

pub fn secondary_contracts_mut( &mut self, ) -> impl Iterator<Item = &mut ContractVariant>

pub fn get_contract_by_id( &self, contract_id: String, ) -> Option<&ContractVariant>

pub fn get_contract_by_name( &self, contract_name: String, ) -> Option<&ContractVariant>

pub fn find_contract(&self, contract_name: &str) -> &ContractVariant

Yields the contract with the given public name.

pub fn validate_contract_variants(&self)

Trait Implementations

impl Debug for ScConfig

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

Formats the value using the given formatter.