-
Notifications
You must be signed in to change notification settings - Fork 44
/
Copy pathMakefile
181 lines (145 loc) · 7.82 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
.PHONY: build lint test clean run-image build-image clean-vectors \
setup-hive test-pattern-default run-hive run-hive-debug clean-hive-logs \
load-test-fibonacci load-test-io
help: ## 📚 Show help for each of the Makefile recipes
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
build: ## 🔨 Build the client
cargo build --workspace
lint: ## 🧹 Linter check
cargo clippy --all-targets --all-features --workspace --exclude ethrex-prover --exclude zkvm_interface -- -D warnings
CRATE ?= *
test: ## 🧪 Run each crate's tests
cargo test -p '$(CRATE)' --workspace --exclude ethrex-prover --exclude ethrex-prover-bench --exclude ethrex-levm --exclude ef_tests-blockchain --exclude ef_tests-state --exclude ethrex-l2 -- --skip test_contract_compilation
$(MAKE) -C cmd/ef_tests/blockchain test
clean: clean-vectors ## 🧹 Remove build artifacts
cargo clean
rm -rf hive
STAMP_FILE := .docker_build_stamp
$(STAMP_FILE): $(shell find crates cmd -type f -name '*.rs') Cargo.toml Dockerfile
docker build -t ethrex .
touch $(STAMP_FILE)
build-image: $(STAMP_FILE) ## 🐳 Build the Docker image
run-image: build-image ## 🏃 Run the Docker image
docker run --rm -p 127.0.0.1:8545:8545 ethrex --http.addr 0.0.0.0
dev: ## 🏃 Run the ethrex client in DEV_MODE with the InMemory Engine
cargo run --bin ethrex --features dev -- \
--network ./test_data/genesis-l1.json \
--http.port 8545 \
--http.addr 0.0.0.0 \
--authrpc.port 8551 \
--evm levm \
--dev \
--datadir memory
ETHEREUM_PACKAGE_REVISION := 42963f52f3cfc4eb9deb5248c8529ff97acc709c
# Shallow clones can't specify a single revision, but at least we avoid working
# the whole history by making it shallow since a given date (one day before our
# target revision).
ethereum-package:
git clone --single-branch --branch ethrex-integration-pectra https://github.com/lambdaclass/ethereum-package
checkout-ethereum-package: ethereum-package ## 📦 Checkout specific Ethereum package revision
cd ethereum-package && \
git fetch && \
git checkout $(ETHEREUM_PACKAGE_REVISION)
ENCLAVE ?= lambdanet
localnet: stop-localnet-silent build-image checkout-ethereum-package ## 🌐 Start local network
kurtosis run --enclave $(ENCLAVE) ethereum-package --args-file test_data/network_params.yaml
docker logs -f $$(docker ps -q --filter ancestor=ethrex)
localnet-assertoor-blob: stop-localnet-silent build-image checkout-ethereum-package ## 🌐 Start local network with assertoor test
kurtosis run --enclave $(ENCLAVE) ethereum-package --args-file .github/config/assertoor/network_params_blob.yaml
docker logs -f $$(docker ps -q --filter ancestor=ethrex)
localnet-assertoor-tx: stop-localnet-silent build-image checkout-ethereum-package ## 🌐 Start local network with assertoor test
kurtosis run --enclave $(ENCLAVE) ethereum-package --args-file .github/config/assertoor/network_params_tx.yaml
docker logs -f $$(docker ps -q --filter ancestor=ethrex)
stop-localnet: ## 🛑 Stop local network
kurtosis enclave stop $(ENCLAVE)
kurtosis enclave rm $(ENCLAVE) --force
stop-localnet-silent:
@echo "Double checking local net is not already started..."
@kurtosis enclave stop $(ENCLAVE) >/dev/null 2>&1 || true
@kurtosis enclave rm $(ENCLAVE) --force >/dev/null 2>&1 || true
HIVE_REVISION := d98bcfa37f501f4ea1869d0a79fde35ed472937f
# Shallow clones can't specify a single revision, but at least we avoid working
# the whole history by making it shallow since a given date (one day before our
# target revision).
HIVE_SHALLOW_SINCE := 2024-09-02
QUIET ?= false
hive:
if [ "$(QUIET)" = "true" ]; then \
git clone --quiet --single-branch --branch master --shallow-since=$(HIVE_SHALLOW_SINCE) https://github.com/lambdaclass/hive && \
cd hive && git checkout --quiet --detach $(HIVE_REVISION) && go build .; \
else \
git clone --single-branch --branch master --shallow-since=$(HIVE_SHALLOW_SINCE) https://github.com/lambdaclass/hive && \
cd hive && git checkout --detach $(HIVE_REVISION) && go build .; \
fi
setup-hive: hive ## 🐝 Set up Hive testing framework
if [ "$$(cd hive && git rev-parse HEAD)" != "$(HIVE_REVISION)" ]; then \
if [ "$(QUIET)" = "true" ]; then \
cd hive && \
git checkout --quiet master && \
git fetch --quiet --shallow-since=$(HIVE_SHALLOW_SINCE) && \
git checkout --quiet --detach $(HIVE_REVISION) && go build .;\
else \
cd hive && \
git checkout master && \
git fetch --shallow-since=$(HIVE_SHALLOW_SINCE) && \
git checkout --detach $(HIVE_REVISION) && go build .;\
fi \
fi
TEST_PATTERN ?= /
SIM_LOG_LEVEL ?= 4
EVM_BACKEND := revm
SIM_PARALLELISM := 16
L1_CLIENT ?= ethrex
display-hive-alternatives:
@echo ""
@echo "Running L1 with ${L1_CLIENT} as client. Other clients are available in order to compare tests results."
@echo "In order to use a different client, use the environment variable 'L1_CLIENT' with one of the follwoing values:"
@echo " - ethrex: https://github.com/lambdaclass/ethrex"
@echo " - go-ethereum: https://github.com/ethereum/go-ethereum"
@echo ""
# Runs a hive testing suite
# The endpoints tested may be limited by supplying a test pattern in the form "/endpoint_1|enpoint_2|..|enpoint_n"
# For example, to run the rpc-compat suites for eth_chainId & eth_blockNumber you should run:
# `make run-hive SIMULATION=ethereum/rpc-compat TEST_PATTERN="/eth_chainId|eth_blockNumber"`
run-hive: display-hive-alternatives build-image setup-hive ## 🧪 Run Hive testing suite
cd hive && ./hive --client $(L1_CLIENT) --ethrex.flags "--evm $(EVM_BACKEND)" --sim $(SIMULATION) --sim.limit "$(TEST_PATTERN)" --sim.parallelism "$(SIM_PARALLELISM)"
run-hive-all: display-hive-alternatives build-image setup-hive ## 🧪 Run all Hive testing suites
cd hive && ./hive --client $(L1_CLIENT) --ethrex.flags "--evm $(EVM_BACKEND)" --sim ".*" --sim.parallelism "$(SIM_PARALLELISM)"
run-hive-debug: display-hive-alternatives build-image setup-hive ## 🐞 Run Hive testing suite in debug mode
cd hive && ./hive --sim $(SIMULATION) --client $(L1_CLIENT) --ethrex.flags "--evm $(EVM_BACKEND)" --sim.loglevel $(SIM_LOG_LEVEL) --sim.limit "$(TEST_PATTERN)" --sim.parallelism "$(SIM_PARALLELISM)" --docker.output
clean-hive-logs: ## 🧹 Clean Hive logs
rm -rf ./hive/workspace/logs
install-cli: ## 🛠️ Installs the ethrex-l2 cli
cargo install --path cmd/ethrex_l2/ --force
start-node-with-flamegraph: rm-test-db ## 🚀🔥 Starts an ethrex client used for testing
@if [ -z "$$L" ]; then \
LEVM="revm"; \
echo "Running the test-node without the LEVM feature"; \
echo "If you want to use levm, run the target with an L at the end: make <target> L=1"; \
else \
LEVM="levm"; \
echo "Running the test-node with the LEVM feature"; \
fi; \
sudo -E CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph \
--bin ethrex \
--features "dev" \
-- \
--evm $$LEVM \
--network test_data/genesis-l2.json \
--http.port 1729 \
--dev \
--datadir test_ethrex
load-test: install-cli ## 🚧 Runs a load-test. Run make start-node-with-flamegraph and in a new terminal make load-node
ethrex_l2 test load --path test_data/private_keys.txt -i 1000 -v --value 100000
load-test-fibonacci:
ethrex_l2 test load --path test_data/private_keys.txt -i 1000 -v --value 100000 --fibonacci
load-test-io:
ethrex_l2 test load --path test_data/private_keys.txt -i 1000 -v --value 100000 --io
rm-test-db: ## 🛑 Removes the DB used by the ethrex client used for testing
sudo cargo run --release --bin ethrex -- removedb --datadir test_ethrex
flamegraph: ## 🚧 Runs a load-test. Run make start-node-with-flamegraph and in a new terminal make flamegraph
sudo bash bench/scripts/flamegraph.sh
test_data/ERC20/ERC20.bin: ## 🔨 Build the ERC20 contract for the load test
solc ./test_data/ERC20.sol -o $@
load-test-erc20: test_data/ERC20/ERC20.bin install-cli
ethrex_l2 test erc20 --path test_data/private_keys.txt -t 100