Struct CloneArgs

pub struct CloneArgs {
    pub address: Address,
    pub root: PathBuf,
    pub no_remappings_txt: bool,
    pub keep_directory_structure: bool,
    pub etherscan: EtherscanOpts,
    pub install: DependencyInstallOpts,
}

CLI arguments for forge clone.

forge clone clones an on-chain contract from block explorers (e.g., Etherscan) in the following steps:

1. Fetch the contract source code from the block explorer.
2. Initialize a empty foundry project at the root directory specified in CloneArgs.
3. Dump the contract sources to the source directory.
4. Update the foundry.toml configuration file with the compiler settings from Etherscan.
5. Try compile the cloned contract, so that we can get the original storage layout. This original storage layout is preserved in the CloneMetadata so that if the user later modifies the contract, it is possible to quickly check the storage layout compatibility with the original on-chain contract.
6. Dump the CloneMetadata to the root directory of the cloned project as .clone.meta file.

Fields

address: Address

The contract address to clone.

root: PathBuf

The root directory of the cloned project.

no_remappings_txt: bool

Do not generate the remappings.txt file. Instead, keep the remappings in the configuration.

keep_directory_structure: bool

Keep the original directory structure collected from Etherscan.

If this flag is set, the directory structure of the cloned project will be kept as is. By default, the directory structure is re-orgnized to increase the readability, but may risk some compilation failures.

etherscan: EtherscanOpts

install: DependencyInstallOpts

Implementations

impl CloneArgs

pub async fn run(self) -> Result<()>

pub(crate) async fn collect_metadata_from_client<C: EtherscanClient>( address: Address, client: &C, ) -> Result<Metadata>

Collect the metadata of the contract from the block explorer.

• address - the address of the contract to be cloned.
• client - the client of the block explorer.

pub(crate) fn init_an_empty_project( root: &Path, install: DependencyInstallOpts, ) -> Result<()>

Initialize an empty project at the root directory.

• root - the root directory of the project.
• enable_git - whether to enable git for the project.
• quiet - whether to print messages.

pub(crate) async fn collect_compilation_metadata<C: EtherscanClient>( meta: &Metadata, chain: Chain, address: Address, root: &PathBuf, client: &C, ) -> Result<()>

Collect the compilation metadata of the cloned contract. This function compiles the cloned contract and collects the compilation metadata.

• meta - the metadata of the contract (from Etherscan).
• chain - the chain where the contract to be cloned locates.
• address - the address of the contract to be cloned.
• root - the root directory of the cloned project.
• client - the client of the block explorer.

pub(crate) async fn parse_metadata( meta: &Metadata, chain: Chain, root: &PathBuf, no_remappings_txt: bool, keep_directory_structure: bool, ) -> Result<()>

Download and parse the source code from Etherscan.

• chain - the chain where the contract to be cloned locates.
• address - the address of the contract to be cloned.
• root - the root directory to clone the contract into as a foundry project.
• client - the client of the block explorer.
• no_remappings_txt - whether to generate the remappings.txt file.

Trait Implementations

impl Args for CloneArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for CloneArgs

fn clone(&self) -> CloneArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for CloneArgs

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for CloneArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CloneArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CloneArgs

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

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