Struct 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 solc_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

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

Writes extra files for compiled artifact based on Self::additional_files

fn is_dirty( &self, artifact_file: &ArtifactFile<Self::Artifact>, ) -> Result<bool, SolcError>

We want to enforce recompilation if artifact is missing data we need for writing extra files.

fn handle_cached_artifacts( &self, artifacts: &Artifacts<Self::Artifact>, ) -> Result<(), SolcError>

Writes extra files for cached artifacts based on Self::additional_files.

type Artifact = ConfigurableContractArtifact

Represents the artifact that will be stored for a Contract

type CompilerContract = Contract

fn contract_to_artifact( &self, _file: &Path, _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: &Path, 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<L>( &self, contracts: &VersionedContracts<Self::CompilerContract>, sources: &VersionedSourceFiles, layout: &ProjectPathsConfig<L>, ctx: OutputContext<'_>, primary_profiles: &HashMap<PathBuf, &str>, ) -> Result<Artifacts<Self::Artifact>>

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

fn output_file_name( name: &str, version: &Version, profile: &str, with_version: bool, with_profile: bool, ) -> PathBuf

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

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

Returns the appropriate file name for the conflicting file.

fn output_file( contract_file: &Path, name: &str, version: &Version, profile: &str, with_version: bool, with_profile: bool, ) -> PathBuf

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

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

The inverse of contract_file_name

fn read_cached_artifact(path: &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 get_artifact_path( ctx: &OutputContext<'_>, already_taken: &HashSet<String>, file: &Path, name: &str, artifacts_folder: &Path, version: &Version, profile: &str, with_version: bool, with_profile: bool, ) -> PathBuf

Generates a path for an artifact based on already taken paths by either cached or compiled artifacts.

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

Convert the compiler output into a set of artifacts

impl Clone for ConfigurableArtifacts

fn clone(&self) -> ConfigurableArtifacts

Returns a duplicate 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 for ConfigurableArtifacts

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

Tests for self and other values to be equal, and is used by ==.

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

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 StructuralPartialEq for ConfigurableArtifacts