Skip to content

Commit 17ea3a9

Browse files
authored
chore(makefile): unify naming conventions in targets (#1979)
1 parent 50c9c93 commit 17ea3a9

File tree

8 files changed

+257
-276
lines changed

8 files changed

+257
-276
lines changed

Makefile

Lines changed: 232 additions & 233 deletions
Large diffs are not rendered by default.

aggregation_mode/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ make anvil_start
1919
3. Start batcher
2020

2121
```shell
22-
make start_batcher_local
22+
make batcher_start_local
2323
```
2424

2525
4. Send SP1/Risc0 proofs:
@@ -38,13 +38,13 @@ Notes:
3838

3939
```shell
4040
# This will not run a real prover but a mocked one see below to run a real prover
41-
make start_proof_aggregator_dev AGGREGATOR="sp1|risc0"
41+
make proof_aggregator_start_dev AGGREGATOR="sp1|risc0"
4242
```
4343

4444
or
4545

4646
```shell
47-
make start_proof_aggregator AGGREGATOR="sp1|risc0"
47+
make proof_aggregator_start AGGREGATOR="sp1|risc0"
4848
```
4949

5050
Notes:
@@ -53,7 +53,7 @@ Notes:
5353
- Proving can be quite slow without GPUs, to activate gpu run:
5454

5555
```shell
56-
make start_proof_aggregator_gpu AGGREGATOR="sp1|risc0"
56+
make proof_aggregator_start_gpu AGGREGATOR="sp1|risc0"
5757
```
5858

5959
### Check the logs
@@ -69,7 +69,7 @@ cast logs 0xc351628EB244ec633d5f21fBD6621e1a683B1181 'AggregatedProofVerified(by
6969
Whenever any of the programs change, you must recompile them and update their corresponding program ids in `aggregation_mode/program_ids.json`. To do this, run the following command:
7070

7171
```shell
72-
make agg_mode_write_program_ids
72+
make proof_aggregator_write_program_ids
7373
```
7474

7575
We are using docker to produce deterministic builds so that the program ids are the same for all systems.

docs/0_internal/2_deploy_contracts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Also, you will be able to deploy the Batcher Payment Service contract.
1717
- Install foundry
1818

1919
```shell
20-
make install_foundry
20+
make foundry_install
2121
foundryup -i nightly-a428ba6ad8856611339a6319290aade3347d25d9
2222
```
2323

docs/0_internal/ethereum_package.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,21 @@ make aggregator_start_ethereum_package
4040
To start an operator run:
4141

4242
```bash
43-
make operator_register_start_ethereum_package
43+
make operator_full_registration_and_start_ethereum_package
4444
```
4545

4646
If you want to deploy more operators, you must duplicate the config-operator-1-ethereum-package.yaml and change the private and bls keys and the address.
4747

4848
To start Telemetry and the Explorer, run the usual commands:
4949

5050
```bash
51-
make telemetry_full_start
52-
make run_explorer
51+
make telemetry_start_all
52+
make explorer_start
5353
```
5454

5555
To spam transactions install spamoor:
5656
```bash
57-
make install_spamoor
57+
make spamoor_install
5858
```
5959

6060
and run the following make targets:

docs/3_guides/6_setup_aligned.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,7 @@ If EigenLayer contracts change, the anvil state needs to be updated with:
4747
make anvil_deploy_eigen_contracts
4848
```
4949

50-
You will also need to redeploy the MockStrategy & MockERC20 contracts:
51-
52-
```bash
53-
make anvil_deploy_mock_strategy
54-
```
50+
This also deploys an ERC20 token with a strategy that can be used to test the EigenLayer restaking.
5551

5652
### Aligned Contracts
5753

@@ -80,21 +76,21 @@ make aggregator_start ENVIRONMENT=devnet
8076
or with a custom config:
8177

8278
```bash
83-
make aggregator_start ENVIRONMENT=devnet CONFIG_FILE=<path_to_config_file>
79+
make aggregator_start ENVIRONMENT=devnet AGG_CONFIG_FILE=<path_to_config_file>
8480
```
8581

8682
## Operator
8783

8884
To setup an [Operator](../2_architecture/components/4_operator.md) run:
8985

9086
```bash
91-
make operator_register_and_start ENVIRONMENT=devnet
87+
make operator_full_registration_and_start ENVIRONMENT=devnet
9288
```
9389

9490
or with a custom config:
9591

9692
```bash
97-
make operator_register_and_start ENVIRONMENT=devnet CONFIG_FILE=<path_to_config_file>
93+
make operator_full_registration_and_start ENVIRONMENT=devnet CONFIG_FILE=<path_to_config_file>
9894
```
9995

10096
Different configs for operators can be found in `config-files/config-operator`.
@@ -161,7 +157,7 @@ Then start the explorer:
161157

162158
```shell
163159
make explorer_build_db
164-
make run_explorer
160+
make explorer_start
165161
```
166162

167163
This will:
@@ -170,12 +166,6 @@ This will:
170166
- Run ecto setup
171167
- Start the explorer on http://localhost:4000.
172168

173-
If you want to run the explorer without docker run:
174-
175-
```shell
176-
make run_explorer_without_docker_db
177-
```
178-
179169
<details>
180170
<summary>Clean, dump and recover DB</summary>
181171

@@ -245,7 +235,7 @@ Ensure you have the following installed:
245235
To run Prometheus and Grafana, run:
246236

247237
```bash
248-
make run_metrics
238+
make metrics_start
249239
```
250240

251241
This will start containers for Prometheus and Grafana. You can access Grafana on `http://localhost:3000` with the default credentials `admin:admin`.
@@ -266,12 +256,12 @@ make telemetry_build_db
266256
Then, to start the service:
267257

268258
```bash
269-
make telemetry_full_start
259+
make telemetry_start_all
270260
```
271261

272262
This will:
273263

274-
- Start OpenJaeger container for the traces: available at `http://localhost:16686/`
264+
- Start OpenTelemetry and Jaeger containers for the traces: available at `http://localhost:16686/`
275265
- Start telemetry server: available at `http://localhost:4001/`
276266

277267
---
@@ -295,7 +285,7 @@ make batcher_send_risc0_burst BURST_SIZE=<N>
295285
Send an infinite stream of groth_16 proofs:
296286

297287
```shell
298-
make batcher_send_burst_groth16 BURST_SIZE=2
288+
make batcher_send_groth16_bn254_infinite BURST_SIZE=2
299289
```
300290

301291
Feel free to explore the rest of targets.

docs/3_guides/setup_holesky.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,11 +132,3 @@ Also, you must re-generate the Go smart contract bindings:
132132
```bash
133133
make bindings
134134
```
135-
136-
### Deployment
137-
138-
And finally you must rebuild go binaries, for Operator and Aggregator:
139-
140-
```bash
141-
make build_binaries
142-
```

docs/operator_guides/0_running_an_operator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,34 +51,34 @@ Also, you have to install the following dependencies for Linux:
5151
To install foundry, run:
5252

5353
```bash
54-
make install_foundry
54+
make foundry_install
5555
foundryup
5656
```
5757

5858
To build the operator binary for **Testnet**, run:
5959

6060
```bash
61-
make build_operator ENVIRONMENT=testnet
61+
make operator_build ENVIRONMENT=testnet
6262
```
6363

6464
To build the operator binary for **Mainnet**, run:
6565

6666
```bash
67-
make build_operator ENVIRONMENT=mainnet
67+
make operator_build ENVIRONMENT=mainnet
6868
```
6969

7070
### Upgrading the Operator
7171

7272
If you want to upgrade the operator in **Testnet**, run:
7373

7474
```bash
75-
make update_operator ENVIRONMENT=testnet
75+
make operator_start ENVIRONMENT=testnet
7676
```
7777

7878
If you want to upgrade the operator in **Mainnet**, run:
7979

8080
```bash
81-
make update_operator ENVIRONMENT=mainnet
81+
make operator_start ENVIRONMENT=mainnet
8282
```
8383

8484
This will recreate the binaries. You can then proceed to restart the operator.

telemetry-docker-compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ services:
88
volumes:
99
- ./otel-collector.yaml:/etc/otel-collector.yaml
1010
ports:
11-
- "4317:4317"
11+
- "4319:4317"
1212

1313
cassandra:
1414
image: cassandra:latest

0 commit comments

Comments
 (0)