Struct ethers_solc::ConfigurableArtifacts

pub struct ConfigurableArtifacts {
    pub additional_values: ExtraOutputValues,
    pub additional_files: ExtraOutputFiles,
    /* private fields */
}

An Artifact implementation that can be configured to include additional content and emit additional files

Creates a single json artifact with

 {
   "abi": [],
   "bytecode": {...},
   "deployedBytecode": {...},
   "methodIdentifiers": {...},
   // additional values
 }

Fields

additional_values: ExtraOutputValues

A set of additional values to include in the contract’s artifact file

additional_files: ExtraOutputFiles

A set of values that should be written to a separate file

Implementations

impl ConfigurableArtifacts

pub fn new(
    extra_values: impl IntoIterator<Item = ContractOutputSelection>,
    extra_files: impl IntoIterator<Item = ContractOutputSelection>
) -> Self

pub fn settings(&self) -> Settings

Returns the Settings this configuration corresponds to

pub fn output_selection(&self) -> Vec<ContractOutputSelection>

Returns the output selection corresponding to this configuration

Trait Implementations

impl ArtifactOutput for ConfigurableArtifacts

type Artifact = ConfigurableContractArtifact

Represents the artifact that will be stored for a Contract

fn write_contract_extras(
    &self,
    contract: &Contract,
    file: &Path
) -> Result<(), SolcError>

Write additional files for the contract

fn contract_to_artifact(
    &self,
    _file: &str,
    _name: &str,
    contract: Contract,
    source_file: Option<&SourceFile>
) -> Self::Artifact

Convert a contract to the artifact type

fn standalone_source_file_to_artifact(
    &self,
    _path: &str,
    file: &VersionedSourceFile
) -> Option<Self::Artifact>

This converts a SourceFile that doesn’t contain any contract definitions (interfaces, contracts, libraries) to an artifact.

fn on_output(
    &self,
    contracts: &VersionedContracts,
    sources: &VersionedSourceFiles,
    layout: &ProjectPathsConfig,
    ctx: OutputContext<'_>
) -> Result<Artifacts<Self::Artifact>>

Handle the aggregated set of compiled contracts from the solc crate::CompilerOutput.

fn write_extras(
    &self,
    contracts: &VersionedContracts,
    artifacts: &Artifacts<Self::Artifact>
) -> Result<()>

Writes additional files for the contracts if the included in the Contract, such as ir, ewasm, iropt.

fn output_file_name(name: impl AsRef<str>) -> PathBuf

Returns the file name for the contract’s artifact Greeter.json

fn output_file_name_versioned(
    name: impl AsRef<str>,
    version: &Version
) -> PathBuf

Returns the file name for the contract’s artifact and the given version Greeter.0.8.11.json

fn conflict_free_output_file(
    already_taken: &HashSet<PathBuf>,
    conflict: PathBuf,
    contract_file: impl AsRef<Path>,
    artifacts_folder: impl AsRef<Path>
) -> PathBuf

Returns the appropriate file name for the conflicting file.

fn output_file(contract_file: impl AsRef<Path>, name: impl AsRef<str>) -> PathBuf

Returns the path to the contract’s artifact location based on the contract’s file and name

fn output_file_versioned(
    contract_file: impl AsRef<Path>,
    name: impl AsRef<str>,
    version: &Version
) -> PathBuf

Returns the path to the contract’s artifact location based on the contract’s file, name and version

fn contract_name(file: impl AsRef<Path>) -> Option<String>

The inverse of contract_file_name

fn output_exists(
    contract_file: impl AsRef<Path>,
    name: impl AsRef<str>,
    root: impl AsRef<Path>
) -> bool

Whether the corresponding artifact of the given contract file and name exists

fn read_cached_artifact(path: impl AsRef<Path>) -> Result<Self::Artifact>

Read the artifact that’s stored at the given path

fn read_cached_artifacts<T, I>(
    files: I
) -> Result<BTreeMap<PathBuf, Self::Artifact>>where
    I: IntoIterator<Item = T>,
    T: Into<PathBuf>,

Read the cached artifacts that are located the paths the iterator yields

fn output_to_artifacts(
    &self,
    contracts: &VersionedContracts,
    sources: &VersionedSourceFiles,
    ctx: OutputContext<'_>,
    layout: &ProjectPathsConfig
) -> Artifacts<Self::Artifact>

Convert the compiler output into a set of artifacts

impl Clone for ConfigurableArtifacts

fn clone(&self) -> ConfigurableArtifacts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigurableArtifacts

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

Formats the value using the given formatter.

impl Default for ConfigurableArtifacts

fn default() -> ConfigurableArtifacts

Returns the “default value” for a type.

impl PartialEq<ConfigurableArtifacts> for ConfigurableArtifacts

fn eq(&self, other: &ConfigurableArtifacts) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ConfigurableArtifacts

impl Eq for ConfigurableArtifacts

impl StructuralEq for ConfigurableArtifacts

impl StructuralPartialEq for ConfigurableArtifacts