feat: compilation restrictions #8668
Merged
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
|
Not sure if it's related to this or some other unreleased code, but on this branch I've noticed some behaviour where |
bowd
added a commit
to mento-protocol/mento-core
that referenced
this pull request
Aug 26, 2024
## Description As I told some of you at dinner, I've had a bad case of insomnia over the last week. This PR resulted from a couple of late night coding sessions and the incessant need to make things nicer in our repos. It's a big PR but 𝚫code is negative so 🤷 . What happens in this mondo-PR: 1. All `celo` contracts are removed form the repo and replaced with the `@celo/contracts` NPM package. With a small caveat. 2. All `interfaces` are made to work with `0.8` and cover more of the contract functions. 3. All `tests` contracts are updated to `0.8` and use `deployCode` helpers to deploy lower-version contracts, and the use the interfaces to interact with them. 4. ~We make use of this foundry-rs/foundry#8668 to improve compile time.~ 5. Update `solhint` and `prettier` to a recent version and fix/ignore all issues. 6. Fix solc compiler warnings. 7. Fix/ignore slither > informational warnings. 8. Slight Refactor of ForkTests to make them better to work with. 9. Restructuring of the tests folder. #### `@celo/contracts` The only caveat of using the `@celo/contracts` package is that `UsingRegistry.sol` in there needs to import things from `mento-core` and I didn't manage to get it working ok with remappings, so I kept a copy of `UsingRegistry.sol` in `contracts/common`. It's only used in `swap/Reserve.sol` and when we remove it from there we can completely kill `common`. #### The foundry WIP PR A better solution was found here #502, which removes the need for `via-ir` completely. ~The reason it takes so long to compile our code is because we need `via-ir` for `Airgrab.sol` and `StableTokenV2.sol`, and `via-ir` is super slow. But with the compiler restrictions implemented in foundry-rs/foundry#8668 we can have multiple compiler profile settings for subgraphs of the source-graph, which compile in parallel with different settings.~ ~You can easily install that version of foundry locally, (you have to have rust installed tho):~ ``` foundryup -P 8668 ``` ~With this version of foundry and the settings in `foundry.toml`, if you're not working in a part of the source graph that contains `Airgrab.sol` or `StableTokenV2.sol`, compilation will happen without `via-ir` and will be super snappy. However if you do touch that source graph it will still take noticeably long. Right now on my machine full clean compilation takes 80seconds. It used to take >3minutes.~ #### ForkTest Refactoring Our fork tests can get a bit heavy because they're running test assertions for all the exchanges in a single test call. I've refactor it a bit and split out exchange assertions into their own tests contracts that need to be manually created when new exchanges are deployed. There's a chain-level assertion on the number of exchanges that helps us catch this and keep them up to date. This work was continued here #503 for a much cleaner solution. ### Other changes > _Describe any minor or "drive-by" changes here._ no minor changes here, no :)) ### Tested Tested? Tested! ### Related issues Fixes the issues in my head. ### Backwards compatibility What even is that? ### Documentation Holy Bible --------- Co-authored-by: Bayological <6872903+bayological@users.noreply.github.com> Co-authored-by: chapati <philip.paetz@me.com> Co-authored-by: philbow61 <80156619+philbow61@users.noreply.github.com>
klkvr
force-pushed
the
klkvr/compilation-restrictions
branch
from
40c8e58
to
ecb767d
Compare
it doesn't. Each project file would still get compiled with either default or custom profile unless you specify |
|
Thanks for the reply. Can you please point me to the config key that can be used to dictate which artifacts would get included? |
klkvr
requested review from
grandizzy,
yash-atreya and
zerosnacks
as code owners
klkvr
changed the title
mattsse
approved these changes
Nov 18, 2024
| optimizer_runs: Option<usize>, | ||
| max_optimizer_runs: Option<usize>, | ||
|
|
||
| #[serde(default, with = "serde_helpers::display_from_str_opt")] |
There was a problem hiding this comment.
unrelated,
worth checking which of the serde_utils we'd like to have in alloy-serde
This was referenced Nov 19, 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.
Closes #6099
Closes #5715
This builds on top of foundry-rs/compilers#170 and allows the following configuration options in foundry.toml:
compilation_restrictionsallows users to configure how we compile individual files or directories. Currently accepted keys aremin_evm_version,max_evm_version,min_optimizer_runs,max_optimizer_runs,cancun. Configured restrictions apply to sources importing the restricted file as well.Once we have a set of restrictions, we need to somehow construct settings objects to satisfy them. Right now those should be constructed manually via
additional_compiler_profiles. It is configured a mapping from profile name to settings overrides. In example above we add a single profile namedvia-ir, which uses default settings withvia_irenabled, making it possible to compile a single contract undersrc/with via-ir while all other contracts, including tests are compiled with default profile.We need names for all profiles to include them into artifacts names in cases when same source file is compiled with multiple different profiles. Right now such artifacts would be named as
Counter.{profile}.json.When choosing profile, first profile (starting with default one), satisfying restrictions of the source file and all of its imports will be used.