Struct Linker

pub struct Linker<'a> {
    pub root: PathBuf,
    pub contracts: ArtifactContracts<CompactContractBytecodeCow<'a>>,
}

Fields

root: PathBuf

Root of the project, used to determine whether artifact/library path can be stripped.

contracts: ArtifactContracts<CompactContractBytecodeCow<'a>>

Compilation artifacts.

Implementations

impl<'a> Linker<'a>

pub fn new( root: impl Into<PathBuf>, contracts: ArtifactContracts<CompactContractBytecodeCow<'a>>, ) -> Self

pub(crate) fn convert_artifact_id_to_lib_path( &self, id: &ArtifactId, ) -> (PathBuf, String)

Helper method to convert [ArtifactId] to the format in which libraries are stored in [Libraries] object.

Strips project root path from source file path.

pub(crate) fn find_artifact_id_by_library_path( &'a self, file: &str, name: &str, version: Option<&Version>, ) -> Option<&'a ArtifactId>

Finds an [ArtifactId] object in the given [ArtifactContracts] keys which corresponds to the library path in the form of “./path/to/Lib.sol:Lib”

Optionally accepts solc version, and if present, only compares artifacts with given version.

pub(crate) fn collect_dependencies( &'a self, target: &'a ArtifactId, deps: &mut BTreeSet<&'a ArtifactId>, ) -> Result<(), LinkerError>

Performs DFS on the graph of link references, and populates deps with all found libraries.

pub fn link_with_nonce_or_address( &'a self, libraries: Libraries, sender: Address, nonce: u64, targets: impl IntoIterator<Item = &'a ArtifactId>, ) -> Result<LinkOutput, LinkerError>

Links given artifact with either given library addresses or address computed from sender and nonce.

Each key in libraries should either be a global path or relative to project root. All remappings should be resolved.

When calling for target being an external library itself, you should check that target does not appear in libs_to_deploy to avoid deploying it twice. It may happen in cases when there is a dependency cycle including target.

pub fn link_with_create2( &'a self, libraries: Libraries, sender: Address, salt: B256, target: &'a ArtifactId, ) -> Result<LinkOutput, LinkerError>

pub fn link( &self, target: &ArtifactId, libraries: &Libraries, ) -> Result<CompactContractBytecodeCow<'a>, LinkerError>

Links given artifact with given libraries.

pub fn get_linked_artifacts( &self, libraries: &Libraries, ) -> Result<ArtifactContracts, LinkerError>

pub fn get_linked_artifacts_cow( &self, libraries: &Libraries, ) -> Result<ArtifactContracts<CompactContractBytecodeCow<'a>>, LinkerError>

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: 48 bytes