feat: add Sourcify support to forge clone #12900

avorylli · 2025-12-21T17:42:27Z

Summary

Adds Sourcify API support to forge clone command, allowing users to clone contracts from Sourcify in addition to Etherscan.

Changes

Added --source CLI option to choose between etherscan (default) and sourcify
Implemented SourcifyClient that implements EtherscanClient trait
Added methods to fetch contract source code and creation data from Sourcify API
Updated CloneArgs::run to support both data sources

Usage

Use Etherscan (default)

forge clone

Use Sourcify

forge clone

--source sourcify

Closes #12860

Added support for Sourcify API in `forge clone` command.

avorylli · 2025-12-21T17:54:12Z

will try fixing ci's just need to understand if i'm solving the issue the right way

zerosnacks · 2025-12-23T10:16:37Z

Hi @avorylli thanks for your PR, your approach looks good

Removed unused import of BTreeMap.

avorylli · 2025-12-23T21:07:42Z

@zerosnacks fixed CI, thanks for the review!

grandizzy

@avorylli thank you for your PR! left some things to be changed, pls have a look

grandizzy · 2025-12-24T10:01:12Z

crates/forge/src/cmd/clone.rs

+        &self,
+        address: Address,
+    ) -> std::result::Result<ContractMetadata, EtherscanError> {
+        let url = self.get_contract_url(address, "files,abi,compilation");


field name should be sources instead files: "sources,abi,compilation"

grandizzy · 2025-12-24T10:07:15Z

crates/forge/src/cmd/clone.rs

+        address: Address,
+    ) -> std::result::Result<ContractMetadata, EtherscanError> {
+        let url = self.get_contract_url(address, "files,abi,compilation");
+        let response = self.client.get(&url).send().await?;


let's trace response here to better debug

grandizzy · 2025-12-24T10:12:36Z

crates/forge/src/cmd/clone.rs

+        let response = self.client.get(&url).send().await?;
+
+        let status = response.status();
+        match status.as_u16() {


can match on reqwest constants, e.g.

match response.status() { StatusCode::NOT_FOUND => return Err(EtherscanError::ContractCodeNotVerified(address)), StatusCode::TOO_MANY_REQUESTS => return Err(EtherscanError::RateLimitExceeded), }

also not sure sourcify can rate limit, but maybe OK to keep

grandizzy · 2025-12-24T10:17:56Z

crates/forge/src/cmd/clone.rs

+    error_id: String,
+}
+
+impl EtherscanClient for SourcifyClient {


let's rename EtherscanClient trait to ExplorerClient and have impl ExplorerClient for Client / impl ExplorerClient for SourcifyClient

grandizzy · 2025-12-24T10:20:32Z

crates/forge/src/cmd/clone.rs

+        Self {
+            client: reqwest::Client::new(),
+            chain,
+            base_url: "https://sourcify.dev/server".to_string(),


let's make this configurable so other explorers sourcify compatible API would work too (see

foundry/crates/verify/src/sourcify.rs

Lines 190 to 196 in c63d422

impl SourcifyVerificationProvider {

fn get_base_url(verifier_url: Option<&str>) -> Url {

// note(onbjerg): a little ugly but makes this infallible as we guarantee `SOURCIFY_URL` to

// be well formatted

Url::parse(verifier_url.unwrap_or(SOURCIFY_URL))

.unwrap_or_else(|_| Url::parse(SOURCIFY_URL).unwrap())

}

) and let's reuse the default URL constant

grandizzy · 2025-12-24T10:44:37Z

crates/forge/src/cmd/clone.rs

+    #[serde(default)]
+    name: String,
+    #[serde(default)]
+    settings: Option<serde_json::Value>,


this should be compiler_settings see https://sourcify.dev/server/v2/contract/1/0xDb53f47aC61FE54F456A4eb3E09832D08Dd7BEec?fields=sources,abi,compilation for a full response example

grandizzy · 2025-12-24T10:46:47Z

crates/forge/src/cmd/clone.rs

+            )));
+        }
+
+        let response_data: SourcifyContractResponse = response.json().await?;


this doesn't properly deserialize, you can test with forge clone --source sourcify 0xDb53f47aC61FE54F456A4eb3E09832D08Dd7BEec. Let's also add this as a test similar to etherscan tests here

foundry/crates/forge/tests/cli/cmd.rs

Lines 698 to 815 in c63d422

// checks that clone works

forgetest!(can_clone, |prj, cmd| {

prj.wipe();

let foundry_toml = prj.root().join(Config::FILE_NAME);

assert!(!foundry_toml.exists());

cmd.args([

"clone",

"--etherscan-api-key",

next_etherscan_api_key().as_str(),

"0x044b75f554b886A065b9567891e45c79542d7357",

])

.arg(prj.root())

.assert_success()

.stdout_eq(str![[r#"

Downloading the source code of 0x044b75f554b886A065b9567891e45c79542d7357 from Etherscan...

Initializing [..]...

Installing forge-std in [..] (url: https://github.com/foundry-rs/forge-std, tag: None)

Installed forge-std[..]

Initialized forge project

Collecting the creation information of 0x044b75f554b886A065b9567891e45c79542d7357 from Etherscan...

[COMPILING_FILES] with [SOLC_VERSION]

[SOLC_VERSION] [ELAPSED]

Compiler run successful!

"#]]);

let s = read_string(&foundry_toml);

let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;

});

// Checks that quiet mode does not print anything for clone

forgetest!(can_clone_quiet, |prj, cmd| {

prj.wipe();

cmd.args([

"clone",

"--etherscan-api-key",

next_etherscan_api_key().as_str(),

"--quiet",

"0xDb53f47aC61FE54F456A4eb3E09832D08Dd7BEec",

])

.arg(prj.root())

.assert_empty_stdout();

});

// checks that clone works with --no-remappings-txt

forgetest!(can_clone_no_remappings_txt, |prj, cmd| {

prj.wipe();

let foundry_toml = prj.root().join(Config::FILE_NAME);

assert!(!foundry_toml.exists());

cmd.args([

"clone",

"--etherscan-api-key",

next_etherscan_api_key().as_str(),

"--no-remappings-txt",

"0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf",

])

.arg(prj.root())

.assert_success()

.stdout_eq(str![[r#"

Downloading the source code of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from Etherscan...

Initializing [..]...

Installing forge-std in [..] (url: https://github.com/foundry-rs/forge-std, tag: None)

Installed forge-std[..]

Initialized forge project

Collecting the creation information of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from Etherscan...

[COMPILING_FILES] with [SOLC_VERSION]

[SOLC_VERSION] [ELAPSED]

Compiler run successful!

"#]]);

let s = read_string(&foundry_toml);

let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;

});

// checks that clone works with --keep-directory-structure

forgetest!(can_clone_keep_directory_structure, |prj, cmd| {

prj.wipe();

let foundry_toml = prj.root().join(Config::FILE_NAME);

assert!(!foundry_toml.exists());

let output = cmd

.forge_fuse()

.args([

"clone",

"--etherscan-api-key",

next_etherscan_api_key().as_str(),

"--keep-directory-structure",

"0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf",

])

.arg(prj.root())

.assert_success()

.get_output()

.stdout_lossy();

if output.contains("502 Bad Gateway") {

// etherscan nginx proxy issue, skip this test:

//

// stdout:

// Downloading the source code of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from

// Etherscan... 2024-07-05T11:40:11.801765Z ERROR etherscan: Failed to deserialize

// response: expected value at line 1 column 1 res="<html>\r\n<head><title>502 Bad

// Gateway</title></head>\r\n<body>\r\n<center><h1>502 Bad

// Gateway</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n"

eprintln!("Skipping test due to 502 Bad Gateway");

return;

}

let s = read_string(&foundry_toml);

let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;

});

Add test for cloning with sourcify source

Updated the Sourcify client to cache creation data and reuse it across API calls, improving efficiency. Modified the contract source code retrieval to include additional creation data fields.

Refactor contract source code and creation data retrieval to use fallback values when API requests fail or fields are unavailable.

Updated contract_source_code to include additional fields in the API request and improved caching of creation data. Removed fallback logic for fetching creation data from the API.

Removed redundant creation_data initialization and caching.

Integrate Sourcify API for contract cloning

84e6d0f

Added support for Sourcify API in `forge clone` command.

avorylli requested review from 0xrusowsky, DaniPopes, grandizzy, mattsse, onbjerg and zerosnacks as code owners December 21, 2025 17:42

github-project-automation bot added this to Foundry Dec 21, 2025

avorylli added 3 commits December 23, 2025 22:44

Add reqwest dependency with json feature

724f36e

Remove unused import in clone.rs

8841b6a

Removed unused import of BTreeMap.

Merge branch 'master' into feat/forge-clone-sourcify

47a0182

grandizzy requested changes Dec 24, 2025

View reviewed changes

avorylli added 13 commits December 25, 2025 09:30

Refactor EtherscanClient to ExplorerClient

21bde3c

Change sourcify module from private to public

9f6d6a7

Implement test for sourcify clone functionality

cbe7a9d

Add test for cloning with sourcify source

Merge branch 'master' into feat/forge-clone-sourcify

7ace946

Update clone.rs

cd1bc3c

Add url dependency to Cargo.toml

1a0f342

cargo fmt

77a8eca

Enhance Sourcify client with cached creation data

420c88f

Updated the Sourcify client to cache creation data and reuse it across API calls, improving efficiency. Modified the contract source code retrieval to include additional creation data fields.

Improve error handling for contract data retrieval

6990646

Refactor contract source code and creation data retrieval to use fallback values when API requests fail or fields are unavailable.

Enhance contract_source_code with improved caching

f4a5ae6

Updated contract_source_code to include additional fields in the API request and improved caching of creation data. Removed fallback logic for fetching creation data from the API.

Refactor creation_data handling in clone.rs

939ce09

Removed redundant creation_data initialization and caching.

Refactor response deserialization to use untagged enum

ba4cfa4

Merge branch 'master' into feat/forge-clone-sourcify

908842e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add Sourcify support to forge clone #12900

feat: add Sourcify support to forge clone #12900

avorylli commented Dec 21, 2025

Uh oh!

avorylli commented Dec 21, 2025

Uh oh!

zerosnacks commented Dec 23, 2025

Uh oh!

avorylli commented Dec 23, 2025

Uh oh!

grandizzy left a comment

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

grandizzy Dec 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	impl SourcifyVerificationProvider {
	fn get_base_url(verifier_url: Option<&str>) -> Url {
	// note(onbjerg): a little ugly but makes this infallible as we guarantee `SOURCIFY_URL` to
	// be well formatted
	Url::parse(verifier_url.unwrap_or(SOURCIFY_URL))
	.unwrap_or_else(\|_\| Url::parse(SOURCIFY_URL).unwrap())
	}

	// checks that clone works
	forgetest!(can_clone, \|prj, cmd\| {
	prj.wipe();

	let foundry_toml = prj.root().join(Config::FILE_NAME);
	assert!(!foundry_toml.exists());

	cmd.args([
	"clone",
	"--etherscan-api-key",
	next_etherscan_api_key().as_str(),
	"0x044b75f554b886A065b9567891e45c79542d7357",
	])
	.arg(prj.root())
	.assert_success()
	.stdout_eq(str![[r#"
	Downloading the source code of 0x044b75f554b886A065b9567891e45c79542d7357 from Etherscan...
	Initializing [..]...
	Installing forge-std in [..] (url: https://github.com/foundry-rs/forge-std, tag: None)
	Installed forge-std[..]
	Initialized forge project
	Collecting the creation information of 0x044b75f554b886A065b9567891e45c79542d7357 from Etherscan...
	[COMPILING_FILES] with [SOLC_VERSION]
	[SOLC_VERSION] [ELAPSED]
	Compiler run successful!

	"#]]);

	let s = read_string(&foundry_toml);
	let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;
	});

	// Checks that quiet mode does not print anything for clone
	forgetest!(can_clone_quiet, \|prj, cmd\| {
	prj.wipe();

	cmd.args([
	"clone",
	"--etherscan-api-key",
	next_etherscan_api_key().as_str(),
	"--quiet",
	"0xDb53f47aC61FE54F456A4eb3E09832D08Dd7BEec",
	])
	.arg(prj.root())
	.assert_empty_stdout();
	});

	// checks that clone works with --no-remappings-txt
	forgetest!(can_clone_no_remappings_txt, \|prj, cmd\| {
	prj.wipe();

	let foundry_toml = prj.root().join(Config::FILE_NAME);
	assert!(!foundry_toml.exists());

	cmd.args([
	"clone",
	"--etherscan-api-key",
	next_etherscan_api_key().as_str(),
	"--no-remappings-txt",
	"0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf",
	])
	.arg(prj.root())
	.assert_success()
	.stdout_eq(str![[r#"
	Downloading the source code of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from Etherscan...
	Initializing [..]...
	Installing forge-std in [..] (url: https://github.com/foundry-rs/forge-std, tag: None)
	Installed forge-std[..]
	Initialized forge project
	Collecting the creation information of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from Etherscan...
	[COMPILING_FILES] with [SOLC_VERSION]
	[SOLC_VERSION] [ELAPSED]
	Compiler run successful!

	"#]]);

	let s = read_string(&foundry_toml);
	let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;
	});

	// checks that clone works with --keep-directory-structure
	forgetest!(can_clone_keep_directory_structure, \|prj, cmd\| {
	prj.wipe();

	let foundry_toml = prj.root().join(Config::FILE_NAME);
	assert!(!foundry_toml.exists());

	let output = cmd
	.forge_fuse()
	.args([
	"clone",
	"--etherscan-api-key",
	next_etherscan_api_key().as_str(),
	"--keep-directory-structure",
	"0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf",
	])
	.arg(prj.root())
	.assert_success()
	.get_output()
	.stdout_lossy();

	if output.contains("502 Bad Gateway") {
	// etherscan nginx proxy issue, skip this test:
	//
	// stdout:
	// Downloading the source code of 0x33e690aEa97E4Ef25F0d140F1bf044d663091DAf from
	// Etherscan... 2024-07-05T11:40:11.801765Z ERROR etherscan: Failed to deserialize
	// response: expected value at line 1 column 1 res="<html>\r\n<head><title>502 Bad
	// Gateway</title></head>\r\n<body>\r\n<center><h1>502 Bad
	// Gateway</h1></center>\r\n<hr><center>nginx</center>\r\n</body>\r\n</html>\r\n"

	eprintln!("Skipping test due to 502 Bad Gateway");
	return;
	}

	let s = read_string(&foundry_toml);
	let _config: BasicConfig = parse_with_profile(&s).unwrap().unwrap().1;
	});

feat: add Sourcify support to forge clone #12900

Are you sure you want to change the base?

feat: add Sourcify support to forge clone #12900

Conversation

avorylli commented Dec 21, 2025

Summary

Changes

Usage

Use Etherscan (default)

Use Sourcify

Uh oh!

avorylli commented Dec 21, 2025

Uh oh!

zerosnacks commented Dec 23, 2025

Uh oh!

avorylli commented Dec 23, 2025

Uh oh!

grandizzy left a comment

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

grandizzy Dec 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants