mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-22 21:57:58 +00:00
Compare commits
63 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e7ebe4fa2f | |||
| 5c957e5ac1 | |||
| a0248b58f3 | |||
| 6a9acea748 | |||
| c31c7d94f9 | |||
| 589a5dc988 | |||
| dcc43d4ea6 | |||
| cb13c3c2cd | |||
| 7cda3416f0 | |||
| d7bc4f1fab | |||
| b6db597a57 | |||
| d7136d9a3d | |||
| c6d55515be | |||
| a9970eb2bb | |||
| e5a3f0aee9 | |||
| 3cdf57f7c3 | |||
| dab8ffe520 | |||
| c913a8222f | |||
| c8cef4834f | |||
| ca59a1f6a9 | |||
| adc0c44cde | |||
| 811e17136b | |||
| 2259942363 | |||
| 0b97d7dc29 | |||
| 2bee2d5c8b | |||
| 854e8d9690 | |||
| ba32bad6b3 | |||
| bb754cba4f | |||
| c858bbe66d | |||
| 906878f06a | |||
| 9a71369e8a | |||
| 84ab873b46 | |||
| 2ef6f7ba63 | |||
| 38e6140a7c | |||
| ca6c5529e2 | |||
| 038a2db53c | |||
| 2d517784dd | |||
| baa11ad28f | |||
| c2e65f9e33 | |||
| 14888f9767 | |||
| 3e99d1c2a5 | |||
| 4e234aa1bd | |||
| b204de5484 | |||
| 5eb3a0e1b5 | |||
| 772bd217c3 | |||
| 0513a4befb | |||
| de7c7d6703 | |||
| 3a537c2812 | |||
| 4ab79ed97e | |||
| ee97b62e70 | |||
| e9b5a06aec | |||
| 534170db6f | |||
| 090b56c46a | |||
| 547563e718 | |||
| c8eb8cf7b0 | |||
| 3b26e1e1d6 | |||
| 1bc20d088f | |||
| 10bfaed461 | |||
| 399f7820cd | |||
| ae1174febe | |||
| 38b42560ec | |||
| 8009f5880c | |||
| c590fa7bfd |
@@ -0,0 +1,147 @@
|
|||||||
|
name: Test workflow
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
types: [opened, synchronize]
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
env:
|
||||||
|
CARGO_TERM_COLOR: always
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
cache-polkadot:
|
||||||
|
name: Build and cache Polkadot binaries on ${{ matrix.os }}
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-24.04, macos-14]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repo and submodules
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
submodules: recursive
|
||||||
|
|
||||||
|
- name: Install dependencies (Linux)
|
||||||
|
if: matrix.os == 'ubuntu-24.04'
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y protobuf-compiler clang libclang-dev
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
rustup component add rust-src
|
||||||
|
|
||||||
|
- name: Install dependencies (macOS)
|
||||||
|
if: matrix.os == 'macos-14'
|
||||||
|
run: |
|
||||||
|
brew install protobuf
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
rustup component add rust-src
|
||||||
|
|
||||||
|
- name: Cache binaries
|
||||||
|
id: cache
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/bin/substrate-node
|
||||||
|
~/.cargo/bin/eth-rpc
|
||||||
|
key: polkadot-binaries-${{ matrix.os }}-${{ hashFiles('polkadot-sdk/.git') }}
|
||||||
|
|
||||||
|
- name: Build substrate-node
|
||||||
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
cd polkadot-sdk
|
||||||
|
cargo install --locked --force --profile=production --path substrate/bin/node/cli --bin substrate-node --features cli
|
||||||
|
|
||||||
|
- name: Build eth-rpc
|
||||||
|
if: steps.cache.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
cd polkadot-sdk
|
||||||
|
cargo install --path substrate/frame/revive/rpc --bin eth-rpc
|
||||||
|
|
||||||
|
ci:
|
||||||
|
name: CI on ${{ matrix.os }}
|
||||||
|
needs: cache-polkadot
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
os: [ubuntu-24.04, macos-14]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repo
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Restore binaries from cache
|
||||||
|
uses: actions/cache@v3
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.cargo/bin/substrate-node
|
||||||
|
~/.cargo/bin/eth-rpc
|
||||||
|
key: polkadot-binaries-${{ matrix.os }}-${{ hashFiles('polkadot-sdk/.git') }}
|
||||||
|
|
||||||
|
- name: Setup Rust toolchain
|
||||||
|
uses: actions-rust-lang/setup-rust-toolchain@v1
|
||||||
|
with:
|
||||||
|
rustflags: ""
|
||||||
|
|
||||||
|
- name: Add wasm32 target
|
||||||
|
run: |
|
||||||
|
rustup target add wasm32-unknown-unknown
|
||||||
|
rustup component add rust-src
|
||||||
|
|
||||||
|
- name: Install Geth on Ubuntu
|
||||||
|
if: matrix.os == 'ubuntu-24.04'
|
||||||
|
run: |
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y protobuf-compiler
|
||||||
|
|
||||||
|
# We were facing some issues in CI with the 1.16.* versions of geth, and specifically on
|
||||||
|
# Ubuntu. Eventually, we found out that the last version of geth that worked in our CI was
|
||||||
|
# version 1.15.11. Thus, this is the version that we want to use in CI. The PPA sadly does
|
||||||
|
# not have historic versions of Geth and therefore we need to resort to downloading pre
|
||||||
|
# built binaries for Geth and the surrounding tools which is what the following parts of
|
||||||
|
# the script do.
|
||||||
|
|
||||||
|
sudo apt-get install -y wget ca-certificates tar
|
||||||
|
ARCH=$(uname -m)
|
||||||
|
if [ "$ARCH" = "x86_64" ]; then
|
||||||
|
URL="https://gethstore.blob.core.windows.net/builds/geth-alltools-linux-amd64-1.15.11-36b2371c.tar.gz"
|
||||||
|
elif [ "$ARCH" = "aarch64" ]; then
|
||||||
|
URL="https://gethstore.blob.core.windows.net/builds/geth-alltools-linux-arm64-1.15.11-36b2371c.tar.gz"
|
||||||
|
else
|
||||||
|
echo "Unsupported architecture: $ARCH"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
wget -qO- "$URL" | sudo tar xz -C /usr/local/bin --strip-components=1
|
||||||
|
geth --version
|
||||||
|
|
||||||
|
- name: Install Geth on macOS
|
||||||
|
if: matrix.os == 'macos-14'
|
||||||
|
run: |
|
||||||
|
brew tap ethereum/ethereum
|
||||||
|
brew install ethereum protobuf
|
||||||
|
|
||||||
|
- name: Machete
|
||||||
|
uses: bnjbvr/cargo-machete@v0.7.1
|
||||||
|
|
||||||
|
- name: Format
|
||||||
|
run: make format
|
||||||
|
|
||||||
|
- name: Clippy
|
||||||
|
run: make clippy
|
||||||
|
|
||||||
|
- name: Check substrate-node version
|
||||||
|
run: substrate-node --version
|
||||||
|
|
||||||
|
- name: Check eth-rpc version
|
||||||
|
run: eth-rpc --version
|
||||||
|
|
||||||
|
- name: Test cargo workspace
|
||||||
|
run: make test
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
/target
|
||||||
|
.vscode/
|
||||||
|
.DS_Store
|
||||||
|
node_modules
|
||||||
|
/*.json
|
||||||
|
|
||||||
|
# We do not want to commit any log files that we produce from running the code locally so this is
|
||||||
|
# added to the .gitignore file.
|
||||||
|
*.log
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
[submodule "polkadot-sdk"]
|
||||||
|
path = polkadot-sdk
|
||||||
|
url = https://github.com/paritytech/polkadot-sdk.git
|
||||||
Generated
+6325
File diff suppressed because it is too large
Load Diff
+82
@@ -0,0 +1,82 @@
|
|||||||
|
[workspace]
|
||||||
|
resolver = "2"
|
||||||
|
members = ["crates/*"]
|
||||||
|
|
||||||
|
[workspace.package]
|
||||||
|
version = "0.1.0"
|
||||||
|
authors = ["Parity Technologies <admin@parity.io>"]
|
||||||
|
license = "MIT/Apache-2.0"
|
||||||
|
edition = "2024"
|
||||||
|
repository = "https://github.com/paritytech/revive-differential-testing.git"
|
||||||
|
rust-version = "1.85.0"
|
||||||
|
|
||||||
|
[workspace.dependencies]
|
||||||
|
revive-dt-compiler = { version = "0.1.0", path = "crates/compiler" }
|
||||||
|
revive-dt-config = { version = "0.1.0", path = "crates/config" }
|
||||||
|
revive-dt-core = { version = "0.1.0", path = "crates/core" }
|
||||||
|
revive-dt-format = { version = "0.1.0", path = "crates/format" }
|
||||||
|
revive-dt-node = { version = "0.1.0", path = "crates/node" }
|
||||||
|
revive-dt-node-interaction = { version = "0.1.0", path = "crates/node-interaction" }
|
||||||
|
revive-dt-node-pool = { version = "0.1.0", path = "crates/node-pool" }
|
||||||
|
revive-dt-report = { version = "0.1.0", path = "crates/report" }
|
||||||
|
revive-dt-solc-binaries = { version = "0.1.0", path = "crates/solc-binaries" }
|
||||||
|
|
||||||
|
alloy-primitives = "1.2.1"
|
||||||
|
alloy-sol-types = "1.2.1"
|
||||||
|
anyhow = "1.0"
|
||||||
|
clap = { version = "4", features = ["derive"] }
|
||||||
|
futures = { version = "0.3.31" }
|
||||||
|
hex = "0.4.3"
|
||||||
|
reqwest = { version = "0.12.15", features = ["blocking", "json"] }
|
||||||
|
once_cell = "1.21"
|
||||||
|
rayon = { version = "1.10" }
|
||||||
|
semver = { version = "1.0", features = ["serde"] }
|
||||||
|
serde = { version = "1.0", default-features = false, features = ["derive"] }
|
||||||
|
serde_json = { version = "1.0", default-features = false, features = [
|
||||||
|
"arbitrary_precision",
|
||||||
|
"std",
|
||||||
|
] }
|
||||||
|
sha2 = { version = "0.10.9" }
|
||||||
|
sp-core = "36.1.0"
|
||||||
|
sp-runtime = "41.1.0"
|
||||||
|
temp-dir = { version = "0.1.16" }
|
||||||
|
tempfile = "3.3"
|
||||||
|
tokio = { version = "1", default-features = false, features = [
|
||||||
|
"rt-multi-thread",
|
||||||
|
] }
|
||||||
|
uuid = { version = "1.8", features = ["v4"] }
|
||||||
|
tracing = "0.1.41"
|
||||||
|
tracing-subscriber = { version = "0.3.19", default-features = false, features = [
|
||||||
|
"fmt",
|
||||||
|
"json",
|
||||||
|
"env-filter",
|
||||||
|
] }
|
||||||
|
indexmap = { version = "2.10.0", default-features = false }
|
||||||
|
|
||||||
|
# revive compiler
|
||||||
|
revive-solc-json-interface = { git = "https://github.com/paritytech/revive", rev = "3389865af7c3ff6f29a586d82157e8bc573c1a8e" }
|
||||||
|
revive-common = { git = "https://github.com/paritytech/revive", rev = "3389865af7c3ff6f29a586d82157e8bc573c1a8e" }
|
||||||
|
revive-differential = { git = "https://github.com/paritytech/revive", rev = "3389865af7c3ff6f29a586d82157e8bc573c1a8e" }
|
||||||
|
|
||||||
|
[workspace.dependencies.alloy]
|
||||||
|
version = "1.0.22"
|
||||||
|
default-features = false
|
||||||
|
features = [
|
||||||
|
"json-abi",
|
||||||
|
"providers",
|
||||||
|
"provider-ipc",
|
||||||
|
"provider-debug-api",
|
||||||
|
"reqwest",
|
||||||
|
"rpc-types",
|
||||||
|
"signer-local",
|
||||||
|
"std",
|
||||||
|
"network",
|
||||||
|
"serde",
|
||||||
|
"rpc-types-eth",
|
||||||
|
"genesis",
|
||||||
|
]
|
||||||
|
|
||||||
|
[profile.bench]
|
||||||
|
inherits = "release"
|
||||||
|
lto = true
|
||||||
|
codegen-units = 1
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
.PHONY: format clippy test machete
|
||||||
|
|
||||||
|
format:
|
||||||
|
cargo fmt --all -- --check
|
||||||
|
|
||||||
|
clippy:
|
||||||
|
cargo clippy --all-features --workspace -- --deny warnings
|
||||||
|
|
||||||
|
machete:
|
||||||
|
cargo install cargo-machete
|
||||||
|
cargo machete crates
|
||||||
|
|
||||||
|
test: format clippy machete
|
||||||
|
cargo test --workspace -- --nocapture
|
||||||
|
|
||||||
@@ -1,2 +1,34 @@
|
|||||||
# revive-differential-tests
|
# revive-differential-tests
|
||||||
revive differential testing framework
|
|
||||||
|
The revive differential testing framework allows to define smart contract tests in a declarative manner in order to compile and execute them against different Ethereum-compatible blockchain implmentations. This is useful to:
|
||||||
|
- Analyze observable differences in contract compilation and execution across different blockchain implementations, including contract storage, account balances, transaction output and emitted events on a per-transaction base.
|
||||||
|
- Collect and compare benchmark metrics such as code size, gas usage or transaction throughput per seconds (TPS) of different blockchain implementations.
|
||||||
|
- Ensure reproducible contract builds across multiple compiler implementations or multiple host platforms.
|
||||||
|
- Implement end-to-end regression tests for Ethereum-compatible smart contract stacks.
|
||||||
|
|
||||||
|
# Declarative test format
|
||||||
|
|
||||||
|
For now, the format used to write tests is the [matter-labs era compiler format](https://github.com/matter-labs/era-compiler-tests?tab=readme-ov-file#matter-labs-simplecomplex-format). This allows us to re-use many tests from their corpora.
|
||||||
|
|
||||||
|
# The `retester` utility
|
||||||
|
|
||||||
|
The `retester` helper utilty is used to run the tests. To get an idea of what `retester` can do, please consults its command line help:
|
||||||
|
|
||||||
|
```
|
||||||
|
cargo run -p revive-dt-core -- --help
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, to run the [complex Solidity tests](https://github.com/matter-labs/era-compiler-tests/tree/main/solidity/complex), define a corpus structure as follows:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "ML Solidity Complex",
|
||||||
|
"path": "/path/to/era-compiler-tests/solidity/complex"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Assuming this to be saved in a `ml-solidity-complex.json` file, the following command will try to compile and execute the tests found inside the corpus:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
RUST_LOG=debug cargo r --release -p revive-dt-core -- --corpus ml-solidity-complex.json
|
||||||
|
```
|
||||||
|
|||||||
@@ -0,0 +1,326 @@
|
|||||||
|
{
|
||||||
|
"modes": [
|
||||||
|
"Y >=0.8.9",
|
||||||
|
"E",
|
||||||
|
"I"
|
||||||
|
],
|
||||||
|
"cases": [
|
||||||
|
{
|
||||||
|
"name": "first",
|
||||||
|
"inputs": [
|
||||||
|
{
|
||||||
|
"instance": "WBTC_1",
|
||||||
|
"method": "#deployer",
|
||||||
|
"calldata": [
|
||||||
|
"0x40",
|
||||||
|
"0x80",
|
||||||
|
"4",
|
||||||
|
"0x5742544300000000000000000000000000000000000000000000000000000000",
|
||||||
|
"14",
|
||||||
|
"0x5772617070656420425443000000000000000000000000000000000000000000"
|
||||||
|
],
|
||||||
|
"expected": [
|
||||||
|
"WBTC_1.address"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "WBTC_2",
|
||||||
|
"method": "#deployer",
|
||||||
|
"calldata": [
|
||||||
|
"0x40",
|
||||||
|
"0x80",
|
||||||
|
"4",
|
||||||
|
"0x5742544300000000000000000000000000000000000000000000000000000000",
|
||||||
|
"14",
|
||||||
|
"0x5772617070656420425443000000000000000000000000000000000000000000"
|
||||||
|
],
|
||||||
|
"expected": [
|
||||||
|
"WBTC_2.address"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "Mooniswap",
|
||||||
|
"method": "#deployer",
|
||||||
|
"calldata": [
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000060",
|
||||||
|
"0x00000000000000000000000000000000000000000000000000000000000000c0",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000100",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000002",
|
||||||
|
"WBTC_1.address",
|
||||||
|
"WBTC_2.address",
|
||||||
|
"4",
|
||||||
|
"0x5742544300000000000000000000000000000000000000000000000000000000",
|
||||||
|
"14",
|
||||||
|
"0x5772617070656420425443000000000000000000000000000000000000000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e0",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"0xdeadbeef01000000000000000000000000000000"
|
||||||
|
],
|
||||||
|
"values": []
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "WBTC_1",
|
||||||
|
"method": "_mint",
|
||||||
|
"calldata": [
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"1000000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"1000000000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "WBTC_2",
|
||||||
|
"method": "_mint",
|
||||||
|
"calldata": [
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"1000000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"1000000000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "WBTC_1",
|
||||||
|
"caller": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"method": "approve",
|
||||||
|
"calldata": [
|
||||||
|
"Mooniswap.address",
|
||||||
|
"500000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000001"
|
||||||
|
],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"500000000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "WBTC_2",
|
||||||
|
"caller": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"method": "approve",
|
||||||
|
"calldata": [
|
||||||
|
"Mooniswap.address",
|
||||||
|
"500000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000001"
|
||||||
|
],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"500000000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "Mooniswap",
|
||||||
|
"caller": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"method": "deposit",
|
||||||
|
"calldata": [
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000040",
|
||||||
|
"0x00000000000000000000000000000000000000000000000000000000000000a0",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000002",
|
||||||
|
"10000000",
|
||||||
|
"10000000",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000002",
|
||||||
|
"1000000",
|
||||||
|
"1000000"
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [
|
||||||
|
"10000000"
|
||||||
|
],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"1000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"10000000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"490000000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"10000000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"490000000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"10000000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x2da466a7b24304f47e87fa2e1e5a81b9831ce54fec19055ce277ca2f39ba42c4",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"10000000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"instance": "Mooniswap",
|
||||||
|
"caller": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"method": "swap",
|
||||||
|
"calldata": [
|
||||||
|
"WBTC_1.address",
|
||||||
|
"WBTC_2.address",
|
||||||
|
"5000",
|
||||||
|
"5000",
|
||||||
|
"0"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"expected": {
|
||||||
|
"return_data": [
|
||||||
|
"5000"
|
||||||
|
],
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"5000"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"topics": [
|
||||||
|
"0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
|
||||||
|
"0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"Mooniswap.address"
|
||||||
|
],
|
||||||
|
"values": [
|
||||||
|
"489995000"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"exception": false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"contracts": {
|
||||||
|
"Mooniswap": "Mooniswap.sol:Mooniswap",
|
||||||
|
"WBTC_1": "ERC20/ERC20.sol:ERC20",
|
||||||
|
"WBTC_2": "ERC20/ERC20.sol:ERC20",
|
||||||
|
"VirtualBalance": "Mooniswap.sol:VirtualBalance",
|
||||||
|
"Math": "math/Math.sol:Math"
|
||||||
|
},
|
||||||
|
"libraries": {
|
||||||
|
"Mooniswap.sol": {
|
||||||
|
"VirtualBalance": "VirtualBalance"
|
||||||
|
},
|
||||||
|
"math/Math.sol": {
|
||||||
|
"Math": "Math"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"group": "Real life"
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-compiler"
|
||||||
|
description = "Library for compiling Solidity contracts to EVM and PVM"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
revive-solc-json-interface = { workspace = true }
|
||||||
|
revive-dt-config = { workspace = true }
|
||||||
|
revive-dt-solc-binaries = { workspace = true }
|
||||||
|
revive-common = { workspace = true }
|
||||||
|
semver = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
//! This crate provides compiler helpers for all supported Solidity targets:
|
||||||
|
//! - Ethereum solc compiler
|
||||||
|
//! - Polkadot revive resolc compiler
|
||||||
|
//! - Polkadot revive Wasm compiler
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
fs::read_to_string,
|
||||||
|
hash::Hash,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
};
|
||||||
|
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
|
||||||
|
use revive_common::EVMVersion;
|
||||||
|
use revive_solc_json_interface::{
|
||||||
|
SolcStandardJsonInput, SolcStandardJsonInputLanguage, SolcStandardJsonInputSettings,
|
||||||
|
SolcStandardJsonInputSettingsOptimizer, SolcStandardJsonInputSettingsSelection,
|
||||||
|
SolcStandardJsonOutput,
|
||||||
|
};
|
||||||
|
use semver::Version;
|
||||||
|
|
||||||
|
pub mod revive_js;
|
||||||
|
pub mod revive_resolc;
|
||||||
|
pub mod solc;
|
||||||
|
|
||||||
|
/// A common interface for all supported Solidity compilers.
|
||||||
|
pub trait SolidityCompiler {
|
||||||
|
/// Extra options specific to the compiler.
|
||||||
|
type Options: Default + PartialEq + Eq + Hash;
|
||||||
|
|
||||||
|
/// The low-level compiler interface.
|
||||||
|
fn build(
|
||||||
|
&self,
|
||||||
|
input: CompilerInput<Self::Options>,
|
||||||
|
) -> anyhow::Result<CompilerOutput<Self::Options>>;
|
||||||
|
|
||||||
|
fn new(solc_executable: PathBuf) -> Self;
|
||||||
|
|
||||||
|
fn get_compiler_executable(config: &Arguments, version: Version) -> anyhow::Result<PathBuf>;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The generic compilation input configuration.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct CompilerInput<T: PartialEq + Eq + Hash> {
|
||||||
|
pub extra_options: T,
|
||||||
|
pub input: SolcStandardJsonInput,
|
||||||
|
pub allow_paths: Vec<PathBuf>,
|
||||||
|
pub base_path: Option<PathBuf>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The generic compilation output configuration.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct CompilerOutput<T: PartialEq + Eq + Hash> {
|
||||||
|
/// The solc standard JSON input.
|
||||||
|
pub input: CompilerInput<T>,
|
||||||
|
/// The produced solc standard JSON output.
|
||||||
|
pub output: SolcStandardJsonOutput,
|
||||||
|
/// The error message in case the compiler returns abnormally.
|
||||||
|
pub error: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> PartialEq for CompilerInput<T>
|
||||||
|
where
|
||||||
|
T: PartialEq + Eq + Hash,
|
||||||
|
{
|
||||||
|
fn eq(&self, other: &Self) -> bool {
|
||||||
|
let self_input = serde_json::to_vec(&self.input).unwrap_or_default();
|
||||||
|
let other_input = serde_json::to_vec(&self.input).unwrap_or_default();
|
||||||
|
self.extra_options.eq(&other.extra_options) && self_input == other_input
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> Eq for CompilerInput<T> where T: PartialEq + Eq + Hash {}
|
||||||
|
|
||||||
|
impl<T> Hash for CompilerInput<T>
|
||||||
|
where
|
||||||
|
T: PartialEq + Eq + Hash,
|
||||||
|
{
|
||||||
|
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
|
||||||
|
self.extra_options.hash(state);
|
||||||
|
state.write(&serde_json::to_vec(&self.input).unwrap_or_default());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A generic builder style interface for configuring all compiler options.
|
||||||
|
pub struct Compiler<T: SolidityCompiler> {
|
||||||
|
input: SolcStandardJsonInput,
|
||||||
|
extra_options: T::Options,
|
||||||
|
allow_paths: Vec<PathBuf>,
|
||||||
|
base_path: Option<PathBuf>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for Compiler<solc::Solc> {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> Compiler<T>
|
||||||
|
where
|
||||||
|
T: SolidityCompiler,
|
||||||
|
{
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self {
|
||||||
|
input: SolcStandardJsonInput {
|
||||||
|
language: SolcStandardJsonInputLanguage::Solidity,
|
||||||
|
sources: Default::default(),
|
||||||
|
settings: SolcStandardJsonInputSettings::new(
|
||||||
|
None,
|
||||||
|
Default::default(),
|
||||||
|
None,
|
||||||
|
SolcStandardJsonInputSettingsSelection::new_required(),
|
||||||
|
SolcStandardJsonInputSettingsOptimizer::new(
|
||||||
|
false,
|
||||||
|
None,
|
||||||
|
&Version::new(0, 0, 0),
|
||||||
|
false,
|
||||||
|
),
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
),
|
||||||
|
},
|
||||||
|
extra_options: Default::default(),
|
||||||
|
allow_paths: Default::default(),
|
||||||
|
base_path: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn solc_optimizer(mut self, enabled: bool) -> Self {
|
||||||
|
self.input.settings.optimizer.enabled = enabled;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_source(mut self, path: &Path) -> anyhow::Result<Self> {
|
||||||
|
self.input
|
||||||
|
.sources
|
||||||
|
.insert(path.display().to_string(), read_to_string(path)?.into());
|
||||||
|
Ok(self)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn evm_version(mut self, evm_version: EVMVersion) -> Self {
|
||||||
|
self.input.settings.evm_version = Some(evm_version);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn extra_options(mut self, extra_options: T::Options) -> Self {
|
||||||
|
self.extra_options = extra_options;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn allow_path(mut self, path: PathBuf) -> Self {
|
||||||
|
self.allow_paths.push(path);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn base_path(mut self, base_path: PathBuf) -> Self {
|
||||||
|
self.base_path = Some(base_path);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn try_build(self, solc_path: PathBuf) -> anyhow::Result<CompilerOutput<T::Options>> {
|
||||||
|
T::new(solc_path).build(CompilerInput {
|
||||||
|
extra_options: self.extra_options,
|
||||||
|
input: self.input,
|
||||||
|
allow_paths: self.allow_paths,
|
||||||
|
base_path: self.base_path,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the compiler JSON input.
|
||||||
|
pub fn input(&self) -> SolcStandardJsonInput {
|
||||||
|
self.input.clone()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
//! Implements the [crate::SolidityCompiler] trait with revive Wasm for
|
||||||
|
//! compiling contracts to PVM bytecode (via Wasm).
|
||||||
@@ -0,0 +1,154 @@
|
|||||||
|
//! Implements the [SolidityCompiler] trait with `resolc` for
|
||||||
|
//! compiling contracts to PolkaVM (PVM) bytecode.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
path::PathBuf,
|
||||||
|
process::{Command, Stdio},
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
use revive_solc_json_interface::SolcStandardJsonOutput;
|
||||||
|
|
||||||
|
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct Resolc {
|
||||||
|
/// Path to the `resolc` executable
|
||||||
|
resolc_path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SolidityCompiler for Resolc {
|
||||||
|
type Options = Vec<String>;
|
||||||
|
|
||||||
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
|
fn build(
|
||||||
|
&self,
|
||||||
|
input: CompilerInput<Self::Options>,
|
||||||
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
|
let mut command = Command::new(&self.resolc_path);
|
||||||
|
command
|
||||||
|
.stdin(Stdio::piped())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::piped())
|
||||||
|
.arg("--standard-json");
|
||||||
|
|
||||||
|
if let Some(ref base_path) = input.base_path {
|
||||||
|
command.arg("--base-path").arg(base_path);
|
||||||
|
}
|
||||||
|
if !input.allow_paths.is_empty() {
|
||||||
|
command.arg("--allow-paths").arg(
|
||||||
|
input
|
||||||
|
.allow_paths
|
||||||
|
.iter()
|
||||||
|
.map(|path| path.display().to_string())
|
||||||
|
.collect::<Vec<_>>()
|
||||||
|
.join(","),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
let mut child = command.spawn()?;
|
||||||
|
|
||||||
|
let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
|
||||||
|
serde_json::to_writer(stdin_pipe, &input.input)?;
|
||||||
|
|
||||||
|
let json_in = serde_json::to_string_pretty(&input.input)?;
|
||||||
|
|
||||||
|
let output = child.wait_with_output()?;
|
||||||
|
let stdout = output.stdout;
|
||||||
|
let stderr = output.stderr;
|
||||||
|
|
||||||
|
if !output.status.success() {
|
||||||
|
let message = String::from_utf8_lossy(&stderr);
|
||||||
|
tracing::error!(
|
||||||
|
"resolc failed exit={} stderr={} JSON-in={} ",
|
||||||
|
output.status,
|
||||||
|
&message,
|
||||||
|
json_in,
|
||||||
|
);
|
||||||
|
return Ok(CompilerOutput {
|
||||||
|
input,
|
||||||
|
output: Default::default(),
|
||||||
|
error: Some(message.into()),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut parsed =
|
||||||
|
serde_json::from_slice::<SolcStandardJsonOutput>(&stdout).map_err(|e| {
|
||||||
|
anyhow::anyhow!(
|
||||||
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
|
String::from_utf8_lossy(&stderr)
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
// Detecting if the compiler output contained errors and reporting them through logs and
|
||||||
|
// errors instead of returning the compiler output that might contain errors.
|
||||||
|
for error in parsed.errors.iter().flatten() {
|
||||||
|
if error.severity == "error" {
|
||||||
|
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
||||||
|
anyhow::bail!("Encountered an error in the compilation: {error}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// We need to do some post processing on the output to make it in the same format that solc
|
||||||
|
// outputs. More specifically, for each contract, the `.metadata` field should be replaced
|
||||||
|
// with the `.metadata.solc_metadata` field which contains the ABI and other information
|
||||||
|
// about the compiled contracts. We do this because we do not want any downstream logic to
|
||||||
|
// need to differentiate between which compiler is being used when extracting the ABI of the
|
||||||
|
// contracts.
|
||||||
|
if let Some(ref mut contracts) = parsed.contracts {
|
||||||
|
for (contract_path, contracts_map) in contracts.iter_mut() {
|
||||||
|
for (contract_name, contract_info) in contracts_map.iter_mut() {
|
||||||
|
let Some(metadata) = contract_info.metadata.take() else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Get the `solc_metadata` in the metadata of the contract.
|
||||||
|
let Some(solc_metadata) = metadata
|
||||||
|
.get("solc_metadata")
|
||||||
|
.and_then(|metadata| metadata.as_str())
|
||||||
|
else {
|
||||||
|
tracing::error!(
|
||||||
|
contract_path,
|
||||||
|
contract_name,
|
||||||
|
metadata = serde_json::to_string(&metadata).unwrap(),
|
||||||
|
"Encountered a contract compiled with resolc that has no solc_metadata"
|
||||||
|
);
|
||||||
|
anyhow::bail!(
|
||||||
|
"Contract {} compiled with resolc that has no solc_metadata",
|
||||||
|
contract_name
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Replace the original metadata with the new solc_metadata.
|
||||||
|
contract_info.metadata =
|
||||||
|
Some(serde_json::Value::String(solc_metadata.to_string()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!(
|
||||||
|
output = %serde_json::to_string(&parsed).unwrap(),
|
||||||
|
"Compiled successfully"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(CompilerOutput {
|
||||||
|
input,
|
||||||
|
output: parsed,
|
||||||
|
error: None,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new(resolc_path: PathBuf) -> Self {
|
||||||
|
Resolc { resolc_path }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_compiler_executable(
|
||||||
|
config: &Arguments,
|
||||||
|
_version: semver::Version,
|
||||||
|
) -> anyhow::Result<PathBuf> {
|
||||||
|
if !config.resolc.as_os_str().is_empty() {
|
||||||
|
return Ok(config.resolc.clone());
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(PathBuf::from("resolc"))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
//! Implements the [SolidityCompiler] trait with solc for
|
||||||
|
//! compiling contracts to EVM bytecode.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
path::PathBuf,
|
||||||
|
process::{Command, Stdio},
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
use revive_dt_solc_binaries::download_solc;
|
||||||
|
use revive_solc_json_interface::SolcStandardJsonOutput;
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct Solc {
|
||||||
|
solc_path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SolidityCompiler for Solc {
|
||||||
|
type Options = ();
|
||||||
|
|
||||||
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
|
fn build(
|
||||||
|
&self,
|
||||||
|
input: CompilerInput<Self::Options>,
|
||||||
|
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
||||||
|
let mut command = Command::new(&self.solc_path);
|
||||||
|
command
|
||||||
|
.stdin(Stdio::piped())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::piped())
|
||||||
|
.arg("--standard-json");
|
||||||
|
|
||||||
|
if let Some(ref base_path) = input.base_path {
|
||||||
|
command.arg("--base-path").arg(base_path);
|
||||||
|
}
|
||||||
|
if !input.allow_paths.is_empty() {
|
||||||
|
command.arg("--allow-paths").arg(
|
||||||
|
input
|
||||||
|
.allow_paths
|
||||||
|
.iter()
|
||||||
|
.map(|path| path.display().to_string())
|
||||||
|
.collect::<Vec<_>>()
|
||||||
|
.join(","),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
let mut child = command.spawn()?;
|
||||||
|
|
||||||
|
let stdin = child.stdin.as_mut().expect("should be piped");
|
||||||
|
serde_json::to_writer(stdin, &input.input)?;
|
||||||
|
let output = child.wait_with_output()?;
|
||||||
|
|
||||||
|
if !output.status.success() {
|
||||||
|
let message = String::from_utf8_lossy(&output.stderr);
|
||||||
|
tracing::error!("solc failed exit={} stderr={}", output.status, &message);
|
||||||
|
return Ok(CompilerOutput {
|
||||||
|
input,
|
||||||
|
output: Default::default(),
|
||||||
|
error: Some(message.into()),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let parsed =
|
||||||
|
serde_json::from_slice::<SolcStandardJsonOutput>(&output.stdout).map_err(|e| {
|
||||||
|
anyhow::anyhow!(
|
||||||
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
|
String::from_utf8_lossy(&output.stdout)
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
// Detecting if the compiler output contained errors and reporting them through logs and
|
||||||
|
// errors instead of returning the compiler output that might contain errors.
|
||||||
|
for error in parsed.errors.iter().flatten() {
|
||||||
|
if error.severity == "error" {
|
||||||
|
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
||||||
|
anyhow::bail!("Encountered an error in the compilation: {error}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!(
|
||||||
|
output = %String::from_utf8_lossy(&output.stdout).to_string(),
|
||||||
|
"Compiled successfully"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(CompilerOutput {
|
||||||
|
input,
|
||||||
|
output: parsed,
|
||||||
|
error: None,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new(solc_path: PathBuf) -> Self {
|
||||||
|
Self { solc_path }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_compiler_executable(
|
||||||
|
config: &Arguments,
|
||||||
|
version: semver::Version,
|
||||||
|
) -> anyhow::Result<PathBuf> {
|
||||||
|
let path = download_solc(config.directory(), version, config.wasm)?;
|
||||||
|
Ok(path)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-config"
|
||||||
|
description = "global configuration for the revive differential tester"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
alloy = { workspace = true }
|
||||||
|
clap = { workspace = true }
|
||||||
|
semver = { workspace = true }
|
||||||
|
temp-dir = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
|
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
//! The global configuration used across all revive differential testing crates.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
fmt::Display,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::{network::EthereumWallet, signers::local::PrivateKeySigner};
|
||||||
|
use clap::{Parser, ValueEnum};
|
||||||
|
use semver::Version;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use temp_dir::TempDir;
|
||||||
|
|
||||||
|
#[derive(Debug, Parser, Clone, Serialize, Deserialize)]
|
||||||
|
#[command(name = "retester")]
|
||||||
|
pub struct Arguments {
|
||||||
|
/// The `solc` version to use if the test didn't specify it explicitly.
|
||||||
|
#[arg(long = "solc", short, default_value = "0.8.29")]
|
||||||
|
pub solc: Version,
|
||||||
|
|
||||||
|
/// Use the Wasm compiler versions.
|
||||||
|
#[arg(long = "wasm")]
|
||||||
|
pub wasm: bool,
|
||||||
|
|
||||||
|
/// The path to the `resolc` executable to be tested.
|
||||||
|
///
|
||||||
|
/// By default it uses the `resolc` binary found in `$PATH`.
|
||||||
|
///
|
||||||
|
/// If `--wasm` is set, this should point to the resolc Wasm ile.
|
||||||
|
#[arg(long = "resolc", short, default_value = "resolc")]
|
||||||
|
pub resolc: PathBuf,
|
||||||
|
|
||||||
|
/// A list of test corpus JSON files to be tested.
|
||||||
|
#[arg(long = "corpus", short)]
|
||||||
|
pub corpus: Vec<PathBuf>,
|
||||||
|
|
||||||
|
/// A place to store temporary artifacts during test execution.
|
||||||
|
///
|
||||||
|
/// Creates a temporary dir if not specified.
|
||||||
|
#[arg(long = "workdir", short)]
|
||||||
|
pub working_directory: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Add a tempdir manually if `working_directory` was not given.
|
||||||
|
///
|
||||||
|
/// We attach it here because [TempDir] prunes itself on drop.
|
||||||
|
#[clap(skip)]
|
||||||
|
#[serde(skip)]
|
||||||
|
pub temp_dir: Option<&'static TempDir>,
|
||||||
|
|
||||||
|
/// The path to the `geth` executable.
|
||||||
|
///
|
||||||
|
/// By default it uses `geth` binary found in `$PATH`.
|
||||||
|
#[arg(short, long = "geth", default_value = "geth")]
|
||||||
|
pub geth: PathBuf,
|
||||||
|
|
||||||
|
/// The maximum time in milliseconds to wait for geth to start.
|
||||||
|
#[arg(long = "geth-start-timeout", default_value = "2000")]
|
||||||
|
pub geth_start_timeout: u64,
|
||||||
|
|
||||||
|
/// The test network chain ID.
|
||||||
|
#[arg(short, long = "network-id", default_value = "420420420")]
|
||||||
|
pub network_id: u64,
|
||||||
|
|
||||||
|
/// Configure nodes according to this genesis.json file.
|
||||||
|
#[arg(long = "genesis", default_value = "genesis.json")]
|
||||||
|
pub genesis_file: PathBuf,
|
||||||
|
|
||||||
|
/// The signing account private key.
|
||||||
|
#[arg(
|
||||||
|
short,
|
||||||
|
long = "account",
|
||||||
|
default_value = "0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d"
|
||||||
|
)]
|
||||||
|
pub account: String,
|
||||||
|
|
||||||
|
/// The differential testing leader node implementation.
|
||||||
|
#[arg(short, long = "leader", default_value = "geth")]
|
||||||
|
pub leader: TestingPlatform,
|
||||||
|
|
||||||
|
/// The differential testing follower node implementation.
|
||||||
|
#[arg(short, long = "follower", default_value = "kitchensink")]
|
||||||
|
pub follower: TestingPlatform,
|
||||||
|
|
||||||
|
/// Only compile against this testing platform (doesn't execute the tests).
|
||||||
|
#[arg(long = "compile-only")]
|
||||||
|
pub compile_only: Option<TestingPlatform>,
|
||||||
|
|
||||||
|
/// Determines the amount of tests that are executed in parallel.
|
||||||
|
#[arg(long = "workers", default_value = "12")]
|
||||||
|
pub workers: usize,
|
||||||
|
|
||||||
|
/// Extract problems back to the test corpus.
|
||||||
|
#[arg(short, long = "extract-problems")]
|
||||||
|
pub extract_problems: bool,
|
||||||
|
|
||||||
|
/// The path to the `kitchensink` executable.
|
||||||
|
///
|
||||||
|
/// By default it uses `substrate-node` binary found in `$PATH`.
|
||||||
|
#[arg(short, long = "kitchensink", default_value = "substrate-node")]
|
||||||
|
pub kitchensink: PathBuf,
|
||||||
|
|
||||||
|
/// The path to the `eth_proxy` executable.
|
||||||
|
///
|
||||||
|
/// By default it uses `eth-rpc` binary found in `$PATH`.
|
||||||
|
#[arg(short = 'p', long = "eth_proxy", default_value = "eth-rpc")]
|
||||||
|
pub eth_proxy: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Arguments {
|
||||||
|
/// Return the configured working directory with the following precedence:
|
||||||
|
/// 1. `self.working_directory` if it was provided.
|
||||||
|
/// 2. `self.temp_dir` if it it was provided
|
||||||
|
/// 3. Panic.
|
||||||
|
pub fn directory(&self) -> &Path {
|
||||||
|
if let Some(path) = &self.working_directory {
|
||||||
|
return path.as_path();
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(temp_dir) = &self.temp_dir {
|
||||||
|
return temp_dir.path();
|
||||||
|
}
|
||||||
|
|
||||||
|
panic!("should have a workdir configured")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Try to parse `self.account` into a [PrivateKeySigner],
|
||||||
|
/// panicing on error.
|
||||||
|
pub fn wallet(&self) -> EthereumWallet {
|
||||||
|
let signer = self
|
||||||
|
.account
|
||||||
|
.parse::<PrivateKeySigner>()
|
||||||
|
.unwrap_or_else(|error| {
|
||||||
|
panic!("private key '{}' parsing error: {error}", self.account);
|
||||||
|
});
|
||||||
|
EthereumWallet::new(signer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for Arguments {
|
||||||
|
fn default() -> Self {
|
||||||
|
Arguments::parse_from(["retester"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The Solidity compatible node implementation.
|
||||||
|
///
|
||||||
|
/// This describes the solutions to be tested against on a high level.
|
||||||
|
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, ValueEnum, Serialize, Deserialize)]
|
||||||
|
#[clap(rename_all = "lower")]
|
||||||
|
pub enum TestingPlatform {
|
||||||
|
/// The go-ethereum reference full node EVM implementation.
|
||||||
|
Geth,
|
||||||
|
/// The kitchensink runtime provides the PolkaVM (PVM) based node implentation.
|
||||||
|
Kitchensink,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for TestingPlatform {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
Self::Geth => f.write_str("geth"),
|
||||||
|
Self::Kitchensink => f.write_str("revive"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-core"
|
||||||
|
description = "revive differential testing core utility"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[[bin]]
|
||||||
|
name = "retester"
|
||||||
|
path = "src/main.rs"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
revive-dt-compiler = { workspace = true }
|
||||||
|
revive-dt-config = { workspace = true }
|
||||||
|
revive-dt-format = { workspace = true }
|
||||||
|
revive-dt-node = { workspace = true }
|
||||||
|
revive-dt-node-interaction = { workspace = true }
|
||||||
|
revive-dt-report = { workspace = true }
|
||||||
|
|
||||||
|
alloy = { workspace = true }
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
clap = { workspace = true }
|
||||||
|
indexmap = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
tracing-subscriber = { workspace = true }
|
||||||
|
rayon = { workspace = true }
|
||||||
|
revive-solc-json-interface = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
temp-dir = { workspace = true }
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
use std::{borrow::Cow, collections::HashSet, path::PathBuf};
|
||||||
|
|
||||||
|
/// An iterator that finds files of a certain extension in the provided directory. You can think of
|
||||||
|
/// this a glob pattern similar to: `${path}/**/*.md`
|
||||||
|
pub struct FilesWithExtensionIterator {
|
||||||
|
/// The set of allowed extensions that that match the requirement and that should be returned
|
||||||
|
/// when found.
|
||||||
|
allowed_extensions: HashSet<Cow<'static, str>>,
|
||||||
|
|
||||||
|
/// The set of directories to visit next. This iterator does BFS and so these directories will
|
||||||
|
/// only be visited if we can't find any files in our state.
|
||||||
|
directories_to_search: Vec<PathBuf>,
|
||||||
|
|
||||||
|
/// The set of files matching the allowed extensions that were found. If there are entries in
|
||||||
|
/// this vector then they will be returned when the [`Iterator::next`] method is called. If not
|
||||||
|
/// then we visit one of the next directories to visit.
|
||||||
|
files_matching_allowed_extensions: Vec<PathBuf>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FilesWithExtensionIterator {
|
||||||
|
pub fn new(root_directory: PathBuf) -> Self {
|
||||||
|
Self {
|
||||||
|
allowed_extensions: Default::default(),
|
||||||
|
directories_to_search: vec![root_directory],
|
||||||
|
files_matching_allowed_extensions: Default::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_allowed_extension(
|
||||||
|
mut self,
|
||||||
|
allowed_extension: impl Into<Cow<'static, str>>,
|
||||||
|
) -> Self {
|
||||||
|
self.allowed_extensions.insert(allowed_extension.into());
|
||||||
|
self
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Iterator for FilesWithExtensionIterator {
|
||||||
|
type Item = PathBuf;
|
||||||
|
|
||||||
|
fn next(&mut self) -> Option<Self::Item> {
|
||||||
|
if let Some(file_path) = self.files_matching_allowed_extensions.pop() {
|
||||||
|
return Some(file_path);
|
||||||
|
};
|
||||||
|
|
||||||
|
let directory_to_search = self.directories_to_search.pop()?;
|
||||||
|
|
||||||
|
// Read all of the entries in the directory. If we failed to read this dir's entires then we
|
||||||
|
// elect to just ignore it and look in the next directory, we do that by calling the next
|
||||||
|
// method again on the iterator, which is an intentional decision that we made here instead
|
||||||
|
// of panicking.
|
||||||
|
let Ok(dir_entries) = std::fs::read_dir(directory_to_search) else {
|
||||||
|
return self.next();
|
||||||
|
};
|
||||||
|
|
||||||
|
for entry in dir_entries.flatten() {
|
||||||
|
let entry_path = entry.path();
|
||||||
|
if entry_path.is_dir() {
|
||||||
|
self.directories_to_search.push(entry_path)
|
||||||
|
} else if entry_path.is_file()
|
||||||
|
&& entry_path.extension().is_some_and(|ext| {
|
||||||
|
self.allowed_extensions
|
||||||
|
.iter()
|
||||||
|
.any(|allowed| ext.eq_ignore_ascii_case(allowed.as_ref()))
|
||||||
|
})
|
||||||
|
{
|
||||||
|
self.files_matching_allowed_extensions.push(entry_path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
self.next()
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,47 @@
|
|||||||
|
//! The revive differential testing core library.
|
||||||
|
//!
|
||||||
|
//! This crate defines the testing configuration and
|
||||||
|
//! provides a helper utility to execute tests.
|
||||||
|
|
||||||
|
use revive_dt_compiler::{SolidityCompiler, revive_resolc, solc};
|
||||||
|
use revive_dt_config::TestingPlatform;
|
||||||
|
use revive_dt_node::{Node, geth, kitchensink::KitchensinkNode};
|
||||||
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
|
||||||
|
pub mod common;
|
||||||
|
pub mod driver;
|
||||||
|
|
||||||
|
/// One platform can be tested differentially against another.
|
||||||
|
///
|
||||||
|
/// For this we need a blockchain node implementation and a compiler.
|
||||||
|
pub trait Platform {
|
||||||
|
type Blockchain: EthereumNode + Node;
|
||||||
|
type Compiler: SolidityCompiler;
|
||||||
|
|
||||||
|
/// Returns the matching [TestingPlatform] of the [revive_dt_config::Arguments].
|
||||||
|
fn config_id() -> TestingPlatform;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Default)]
|
||||||
|
pub struct Geth;
|
||||||
|
|
||||||
|
impl Platform for Geth {
|
||||||
|
type Blockchain = geth::Instance;
|
||||||
|
type Compiler = solc::Solc;
|
||||||
|
|
||||||
|
fn config_id() -> TestingPlatform {
|
||||||
|
TestingPlatform::Geth
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Default)]
|
||||||
|
pub struct Kitchensink;
|
||||||
|
|
||||||
|
impl Platform for Kitchensink {
|
||||||
|
type Blockchain = KitchensinkNode;
|
||||||
|
type Compiler = revive_resolc::Resolc;
|
||||||
|
|
||||||
|
fn config_id() -> TestingPlatform {
|
||||||
|
TestingPlatform::Kitchensink
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,244 @@
|
|||||||
|
use std::{
|
||||||
|
collections::{HashMap, HashSet},
|
||||||
|
sync::LazyLock,
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::{
|
||||||
|
network::TxSigner,
|
||||||
|
primitives::FixedBytes,
|
||||||
|
signers::{Signature, local::PrivateKeySigner},
|
||||||
|
};
|
||||||
|
use clap::Parser;
|
||||||
|
use rayon::{ThreadPoolBuilder, prelude::*};
|
||||||
|
|
||||||
|
use revive_dt_config::*;
|
||||||
|
use revive_dt_core::{
|
||||||
|
Geth, Kitchensink, Platform,
|
||||||
|
driver::{Driver, State},
|
||||||
|
};
|
||||||
|
use revive_dt_format::{
|
||||||
|
corpus::Corpus,
|
||||||
|
input::default_caller,
|
||||||
|
metadata::{AddressReplacementMap, MetadataFile},
|
||||||
|
};
|
||||||
|
use revive_dt_node::pool::NodePool;
|
||||||
|
use revive_dt_report::reporter::{Report, Span};
|
||||||
|
use temp_dir::TempDir;
|
||||||
|
use tracing::Level;
|
||||||
|
use tracing_subscriber::{EnvFilter, FmtSubscriber};
|
||||||
|
|
||||||
|
static TEMP_DIR: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
|
||||||
|
|
||||||
|
fn main() -> anyhow::Result<()> {
|
||||||
|
let args = init_cli()?;
|
||||||
|
|
||||||
|
let mut corpora = collect_corpora(&args)?;
|
||||||
|
let mut replacement_private_keys = HashSet::<FixedBytes<32>>::new();
|
||||||
|
for case in corpora
|
||||||
|
.values_mut()
|
||||||
|
.flat_map(|metadata| metadata.iter_mut())
|
||||||
|
.flat_map(|metadata| metadata.content.cases.iter_mut())
|
||||||
|
{
|
||||||
|
let mut replacement_map = AddressReplacementMap::new();
|
||||||
|
for address in case.inputs.iter().filter_map(|input| {
|
||||||
|
if input.caller != default_caller() {
|
||||||
|
Some(input.caller)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}) {
|
||||||
|
replacement_map.add(address);
|
||||||
|
}
|
||||||
|
case.handle_address_replacement(&mut replacement_map)?;
|
||||||
|
replacement_private_keys.extend(
|
||||||
|
replacement_map
|
||||||
|
.into_inner()
|
||||||
|
.into_values()
|
||||||
|
.map(|(sk, _)| sk)
|
||||||
|
.map(|sk| sk.to_bytes()),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (corpus, tests) in corpora {
|
||||||
|
let span = Span::new(corpus, args.clone())?;
|
||||||
|
|
||||||
|
match &args.compile_only {
|
||||||
|
Some(platform) => compile_corpus(&args, &tests, platform, span),
|
||||||
|
None => execute_corpus(
|
||||||
|
&args,
|
||||||
|
&tests,
|
||||||
|
replacement_private_keys
|
||||||
|
.clone()
|
||||||
|
.into_iter()
|
||||||
|
.map(|bytes| PrivateKeySigner::from_bytes(&bytes).expect("Can't fail"))
|
||||||
|
.collect::<Vec<_>>(),
|
||||||
|
span,
|
||||||
|
)?,
|
||||||
|
}
|
||||||
|
|
||||||
|
Report::save()?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn init_cli() -> anyhow::Result<Arguments> {
|
||||||
|
let subscriber = FmtSubscriber::builder()
|
||||||
|
.with_thread_ids(true)
|
||||||
|
.with_thread_names(true)
|
||||||
|
.with_env_filter(EnvFilter::from_default_env())
|
||||||
|
.with_ansi(false)
|
||||||
|
.pretty()
|
||||||
|
.finish();
|
||||||
|
tracing::subscriber::set_global_default(subscriber)?;
|
||||||
|
|
||||||
|
let mut args = Arguments::parse();
|
||||||
|
|
||||||
|
if args.corpus.is_empty() {
|
||||||
|
anyhow::bail!("no test corpus specified");
|
||||||
|
}
|
||||||
|
|
||||||
|
match args.working_directory.as_ref() {
|
||||||
|
Some(dir) => {
|
||||||
|
if !dir.exists() {
|
||||||
|
anyhow::bail!("workdir {} does not exist", dir.display());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
args.temp_dir = Some(&TEMP_DIR);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
tracing::info!("workdir: {}", args.directory().display());
|
||||||
|
|
||||||
|
ThreadPoolBuilder::new()
|
||||||
|
.num_threads(args.workers)
|
||||||
|
.build_global()?;
|
||||||
|
|
||||||
|
Ok(args)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn collect_corpora(args: &Arguments) -> anyhow::Result<HashMap<Corpus, Vec<MetadataFile>>> {
|
||||||
|
let mut corpora = HashMap::new();
|
||||||
|
|
||||||
|
for path in &args.corpus {
|
||||||
|
let corpus = Corpus::try_from_path(path)?;
|
||||||
|
tracing::info!("found corpus: {}", path.display());
|
||||||
|
let tests = corpus.enumerate_tests();
|
||||||
|
tracing::info!("corpus '{}' contains {} tests", &corpus.name, tests.len());
|
||||||
|
corpora.insert(corpus, tests);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(corpora)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_driver<L, F>(
|
||||||
|
args: &Arguments,
|
||||||
|
tests: &[MetadataFile],
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>
|
||||||
|
+ Clone
|
||||||
|
+ Send
|
||||||
|
+ Sync
|
||||||
|
+ 'static,
|
||||||
|
span: Span,
|
||||||
|
) -> anyhow::Result<()>
|
||||||
|
where
|
||||||
|
L: Platform,
|
||||||
|
F: Platform,
|
||||||
|
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
{
|
||||||
|
let leader_nodes = NodePool::<L::Blockchain>::new(args, additional_signers.clone())?;
|
||||||
|
let follower_nodes = NodePool::<F::Blockchain>::new(args, additional_signers)?;
|
||||||
|
|
||||||
|
tests.par_iter().for_each(
|
||||||
|
|MetadataFile {
|
||||||
|
content: metadata,
|
||||||
|
path: metadata_file_path,
|
||||||
|
}| {
|
||||||
|
// Starting a new tracing span for this metadata file. This allows our logs to be clear
|
||||||
|
// about which metadata file the logs belong to. We can add other information into this
|
||||||
|
// as well to be able to associate the logs with the correct metadata file and case
|
||||||
|
// that's being executed.
|
||||||
|
let tracing_span = tracing::span!(
|
||||||
|
Level::INFO,
|
||||||
|
"Running driver",
|
||||||
|
metadata_file_path = metadata_file_path.display().to_string(),
|
||||||
|
);
|
||||||
|
let _guard = tracing_span.enter();
|
||||||
|
|
||||||
|
let mut driver = Driver::<L, F>::new(
|
||||||
|
metadata,
|
||||||
|
args,
|
||||||
|
leader_nodes.round_robbin(),
|
||||||
|
follower_nodes.round_robbin(),
|
||||||
|
);
|
||||||
|
|
||||||
|
let execution_result = driver.execute(span);
|
||||||
|
tracing::info!(
|
||||||
|
case_success_count = execution_result.successful_cases_count,
|
||||||
|
case_failure_count = execution_result.failed_cases_count,
|
||||||
|
"Execution completed"
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut error_count = 0;
|
||||||
|
for result in execution_result.results.iter() {
|
||||||
|
if !result.is_success() {
|
||||||
|
tracing::error!(execution_error = ?result, "Encountered an error");
|
||||||
|
error_count += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if error_count == 0 {
|
||||||
|
tracing::info!("Execution succeeded");
|
||||||
|
} else {
|
||||||
|
tracing::info!("Execution failed");
|
||||||
|
}
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn execute_corpus(
|
||||||
|
args: &Arguments,
|
||||||
|
tests: &[MetadataFile],
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>
|
||||||
|
+ Clone
|
||||||
|
+ Send
|
||||||
|
+ Sync
|
||||||
|
+ 'static,
|
||||||
|
span: Span,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
match (&args.leader, &args.follower) {
|
||||||
|
(TestingPlatform::Geth, TestingPlatform::Kitchensink) => {
|
||||||
|
run_driver::<Geth, Kitchensink>(args, tests, additional_signers, span)?
|
||||||
|
}
|
||||||
|
(TestingPlatform::Geth, TestingPlatform::Geth) => {
|
||||||
|
run_driver::<Geth, Geth>(args, tests, additional_signers, span)?
|
||||||
|
}
|
||||||
|
_ => unimplemented!(),
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn compile_corpus(
|
||||||
|
config: &Arguments,
|
||||||
|
tests: &[MetadataFile],
|
||||||
|
platform: &TestingPlatform,
|
||||||
|
span: Span,
|
||||||
|
) {
|
||||||
|
tests.par_iter().for_each(|metadata| {
|
||||||
|
for mode in &metadata.solc_modes() {
|
||||||
|
match platform {
|
||||||
|
TestingPlatform::Geth => {
|
||||||
|
let mut state = State::<Geth>::new(config, span);
|
||||||
|
let _ = state.build_contracts(mode, metadata);
|
||||||
|
}
|
||||||
|
TestingPlatform::Kitchensink => {
|
||||||
|
let mut state = State::<Kitchensink>::new(config, span);
|
||||||
|
let _ = state.build_contracts(mode, metadata);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-format"
|
||||||
|
description = "declarative test definition format"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
revive-dt-node-interaction = { workspace = true }
|
||||||
|
|
||||||
|
alloy = { workspace = true }
|
||||||
|
alloy-primitives = { workspace = true }
|
||||||
|
alloy-sol-types = { workspace = true }
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
semver = { workspace = true }
|
||||||
|
serde = { workspace = true, features = ["derive"] }
|
||||||
|
serde_json = { workspace = true }
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
use serde::Deserialize;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
define_wrapper_type,
|
||||||
|
input::{Expected, Input},
|
||||||
|
metadata::AddressReplacementMap,
|
||||||
|
mode::Mode,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub struct Case {
|
||||||
|
pub name: Option<String>,
|
||||||
|
pub comment: Option<String>,
|
||||||
|
pub modes: Option<Vec<Mode>>,
|
||||||
|
pub inputs: Vec<Input>,
|
||||||
|
pub group: Option<String>,
|
||||||
|
pub expected: Option<Expected>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Case {
|
||||||
|
pub fn inputs_iterator(&self) -> impl Iterator<Item = Input> {
|
||||||
|
let inputs_len = self.inputs.len();
|
||||||
|
self.inputs
|
||||||
|
.clone()
|
||||||
|
.into_iter()
|
||||||
|
.enumerate()
|
||||||
|
.map(move |(idx, mut input)| {
|
||||||
|
if idx + 1 == inputs_len {
|
||||||
|
if input.expected.is_none() {
|
||||||
|
input.expected = self.expected.clone();
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: What does it mean for us to have an `expected` field on the case itself
|
||||||
|
// but the final input also has an expected field that doesn't match the one on
|
||||||
|
// the case? What are we supposed to do with that final expected field on the
|
||||||
|
// case?
|
||||||
|
|
||||||
|
input
|
||||||
|
} else {
|
||||||
|
input
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &mut AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
for input in self.inputs.iter_mut() {
|
||||||
|
input.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
if let Some(ref mut expected) = self.expected {
|
||||||
|
expected.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
define_wrapper_type!(
|
||||||
|
/// A wrapper type for the index of test cases found in metadata file.
|
||||||
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
CaseIdx(usize);
|
||||||
|
);
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
use std::{
|
||||||
|
fs::File,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
};
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::metadata::MetadataFile;
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Default, Serialize, Deserialize, Eq, PartialEq, Hash)]
|
||||||
|
pub struct Corpus {
|
||||||
|
pub name: String,
|
||||||
|
pub path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Corpus {
|
||||||
|
/// Try to read and parse the corpus definition file at given `path`.
|
||||||
|
pub fn try_from_path(path: &Path) -> anyhow::Result<Self> {
|
||||||
|
let file = File::open(path)?;
|
||||||
|
Ok(serde_json::from_reader(file)?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Scan the corpus base directory and return all tests found.
|
||||||
|
pub fn enumerate_tests(&self) -> Vec<MetadataFile> {
|
||||||
|
let mut tests = Vec::new();
|
||||||
|
collect_metadata(&self.path, &mut tests);
|
||||||
|
tests
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Recursively walks `path` and parses any JSON or Solidity file into a test
|
||||||
|
/// definition [Metadata].
|
||||||
|
///
|
||||||
|
/// Found tests are inserted into `tests`.
|
||||||
|
///
|
||||||
|
/// `path` is expected to be a directory.
|
||||||
|
pub fn collect_metadata(path: &Path, tests: &mut Vec<MetadataFile>) {
|
||||||
|
let dir_entry = match std::fs::read_dir(path) {
|
||||||
|
Ok(dir_entry) => dir_entry,
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!("failed to read dir '{}': {error}", path.display());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
for entry in dir_entry {
|
||||||
|
let entry = match entry {
|
||||||
|
Ok(entry) => entry,
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!("error reading dir entry: {error}");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let path = entry.path();
|
||||||
|
if path.is_dir() {
|
||||||
|
collect_metadata(&path, tests);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if path.is_file() {
|
||||||
|
if let Some(metadata) = MetadataFile::try_from_file(&path) {
|
||||||
|
tests.push(metadata)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,815 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
use alloy::{
|
||||||
|
eips::BlockNumberOrTag,
|
||||||
|
json_abi::JsonAbi,
|
||||||
|
network::TransactionBuilder,
|
||||||
|
primitives::{Address, Bytes, U256},
|
||||||
|
rpc::types::TransactionRequest,
|
||||||
|
};
|
||||||
|
use alloy_primitives::{FixedBytes, utils::parse_units};
|
||||||
|
use semver::VersionReq;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
define_wrapper_type,
|
||||||
|
metadata::{AddressReplacementMap, ContractInstance},
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
||||||
|
pub struct Input {
|
||||||
|
#[serde(default = "default_caller")]
|
||||||
|
pub caller: Address,
|
||||||
|
pub comment: Option<String>,
|
||||||
|
#[serde(default = "default_instance")]
|
||||||
|
pub instance: ContractInstance,
|
||||||
|
pub method: Method,
|
||||||
|
#[serde(default)]
|
||||||
|
pub calldata: Calldata,
|
||||||
|
pub expected: Option<Expected>,
|
||||||
|
pub value: Option<EtherValue>,
|
||||||
|
pub storage: Option<HashMap<String, Calldata>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
||||||
|
#[serde(untagged)]
|
||||||
|
pub enum Expected {
|
||||||
|
Calldata(Calldata),
|
||||||
|
Expected(ExpectedOutput),
|
||||||
|
ExpectedMany(Vec<ExpectedOutput>),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
||||||
|
pub struct ExpectedOutput {
|
||||||
|
pub compiler_version: Option<VersionReq>,
|
||||||
|
pub return_data: Option<Calldata>,
|
||||||
|
pub events: Option<Vec<Event>>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub exception: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
|
||||||
|
pub struct Event {
|
||||||
|
pub address: Option<Address>,
|
||||||
|
pub topics: Vec<String>,
|
||||||
|
pub values: Calldata,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
|
||||||
|
#[serde(untagged)]
|
||||||
|
pub enum Calldata {
|
||||||
|
Single(String),
|
||||||
|
Compound(Vec<String>),
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Specify how the contract is called.
|
||||||
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub enum Method {
|
||||||
|
/// Initiate a deploy transaction, calling contracts constructor.
|
||||||
|
///
|
||||||
|
/// Indicated by `#deployer`.
|
||||||
|
#[serde(rename = "#deployer")]
|
||||||
|
Deployer,
|
||||||
|
|
||||||
|
/// Does not calculate and insert a function selector.
|
||||||
|
///
|
||||||
|
/// Indicated by `#fallback`.
|
||||||
|
#[default]
|
||||||
|
#[serde(rename = "#fallback")]
|
||||||
|
Fallback,
|
||||||
|
|
||||||
|
/// Call the public function with the given name.
|
||||||
|
#[serde(untagged)]
|
||||||
|
FunctionName(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
define_wrapper_type!(
|
||||||
|
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
EtherValue(U256);
|
||||||
|
);
|
||||||
|
|
||||||
|
impl Serialize for EtherValue {
|
||||||
|
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||||
|
where
|
||||||
|
S: serde::Serializer,
|
||||||
|
{
|
||||||
|
format!("{} wei", self.0).serialize(serializer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'de> Deserialize<'de> for EtherValue {
|
||||||
|
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||||
|
where
|
||||||
|
D: serde::Deserializer<'de>,
|
||||||
|
{
|
||||||
|
let string = String::deserialize(deserializer)?;
|
||||||
|
let mut splitted = string.split(' ');
|
||||||
|
let (Some(value), Some(unit)) = (splitted.next(), splitted.next()) else {
|
||||||
|
return Err(serde::de::Error::custom("Failed to parse the value"));
|
||||||
|
};
|
||||||
|
let parsed = parse_units(value, unit.replace("eth", "ether"))
|
||||||
|
.map_err(|_| serde::de::Error::custom("Failed to parse units"))?
|
||||||
|
.into();
|
||||||
|
Ok(Self(parsed))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ExpectedOutput {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Default::default()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_success(mut self) -> Self {
|
||||||
|
self.exception = false;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_failure(mut self) -> Self {
|
||||||
|
self.exception = true;
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_calldata(mut self, calldata: Calldata) -> Self {
|
||||||
|
self.return_data = Some(calldata);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
if let Some(ref mut calldata) = self.return_data {
|
||||||
|
calldata.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
if let Some(ref mut events) = self.events {
|
||||||
|
for event in events.iter_mut() {
|
||||||
|
event.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Event {
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
if let Some(ref mut address) = self.address {
|
||||||
|
if let Some(new_address) = old_to_new_mapping.resolve(address.to_string().as_str()) {
|
||||||
|
*address = new_address
|
||||||
|
}
|
||||||
|
};
|
||||||
|
for topic in self.topics.iter_mut() {
|
||||||
|
if let Some(new_address) = old_to_new_mapping.resolve(topic.to_string().as_str()) {
|
||||||
|
*topic = new_address.to_string();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
self.values.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for Calldata {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::Compound(Default::default())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Calldata {
|
||||||
|
pub fn find_all_contract_instances(&self, vec: &mut Vec<ContractInstance>) {
|
||||||
|
if let Calldata::Compound(compound) = self {
|
||||||
|
for item in compound {
|
||||||
|
if let Some(instance) = item.strip_suffix(".address") {
|
||||||
|
vec.push(ContractInstance::new_from(instance))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
match self {
|
||||||
|
Calldata::Single(_) => {}
|
||||||
|
Calldata::Compound(items) => {
|
||||||
|
for item in items.iter_mut() {
|
||||||
|
if let Some(resolved) = old_to_new_mapping.resolve(item) {
|
||||||
|
*item = resolved.to_string()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn calldata(
|
||||||
|
&self,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
chain_state_provider: &impl EthereumNode,
|
||||||
|
) -> anyhow::Result<Vec<u8>> {
|
||||||
|
let mut buffer = Vec::<u8>::with_capacity(self.size_requirement());
|
||||||
|
self.calldata_into_slice(&mut buffer, deployed_contracts, chain_state_provider)?;
|
||||||
|
Ok(buffer)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn calldata_into_slice(
|
||||||
|
&self,
|
||||||
|
buffer: &mut Vec<u8>,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
chain_state_provider: &impl EthereumNode,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
match self {
|
||||||
|
Calldata::Single(string) => {
|
||||||
|
alloy::hex::decode_to_slice(string, buffer)?;
|
||||||
|
}
|
||||||
|
Calldata::Compound(items) => {
|
||||||
|
for (arg_idx, arg) in items.iter().enumerate() {
|
||||||
|
match resolve_argument(arg, deployed_contracts, chain_state_provider) {
|
||||||
|
Ok(resolved) => {
|
||||||
|
buffer.extend(resolved.to_be_bytes::<32>());
|
||||||
|
}
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!(arg, arg_idx, ?error, "Failed to resolve argument");
|
||||||
|
return Err(error);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn size_requirement(&self) -> usize {
|
||||||
|
match self {
|
||||||
|
Calldata::Single(single) => (single.len() - 2) / 2,
|
||||||
|
Calldata::Compound(items) => items.len() * 32,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Expected {
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
match self {
|
||||||
|
Expected::Calldata(calldata) => {
|
||||||
|
calldata.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
Expected::Expected(expected_output) => {
|
||||||
|
expected_output.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
Expected::ExpectedMany(expected_outputs) => {
|
||||||
|
for expected_output in expected_outputs.iter_mut() {
|
||||||
|
expected_output.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Input {
|
||||||
|
fn instance_to_address(
|
||||||
|
&self,
|
||||||
|
instance: &ContractInstance,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
) -> anyhow::Result<Address> {
|
||||||
|
deployed_contracts
|
||||||
|
.get(instance)
|
||||||
|
.map(|(a, _)| *a)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("instance {instance:?} not deployed"))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn encoded_input(
|
||||||
|
&self,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
chain_state_provider: &impl EthereumNode,
|
||||||
|
) -> anyhow::Result<Bytes> {
|
||||||
|
match self.method {
|
||||||
|
Method::Deployer | Method::Fallback => {
|
||||||
|
let calldata = self
|
||||||
|
.calldata
|
||||||
|
.calldata(deployed_contracts, chain_state_provider)?;
|
||||||
|
|
||||||
|
Ok(calldata.into())
|
||||||
|
}
|
||||||
|
Method::FunctionName(ref function_name) => {
|
||||||
|
let Some(abi) = deployed_contracts.get(&self.instance).map(|(_, a)| a) else {
|
||||||
|
tracing::error!(
|
||||||
|
contract_name = self.instance.as_ref(),
|
||||||
|
available_abis = ?deployed_contracts.keys().collect::<Vec<_>>(),
|
||||||
|
"Attempted to lookup ABI of contract but it wasn't found"
|
||||||
|
);
|
||||||
|
anyhow::bail!("ABI for instance '{}' not found", self.instance.as_ref());
|
||||||
|
};
|
||||||
|
|
||||||
|
tracing::trace!("ABI found for instance: {}", &self.instance.as_ref());
|
||||||
|
|
||||||
|
// We follow the same logic that's implemented in the matter-labs-tester where they resolve
|
||||||
|
// the function name into a function selector and they assume that he function doesn't have
|
||||||
|
// any existing overloads.
|
||||||
|
// https://github.com/matter-labs/era-compiler-tester/blob/1dfa7d07cba0734ca97e24704f12dd57f6990c2c/compiler_tester/src/test/case/input/mod.rs#L158-L190
|
||||||
|
let function = abi
|
||||||
|
.functions()
|
||||||
|
.find(|function| function.signature().starts_with(function_name))
|
||||||
|
.ok_or_else(|| {
|
||||||
|
anyhow::anyhow!(
|
||||||
|
"Function with name {:?} not found in ABI for the instance {:?}",
|
||||||
|
function_name,
|
||||||
|
&self.instance
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
tracing::trace!("Functions found for instance: {}", self.instance.as_ref());
|
||||||
|
|
||||||
|
tracing::trace!(
|
||||||
|
"Starting encoding ABI's parameters for instance: {}",
|
||||||
|
self.instance.as_ref()
|
||||||
|
);
|
||||||
|
|
||||||
|
// Allocating a vector that we will be using for the calldata. The vector size will be:
|
||||||
|
// 4 bytes for the function selector.
|
||||||
|
// function.inputs.len() * 32 bytes for the arguments (each argument is a U256).
|
||||||
|
//
|
||||||
|
// We're using indices in the following code in order to avoid the need for us to allocate
|
||||||
|
// a new buffer for each one of the resolved arguments.
|
||||||
|
let mut calldata = Vec::<u8>::with_capacity(4 + self.calldata.size_requirement());
|
||||||
|
calldata.extend(function.selector().0);
|
||||||
|
self.calldata.calldata_into_slice(
|
||||||
|
&mut calldata,
|
||||||
|
deployed_contracts,
|
||||||
|
chain_state_provider,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Ok(calldata.into())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Parse this input into a legacy transaction.
|
||||||
|
pub fn legacy_transaction(
|
||||||
|
&self,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
chain_state_provider: &impl EthereumNode,
|
||||||
|
) -> anyhow::Result<TransactionRequest> {
|
||||||
|
let input_data = self.encoded_input(deployed_contracts, chain_state_provider)?;
|
||||||
|
let transaction_request = TransactionRequest::default().from(self.caller).value(
|
||||||
|
self.value
|
||||||
|
.map(|value| value.into_inner())
|
||||||
|
.unwrap_or_default(),
|
||||||
|
);
|
||||||
|
match self.method {
|
||||||
|
Method::Deployer => Ok(transaction_request.with_deploy_code(input_data)),
|
||||||
|
_ => Ok(transaction_request
|
||||||
|
.to(self.instance_to_address(&self.instance, deployed_contracts)?)
|
||||||
|
.input(input_data.into())),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn find_all_contract_instances(&self) -> Vec<ContractInstance> {
|
||||||
|
let mut vec = Vec::new();
|
||||||
|
vec.push(self.instance.clone());
|
||||||
|
|
||||||
|
self.calldata.find_all_contract_instances(&mut vec);
|
||||||
|
|
||||||
|
vec
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &mut AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
if self.caller != default_caller() {
|
||||||
|
self.caller = old_to_new_mapping.add(self.caller);
|
||||||
|
}
|
||||||
|
self.calldata
|
||||||
|
.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
if let Some(ref mut expected) = self.expected {
|
||||||
|
expected.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
if let Some(ref mut storage) = self.storage {
|
||||||
|
for calldata in storage.values_mut() {
|
||||||
|
calldata.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn default_instance() -> ContractInstance {
|
||||||
|
ContractInstance::new_from("Test")
|
||||||
|
}
|
||||||
|
|
||||||
|
pub const fn default_caller() -> Address {
|
||||||
|
Address(FixedBytes(alloy::hex!(
|
||||||
|
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1"
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This function takes in the string calldata argument provided in the JSON input and resolves it
|
||||||
|
/// into a [`U256`] which is later used to construct the calldata.
|
||||||
|
///
|
||||||
|
/// # Note
|
||||||
|
///
|
||||||
|
/// This piece of code is taken from the matter-labs-tester repository which is licensed under MIT
|
||||||
|
/// or Apache. The original source code can be found here:
|
||||||
|
/// https://github.com/matter-labs/era-compiler-tester/blob/0ed598a27f6eceee7008deab3ff2311075a2ec69/compiler_tester/src/test/case/input/value.rs#L43-L146
|
||||||
|
pub fn resolve_argument(
|
||||||
|
value: &str,
|
||||||
|
deployed_contracts: &HashMap<ContractInstance, (Address, JsonAbi)>,
|
||||||
|
chain_state_provider: &impl EthereumNode,
|
||||||
|
) -> anyhow::Result<U256> {
|
||||||
|
if let Some(instance) = value.strip_suffix(".address") {
|
||||||
|
Ok(U256::from_be_slice(
|
||||||
|
deployed_contracts
|
||||||
|
.get(&ContractInstance::new_from(instance))
|
||||||
|
.map(|(a, _)| *a)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("Instance `{}` not found", instance))?
|
||||||
|
.as_ref(),
|
||||||
|
))
|
||||||
|
} else if let Some(value) = value.strip_prefix('-') {
|
||||||
|
let value = U256::from_str_radix(value, 10)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid decimal literal after `-`: {}", error))?;
|
||||||
|
if value > U256::ONE << 255u8 {
|
||||||
|
anyhow::bail!("Decimal literal after `-` is too big");
|
||||||
|
}
|
||||||
|
let value = value
|
||||||
|
.checked_sub(U256::ONE)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("`-0` is invalid literal"))?;
|
||||||
|
Ok(U256::MAX.checked_sub(value).expect("Always valid"))
|
||||||
|
} else if let Some(value) = value.strip_prefix("0x") {
|
||||||
|
Ok(U256::from_str_radix(value, 16)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid hexadecimal literal: {}", error))?)
|
||||||
|
} else if value == "$CHAIN_ID" {
|
||||||
|
let chain_id = chain_state_provider.chain_id()?;
|
||||||
|
Ok(U256::from(chain_id))
|
||||||
|
} else if value == "$GAS_LIMIT" {
|
||||||
|
let gas_limit = chain_state_provider.block_gas_limit(BlockNumberOrTag::Latest)?;
|
||||||
|
Ok(U256::from(gas_limit))
|
||||||
|
} else if value == "$COINBASE" {
|
||||||
|
let coinbase = chain_state_provider.block_coinbase(BlockNumberOrTag::Latest)?;
|
||||||
|
Ok(U256::from_be_slice(coinbase.as_ref()))
|
||||||
|
} else if value == "$DIFFICULTY" {
|
||||||
|
let block_difficulty = chain_state_provider.block_difficulty(BlockNumberOrTag::Latest)?;
|
||||||
|
Ok(block_difficulty)
|
||||||
|
} else if value.starts_with("$BLOCK_HASH") {
|
||||||
|
let offset: u64 = value
|
||||||
|
.split(':')
|
||||||
|
.next_back()
|
||||||
|
.and_then(|value| value.parse().ok())
|
||||||
|
.unwrap_or_default();
|
||||||
|
|
||||||
|
let current_block_number = chain_state_provider.last_block_number()?;
|
||||||
|
let desired_block_number = current_block_number - offset;
|
||||||
|
|
||||||
|
let block_hash = chain_state_provider.block_hash(desired_block_number.into())?;
|
||||||
|
|
||||||
|
Ok(U256::from_be_bytes(block_hash.0))
|
||||||
|
} else if value == "$BLOCK_NUMBER" {
|
||||||
|
let current_block_number = chain_state_provider.last_block_number()?;
|
||||||
|
Ok(U256::from(current_block_number))
|
||||||
|
} else if value == "$BLOCK_TIMESTAMP" {
|
||||||
|
let timestamp = chain_state_provider.block_timestamp(BlockNumberOrTag::Latest)?;
|
||||||
|
Ok(U256::from(timestamp))
|
||||||
|
} else {
|
||||||
|
Ok(U256::from_str_radix(value, 10)
|
||||||
|
.map_err(|error| anyhow::anyhow!("Invalid decimal literal: {}", error))?)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use alloy::json_abi::JsonAbi;
|
||||||
|
use alloy_primitives::address;
|
||||||
|
use alloy_sol_types::SolValue;
|
||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
struct DummyEthereumNode;
|
||||||
|
|
||||||
|
impl EthereumNode for DummyEthereumNode {
|
||||||
|
fn execute_transaction(
|
||||||
|
&self,
|
||||||
|
_: TransactionRequest,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
||||||
|
unimplemented!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn trace_transaction(
|
||||||
|
&self,
|
||||||
|
_: &alloy::rpc::types::TransactionReceipt,
|
||||||
|
_: alloy::rpc::types::trace::geth::GethDebugTracingOptions,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||||
|
unimplemented!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn state_diff(
|
||||||
|
&self,
|
||||||
|
_: &alloy::rpc::types::TransactionReceipt,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::DiffMode> {
|
||||||
|
unimplemented!()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn chain_id(&self) -> anyhow::Result<alloy_primitives::ChainId> {
|
||||||
|
Ok(0x123)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_gas_limit(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<u128> {
|
||||||
|
Ok(0x1234)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_coinbase(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<Address> {
|
||||||
|
Ok(Address::ZERO)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_difficulty(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<U256> {
|
||||||
|
Ok(U256::from(0x12345u128))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_hash(
|
||||||
|
&self,
|
||||||
|
_: alloy::eips::BlockNumberOrTag,
|
||||||
|
) -> anyhow::Result<alloy_primitives::BlockHash> {
|
||||||
|
Ok([0xEE; 32].into())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_timestamp(
|
||||||
|
&self,
|
||||||
|
_: alloy::eips::BlockNumberOrTag,
|
||||||
|
) -> anyhow::Result<alloy_primitives::BlockTimestamp> {
|
||||||
|
Ok(0x123456)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn last_block_number(&self) -> anyhow::Result<alloy_primitives::BlockNumber> {
|
||||||
|
Ok(0x1234567)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encoded_input_uint256() {
|
||||||
|
let raw_metadata = r#"
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"inputs": [{"name": "value", "type": "uint256"}],
|
||||||
|
"name": "store",
|
||||||
|
"outputs": [],
|
||||||
|
"stateMutability": "nonpayable",
|
||||||
|
"type": "function"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let parsed_abi: JsonAbi = serde_json::from_str(raw_metadata).unwrap();
|
||||||
|
let selector = parsed_abi
|
||||||
|
.function("store")
|
||||||
|
.unwrap()
|
||||||
|
.first()
|
||||||
|
.unwrap()
|
||||||
|
.selector()
|
||||||
|
.0;
|
||||||
|
|
||||||
|
let input = Input {
|
||||||
|
instance: ContractInstance::new_from("Contract"),
|
||||||
|
method: Method::FunctionName("store".to_owned()),
|
||||||
|
calldata: Calldata::Compound(vec!["42".into()]),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut contracts = HashMap::new();
|
||||||
|
contracts.insert(
|
||||||
|
ContractInstance::new_from("Contract"),
|
||||||
|
(Address::ZERO, parsed_abi),
|
||||||
|
);
|
||||||
|
|
||||||
|
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||||
|
assert!(encoded.0.starts_with(&selector));
|
||||||
|
|
||||||
|
type T = (u64,);
|
||||||
|
let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
|
||||||
|
assert_eq!(decoded.0, 42);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encoded_input_address_with_signature() {
|
||||||
|
let raw_abi = r#"[
|
||||||
|
{
|
||||||
|
"inputs": [{"name": "recipient", "type": "address"}],
|
||||||
|
"name": "send",
|
||||||
|
"outputs": [],
|
||||||
|
"stateMutability": "nonpayable",
|
||||||
|
"type": "function"
|
||||||
|
}
|
||||||
|
]"#;
|
||||||
|
|
||||||
|
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
||||||
|
let selector = parsed_abi
|
||||||
|
.function("send")
|
||||||
|
.unwrap()
|
||||||
|
.first()
|
||||||
|
.unwrap()
|
||||||
|
.selector()
|
||||||
|
.0;
|
||||||
|
|
||||||
|
let input: Input = Input {
|
||||||
|
instance: "Contract".to_owned().into(),
|
||||||
|
method: Method::FunctionName("send(address)".to_owned()),
|
||||||
|
calldata: Calldata::Compound(vec![
|
||||||
|
"0x1000000000000000000000000000000000000001".to_string(),
|
||||||
|
]),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut contracts = HashMap::new();
|
||||||
|
contracts.insert(
|
||||||
|
ContractInstance::new_from("Contract"),
|
||||||
|
(Address::ZERO, parsed_abi),
|
||||||
|
);
|
||||||
|
|
||||||
|
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||||
|
assert!(encoded.0.starts_with(&selector));
|
||||||
|
|
||||||
|
type T = (alloy_primitives::Address,);
|
||||||
|
let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
decoded.0,
|
||||||
|
address!("0x1000000000000000000000000000000000000001")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encoded_input_address() {
|
||||||
|
let raw_abi = r#"[
|
||||||
|
{
|
||||||
|
"inputs": [{"name": "recipient", "type": "address"}],
|
||||||
|
"name": "send",
|
||||||
|
"outputs": [],
|
||||||
|
"stateMutability": "nonpayable",
|
||||||
|
"type": "function"
|
||||||
|
}
|
||||||
|
]"#;
|
||||||
|
|
||||||
|
let parsed_abi: JsonAbi = serde_json::from_str(raw_abi).unwrap();
|
||||||
|
let selector = parsed_abi
|
||||||
|
.function("send")
|
||||||
|
.unwrap()
|
||||||
|
.first()
|
||||||
|
.unwrap()
|
||||||
|
.selector()
|
||||||
|
.0;
|
||||||
|
|
||||||
|
let input: Input = Input {
|
||||||
|
instance: ContractInstance::new_from("Contract"),
|
||||||
|
method: Method::FunctionName("send".to_owned()),
|
||||||
|
calldata: Calldata::Compound(vec![
|
||||||
|
"0x1000000000000000000000000000000000000001".to_string(),
|
||||||
|
]),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut contracts = HashMap::new();
|
||||||
|
contracts.insert(
|
||||||
|
ContractInstance::new_from("Contract"),
|
||||||
|
(Address::ZERO, parsed_abi),
|
||||||
|
);
|
||||||
|
|
||||||
|
let encoded = input.encoded_input(&contracts, &DummyEthereumNode).unwrap();
|
||||||
|
assert!(encoded.0.starts_with(&selector));
|
||||||
|
|
||||||
|
type T = (alloy_primitives::Address,);
|
||||||
|
let decoded: T = T::abi_decode(&encoded.0[4..]).unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
decoded.0,
|
||||||
|
address!("0x1000000000000000000000000000000000000001")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_chain_id_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$CHAIN_ID";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(resolved, U256::from(DummyEthereumNode.chain_id().unwrap()))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_gas_limit_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$GAS_LIMIT";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
U256::from(
|
||||||
|
DummyEthereumNode
|
||||||
|
.block_gas_limit(Default::default())
|
||||||
|
.unwrap()
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_coinbase_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$COINBASE";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
U256::from_be_slice(
|
||||||
|
DummyEthereumNode
|
||||||
|
.block_coinbase(Default::default())
|
||||||
|
.unwrap()
|
||||||
|
.as_ref()
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_block_difficulty_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$DIFFICULTY";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
DummyEthereumNode
|
||||||
|
.block_difficulty(Default::default())
|
||||||
|
.unwrap()
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_block_hash_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$BLOCK_HASH";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
U256::from_be_bytes(DummyEthereumNode.block_hash(Default::default()).unwrap().0)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_block_number_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$BLOCK_NUMBER";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
U256::from(DummyEthereumNode.last_block_number().unwrap())
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolver_can_resolve_block_timestamp_variable() {
|
||||||
|
// Arrange
|
||||||
|
let input = "$BLOCK_TIMESTAMP";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let resolved = resolve_argument(input, &Default::default(), &DummyEthereumNode);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let resolved = resolved.expect("Failed to resolve argument");
|
||||||
|
assert_eq!(
|
||||||
|
resolved,
|
||||||
|
U256::from(
|
||||||
|
DummyEthereumNode
|
||||||
|
.block_timestamp(Default::default())
|
||||||
|
.unwrap()
|
||||||
|
)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
//! The revive differential tests case format.
|
||||||
|
|
||||||
|
pub mod case;
|
||||||
|
pub mod corpus;
|
||||||
|
pub mod input;
|
||||||
|
pub mod macros;
|
||||||
|
pub mod metadata;
|
||||||
|
pub mod mode;
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
/// Defines wrappers around types.
|
||||||
|
///
|
||||||
|
/// For example, the macro invocation seen below:
|
||||||
|
///
|
||||||
|
/// ```rust,ignore
|
||||||
|
/// define_wrapper_type!(CaseId => usize);
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Would define a wrapper type that looks like the following:
|
||||||
|
///
|
||||||
|
/// ```rust,ignore
|
||||||
|
/// pub struct CaseId(usize);
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// And would also implement a number of methods on this type making it easier
|
||||||
|
/// to use.
|
||||||
|
///
|
||||||
|
/// These wrapper types become very useful as they make the code a lot easier
|
||||||
|
/// to read.
|
||||||
|
///
|
||||||
|
/// Take the following as an example:
|
||||||
|
///
|
||||||
|
/// ```rust,ignore
|
||||||
|
/// struct State {
|
||||||
|
/// contracts: HashMap<usize, HashMap<String, Vec<u8>>>
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// In the above code it's hard to understand what the various types refer to or
|
||||||
|
/// what to expect them to contain.
|
||||||
|
///
|
||||||
|
/// With these wrapper types we're able to create code that's self-documenting
|
||||||
|
/// in that the types tell us what the code is referring to. The above code is
|
||||||
|
/// transformed into
|
||||||
|
///
|
||||||
|
/// ```rust,ignore
|
||||||
|
/// struct State {
|
||||||
|
/// contracts: HashMap<CaseId, HashMap<ContractName, ContractByteCode>>
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
#[macro_export]
|
||||||
|
macro_rules! define_wrapper_type {
|
||||||
|
(
|
||||||
|
$(#[$meta: meta])*
|
||||||
|
$ident: ident($ty: ty) $(;)?
|
||||||
|
) => {
|
||||||
|
$(#[$meta])*
|
||||||
|
pub struct $ident($ty);
|
||||||
|
|
||||||
|
impl $ident {
|
||||||
|
pub fn new(value: $ty) -> Self {
|
||||||
|
Self(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_from<T: Into<$ty>>(value: T) -> Self {
|
||||||
|
Self(value.into())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_inner(self) -> $ty {
|
||||||
|
self.0
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn as_inner(&self) -> &$ty {
|
||||||
|
&self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsRef<$ty> for $ident {
|
||||||
|
fn as_ref(&self) -> &$ty {
|
||||||
|
&self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsMut<$ty> for $ident {
|
||||||
|
fn as_mut(&mut self) -> &mut $ty {
|
||||||
|
&mut self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::ops::Deref for $ident {
|
||||||
|
type Target = $ty;
|
||||||
|
|
||||||
|
fn deref(&self) -> &Self::Target {
|
||||||
|
&self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::ops::DerefMut for $ident {
|
||||||
|
fn deref_mut(&mut self) -> &mut Self::Target {
|
||||||
|
&mut self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<$ty> for $ident {
|
||||||
|
fn from(value: $ty) -> Self {
|
||||||
|
Self(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<$ident> for $ty {
|
||||||
|
fn from(value: $ident) -> Self {
|
||||||
|
value.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,488 @@
|
|||||||
|
use std::{
|
||||||
|
collections::{BTreeMap, HashMap},
|
||||||
|
fmt::Display,
|
||||||
|
fs::{File, read_to_string},
|
||||||
|
ops::Deref,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
str::FromStr,
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::signers::local::PrivateKeySigner;
|
||||||
|
use alloy_primitives::Address;
|
||||||
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
case::Case,
|
||||||
|
define_wrapper_type,
|
||||||
|
input::resolve_argument,
|
||||||
|
mode::{Mode, SolcMode},
|
||||||
|
};
|
||||||
|
|
||||||
|
pub const METADATA_FILE_EXTENSION: &str = "json";
|
||||||
|
pub const SOLIDITY_CASE_FILE_EXTENSION: &str = "sol";
|
||||||
|
pub const SOLIDITY_CASE_COMMENT_MARKER: &str = "//!";
|
||||||
|
|
||||||
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub struct MetadataFile {
|
||||||
|
pub path: PathBuf,
|
||||||
|
pub content: Metadata,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl MetadataFile {
|
||||||
|
pub fn try_from_file(path: &Path) -> Option<Self> {
|
||||||
|
Metadata::try_from_file(path).map(|metadata| Self {
|
||||||
|
path: path.to_owned(),
|
||||||
|
content: metadata,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Deref for MetadataFile {
|
||||||
|
type Target = Metadata;
|
||||||
|
|
||||||
|
fn deref(&self) -> &Self::Target {
|
||||||
|
&self.content
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub struct Metadata {
|
||||||
|
pub targets: Option<Vec<String>>,
|
||||||
|
pub cases: Vec<Case>,
|
||||||
|
pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdentifier>>,
|
||||||
|
// TODO: Convert into wrapper types for clarity.
|
||||||
|
pub libraries: Option<BTreeMap<String, BTreeMap<String, String>>>,
|
||||||
|
pub ignore: Option<bool>,
|
||||||
|
pub modes: Option<Vec<Mode>>,
|
||||||
|
pub file_path: Option<PathBuf>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Metadata {
|
||||||
|
/// Returns the solc modes of this metadata, inserting a default mode if not present.
|
||||||
|
pub fn solc_modes(&self) -> Vec<SolcMode> {
|
||||||
|
self.modes
|
||||||
|
.to_owned()
|
||||||
|
.unwrap_or_else(|| vec![Mode::Solidity(Default::default())])
|
||||||
|
.iter()
|
||||||
|
.filter_map(|mode| match mode {
|
||||||
|
Mode::Solidity(solc_mode) => Some(solc_mode),
|
||||||
|
Mode::Unknown(mode) => {
|
||||||
|
tracing::debug!("compiler: ignoring unknown mode '{mode}'");
|
||||||
|
None
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.cloned()
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the base directory of this metadata.
|
||||||
|
pub fn directory(&self) -> anyhow::Result<PathBuf> {
|
||||||
|
Ok(self
|
||||||
|
.file_path
|
||||||
|
.as_ref()
|
||||||
|
.and_then(|path| path.parent())
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("metadata invalid file path: {:?}", self.file_path))?
|
||||||
|
.to_path_buf())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the contract sources with canonicalized paths for the files
|
||||||
|
pub fn contract_sources(
|
||||||
|
&self,
|
||||||
|
) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdentifier>> {
|
||||||
|
let directory = self.directory()?;
|
||||||
|
let mut sources = BTreeMap::new();
|
||||||
|
let Some(contracts) = &self.contracts else {
|
||||||
|
return Ok(sources);
|
||||||
|
};
|
||||||
|
|
||||||
|
for (
|
||||||
|
alias,
|
||||||
|
ContractPathAndIdentifier {
|
||||||
|
contract_source_path,
|
||||||
|
contract_ident,
|
||||||
|
},
|
||||||
|
) in contracts
|
||||||
|
{
|
||||||
|
let alias = alias.clone();
|
||||||
|
let absolute_path = directory.join(contract_source_path).canonicalize()?;
|
||||||
|
let contract_ident = contract_ident.clone();
|
||||||
|
|
||||||
|
sources.insert(
|
||||||
|
alias,
|
||||||
|
ContractPathAndIdentifier {
|
||||||
|
contract_source_path: absolute_path,
|
||||||
|
contract_ident,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(sources)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Try to parse the test metadata struct from the given file at `path`.
|
||||||
|
///
|
||||||
|
/// Returns `None` if `path` didn't contain a test metadata or case definition.
|
||||||
|
///
|
||||||
|
/// # Panics
|
||||||
|
/// Expects the supplied `path` to be a file.
|
||||||
|
pub fn try_from_file(path: &Path) -> Option<Self> {
|
||||||
|
assert!(path.is_file(), "not a file: {}", path.display());
|
||||||
|
|
||||||
|
let Some(file_extension) = path.extension() else {
|
||||||
|
tracing::debug!("skipping corpus file: {}", path.display());
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
|
||||||
|
if file_extension == METADATA_FILE_EXTENSION {
|
||||||
|
return Self::try_from_json(path);
|
||||||
|
}
|
||||||
|
|
||||||
|
if file_extension == SOLIDITY_CASE_FILE_EXTENSION {
|
||||||
|
return Self::try_from_solidity(path);
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!("ignoring invalid corpus file: {}", path.display());
|
||||||
|
None
|
||||||
|
}
|
||||||
|
|
||||||
|
fn try_from_json(path: &Path) -> Option<Self> {
|
||||||
|
let file = File::open(path)
|
||||||
|
.inspect_err(|error| {
|
||||||
|
tracing::error!(
|
||||||
|
"opening JSON test metadata file '{}' error: {error}",
|
||||||
|
path.display()
|
||||||
|
);
|
||||||
|
})
|
||||||
|
.ok()?;
|
||||||
|
|
||||||
|
match serde_json::from_reader::<_, Metadata>(file) {
|
||||||
|
Ok(mut metadata) => {
|
||||||
|
metadata.file_path = Some(path.to_path_buf());
|
||||||
|
Some(metadata)
|
||||||
|
}
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!(
|
||||||
|
"parsing JSON test metadata file '{}' error: {error}",
|
||||||
|
path.display()
|
||||||
|
);
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn try_from_solidity(path: &Path) -> Option<Self> {
|
||||||
|
let spec = read_to_string(path)
|
||||||
|
.inspect_err(|error| {
|
||||||
|
tracing::error!(
|
||||||
|
"opening JSON test metadata file '{}' error: {error}",
|
||||||
|
path.display()
|
||||||
|
);
|
||||||
|
})
|
||||||
|
.ok()?
|
||||||
|
.lines()
|
||||||
|
.filter_map(|line| line.strip_prefix(SOLIDITY_CASE_COMMENT_MARKER))
|
||||||
|
.fold(String::new(), |mut buf, string| {
|
||||||
|
buf.push_str(string);
|
||||||
|
buf
|
||||||
|
});
|
||||||
|
|
||||||
|
if spec.is_empty() {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
match serde_json::from_str::<Self>(&spec) {
|
||||||
|
Ok(mut metadata) => {
|
||||||
|
metadata.file_path = Some(path.to_path_buf());
|
||||||
|
metadata.contracts = Some(
|
||||||
|
[(
|
||||||
|
ContractInstance::new_from("test"),
|
||||||
|
ContractPathAndIdentifier {
|
||||||
|
contract_source_path: path.to_path_buf(),
|
||||||
|
contract_ident: ContractIdent::new_from("Test"),
|
||||||
|
},
|
||||||
|
)]
|
||||||
|
.into(),
|
||||||
|
);
|
||||||
|
Some(metadata)
|
||||||
|
}
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!(
|
||||||
|
"parsing Solidity test metadata file '{}' error: '{error}' from data: {spec}",
|
||||||
|
path.display()
|
||||||
|
);
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn handle_address_replacement(
|
||||||
|
&mut self,
|
||||||
|
old_to_new_mapping: &mut AddressReplacementMap,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
for case in self.cases.iter_mut() {
|
||||||
|
case.handle_address_replacement(old_to_new_mapping)?;
|
||||||
|
}
|
||||||
|
tracing::debug!(metadata = ?self, "Performed replacement on metadata");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
define_wrapper_type!(
|
||||||
|
/// Represents a contract instance found a metadata file.
|
||||||
|
///
|
||||||
|
/// Typically, this is used as the key to the "contracts" field of metadata files.
|
||||||
|
#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
|
#[serde(transparent)]
|
||||||
|
ContractInstance(String);
|
||||||
|
);
|
||||||
|
|
||||||
|
define_wrapper_type!(
|
||||||
|
/// Represents a contract identifier found a metadata file.
|
||||||
|
///
|
||||||
|
/// A contract identifier is the name of the contract in the source code.
|
||||||
|
#[derive(Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
|
#[serde(transparent)]
|
||||||
|
ContractIdent(String);
|
||||||
|
);
|
||||||
|
|
||||||
|
/// Represents an identifier used for contracts.
|
||||||
|
///
|
||||||
|
/// The type supports serialization from and into the following string format:
|
||||||
|
///
|
||||||
|
/// ```text
|
||||||
|
/// ${path}:${contract_ident}
|
||||||
|
/// ```
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
|
#[serde(try_from = "String", into = "String")]
|
||||||
|
pub struct ContractPathAndIdentifier {
|
||||||
|
/// The path of the contract source code relative to the directory containing the metadata file.
|
||||||
|
pub contract_source_path: PathBuf,
|
||||||
|
|
||||||
|
/// The identifier of the contract.
|
||||||
|
pub contract_ident: ContractIdent,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ContractPathAndIdentifier {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
write!(
|
||||||
|
f,
|
||||||
|
"{}:{}",
|
||||||
|
self.contract_source_path.display(),
|
||||||
|
self.contract_ident.as_ref()
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for ContractPathAndIdentifier {
|
||||||
|
type Err = anyhow::Error;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
let mut splitted_string = s.split(":").peekable();
|
||||||
|
let mut path = None::<String>;
|
||||||
|
let mut identifier = None::<String>;
|
||||||
|
loop {
|
||||||
|
let Some(next_item) = splitted_string.next() else {
|
||||||
|
break;
|
||||||
|
};
|
||||||
|
if splitted_string.peek().is_some() {
|
||||||
|
match path {
|
||||||
|
Some(ref mut path) => {
|
||||||
|
path.push(':');
|
||||||
|
path.push_str(next_item);
|
||||||
|
}
|
||||||
|
None => path = Some(next_item.to_owned()),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
identifier = Some(next_item.to_owned())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let Some(path) = path else {
|
||||||
|
anyhow::bail!("Path is not defined");
|
||||||
|
};
|
||||||
|
let Some(identifier) = identifier else {
|
||||||
|
anyhow::bail!("Contract identifier is not defined")
|
||||||
|
};
|
||||||
|
Ok(Self {
|
||||||
|
contract_source_path: PathBuf::from(path),
|
||||||
|
contract_ident: ContractIdent::new(identifier),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<String> for ContractPathAndIdentifier {
|
||||||
|
type Error = anyhow::Error;
|
||||||
|
|
||||||
|
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||||
|
Self::from_str(&value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<ContractPathAndIdentifier> for String {
|
||||||
|
fn from(value: ContractPathAndIdentifier) -> Self {
|
||||||
|
value.to_string()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Default)]
|
||||||
|
pub struct AddressReplacementMap(HashMap<Address, (PrivateKeySigner, Address)>);
|
||||||
|
|
||||||
|
impl AddressReplacementMap {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self(Default::default())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_inner(self) -> HashMap<Address, (PrivateKeySigner, Address)> {
|
||||||
|
self.0
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn contains_key(&self, address: &Address) -> bool {
|
||||||
|
self.0.contains_key(address)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn add(&mut self, address: Address) -> Address {
|
||||||
|
self.0
|
||||||
|
.entry(address)
|
||||||
|
.or_insert_with(|| {
|
||||||
|
let private_key = Self::new_random_private_key_signer();
|
||||||
|
let account = private_key.address();
|
||||||
|
tracing::debug!(
|
||||||
|
old_address = %address,
|
||||||
|
new_address = %account,
|
||||||
|
"Added a new address replacement"
|
||||||
|
);
|
||||||
|
(private_key, account)
|
||||||
|
})
|
||||||
|
.1
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn resolve(&self, value: &str) -> Option<Address> {
|
||||||
|
// We attempt to resolve the given string without any additional context of the deployed
|
||||||
|
// contracts or the node API as we do not need them. If the resolution fails then we know
|
||||||
|
// that this isn't an address and we skip it.
|
||||||
|
let Ok(resolved) = resolve_argument(value, &Default::default(), &UnimplementedEthereumNode)
|
||||||
|
else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
let resolved_bytes = resolved.to_be_bytes_trimmed_vec();
|
||||||
|
let Ok(address) = Address::try_from(resolved_bytes.as_slice()) else {
|
||||||
|
return None;
|
||||||
|
};
|
||||||
|
self.0.get(&address).map(|(_, address)| *address)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new_random_private_key_signer() -> PrivateKeySigner {
|
||||||
|
// TODO: Use a seedable RNG to allow for deterministic allocation of the private keys so
|
||||||
|
// that we get reproducible runs.
|
||||||
|
PrivateKeySigner::random()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AsRef<HashMap<Address, (PrivateKeySigner, Address)>> for AddressReplacementMap {
|
||||||
|
fn as_ref(&self) -> &HashMap<Address, (PrivateKeySigner, Address)> {
|
||||||
|
&self.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
struct UnimplementedEthereumNode;
|
||||||
|
|
||||||
|
impl EthereumNode for UnimplementedEthereumNode {
|
||||||
|
fn execute_transaction(
|
||||||
|
&self,
|
||||||
|
_: alloy::rpc::types::TransactionRequest,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn chain_id(&self) -> anyhow::Result<alloy_primitives::ChainId> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_gas_limit(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<u128> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_coinbase(&self, _: alloy::eips::BlockNumberOrTag) -> anyhow::Result<Address> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_difficulty(
|
||||||
|
&self,
|
||||||
|
_: alloy::eips::BlockNumberOrTag,
|
||||||
|
) -> anyhow::Result<alloy_primitives::U256> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_hash(
|
||||||
|
&self,
|
||||||
|
_: alloy::eips::BlockNumberOrTag,
|
||||||
|
) -> anyhow::Result<alloy_primitives::BlockHash> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn block_timestamp(
|
||||||
|
&self,
|
||||||
|
_: alloy::eips::BlockNumberOrTag,
|
||||||
|
) -> anyhow::Result<alloy_primitives::BlockTimestamp> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn last_block_number(&self) -> anyhow::Result<alloy_primitives::BlockNumber> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn trace_transaction(
|
||||||
|
&self,
|
||||||
|
_: &alloy::rpc::types::TransactionReceipt,
|
||||||
|
_: alloy::rpc::types::trace::geth::GethDebugTracingOptions,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
|
||||||
|
fn state_diff(
|
||||||
|
&self,
|
||||||
|
_: &alloy::rpc::types::TransactionReceipt,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::DiffMode> {
|
||||||
|
anyhow::bail!("Unimplemented")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod test {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn contract_identifier_respects_roundtrip_property() {
|
||||||
|
// Arrange
|
||||||
|
let string = "ERC20/ERC20.sol:ERC20";
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let identifier = ContractPathAndIdentifier::from_str(string);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let identifier = identifier.expect("Failed to parse");
|
||||||
|
assert_eq!(
|
||||||
|
identifier.contract_source_path.display().to_string(),
|
||||||
|
"ERC20/ERC20.sol"
|
||||||
|
);
|
||||||
|
assert_eq!(identifier.contract_ident, "ERC20".to_owned().into());
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let reserialized = identifier.to_string();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert_eq!(string, reserialized);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn complex_metadata_file_can_be_deserialized() {
|
||||||
|
// Arrange
|
||||||
|
const JSON: &str = include_str!("../../../assets/test_metadata.json");
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let metadata = serde_json::from_str::<Metadata>(JSON);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
metadata.expect("Failed to deserialize metadata");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
use semver::Version;
|
||||||
|
use serde::de::Deserializer;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Specifies the compilation mode of the test artifact.
|
||||||
|
#[derive(Hash, Debug, Clone, Eq, PartialEq)]
|
||||||
|
pub enum Mode {
|
||||||
|
Solidity(SolcMode),
|
||||||
|
Unknown(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Specify Solidity specific compiler options.
|
||||||
|
#[derive(Hash, Debug, Default, Clone, Eq, PartialEq, Serialize, Deserialize)]
|
||||||
|
pub struct SolcMode {
|
||||||
|
pub solc_version: Option<semver::VersionReq>,
|
||||||
|
solc_optimize: Option<bool>,
|
||||||
|
pub llvm_optimizer_settings: Vec<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SolcMode {
|
||||||
|
/// Try to parse a mode string into a solc mode.
|
||||||
|
/// Returns `None` if the string wasn't a solc YUL mode string.
|
||||||
|
///
|
||||||
|
/// The mode string is expected to start with the `Y` ID (YUL ID),
|
||||||
|
/// optionally followed by `+` or `-` for the solc optimizer settings.
|
||||||
|
///
|
||||||
|
/// Options can be separated by a whitespace contain the following
|
||||||
|
/// - A solc `SemVer version requirement` string
|
||||||
|
/// - One or more `-OX` where X is a supposed to be an LLVM opt mode
|
||||||
|
pub fn parse_from_mode_string(mode_string: &str) -> Option<Self> {
|
||||||
|
let mut result = Self::default();
|
||||||
|
|
||||||
|
let mut parts = mode_string.trim().split(" ");
|
||||||
|
|
||||||
|
match parts.next()? {
|
||||||
|
"Y" => {}
|
||||||
|
"Y+" => result.solc_optimize = Some(true),
|
||||||
|
"Y-" => result.solc_optimize = Some(false),
|
||||||
|
_ => return None,
|
||||||
|
}
|
||||||
|
|
||||||
|
for part in parts {
|
||||||
|
if let Ok(solc_version) = semver::VersionReq::parse(part) {
|
||||||
|
result.solc_version = Some(solc_version);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some(level) = part.strip_prefix("-O") {
|
||||||
|
result.llvm_optimizer_settings.push(level.to_string());
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
panic!("the YUL mode string {mode_string} failed to parse, invalid part: {part}")
|
||||||
|
}
|
||||||
|
|
||||||
|
Some(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns whether to enable the solc optimizer.
|
||||||
|
pub fn solc_optimize(&self) -> bool {
|
||||||
|
self.solc_optimize.unwrap_or(true)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Calculate the latest matching solc patch version. Returns:
|
||||||
|
/// - `latest_supported` if no version request was specified.
|
||||||
|
/// - A matching version with the same minor version as `latest_supported`, if any.
|
||||||
|
/// - `None` if no minor version of the `latest_supported` version matches.
|
||||||
|
pub fn last_patch_version(&self, latest_supported: &Version) -> Option<Version> {
|
||||||
|
let Some(version_req) = self.solc_version.as_ref() else {
|
||||||
|
return Some(latest_supported.to_owned());
|
||||||
|
};
|
||||||
|
|
||||||
|
// lgtm
|
||||||
|
for patch in (0..latest_supported.patch + 1).rev() {
|
||||||
|
let version = Version::new(0, latest_supported.minor, patch);
|
||||||
|
if version_req.matches(&version) {
|
||||||
|
return Some(version);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'de> Deserialize<'de> for Mode {
|
||||||
|
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
||||||
|
where
|
||||||
|
D: Deserializer<'de>,
|
||||||
|
{
|
||||||
|
let mode_string = String::deserialize(deserializer)?;
|
||||||
|
|
||||||
|
if let Some(solc_mode) = SolcMode::parse_from_mode_string(&mode_string) {
|
||||||
|
return Ok(Self::Solidity(solc_mode));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Self::Unknown(mode_string))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-node-interaction"
|
||||||
|
description = "send and trace transactions to nodes"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
alloy = { workspace = true }
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
futures = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
once_cell = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
@@ -0,0 +1,228 @@
|
|||||||
|
//! The alloy crate __requires__ a tokio runtime.
|
||||||
|
//! We contain any async rust right here.
|
||||||
|
|
||||||
|
use std::{any::Any, panic::AssertUnwindSafe, pin::Pin, thread};
|
||||||
|
|
||||||
|
use futures::FutureExt;
|
||||||
|
use once_cell::sync::Lazy;
|
||||||
|
use tokio::{
|
||||||
|
runtime::Builder,
|
||||||
|
sync::{mpsc::UnboundedSender, oneshot},
|
||||||
|
};
|
||||||
|
use tracing::Instrument;
|
||||||
|
|
||||||
|
/// A blocking async executor.
|
||||||
|
///
|
||||||
|
/// This struct exposes the abstraction of a blocking async executor. It is a global and static
|
||||||
|
/// executor which means that it doesn't require for new instances of it to be created, it's a
|
||||||
|
/// singleton and can be accessed by any thread that wants to perform some async computation on the
|
||||||
|
/// blocking executor thread.
|
||||||
|
///
|
||||||
|
/// The API of the blocking executor is created in a way so that it's very natural, simple to use,
|
||||||
|
/// and unbounded to specific tasks or return types. The following is an example of using this
|
||||||
|
/// executor to drive an async computation:
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// use revive_dt_node_interaction::*;
|
||||||
|
///
|
||||||
|
/// fn blocking_function() {
|
||||||
|
/// let result = BlockingExecutor::execute(async move {
|
||||||
|
/// tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||||
|
/// 0xFFu8
|
||||||
|
/// })
|
||||||
|
/// .expect("Computation failed");
|
||||||
|
///
|
||||||
|
/// assert_eq!(result, 0xFF);
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Users get to pass in their async tasks without needing to worry about putting them in a [`Box`],
|
||||||
|
/// [`Pin`], needing to perform down-casting, or the internal channel mechanism used by the runtime.
|
||||||
|
/// To the user, it just looks like a function that converts some async code into sync code.
|
||||||
|
///
|
||||||
|
/// This struct also handled panics that occur in the passed futures and converts them into errors
|
||||||
|
/// that can be handled by the user. This is done to allow the executor to be robust.
|
||||||
|
///
|
||||||
|
/// Internally, the executor communicates with the tokio runtime thread through channels which carry
|
||||||
|
/// the [`TaskMessage`] and the results of the execution.
|
||||||
|
pub struct BlockingExecutor;
|
||||||
|
|
||||||
|
impl BlockingExecutor {
|
||||||
|
pub fn execute<R>(future: impl Future<Output = R> + Send + 'static) -> Result<R, anyhow::Error>
|
||||||
|
where
|
||||||
|
R: Send + 'static,
|
||||||
|
{
|
||||||
|
// Note: The blocking executor is a singleton and therefore we store its state in a static
|
||||||
|
// so that it's assigned only once. Additionally, when we set the state of the executor we
|
||||||
|
// spawn the thread where the async runtime runs.
|
||||||
|
static STATE: Lazy<ExecutorState> = Lazy::new(|| {
|
||||||
|
tracing::trace!("Initializing the BlockingExecutor state");
|
||||||
|
|
||||||
|
// All communication with the tokio runtime thread happens over mspc channels where the
|
||||||
|
// producers here are the threads that want to run async tasks and the consumer here is
|
||||||
|
// the tokio runtime thread.
|
||||||
|
let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<TaskMessage>();
|
||||||
|
|
||||||
|
thread::spawn(move || {
|
||||||
|
tracing::info!(
|
||||||
|
thread_id = ?std::thread::current().id(),
|
||||||
|
"Starting async runtime thread"
|
||||||
|
);
|
||||||
|
|
||||||
|
let runtime = Builder::new_current_thread()
|
||||||
|
.enable_all()
|
||||||
|
.build()
|
||||||
|
.expect("Failed to create the async runtime");
|
||||||
|
|
||||||
|
runtime.block_on(async move {
|
||||||
|
while let Some(TaskMessage {
|
||||||
|
future: task,
|
||||||
|
response_tx: response_channel,
|
||||||
|
}) = rx.recv().await
|
||||||
|
{
|
||||||
|
tracing::trace!("Received a new future to execute");
|
||||||
|
tokio::spawn(async move {
|
||||||
|
// One of the things that the blocking executor does is that it allows
|
||||||
|
// us to catch panics if they occur. By wrapping the given future in an
|
||||||
|
// AssertUnwindSafe::catch_unwind we are able to catch all panic unwinds
|
||||||
|
// in the given future and convert them into errors.
|
||||||
|
let task = AssertUnwindSafe(task).catch_unwind();
|
||||||
|
|
||||||
|
let result = task.await;
|
||||||
|
let _ = response_channel.send(result);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
ExecutorState { tx }
|
||||||
|
});
|
||||||
|
|
||||||
|
// We need to perform blocking synchronous communication between the current thread and the
|
||||||
|
// tokio runtime thread with the result of the async computation and the oneshot channels
|
||||||
|
// from tokio allows us to do that. The sender side of the channel will be given to the
|
||||||
|
// tokio runtime thread to send the result when the computation is completed and the receive
|
||||||
|
// side of the channel will be kept with this thread to await for the response of the async
|
||||||
|
// task to come back.
|
||||||
|
let (response_tx, response_rx) =
|
||||||
|
oneshot::channel::<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>();
|
||||||
|
|
||||||
|
// The tokio runtime thread expects a Future<Output = Box<dyn Any + Send>> + Send to be
|
||||||
|
// sent to it to execute. However, this function has a typed Future<Output = R> + Send and
|
||||||
|
// therefore we need to change the type of the future to fit what the runtime thread expects
|
||||||
|
// in the task message. In doing this conversion, we lose some of the type information since
|
||||||
|
// we're converting R => dyn Any. However, we will perform down-casting on the result to
|
||||||
|
// convert it back into R.
|
||||||
|
let future = Box::pin(
|
||||||
|
async move { Box::new(future.await) as Box<dyn Any + Send> }.in_current_span(),
|
||||||
|
);
|
||||||
|
|
||||||
|
let task = TaskMessage::new(future, response_tx);
|
||||||
|
if let Err(error) = STATE.tx.send(task) {
|
||||||
|
tracing::error!(?error, "Failed to send the task to the blocking executor");
|
||||||
|
anyhow::bail!("Failed to send the task to the blocking executor: {error:?}")
|
||||||
|
}
|
||||||
|
|
||||||
|
let result = match response_rx.blocking_recv() {
|
||||||
|
Ok(result) => result,
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!(
|
||||||
|
?error,
|
||||||
|
"Failed to get the response from the blocking executor"
|
||||||
|
);
|
||||||
|
anyhow::bail!("Failed to get the response from the blocking executor: {error:?}")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
match result.map(|result| {
|
||||||
|
*result
|
||||||
|
.downcast::<R>()
|
||||||
|
.expect("Type mismatch in the downcast")
|
||||||
|
}) {
|
||||||
|
Ok(result) => Ok(result),
|
||||||
|
Err(error) => {
|
||||||
|
tracing::error!(
|
||||||
|
?error,
|
||||||
|
"Failed to downcast the returned result into the expected type"
|
||||||
|
);
|
||||||
|
anyhow::bail!(
|
||||||
|
"Failed to downcast the returned result into the expected type: {error:?}"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
/// Represents the state of the async runtime. This runtime is designed to be a singleton runtime
|
||||||
|
/// which means that in the current running program there's just a single thread that has an async
|
||||||
|
/// runtime.
|
||||||
|
struct ExecutorState {
|
||||||
|
/// The sending side of the task messages channel. This is used by all of the other threads to
|
||||||
|
/// communicate with the async runtime thread.
|
||||||
|
tx: UnboundedSender<TaskMessage>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Represents a message that contains an asynchronous task that's to be executed by the runtime
|
||||||
|
/// as well as a way for the runtime to report back on the result of the execution.
|
||||||
|
struct TaskMessage {
|
||||||
|
/// The task that's being requested to run. This is a future that returns an object that does
|
||||||
|
/// implement [`Any`] and [`Send`] to allow it to be sent between the requesting thread and the
|
||||||
|
/// async thread.
|
||||||
|
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
||||||
|
|
||||||
|
/// A one shot sender channel where the sender of the task is expecting to hear back on the
|
||||||
|
/// result of the task.
|
||||||
|
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TaskMessage {
|
||||||
|
pub fn new(
|
||||||
|
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
||||||
|
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
future,
|
||||||
|
response_tx,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod test {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn simple_future_works() {
|
||||||
|
// Act
|
||||||
|
let result = BlockingExecutor::execute(async move {
|
||||||
|
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||||
|
0xFFu8
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert_eq!(result, 0xFFu8);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[allow(unreachable_code, clippy::unreachable)]
|
||||||
|
fn panics_in_futures_are_caught() {
|
||||||
|
// Act
|
||||||
|
let result = BlockingExecutor::execute(async move {
|
||||||
|
panic!("This is a panic!");
|
||||||
|
0xFFu8
|
||||||
|
});
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert!(result.is_err());
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let result = BlockingExecutor::execute(async move {
|
||||||
|
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||||
|
0xFFu8
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
assert_eq!(result, 0xFFu8)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
//! This crate implements all node interactions.
|
||||||
|
|
||||||
|
use alloy::eips::BlockNumberOrTag;
|
||||||
|
use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256};
|
||||||
|
use alloy::rpc::types::trace::geth::{DiffMode, GethDebugTracingOptions, GethTrace};
|
||||||
|
use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
|
||||||
|
use anyhow::Result;
|
||||||
|
|
||||||
|
mod blocking_executor;
|
||||||
|
pub use blocking_executor::*;
|
||||||
|
|
||||||
|
/// An interface for all interactions with Ethereum compatible nodes.
|
||||||
|
pub trait EthereumNode {
|
||||||
|
/// Execute the [TransactionRequest] and return a [TransactionReceipt].
|
||||||
|
fn execute_transaction(&self, transaction: TransactionRequest) -> Result<TransactionReceipt>;
|
||||||
|
|
||||||
|
/// Trace the transaction in the [TransactionReceipt] and return a [GethTrace].
|
||||||
|
fn trace_transaction(
|
||||||
|
&self,
|
||||||
|
receipt: &TransactionReceipt,
|
||||||
|
trace_options: GethDebugTracingOptions,
|
||||||
|
) -> Result<GethTrace>;
|
||||||
|
|
||||||
|
/// Returns the state diff of the transaction hash in the [TransactionReceipt].
|
||||||
|
fn state_diff(&self, receipt: &TransactionReceipt) -> Result<DiffMode>;
|
||||||
|
|
||||||
|
/// Returns the ID of the chain that the node is on.
|
||||||
|
fn chain_id(&self) -> Result<ChainId>;
|
||||||
|
|
||||||
|
// TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
|
||||||
|
// when we implement the changes to the gas we need to adjust this to be a u64.
|
||||||
|
/// Returns the gas limit of the specified block.
|
||||||
|
fn block_gas_limit(&self, number: BlockNumberOrTag) -> Result<u128>;
|
||||||
|
|
||||||
|
/// Returns the coinbase of the specified block.
|
||||||
|
fn block_coinbase(&self, number: BlockNumberOrTag) -> Result<Address>;
|
||||||
|
|
||||||
|
/// Returns the difficulty of the specified block.
|
||||||
|
fn block_difficulty(&self, number: BlockNumberOrTag) -> Result<U256>;
|
||||||
|
|
||||||
|
/// Returns the hash of the specified block.
|
||||||
|
fn block_hash(&self, number: BlockNumberOrTag) -> Result<BlockHash>;
|
||||||
|
|
||||||
|
/// Returns the timestamp of the specified block,
|
||||||
|
fn block_timestamp(&self, number: BlockNumberOrTag) -> Result<BlockTimestamp>;
|
||||||
|
|
||||||
|
/// Returns the number of the last block.
|
||||||
|
fn last_block_number(&self) -> Result<BlockNumber>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-node"
|
||||||
|
description = "abstraction over blockchain nodes"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
alloy = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
|
|
||||||
|
revive-dt-node-interaction = { workspace = true }
|
||||||
|
revive-dt-config = { workspace = true }
|
||||||
|
|
||||||
|
serde = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
|
||||||
|
sp-core = { workspace = true }
|
||||||
|
sp-runtime = { workspace = true }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
temp-dir = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
use alloy::{
|
||||||
|
network::{Network, TransactionBuilder},
|
||||||
|
providers::{
|
||||||
|
Provider, SendableTx,
|
||||||
|
fillers::{GasFiller, TxFiller},
|
||||||
|
},
|
||||||
|
transports::TransportResult,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct FallbackGasFiller {
|
||||||
|
inner: GasFiller,
|
||||||
|
default_gas_limit: u64,
|
||||||
|
default_max_fee_per_gas: u128,
|
||||||
|
default_priority_fee: u128,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FallbackGasFiller {
|
||||||
|
pub fn new(
|
||||||
|
default_gas_limit: u64,
|
||||||
|
default_max_fee_per_gas: u128,
|
||||||
|
default_priority_fee: u128,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
inner: GasFiller,
|
||||||
|
default_gas_limit,
|
||||||
|
default_max_fee_per_gas,
|
||||||
|
default_priority_fee,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<N> TxFiller<N> for FallbackGasFiller
|
||||||
|
where
|
||||||
|
N: Network,
|
||||||
|
{
|
||||||
|
type Fillable = Option<<GasFiller as TxFiller<N>>::Fillable>;
|
||||||
|
|
||||||
|
fn status(
|
||||||
|
&self,
|
||||||
|
tx: &<N as Network>::TransactionRequest,
|
||||||
|
) -> alloy::providers::fillers::FillerControlFlow {
|
||||||
|
<GasFiller as TxFiller<N>>::status(&self.inner, tx)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn fill_sync(&self, _: &mut alloy::providers::SendableTx<N>) {}
|
||||||
|
|
||||||
|
async fn prepare<P: Provider<N>>(
|
||||||
|
&self,
|
||||||
|
provider: &P,
|
||||||
|
tx: &<N as Network>::TransactionRequest,
|
||||||
|
) -> TransportResult<Self::Fillable> {
|
||||||
|
// Try to fetch GasFiller’s “fillable” (gas_price, base_fee, estimate_gas, …)
|
||||||
|
// If it errors (i.e. tx would revert under eth_estimateGas), swallow it.
|
||||||
|
match self.inner.prepare(provider, tx).await {
|
||||||
|
Ok(fill) => Ok(Some(fill)),
|
||||||
|
Err(_) => Ok(None),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn fill(
|
||||||
|
&self,
|
||||||
|
fillable: Self::Fillable,
|
||||||
|
mut tx: alloy::providers::SendableTx<N>,
|
||||||
|
) -> TransportResult<SendableTx<N>> {
|
||||||
|
if let Some(fill) = fillable {
|
||||||
|
// our inner GasFiller succeeded — use it
|
||||||
|
self.inner.fill(fill, tx).await
|
||||||
|
} else {
|
||||||
|
if let Some(builder) = tx.as_mut_builder() {
|
||||||
|
builder.set_gas_limit(self.default_gas_limit);
|
||||||
|
builder.set_max_fee_per_gas(self.default_max_fee_per_gas);
|
||||||
|
builder.set_max_priority_fee_per_gas(self.default_priority_fee);
|
||||||
|
}
|
||||||
|
Ok(tx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,673 @@
|
|||||||
|
//! The go-ethereum node implementation.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
||||||
|
io::{BufRead, BufReader, Read, Write},
|
||||||
|
path::PathBuf,
|
||||||
|
process::{Child, Command, Stdio},
|
||||||
|
sync::atomic::{AtomicU32, Ordering},
|
||||||
|
time::{Duration, Instant},
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::{
|
||||||
|
eips::BlockNumberOrTag,
|
||||||
|
genesis::{Genesis, GenesisAccount},
|
||||||
|
network::{Ethereum, EthereumWallet, NetworkWallet, TxSigner},
|
||||||
|
primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, U256},
|
||||||
|
providers::{
|
||||||
|
Provider, ProviderBuilder,
|
||||||
|
ext::DebugApi,
|
||||||
|
fillers::{CachedNonceManager, ChainIdFiller, FillProvider, NonceFiller, TxFiller},
|
||||||
|
},
|
||||||
|
rpc::types::{
|
||||||
|
TransactionReceipt, TransactionRequest,
|
||||||
|
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
||||||
|
},
|
||||||
|
signers::Signature,
|
||||||
|
};
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
use revive_dt_node_interaction::{BlockingExecutor, EthereumNode};
|
||||||
|
use tracing::Level;
|
||||||
|
|
||||||
|
use crate::{Node, common::FallbackGasFiller};
|
||||||
|
|
||||||
|
static NODE_COUNT: AtomicU32 = AtomicU32::new(0);
|
||||||
|
|
||||||
|
/// The go-ethereum node instance implementation.
|
||||||
|
///
|
||||||
|
/// Implements helpers to initialize, spawn and wait the node.
|
||||||
|
///
|
||||||
|
/// Assumes dev mode and IPC only (`P2P`, `http`` etc. are kept disabled).
|
||||||
|
///
|
||||||
|
/// Prunes the child process and the base directory on drop.
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct Instance {
|
||||||
|
connection_string: String,
|
||||||
|
base_directory: PathBuf,
|
||||||
|
data_directory: PathBuf,
|
||||||
|
logs_directory: PathBuf,
|
||||||
|
geth: PathBuf,
|
||||||
|
id: u32,
|
||||||
|
handle: Option<Child>,
|
||||||
|
network_id: u64,
|
||||||
|
start_timeout: u64,
|
||||||
|
wallet: EthereumWallet,
|
||||||
|
nonce_manager: CachedNonceManager,
|
||||||
|
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
||||||
|
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
||||||
|
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
||||||
|
/// what it belongs to, we just want to flush them on [`Drop`] of the node.
|
||||||
|
logs_file_to_flush: Vec<File>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Instance {
|
||||||
|
const BASE_DIRECTORY: &str = "geth";
|
||||||
|
const DATA_DIRECTORY: &str = "data";
|
||||||
|
const LOGS_DIRECTORY: &str = "logs";
|
||||||
|
|
||||||
|
const IPC_FILE: &str = "geth.ipc";
|
||||||
|
const GENESIS_JSON_FILE: &str = "genesis.json";
|
||||||
|
|
||||||
|
const READY_MARKER: &str = "IPC endpoint opened";
|
||||||
|
const ERROR_MARKER: &str = "Fatal:";
|
||||||
|
|
||||||
|
const GETH_STDOUT_LOG_FILE_NAME: &str = "node_stdout.log";
|
||||||
|
const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
||||||
|
|
||||||
|
/// Create the node directory and call `geth init` to configure the genesis.
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
||||||
|
create_dir_all(&self.base_directory)?;
|
||||||
|
create_dir_all(&self.logs_directory)?;
|
||||||
|
|
||||||
|
let mut genesis = serde_json::from_str::<Genesis>(&genesis)?;
|
||||||
|
for signer_address in
|
||||||
|
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
||||||
|
{
|
||||||
|
genesis.alloc.entry(signer_address).or_insert(
|
||||||
|
GenesisAccount::default()
|
||||||
|
.with_balance(10000000000000000000000u128.try_into().unwrap()),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
||||||
|
serde_json::to_writer(File::create(&genesis_path)?, &genesis)?;
|
||||||
|
|
||||||
|
let mut child = Command::new(&self.geth)
|
||||||
|
.arg("init")
|
||||||
|
.arg("--datadir")
|
||||||
|
.arg(&self.data_directory)
|
||||||
|
.arg(genesis_path)
|
||||||
|
.stderr(Stdio::piped())
|
||||||
|
.stdout(Stdio::null())
|
||||||
|
.spawn()?;
|
||||||
|
|
||||||
|
let mut stderr = String::new();
|
||||||
|
child
|
||||||
|
.stderr
|
||||||
|
.take()
|
||||||
|
.expect("should be piped")
|
||||||
|
.read_to_string(&mut stderr)?;
|
||||||
|
|
||||||
|
if !child.wait()?.success() {
|
||||||
|
anyhow::bail!("failed to initialize geth node #{:?}: {stderr}", &self.id);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(self)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Spawn the go-ethereum node child process.
|
||||||
|
///
|
||||||
|
/// [Instance::init] must be called prior.
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
|
// This is the `OpenOptions` that we wish to use for all of the log files that we will be
|
||||||
|
// opening in this method. We need to construct it in this way to:
|
||||||
|
// 1. Be consistent
|
||||||
|
// 2. Less verbose and more dry
|
||||||
|
// 3. Because the builder pattern uses mutable references so we need to get around that.
|
||||||
|
let open_options = {
|
||||||
|
let mut options = OpenOptions::new();
|
||||||
|
options.create(true).truncate(true).write(true);
|
||||||
|
options
|
||||||
|
};
|
||||||
|
|
||||||
|
let stdout_logs_file = open_options
|
||||||
|
.clone()
|
||||||
|
.open(self.geth_stdout_log_file_path())?;
|
||||||
|
let stderr_logs_file = open_options.open(self.geth_stderr_log_file_path())?;
|
||||||
|
self.handle = Command::new(&self.geth)
|
||||||
|
.arg("--dev")
|
||||||
|
.arg("--datadir")
|
||||||
|
.arg(&self.data_directory)
|
||||||
|
.arg("--ipcpath")
|
||||||
|
.arg(&self.connection_string)
|
||||||
|
.arg("--networkid")
|
||||||
|
.arg(self.network_id.to_string())
|
||||||
|
.arg("--nodiscover")
|
||||||
|
.arg("--maxpeers")
|
||||||
|
.arg("0")
|
||||||
|
.stderr(stderr_logs_file.try_clone()?)
|
||||||
|
.stdout(stdout_logs_file.try_clone()?)
|
||||||
|
.spawn()?
|
||||||
|
.into();
|
||||||
|
|
||||||
|
if let Err(error) = self.wait_ready() {
|
||||||
|
tracing::error!(?error, "Failed to start geth, shutting down gracefully");
|
||||||
|
self.shutdown()?;
|
||||||
|
return Err(error);
|
||||||
|
}
|
||||||
|
|
||||||
|
self.logs_file_to_flush
|
||||||
|
.extend([stderr_logs_file, stdout_logs_file]);
|
||||||
|
|
||||||
|
Ok(self)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Wait for the g-ethereum node child process getting ready.
|
||||||
|
///
|
||||||
|
/// [Instance::spawn_process] must be called priorly.
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
|
let start_time = Instant::now();
|
||||||
|
|
||||||
|
let logs_file = OpenOptions::new()
|
||||||
|
.read(true)
|
||||||
|
.write(false)
|
||||||
|
.append(false)
|
||||||
|
.truncate(false)
|
||||||
|
.open(self.geth_stderr_log_file_path())?;
|
||||||
|
|
||||||
|
let maximum_wait_time = Duration::from_millis(self.start_timeout);
|
||||||
|
let mut stderr = BufReader::new(logs_file).lines();
|
||||||
|
loop {
|
||||||
|
if let Some(Ok(line)) = stderr.next() {
|
||||||
|
if line.contains(Self::ERROR_MARKER) {
|
||||||
|
anyhow::bail!("Failed to start geth {line}");
|
||||||
|
}
|
||||||
|
if line.contains(Self::READY_MARKER) {
|
||||||
|
return Ok(self);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
||||||
|
anyhow::bail!("Timeout in starting geth");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
||||||
|
fn geth_stdout_log_file_path(&self) -> PathBuf {
|
||||||
|
self.logs_directory.join(Self::GETH_STDOUT_LOG_FILE_NAME)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
||||||
|
fn geth_stderr_log_file_path(&self) -> PathBuf {
|
||||||
|
self.logs_directory.join(Self::GETH_STDERR_LOG_FILE_NAME)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn provider(
|
||||||
|
&self,
|
||||||
|
) -> impl Future<
|
||||||
|
Output = anyhow::Result<
|
||||||
|
FillProvider<impl TxFiller<Ethereum>, impl Provider<Ethereum>, Ethereum>,
|
||||||
|
>,
|
||||||
|
> + 'static {
|
||||||
|
let connection_string = self.connection_string();
|
||||||
|
let wallet = self.wallet.clone();
|
||||||
|
|
||||||
|
// Note: We would like all providers to make use of the same nonce manager so that we have
|
||||||
|
// monotonically increasing nonces that are cached. The cached nonce manager uses Arc's in
|
||||||
|
// its implementation and therefore it means that when we clone it then it still references
|
||||||
|
// the same state.
|
||||||
|
let nonce_manager = self.nonce_manager.clone();
|
||||||
|
|
||||||
|
Box::pin(async move {
|
||||||
|
ProviderBuilder::new()
|
||||||
|
.disable_recommended_fillers()
|
||||||
|
.filler(FallbackGasFiller::new(500_000_000, 500_000_000, 1))
|
||||||
|
.filler(ChainIdFiller::default())
|
||||||
|
.filler(NonceFiller::new(nonce_manager))
|
||||||
|
.wallet(wallet)
|
||||||
|
.connect(&connection_string)
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl EthereumNode for Instance {
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn execute_transaction(
|
||||||
|
&self,
|
||||||
|
transaction: TransactionRequest,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
let outer_span = tracing::debug_span!("Submitting transaction", ?transaction);
|
||||||
|
let _outer_guard = outer_span.enter();
|
||||||
|
|
||||||
|
let provider = provider.await?;
|
||||||
|
|
||||||
|
let pending_transaction = provider.send_transaction(transaction).await?;
|
||||||
|
let transaction_hash = pending_transaction.tx_hash();
|
||||||
|
|
||||||
|
let span = tracing::info_span!("Awaiting transaction receipt", ?transaction_hash);
|
||||||
|
let _guard = span.enter();
|
||||||
|
|
||||||
|
// The following is a fix for the "transaction indexing is in progress" error that we
|
||||||
|
// used to get. You can find more information on this in the following GH issue in geth
|
||||||
|
// https://github.com/ethereum/go-ethereum/issues/28877. To summarize what's going on,
|
||||||
|
// before we can get the receipt of the transaction it needs to have been indexed by the
|
||||||
|
// node's indexer. Just because the transaction has been confirmed it doesn't mean that
|
||||||
|
// it has been indexed. When we call alloy's `get_receipt` it checks if the transaction
|
||||||
|
// was confirmed. If it has been, then it will call `eth_getTransactionReceipt` method
|
||||||
|
// which _might_ return the above error if the tx has not yet been indexed yet. So, we
|
||||||
|
// need to implement a retry mechanism for the receipt to keep retrying to get it until
|
||||||
|
// it eventually works, but we only do that if the error we get back is the "transaction
|
||||||
|
// indexing is in progress" error or if the receipt is None.
|
||||||
|
//
|
||||||
|
// At the moment we do not allow for the 60 seconds to be modified and we take it as
|
||||||
|
// being an implementation detail that's invisible to anything outside of this module.
|
||||||
|
//
|
||||||
|
// We allow a total of 60 retries for getting the receipt with one second between each
|
||||||
|
// retry and the next which means that we allow for a total of 60 seconds of waiting
|
||||||
|
// before we consider that we're unable to get the transaction receipt.
|
||||||
|
let mut retries = 0;
|
||||||
|
loop {
|
||||||
|
match provider.get_transaction_receipt(*transaction_hash).await {
|
||||||
|
Ok(Some(receipt)) => {
|
||||||
|
tracing::info!("Obtained the transaction receipt");
|
||||||
|
break Ok(receipt);
|
||||||
|
}
|
||||||
|
Ok(None) => {
|
||||||
|
if retries == 60 {
|
||||||
|
tracing::error!(
|
||||||
|
"Polled for transaction receipt for 60 seconds but failed to get it"
|
||||||
|
);
|
||||||
|
break Err(anyhow::anyhow!("Failed to get the transaction receipt"));
|
||||||
|
} else {
|
||||||
|
tracing::trace!(
|
||||||
|
retries,
|
||||||
|
"Sleeping for 1 second and trying to get the receipt again"
|
||||||
|
);
|
||||||
|
retries += 1;
|
||||||
|
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(error) => {
|
||||||
|
let error_string = error.to_string();
|
||||||
|
if error_string.contains("transaction indexing is in progress") {
|
||||||
|
if retries == 60 {
|
||||||
|
tracing::error!(
|
||||||
|
"Polled for transaction receipt for 60 seconds but failed to get it"
|
||||||
|
);
|
||||||
|
break Err(error.into());
|
||||||
|
} else {
|
||||||
|
tracing::trace!(
|
||||||
|
retries,
|
||||||
|
"Sleeping for 1 second and trying to get the receipt again"
|
||||||
|
);
|
||||||
|
retries += 1;
|
||||||
|
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
break Err(error.into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn trace_transaction(
|
||||||
|
&self,
|
||||||
|
transaction: &TransactionReceipt,
|
||||||
|
trace_options: GethDebugTracingOptions,
|
||||||
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||||
|
let tx_hash = transaction.transaction_hash;
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
Ok(provider
|
||||||
|
.await?
|
||||||
|
.debug_trace_transaction(tx_hash, trace_options)
|
||||||
|
.await?)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn state_diff(&self, transaction: &TransactionReceipt) -> anyhow::Result<DiffMode> {
|
||||||
|
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
||||||
|
diff_mode: Some(true),
|
||||||
|
disable_code: None,
|
||||||
|
disable_storage: None,
|
||||||
|
});
|
||||||
|
match self
|
||||||
|
.trace_transaction(transaction, trace_options)?
|
||||||
|
.try_into_pre_state_frame()?
|
||||||
|
{
|
||||||
|
PreStateFrame::Diff(diff) => Ok(diff),
|
||||||
|
_ => anyhow::bail!("expected a diff mode trace"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider.await?.get_chain_id().await.map_err(Into::into)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider
|
||||||
|
.await?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await?
|
||||||
|
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
||||||
|
.map(|block| block.header.gas_limit as _)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider
|
||||||
|
.await?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await?
|
||||||
|
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
||||||
|
.map(|block| block.header.beneficiary)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider
|
||||||
|
.await?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await?
|
||||||
|
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
||||||
|
.map(|block| block.header.difficulty)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider
|
||||||
|
.await?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await?
|
||||||
|
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
||||||
|
.map(|block| block.header.hash)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider
|
||||||
|
.await?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await?
|
||||||
|
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
||||||
|
.map(|block| block.header.timestamp)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
|
||||||
|
let provider = self.provider();
|
||||||
|
BlockingExecutor::execute(async move {
|
||||||
|
provider.await?.get_block_number().await.map_err(Into::into)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Node for Instance {
|
||||||
|
fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>,
|
||||||
|
) -> Self {
|
||||||
|
let geth_directory = config.directory().join(Self::BASE_DIRECTORY);
|
||||||
|
let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
|
||||||
|
let base_directory = geth_directory.join(id.to_string());
|
||||||
|
|
||||||
|
let mut wallet = config.wallet();
|
||||||
|
for signer in additional_signers {
|
||||||
|
wallet.register_signer(signer);
|
||||||
|
}
|
||||||
|
|
||||||
|
Self {
|
||||||
|
connection_string: base_directory.join(Self::IPC_FILE).display().to_string(),
|
||||||
|
data_directory: base_directory.join(Self::DATA_DIRECTORY),
|
||||||
|
logs_directory: base_directory.join(Self::LOGS_DIRECTORY),
|
||||||
|
base_directory,
|
||||||
|
geth: config.geth.clone(),
|
||||||
|
id,
|
||||||
|
handle: None,
|
||||||
|
network_id: config.network_id,
|
||||||
|
start_timeout: config.geth_start_timeout,
|
||||||
|
wallet,
|
||||||
|
// We know that we only need to be storing 2 files so we can specify that when creating
|
||||||
|
// the vector. It's the stdout and stderr of the geth node.
|
||||||
|
logs_file_to_flush: Vec::with_capacity(2),
|
||||||
|
nonce_manager: Default::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn connection_string(&self) -> String {
|
||||||
|
self.connection_string.clone()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn shutdown(&mut self) -> anyhow::Result<()> {
|
||||||
|
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
||||||
|
if let Some(mut child) = self.handle.take() {
|
||||||
|
child
|
||||||
|
.kill()
|
||||||
|
.map_err(|error| anyhow::anyhow!("Failed to kill the geth process: {error:?}"))?;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flushing the files that we're using for keeping the logs before shutdown.
|
||||||
|
for file in self.logs_file_to_flush.iter_mut() {
|
||||||
|
file.flush()?
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove the node's database so that subsequent runs do not run on the same database. We
|
||||||
|
// ignore the error just in case the directory didn't exist in the first place and therefore
|
||||||
|
// there's nothing to be deleted.
|
||||||
|
let _ = remove_dir_all(self.base_directory.join(Self::DATA_DIRECTORY));
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
||||||
|
self.init(genesis)?.spawn_process()?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn version(&self) -> anyhow::Result<String> {
|
||||||
|
let output = Command::new(&self.geth)
|
||||||
|
.arg("--version")
|
||||||
|
.stdin(Stdio::null())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::null())
|
||||||
|
.spawn()?
|
||||||
|
.wait_with_output()?
|
||||||
|
.stdout;
|
||||||
|
Ok(String::from_utf8_lossy(&output).into())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn matches_target(&self, targets: Option<&[String]>) -> bool {
|
||||||
|
match targets {
|
||||||
|
None => true,
|
||||||
|
Some(targets) => targets.iter().any(|str| str.as_str() == "evm"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Drop for Instance {
|
||||||
|
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn drop(&mut self) {
|
||||||
|
self.shutdown().expect("Failed to shutdown")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
|
||||||
|
use alloy::signers::local::PrivateKeySigner;
|
||||||
|
use temp_dir::TempDir;
|
||||||
|
|
||||||
|
use crate::{GENESIS_JSON, Node};
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn test_config() -> (Arguments, TempDir) {
|
||||||
|
let mut config = Arguments::default();
|
||||||
|
let temp_dir = TempDir::new().unwrap();
|
||||||
|
config.working_directory = temp_dir.path().to_path_buf().into();
|
||||||
|
|
||||||
|
(config, temp_dir)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn new_node() -> (Instance, TempDir) {
|
||||||
|
let (args, temp_dir) = test_config();
|
||||||
|
let mut node = Instance::new(&args, Vec::<PrivateKeySigner>::with_capacity(0));
|
||||||
|
node.init(GENESIS_JSON.to_owned())
|
||||||
|
.expect("Failed to initialize the node")
|
||||||
|
.spawn_process()
|
||||||
|
.expect("Failed to spawn the node process");
|
||||||
|
(node, temp_dir)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn init_works() {
|
||||||
|
Instance::new(&test_config().0, Vec::<PrivateKeySigner>::with_capacity(0))
|
||||||
|
.init(GENESIS_JSON.to_string())
|
||||||
|
.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn spawn_works() {
|
||||||
|
Instance::new(&test_config().0, Vec::<PrivateKeySigner>::with_capacity(0))
|
||||||
|
.spawn(GENESIS_JSON.to_string())
|
||||||
|
.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn version_works() {
|
||||||
|
let version = Instance::new(&test_config().0, Vec::<PrivateKeySigner>::with_capacity(0))
|
||||||
|
.version()
|
||||||
|
.unwrap();
|
||||||
|
assert!(
|
||||||
|
version.starts_with("geth version"),
|
||||||
|
"expected version string, got: '{version}'"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_chain_id_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let chain_id = node.chain_id();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let chain_id = chain_id.expect("Failed to get the chain id");
|
||||||
|
assert_eq!(chain_id, 420_420_420);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_gas_limit_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let gas_limit = gas_limit.expect("Failed to get the gas limit");
|
||||||
|
assert_eq!(gas_limit, u32::MAX as u128)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_coinbase_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let coinbase = node.block_coinbase(BlockNumberOrTag::Latest);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let coinbase = coinbase.expect("Failed to get the coinbase");
|
||||||
|
assert_eq!(coinbase, Address::new([0xFF; 20]))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_block_difficulty_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let block_difficulty = block_difficulty.expect("Failed to get the block difficulty");
|
||||||
|
assert_eq!(block_difficulty, U256::ZERO)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_block_hash_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let block_hash = node.block_hash(BlockNumberOrTag::Latest);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let _ = block_hash.expect("Failed to get the block hash");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_block_timestamp_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let _ = block_timestamp.expect("Failed to get the block timestamp");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn can_get_block_number_from_node() {
|
||||||
|
// Arrange
|
||||||
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let block_number = node.last_block_number();
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let block_number = block_number.expect("Failed to get the block number");
|
||||||
|
assert_eq!(block_number, 0)
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,42 @@
|
|||||||
|
//! This crate implements the testing nodes.
|
||||||
|
|
||||||
|
use alloy::{network::TxSigner, signers::Signature};
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
|
||||||
|
pub mod common;
|
||||||
|
pub mod geth;
|
||||||
|
pub mod kitchensink;
|
||||||
|
pub mod pool;
|
||||||
|
|
||||||
|
/// The default genesis configuration.
|
||||||
|
pub const GENESIS_JSON: &str = include_str!("../../../genesis.json");
|
||||||
|
|
||||||
|
/// An abstract interface for testing nodes.
|
||||||
|
pub trait Node: EthereumNode {
|
||||||
|
/// Create a new uninitialized instance.
|
||||||
|
fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>,
|
||||||
|
) -> Self;
|
||||||
|
|
||||||
|
/// Spawns a node configured according to the genesis json.
|
||||||
|
///
|
||||||
|
/// Blocking until it's ready to accept transactions.
|
||||||
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()>;
|
||||||
|
|
||||||
|
/// Prune the node instance and related data.
|
||||||
|
///
|
||||||
|
/// Blocking until it's completely stopped.
|
||||||
|
fn shutdown(&mut self) -> anyhow::Result<()>;
|
||||||
|
|
||||||
|
/// Returns the nodes connection string.
|
||||||
|
fn connection_string(&self) -> String;
|
||||||
|
|
||||||
|
/// Returns the node version.
|
||||||
|
fn version(&self) -> anyhow::Result<String>;
|
||||||
|
|
||||||
|
/// Given a list of targets from the metadata file, this function determines if the metadata
|
||||||
|
/// file can be ran on this node or not.
|
||||||
|
fn matches_target(&self, targets: Option<&[String]>) -> bool;
|
||||||
|
}
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
//! This crate implements concurrent handling of testing node.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
fs::read_to_string,
|
||||||
|
sync::atomic::{AtomicUsize, Ordering},
|
||||||
|
thread,
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::{network::TxSigner, signers::Signature};
|
||||||
|
use anyhow::Context;
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
|
||||||
|
use crate::Node;
|
||||||
|
|
||||||
|
/// The node pool starts one or more [Node] which then can be accessed
|
||||||
|
/// in a round robbin fasion.
|
||||||
|
pub struct NodePool<T> {
|
||||||
|
next: AtomicUsize,
|
||||||
|
nodes: Vec<T>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<T> NodePool<T>
|
||||||
|
where
|
||||||
|
T: Node + Send + 'static,
|
||||||
|
{
|
||||||
|
/// Create a new Pool. This will start as many nodes as there are workers in `config`.
|
||||||
|
pub fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>
|
||||||
|
+ Clone
|
||||||
|
+ Send
|
||||||
|
+ Sync
|
||||||
|
+ 'static,
|
||||||
|
) -> anyhow::Result<Self> {
|
||||||
|
let nodes = config.workers;
|
||||||
|
let genesis = read_to_string(&config.genesis_file).context(format!(
|
||||||
|
"can not read genesis file: {}",
|
||||||
|
config.genesis_file.display()
|
||||||
|
))?;
|
||||||
|
|
||||||
|
let mut handles = Vec::with_capacity(nodes);
|
||||||
|
for _ in 0..nodes {
|
||||||
|
let config = config.clone();
|
||||||
|
let genesis = genesis.clone();
|
||||||
|
let additional_signers = additional_signers.clone();
|
||||||
|
handles.push(thread::spawn(move || {
|
||||||
|
spawn_node::<T>(&config, additional_signers, genesis)
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut nodes = Vec::with_capacity(nodes);
|
||||||
|
for handle in handles {
|
||||||
|
nodes.push(
|
||||||
|
handle
|
||||||
|
.join()
|
||||||
|
.map_err(|error| anyhow::anyhow!("failed to spawn node: {:?}", error))?
|
||||||
|
.map_err(|error| anyhow::anyhow!("node failed to spawn: {error}"))?,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
nodes,
|
||||||
|
next: Default::default(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get a handle to the next node.
|
||||||
|
pub fn round_robbin(&self) -> &T {
|
||||||
|
let current = self.next.fetch_add(1, Ordering::SeqCst) % self.nodes.len();
|
||||||
|
self.nodes.get(current).unwrap()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn spawn_node<T: Node + Send>(
|
||||||
|
args: &Arguments,
|
||||||
|
additional_signers: impl IntoIterator<Item: TxSigner<Signature> + Send + Sync + 'static>,
|
||||||
|
genesis: String,
|
||||||
|
) -> anyhow::Result<T> {
|
||||||
|
let mut node = T::new(args, additional_signers);
|
||||||
|
tracing::info!("starting node: {}", node.connection_string());
|
||||||
|
node.spawn(genesis)?;
|
||||||
|
Ok(node)
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-report"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
revive-dt-config = { workspace = true }
|
||||||
|
revive-dt-format = { workspace = true }
|
||||||
|
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
revive-solc-json-interface = { workspace = true }
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
//! The report analyzer enriches the raw report data.
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use crate::reporter::CompilationTask;
|
||||||
|
|
||||||
|
/// Provides insights into how well the compilers perform.
|
||||||
|
#[derive(Clone, Default, Debug, Serialize, Deserialize, PartialEq, PartialOrd)]
|
||||||
|
pub struct CompilerStatistics {
|
||||||
|
/// The sum of contracts observed.
|
||||||
|
pub n_contracts: usize,
|
||||||
|
/// The mean size of compiled contracts.
|
||||||
|
pub mean_code_size: usize,
|
||||||
|
/// The mean size of the optimized YUL IR.
|
||||||
|
pub mean_yul_size: usize,
|
||||||
|
/// Is a proxy because the YUL also containes a lot of comments.
|
||||||
|
pub yul_to_bytecode_size_ratio: f32,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CompilerStatistics {
|
||||||
|
/// Cumulatively update the statistics with the next compiler task.
|
||||||
|
pub fn sample(&mut self, compilation_task: &CompilationTask) {
|
||||||
|
let Some(output) = &compilation_task.json_output else {
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let Some(contracts) = &output.contracts else {
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
for (_solidity, contracts) in contracts.iter() {
|
||||||
|
for (_name, contract) in contracts.iter() {
|
||||||
|
let Some(evm) = &contract.evm else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
let Some(deploy_code) = &evm.deployed_bytecode else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
|
||||||
|
// The EVM bytecode can be unlinked and thus is not necessarily a decodable hex
|
||||||
|
// string; for our statistics this is a good enough approximation.
|
||||||
|
let bytecode_size = deploy_code.object.len() / 2;
|
||||||
|
|
||||||
|
let yul_size = contract
|
||||||
|
.ir_optimized
|
||||||
|
.as_ref()
|
||||||
|
.expect("if the contract has a deploy code it should also have the opimized IR")
|
||||||
|
.len();
|
||||||
|
|
||||||
|
self.update_sizes(bytecode_size, yul_size);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Updates the size statistics cumulatively.
|
||||||
|
fn update_sizes(&mut self, bytecode_size: usize, yul_size: usize) {
|
||||||
|
let n_previous = self.n_contracts;
|
||||||
|
let n_current = self.n_contracts + 1;
|
||||||
|
|
||||||
|
self.n_contracts = n_current;
|
||||||
|
|
||||||
|
self.mean_code_size = (n_previous * self.mean_code_size + bytecode_size) / n_current;
|
||||||
|
self.mean_yul_size = (n_previous * self.mean_yul_size + yul_size) / n_current;
|
||||||
|
|
||||||
|
if self.mean_code_size > 0 {
|
||||||
|
self.yul_to_bytecode_size_ratio =
|
||||||
|
self.mean_yul_size as f32 / self.mean_code_size as f32;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::CompilerStatistics;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compiler_statistics() {
|
||||||
|
let mut received = CompilerStatistics::default();
|
||||||
|
received.update_sizes(0, 0);
|
||||||
|
received.update_sizes(3, 37);
|
||||||
|
received.update_sizes(123, 456);
|
||||||
|
|
||||||
|
let mean_code_size = 41; // rounding error from integer truncation
|
||||||
|
let mean_yul_size = 164;
|
||||||
|
let expected = CompilerStatistics {
|
||||||
|
n_contracts: 3,
|
||||||
|
mean_code_size,
|
||||||
|
mean_yul_size,
|
||||||
|
yul_to_bytecode_size_ratio: mean_yul_size as f32 / mean_code_size as f32,
|
||||||
|
};
|
||||||
|
|
||||||
|
assert_eq!(received, expected);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
//! The revive differential tests reporting facility.
|
||||||
|
|
||||||
|
pub mod analyzer;
|
||||||
|
pub mod reporter;
|
||||||
@@ -0,0 +1,243 @@
|
|||||||
|
//! The reporter is the central place observing test execution by collecting data.
|
||||||
|
//!
|
||||||
|
//! The data collected gives useful insights into the outcome of the test run
|
||||||
|
//! and helps identifying and reproducing failing cases.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
collections::HashMap,
|
||||||
|
fs::{self, File, create_dir_all},
|
||||||
|
path::PathBuf,
|
||||||
|
sync::{Mutex, OnceLock},
|
||||||
|
time::{SystemTime, UNIX_EPOCH},
|
||||||
|
};
|
||||||
|
|
||||||
|
use anyhow::Context;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
use revive_dt_config::{Arguments, TestingPlatform};
|
||||||
|
use revive_dt_format::{corpus::Corpus, mode::SolcMode};
|
||||||
|
use revive_solc_json_interface::{SolcStandardJsonInput, SolcStandardJsonOutput};
|
||||||
|
|
||||||
|
use crate::analyzer::CompilerStatistics;
|
||||||
|
|
||||||
|
pub(crate) static REPORTER: OnceLock<Mutex<Report>> = OnceLock::new();
|
||||||
|
|
||||||
|
/// The `Report` datastructure stores all relevant inforamtion required for generating reports.
|
||||||
|
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
|
||||||
|
pub struct Report {
|
||||||
|
/// The configuration used during the test.
|
||||||
|
pub config: Arguments,
|
||||||
|
/// The observed test corpora.
|
||||||
|
pub corpora: Vec<Corpus>,
|
||||||
|
/// The observed test definitions.
|
||||||
|
pub metadata_files: Vec<PathBuf>,
|
||||||
|
/// The observed compilation results.
|
||||||
|
pub compiler_results: HashMap<TestingPlatform, Vec<CompilationResult>>,
|
||||||
|
/// The observed compilation statistics.
|
||||||
|
pub compiler_statistics: HashMap<TestingPlatform, CompilerStatistics>,
|
||||||
|
/// The file name this is serialized to.
|
||||||
|
#[serde(skip)]
|
||||||
|
directory: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Contains a compiled contract.
|
||||||
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||||
|
pub struct CompilationTask {
|
||||||
|
/// The observed compiler input.
|
||||||
|
pub json_input: SolcStandardJsonInput,
|
||||||
|
/// The observed compiler output.
|
||||||
|
pub json_output: Option<SolcStandardJsonOutput>,
|
||||||
|
/// The observed compiler mode.
|
||||||
|
pub mode: SolcMode,
|
||||||
|
/// The observed compiler version.
|
||||||
|
pub compiler_version: String,
|
||||||
|
/// The observed error, if any.
|
||||||
|
pub error: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Represents a report about a compilation task.
|
||||||
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||||
|
pub struct CompilationResult {
|
||||||
|
/// The observed compilation task.
|
||||||
|
pub compilation_task: CompilationTask,
|
||||||
|
/// The linked span.
|
||||||
|
pub span: Span,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The [Span] struct indicates the context of what is being reported.
|
||||||
|
#[derive(Clone, Copy, Debug, Serialize, Deserialize)]
|
||||||
|
pub struct Span {
|
||||||
|
/// The corpus index this belongs to.
|
||||||
|
corpus: usize,
|
||||||
|
/// The metadata file this belongs to.
|
||||||
|
metadata_file: usize,
|
||||||
|
/// The index of the case definition this belongs to.
|
||||||
|
case: usize,
|
||||||
|
/// The index of the case input this belongs to.
|
||||||
|
input: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Report {
|
||||||
|
/// The file name where this report will be written to.
|
||||||
|
pub const FILE_NAME: &str = "report.json";
|
||||||
|
|
||||||
|
/// The [Span] is expected to initialize the reporter by providing the config.
|
||||||
|
const INITIALIZED_VIA_SPAN: &str = "requires a Span which initializes the reporter";
|
||||||
|
|
||||||
|
/// Create a new [Report].
|
||||||
|
fn new(config: Arguments) -> anyhow::Result<Self> {
|
||||||
|
let now = SystemTime::now()
|
||||||
|
.duration_since(UNIX_EPOCH)
|
||||||
|
.unwrap()
|
||||||
|
.as_millis();
|
||||||
|
|
||||||
|
let directory = config.directory().join("report").join(format!("{now}"));
|
||||||
|
if !directory.exists() {
|
||||||
|
create_dir_all(&directory)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
config,
|
||||||
|
directory,
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Add a compilation task to the report.
|
||||||
|
pub fn compilation(span: Span, platform: TestingPlatform, compilation_task: CompilationTask) {
|
||||||
|
let mut report = REPORTER
|
||||||
|
.get()
|
||||||
|
.expect(Report::INITIALIZED_VIA_SPAN)
|
||||||
|
.lock()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
report
|
||||||
|
.compiler_statistics
|
||||||
|
.entry(platform)
|
||||||
|
.or_default()
|
||||||
|
.sample(&compilation_task);
|
||||||
|
|
||||||
|
report
|
||||||
|
.compiler_results
|
||||||
|
.entry(platform)
|
||||||
|
.or_default()
|
||||||
|
.push(CompilationResult {
|
||||||
|
compilation_task,
|
||||||
|
span,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write the report to disk.
|
||||||
|
pub fn save() -> anyhow::Result<()> {
|
||||||
|
let Some(reporter) = REPORTER.get() else {
|
||||||
|
return Ok(());
|
||||||
|
};
|
||||||
|
let report = reporter.lock().unwrap();
|
||||||
|
|
||||||
|
if let Err(error) = report.write_to_file() {
|
||||||
|
anyhow::bail!("can not write report: {error}");
|
||||||
|
}
|
||||||
|
|
||||||
|
if report.config.extract_problems {
|
||||||
|
if let Err(error) = report.save_compiler_problems() {
|
||||||
|
anyhow::bail!("can not write compiler problems: {error}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write compiler problems to disk for later debugging.
|
||||||
|
pub fn save_compiler_problems(&self) -> anyhow::Result<()> {
|
||||||
|
for (platform, results) in self.compiler_results.iter() {
|
||||||
|
for result in results {
|
||||||
|
// ignore if there were no errors
|
||||||
|
if result.compilation_task.error.is_none()
|
||||||
|
&& result
|
||||||
|
.compilation_task
|
||||||
|
.json_output
|
||||||
|
.as_ref()
|
||||||
|
.and_then(|output| output.errors.as_ref())
|
||||||
|
.map(|errors| errors.is_empty())
|
||||||
|
.unwrap_or(true)
|
||||||
|
{
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
let path = &self.metadata_files[result.span.metadata_file]
|
||||||
|
.parent()
|
||||||
|
.unwrap()
|
||||||
|
.join(format!("{platform}_errors"));
|
||||||
|
if !path.exists() {
|
||||||
|
create_dir_all(path)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(error) = result.compilation_task.error.as_ref() {
|
||||||
|
fs::write(path.join("compiler_error.txt"), error)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(errors) = result.compilation_task.json_output.as_ref() {
|
||||||
|
let file = File::create(path.join("compiler_output.txt"))?;
|
||||||
|
serde_json::to_writer_pretty(file, &errors)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn write_to_file(&self) -> anyhow::Result<()> {
|
||||||
|
let path = self.directory.join(Self::FILE_NAME);
|
||||||
|
|
||||||
|
let file = File::create(&path).context(path.display().to_string())?;
|
||||||
|
serde_json::to_writer_pretty(file, &self)?;
|
||||||
|
|
||||||
|
tracing::info!("report written to: {}", path.display());
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Span {
|
||||||
|
/// Create a new [Span] with case and input index at 0.
|
||||||
|
///
|
||||||
|
/// Initializes the reporting facility on the first call.
|
||||||
|
pub fn new(corpus: Corpus, config: Arguments) -> anyhow::Result<Self> {
|
||||||
|
let report = Mutex::new(Report::new(config)?);
|
||||||
|
let mut reporter = REPORTER.get_or_init(|| report).lock().unwrap();
|
||||||
|
reporter.corpora.push(corpus);
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
corpus: reporter.corpora.len() - 1,
|
||||||
|
metadata_file: 0,
|
||||||
|
case: 0,
|
||||||
|
input: 0,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Advance to the next metadata file: Resets the case input index to 0.
|
||||||
|
pub fn next_metadata(&mut self, metadata_file: PathBuf) {
|
||||||
|
let mut reporter = REPORTER
|
||||||
|
.get()
|
||||||
|
.expect(Report::INITIALIZED_VIA_SPAN)
|
||||||
|
.lock()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
reporter.metadata_files.push(metadata_file);
|
||||||
|
|
||||||
|
self.metadata_file = reporter.metadata_files.len() - 1;
|
||||||
|
self.case = 0;
|
||||||
|
self.input = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Advance to the next case: Increas the case index by one and resets the input index to 0.
|
||||||
|
pub fn next_case(&mut self) {
|
||||||
|
self.case += 1;
|
||||||
|
self.input = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Advance to the next input.
|
||||||
|
pub fn next_input(&mut self) {
|
||||||
|
self.input += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
[package]
|
||||||
|
name = "revive-dt-solc-binaries"
|
||||||
|
description = "Download and cache solc binaries"
|
||||||
|
version.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
rust-version.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
hex = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
reqwest = { workspace = true }
|
||||||
|
semver = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
|
sha2 = { workspace = true }
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
//! Helper for caching the solc binaries.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
collections::HashSet,
|
||||||
|
fs::{File, create_dir_all},
|
||||||
|
io::{BufWriter, Write},
|
||||||
|
os::unix::fs::PermissionsExt,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
sync::{LazyLock, Mutex},
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::download::GHDownloader;
|
||||||
|
|
||||||
|
pub const SOLC_CACHE_DIRECTORY: &str = "solc";
|
||||||
|
pub(crate) static SOLC_CACHER: LazyLock<Mutex<HashSet<PathBuf>>> = LazyLock::new(Default::default);
|
||||||
|
|
||||||
|
pub(crate) fn get_or_download(
|
||||||
|
working_directory: &Path,
|
||||||
|
downloader: &GHDownloader,
|
||||||
|
) -> anyhow::Result<PathBuf> {
|
||||||
|
let target_directory = working_directory
|
||||||
|
.join(SOLC_CACHE_DIRECTORY)
|
||||||
|
.join(downloader.version.to_string());
|
||||||
|
let target_file = target_directory.join(downloader.target);
|
||||||
|
|
||||||
|
let mut cache = SOLC_CACHER.lock().unwrap();
|
||||||
|
if cache.contains(&target_file) {
|
||||||
|
tracing::debug!("using cached solc: {}", target_file.display());
|
||||||
|
return Ok(target_file);
|
||||||
|
}
|
||||||
|
|
||||||
|
create_dir_all(target_directory)?;
|
||||||
|
download_to_file(&target_file, downloader)?;
|
||||||
|
cache.insert(target_file.clone());
|
||||||
|
|
||||||
|
Ok(target_file)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn download_to_file(path: &Path, downloader: &GHDownloader) -> anyhow::Result<()> {
|
||||||
|
tracing::info!("caching file: {}", path.display());
|
||||||
|
|
||||||
|
let Ok(file) = File::create_new(path) else {
|
||||||
|
tracing::debug!("cache file already exists: {}", path.display());
|
||||||
|
return Ok(());
|
||||||
|
};
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
let mut permissions = file.metadata()?.permissions();
|
||||||
|
permissions.set_mode(permissions.mode() | 0o111);
|
||||||
|
file.set_permissions(permissions)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut file = BufWriter::new(file);
|
||||||
|
file.write_all(&downloader.download()?)?;
|
||||||
|
file.flush()?;
|
||||||
|
drop(file);
|
||||||
|
|
||||||
|
#[cfg(target_os = "macos")]
|
||||||
|
std::process::Command::new("xattr")
|
||||||
|
.arg("-d")
|
||||||
|
.arg("com.apple.quarantine")
|
||||||
|
.arg(path)
|
||||||
|
.stderr(std::process::Stdio::null())
|
||||||
|
.stdout(std::process::Stdio::null())
|
||||||
|
.stdout(std::process::Stdio::null())
|
||||||
|
.spawn()?
|
||||||
|
.wait()?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
//! This module downloads solc binaries.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
collections::HashMap,
|
||||||
|
sync::{LazyLock, Mutex},
|
||||||
|
};
|
||||||
|
|
||||||
|
use semver::Version;
|
||||||
|
use sha2::{Digest, Sha256};
|
||||||
|
|
||||||
|
use crate::list::List;
|
||||||
|
|
||||||
|
pub static LIST_CACHE: LazyLock<Mutex<HashMap<&'static str, List>>> =
|
||||||
|
LazyLock::new(Default::default);
|
||||||
|
|
||||||
|
impl List {
|
||||||
|
pub const LINUX_URL: &str = "https://binaries.soliditylang.org/linux-amd64/list.json";
|
||||||
|
pub const WINDOWS_URL: &str = "https://binaries.soliditylang.org/windows-amd64/list.json";
|
||||||
|
pub const MACOSX_URL: &str = "https://binaries.soliditylang.org/macosx-amd64/list.json";
|
||||||
|
pub const WASM_URL: &str = "https://binaries.soliditylang.org/wasm/list.json";
|
||||||
|
|
||||||
|
/// Try to downloads the list from the given URL.
|
||||||
|
///
|
||||||
|
/// Caches the list retrieved from the `url` into [LIST_CACHE],
|
||||||
|
/// subsequent calls with the same `url` will return the cached list.
|
||||||
|
pub fn download(url: &'static str) -> anyhow::Result<Self> {
|
||||||
|
if let Some(list) = LIST_CACHE.lock().unwrap().get(url) {
|
||||||
|
return Ok(list.clone());
|
||||||
|
}
|
||||||
|
|
||||||
|
let body: List = reqwest::blocking::get(url)?.json()?;
|
||||||
|
|
||||||
|
LIST_CACHE.lock().unwrap().insert(url, body.clone());
|
||||||
|
|
||||||
|
Ok(body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Download solc binaries from GitHub releases (IPFS links aren't reliable).
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct GHDownloader {
|
||||||
|
pub version: Version,
|
||||||
|
pub target: &'static str,
|
||||||
|
pub list: &'static str,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl GHDownloader {
|
||||||
|
pub const BASE_URL: &str = "https://github.com/ethereum/solidity/releases/download";
|
||||||
|
|
||||||
|
pub const LINUX_NAME: &str = "solc-static-linux";
|
||||||
|
pub const MACOSX_NAME: &str = "solc-macos";
|
||||||
|
pub const WINDOWS_NAME: &str = "solc-windows.exe";
|
||||||
|
pub const WASM_NAME: &str = "soljson.js";
|
||||||
|
|
||||||
|
fn new(version: Version, target: &'static str, list: &'static str) -> Self {
|
||||||
|
Self {
|
||||||
|
version,
|
||||||
|
target,
|
||||||
|
list,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn linux(version: Version) -> Self {
|
||||||
|
Self::new(version, Self::LINUX_NAME, List::LINUX_URL)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn macosx(version: Version) -> Self {
|
||||||
|
Self::new(version, Self::MACOSX_NAME, List::MACOSX_URL)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn windows(version: Version) -> Self {
|
||||||
|
Self::new(version, Self::WINDOWS_NAME, List::WINDOWS_URL)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn wasm(version: Version) -> Self {
|
||||||
|
Self::new(version, Self::WASM_NAME, List::WASM_URL)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the download link.
|
||||||
|
pub fn url(&self) -> String {
|
||||||
|
format!("{}/v{}/{}", Self::BASE_URL, &self.version, &self.target)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Download the solc binary.
|
||||||
|
///
|
||||||
|
/// Errors out if the download fails or the digest of the downloaded file
|
||||||
|
/// mismatches the expected digest from the release [List].
|
||||||
|
pub fn download(&self) -> anyhow::Result<Vec<u8>> {
|
||||||
|
tracing::info!("downloading solc: {self:?}");
|
||||||
|
let expected_digest = List::download(self.list)?
|
||||||
|
.builds
|
||||||
|
.iter()
|
||||||
|
.find(|build| build.version == self.version)
|
||||||
|
.ok_or_else(|| anyhow::anyhow!("solc v{} not found builds", self.version))
|
||||||
|
.map(|b| b.sha256.strip_prefix("0x").unwrap_or(&b.sha256).to_string())?;
|
||||||
|
|
||||||
|
let file = reqwest::blocking::get(self.url())?.bytes()?.to_vec();
|
||||||
|
|
||||||
|
if hex::encode(Sha256::digest(&file)) != expected_digest {
|
||||||
|
anyhow::bail!("sha256 mismatch for solc version {}", self.version);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(file)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use crate::{download::GHDownloader, list::List};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn try_get_windows() {
|
||||||
|
let version = List::download(List::WINDOWS_URL).unwrap().latest_release;
|
||||||
|
GHDownloader::windows(version).download().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn try_get_macosx() {
|
||||||
|
let version = List::download(List::MACOSX_URL).unwrap().latest_release;
|
||||||
|
GHDownloader::macosx(version).download().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn try_get_linux() {
|
||||||
|
let version = List::download(List::LINUX_URL).unwrap().latest_release;
|
||||||
|
GHDownloader::linux(version).download().unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn try_get_wasm() {
|
||||||
|
let version = List::download(List::WASM_URL).unwrap().latest_release;
|
||||||
|
GHDownloader::wasm(version).download().unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
//! This crates provides serializable Rust type definitions for the [solc binary lists][0]
|
||||||
|
//! and download helpers.
|
||||||
|
//!
|
||||||
|
//! [0]: https://binaries.soliditylang.org
|
||||||
|
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
use cache::get_or_download;
|
||||||
|
use download::GHDownloader;
|
||||||
|
use semver::Version;
|
||||||
|
|
||||||
|
pub mod cache;
|
||||||
|
pub mod download;
|
||||||
|
pub mod list;
|
||||||
|
|
||||||
|
/// Downloads the solc binary for Wasm is `wasm` is set, otherwise for
|
||||||
|
/// the target platform.
|
||||||
|
///
|
||||||
|
/// Subsequent calls for the same version will use a cached artifact
|
||||||
|
/// and not download it again.
|
||||||
|
pub fn download_solc(
|
||||||
|
cache_directory: &Path,
|
||||||
|
version: Version,
|
||||||
|
wasm: bool,
|
||||||
|
) -> anyhow::Result<PathBuf> {
|
||||||
|
let downloader = if wasm {
|
||||||
|
GHDownloader::wasm(version)
|
||||||
|
} else if cfg!(target_os = "linux") {
|
||||||
|
GHDownloader::linux(version)
|
||||||
|
} else if cfg!(target_os = "macos") {
|
||||||
|
GHDownloader::macosx(version)
|
||||||
|
} else if cfg!(target_os = "windows") {
|
||||||
|
GHDownloader::windows(version)
|
||||||
|
} else {
|
||||||
|
unimplemented!()
|
||||||
|
};
|
||||||
|
|
||||||
|
get_or_download(cache_directory, &downloader)
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
//! Rust type definitions for the solc binary lists.
|
||||||
|
|
||||||
|
use std::{collections::HashMap, path::PathBuf};
|
||||||
|
|
||||||
|
use semver::Version;
|
||||||
|
use serde::Deserialize;
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub struct List {
|
||||||
|
pub builds: Vec<Build>,
|
||||||
|
pub releases: HashMap<Version, String>,
|
||||||
|
#[serde(rename = "latestRelease")]
|
||||||
|
pub latest_release: Version,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone, Eq, PartialEq)]
|
||||||
|
pub struct Build {
|
||||||
|
pub path: PathBuf,
|
||||||
|
pub version: Version,
|
||||||
|
pub build: String,
|
||||||
|
#[serde(rename = "longVersion")]
|
||||||
|
pub long_version: String,
|
||||||
|
pub keccak256: String,
|
||||||
|
pub sha256: String,
|
||||||
|
pub urls: Vec<String>,
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
{
|
||||||
|
"config": {
|
||||||
|
"chainId": 420420420,
|
||||||
|
"homesteadBlock": 0,
|
||||||
|
"eip150Block": 0,
|
||||||
|
"eip155Block": 0,
|
||||||
|
"eip158Block": 0,
|
||||||
|
"byzantiumBlock": 0,
|
||||||
|
"constantinopleBlock": 0,
|
||||||
|
"petersburgBlock": 0,
|
||||||
|
"istanbulBlock": 0,
|
||||||
|
"berlinBlock": 0,
|
||||||
|
"londonBlock": 0,
|
||||||
|
"arrowGlacierBlock": 0,
|
||||||
|
"grayGlacierBlock": 0,
|
||||||
|
"shanghaiTime": 0,
|
||||||
|
"cancunTime": 0,
|
||||||
|
"terminalTotalDifficulty": 0,
|
||||||
|
"terminalTotalDifficultyPassed": true,
|
||||||
|
"blobSchedule": {
|
||||||
|
"cancun": {
|
||||||
|
"target": 3,
|
||||||
|
"max": 6,
|
||||||
|
"baseFeeUpdateFraction": 3338477
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"coinbase": "0xffffffffffffffffffffffffffffffffffffffff",
|
||||||
|
"difficulty": "0x00",
|
||||||
|
"extraData": "",
|
||||||
|
"gasLimit": "0xffffffff",
|
||||||
|
"nonce": "0x0000000000000042",
|
||||||
|
"mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
|
"timestamp": "0x00",
|
||||||
|
"alloc": {
|
||||||
|
"90F8bf6A479f320ead074411a4B0e7944Ea8c9C1": {
|
||||||
|
"balance": "10000000000000000000000"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Submodule
+1
Submodule polkadot-sdk added at dc3d0e5ab7
Reference in New Issue
Block a user