Skip to content

Commit d39a2da

Browse files
EvalirEvalir
committed
feat: move ethers-solc into foundry-compilers
0 parents  commit d39a2da

File tree

173 files changed

+20034
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

173 files changed

+20034
-0
lines changed

Diff for: ‎.gitignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/target
2+
/Cargo.lock
3+
4+
cache/
5+
artifacts/
6+
7+
.vscode
8+
/.envrc
9+
.idea
10+
.nlsp-settings
11+
.devenv*
12+
devenv.local.nix
13+
.direnv
14+
.pre-commit-config.yaml

Diff for: ‎Cargo.toml

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
[package]
2+
name = "foundry-compilers"
3+
authors = ["Foundry Maintainers"]
4+
version = "0.1.0"
5+
readme = "README.md"
6+
description = "Utilities for working with solidity compilers, namely solc"
7+
keywords = ["foundry", "solidity", "solc", "ethereum", "ethers"]
8+
edition = "2021"
9+
10+
[package.metadata.docs.rs]
11+
all-features = true
12+
rustdoc-args = ["--cfg", "docsrs"]
13+
14+
[package.metadata.playground]
15+
all-features = true
16+
17+
[dependencies]
18+
ethers-core = { version = "2", default-features = false }
19+
20+
solang-parser = { version = "=0.3.2", default-features = false }
21+
22+
# serde
23+
serde = { version = "1", features = ["derive", "rc"] }
24+
serde_json = "1.0"
25+
26+
# tracing
27+
tracing = "0.1.37"
28+
29+
tiny-keccak = { version = "2.0.2", default-features = false }
30+
sha2 = { version = "0.10.7", default-features = false, optional = true }
31+
md-5 = "0.10.5"
32+
33+
semver = { version = "1", features = ["serde"] }
34+
walkdir = "2.3"
35+
once_cell = "1.18"
36+
regex = "1.9"
37+
thiserror = "1.0"
38+
hex = { package = "const-hex", version = "1.6", features = ["hex"] }
39+
yansi = "0.5.1"
40+
dirs = "5.0"
41+
glob = "0.3.1"
42+
43+
44+
num_cpus = "1.16.0"
45+
dunce = "1.0"
46+
rayon = "1.7"
47+
path-slash = "0.2.1"
48+
cfg-if = "1.0.0"
49+
50+
tempfile = { version = "3.8.0", optional = true }
51+
fs_extra = { version = "1.3.0", optional = true }
52+
rand = { version = "0.8", optional = true }
53+
futures-util = { version = "0.3.28", optional = true }
54+
55+
[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
56+
home = "0.5.5"
57+
svm = { package = "svm-rs", version = "0.3", default-features = false, features = [
58+
"blocking",
59+
], optional = true }
60+
svm-builds = { package = "svm-rs-builds", version = "0.2", optional = true }
61+
tokio = { version = "1.32", features = ["rt-multi-thread"] }
62+
63+
[dev-dependencies]
64+
criterion = { version = "0.5", features = ["async_tokio"] }
65+
env_logger = "0.10.0"
66+
tracing-subscriber = { version = "0.3.17", default-features = false, features = ["env-filter", "fmt"] }
67+
rand = "0.8"
68+
pretty_assertions = "1"
69+
tempfile = "3.8"
70+
serde_path_to_error = "0.1"
71+
tokio = { version = "1.32", features = ["rt-multi-thread", "macros"] }
72+
73+
[[bench]]
74+
name = "compile_many"
75+
harness = false
76+
77+
[[bench]]
78+
name = "read_all"
79+
required-features = ["project-util"]
80+
harness = false
81+
82+
[[test]]
83+
name = "project"
84+
path = "tests/project.rs"
85+
required-features = ["full", "project-util"]
86+
87+
[[test]]
88+
name = "mocked"
89+
path = "tests/mocked.rs"
90+
required-features = ["full", "project-util"]
91+
92+
[features]
93+
default = ["rustls"]
94+
95+
full = ["async", "svm-solc"]
96+
97+
async = ["tokio/process", "tokio/io-util", "tokio/fs", "tokio/time", "futures-util"]
98+
svm-solc = ["svm", "svm-builds", "sha2"]
99+
100+
# Utilities for creating and testing project workspaces
101+
project-util = ["tempfile", "fs_extra", "rand"]
102+
103+
tests = []
104+
rustls = ["svm?/rustls"]
105+
openssl = ["svm?/openssl"]

Diff for: ‎LICENSE-APACHE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

Diff for: ‎LICENSE-MIT

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2020 Georgios Konstantopoulos
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

Diff for: ‎README.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# foundry-compilers
2+
3+
Utilities for working with native `solc` and compiling projects.
4+
5+
To also compile contracts during `cargo build` (so that ethers `abigen!` can pull in updated abi automatically) you can configure a `foundry_compilers::Project` in your `build.rs` file
6+
7+
First add `ethers-solc` to your cargo build-dependencies.
8+
9+
Once you compiled the project, you can configure cargo change detection with `rerun_if_sources_changed`, so that cargo will execute the `build.rs` file if a contract in the sources directory has changed
10+
11+
```toml
12+
[build-dependencies]
13+
ethers-solc = { git = "https://github.com/gakonst/ethers-rs" }
14+
```
15+
16+
```rust
17+
use foundry_compilers::{Project, ProjectPathsConfig};
18+
19+
fn main() {
20+
// configure the project with all its paths, solc, cache etc.
21+
let project = Project::builder()
22+
.paths(ProjectPathsConfig::hardhat(env!("CARGO_MANIFEST_DIR")).unwrap())
23+
.build()
24+
.unwrap();
25+
let output = project.compile().unwrap();
26+
27+
// Tell Cargo that if a source file changes, to rerun this build script.
28+
project.rerun_if_sources_changed();
29+
}
30+
```

Diff for: ‎benches/compile_many.rs

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
//! compile many benches
2+
#[macro_use]
3+
extern crate criterion;
4+
5+
use criterion::Criterion;
6+
use foundry_compilers::{CompilerInput, Solc};
7+
use std::path::Path;
8+
9+
fn compile_many_benchmark(c: &mut Criterion) {
10+
let inputs = load_compiler_inputs();
11+
let solc = Solc::default();
12+
13+
let mut group = c.benchmark_group("compile many");
14+
group.sample_size(10);
15+
group.bench_function("sequential", |b| {
16+
b.iter(|| {
17+
for i in inputs.iter() {
18+
let _ = solc.compile(i).unwrap();
19+
}
20+
});
21+
});
22+
23+
#[cfg(feature = "full")]
24+
{
25+
let tasks = inputs.into_iter().map(|input| (Solc::default(), input)).collect::<Vec<_>>();
26+
let num = tasks.len();
27+
group.bench_function("concurrently", |b| {
28+
b.to_async(tokio::runtime::Runtime::new().unwrap()).iter(|| async {
29+
let _ = Solc::compile_many(tasks.clone(), num).await.flattened().unwrap();
30+
});
31+
});
32+
}
33+
}
34+
35+
fn load_compiler_inputs() -> Vec<CompilerInput> {
36+
let mut inputs = Vec::new();
37+
for file in std::fs::read_dir(Path::new(&env!("CARGO_MANIFEST_DIR")).join("test-data/in"))
38+
.unwrap()
39+
.take(5)
40+
{
41+
let file = file.unwrap();
42+
let input = std::fs::read_to_string(file.path()).unwrap();
43+
let input: CompilerInput = serde_json::from_str(&input).unwrap();
44+
inputs.push(input);
45+
}
46+
inputs
47+
}
48+
49+
criterion_group!(benches, compile_many_benchmark);
50+
criterion_main!(benches);

0 commit comments

Comments
 (0)