feat(forge): clone verified contracts as a foundry project #7576
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Forge clone
Test: fix rate limit issue for forge clone tests
Add `clone.toml` metadata to forge clone
Improve clone metadata
Add constructor arguments in the clone metadata
Troublor
commented
Apr 16, 2024
Troublor
commented
Apr 17, 2024
crates/common/src/rpc.rs
Outdated
There was a problem hiding this comment.
Following the practice of RPC endpoints in testing, I also added a list of mainnet Etherscan API keys to facilitate integrated tests that require fetching Etherscan data, e.g., forge clone. The rate limit of Etherscan API with keys should be sufficient to allow tests pass.
ZhangZhuoSJTU
force-pushed
the
forge_clone
branch
from
e034bb3
to
ee11fbf
Compare
|
Thanks for your effort @mattsse! We have future addressed some issues in tests. Could you trigger the CI test and see if this PR works? |
|
ty @Troublor I'll give this a final review tmrw |
|
There's an unusual CI test failure here, although the CI appears correctly in our repo. |
|
nice work! I'm unable to push directly to this branch for some reason, then this is g2m |
mattsse
approved these changes
Apr 18, 2024
|
@mattsse I just merged the latest commit on master branch. Sorry to interrupt the CI that you just triggered. Could you please trigger again? |
|
tysm for this! |
klkvr
pushed a commit
that referenced
this pull request
Apr 20, 2024
* feat:support forge clone * feat: update configuration based on metadate from EtherScan 👷 * doc: update the documenation for * add dump_sources function * fix: add existing remapping into remappings.txt * apply remapping on libraries * add tests * feat: update remappings in config file * add two more test cases * fix library remapping bug * test: add e2e test cases for forge clone * test: fix rate limit issue for forge clone tests * feat: disable git by default for forge clone * dump clone.toml metadata in cloned projects * add storage layout to the clone metadata * dump clone metadata in a hidden, readonly, compact json file * add constructor arguments in clone metadata * fix: typo field name * fix: bug in remapping * fix: remapping disorder for verified foundry contracts * fix clippy and fmt warnings * fmt in the foundry way * chore: restore files to be consistent with foundry fmt style * cherry pick bug fixes from tweak branch * fix: remove the dependency of Etherscan in tests * chore: move mockall to dev dependency, only mock in test build * feat: use camelCase in .clone.meta * doc: add comments to explain forge clone * fix: import file not found error * chore: remove uncessary dependency fix: fix a foundry config bug regarding generating project_paths * chore: refactor the test code a bit * Update crates/forge/bin/cmd/clone.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * Update crates/forge/bin/cmd/clone.rs Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> * chore: change string as address in CloneArg * test: add one basic forgetest for clone * feat: dump remappings into remappings.txt by default chore: break a large function into multiple small one to improve readability * feat: improve UX and make --quiet true quiet * test: add one more forgetest! for clone * fix minor issues suggested in code review * fix: incorrect assertion for project paths * test: add default etherscan api keys and remove sleep in tests * test: add more etherscan api keys * fix: revoke the unnecessary changes in config.rs * feat: bump foundry-compilers to 0.3.16 * chore: refactor code and clean some comments * fix: path disorder on windows * touchups --------- Co-authored-by: Zhuo Zhang <zhan3299@purdue.edu> Co-authored-by: Zhuo Zhang <14835483+ZhangZhuoSJTU@users.noreply.github.com> Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com> Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
This was referenced Apr 26, 2024
This was referenced Jul 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the first step of integrating on-chain contract tweak feature into foundry, as mentioned in #7575.
We introduce
forge clonecommand, which takes the address of an on-chain verified contract and creates a corresponding foundry project in the local filesystem.The foundry configuration
foundry.tomlis well generated so that the project is compilation-ready and guaranteed to generate exactly the same code as the on-chain contract.We also generate a metadata file,
.clone.meta, which contains the original address of the contract, constructor arguments, storage layout, etc, which may be useful for downstream tasks.