You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR updates the devnet setup we have in our repo:
- Removes the metrics stack, which was integrated into lean-quickstart
in blockblaz/lean-quickstart#109
- Updates the `run-devnet` target to use the just built Docker tag for
the devnet
- Adds a `make fmt` target for formatting the code
- Update the documentation with a list of Makefile targets and removing
mentions of our metrics stack
run-devnet: docker-build lean-quickstart ## 🚀 Run a local devnet using lean-quickstart
39
-
# Go to lean-quickstart/local-devnet/genesis/validator-config.yaml to modify
40
-
# the validator configuration for the local devnet.
41
-
# NOTE: to run the local image of ethlambda, make sure to set the image tag
42
-
# in lean-quickstart/client-cmds/ethlambda-cmd.sh to "ghcr.io/lambdaclass/ethlambda:local"
43
-
cd lean-quickstart \
44
-
&& NETWORK_DIR=local-devnet ./spin-node.sh --node all --generateGenesis --metrics
41
+
@echo "Starting local devnet with ethlambda client (\"$(DOCKER_TAG)\" tag). Logs will be dumped in devnet.log, and metrics served in http://localhost:3000"
42
+
@echo
43
+
@echo "Devnet will be using the current configuration. For custom configurations, modify lean-quickstart/local-devnet/genesis/validator-config.yaml and restart the devnet."
44
+
@echo
45
+
@# Use temp file instead of sed -i for macOS/GNU portability
Copy file name to clipboardExpand all lines: README.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,17 @@ Minimalist, fast and modular implementation of the Lean Ethereum client written
4
4
5
5
## Getting started
6
6
7
-
We use `cargo` as our build system. To build and run the client, simply run:
7
+
We use `cargo` as our build system, but prefer `make` as a convenient wrapper for common tasks. These are some common targets:
8
8
9
9
```sh
10
-
cargo run
10
+
# Formats all code
11
+
make fmt
12
+
# Checks and lints the code
13
+
make lint
14
+
# Runs all tests
15
+
make test
16
+
# Builds a docker image tagged as "ghcr.io/lambdaclass/ethlambda:local"
17
+
make docker-build DOCKER_TAG=local
11
18
```
12
19
13
20
Run `make help` or take a look at our [`Makefile`](./Makefile) for other useful commands.
@@ -21,9 +28,11 @@ To run a local devnet with multiple clients using [lean-quickstart](https://gith
21
28
make run-devnet
22
29
```
23
30
24
-
This generates fresh genesis files and starts all three clients with metrics enabled.
31
+
This generates fresh genesis files and starts all configured clients with metrics enabled.
25
32
Press `Ctrl+C` to stop all nodes.
26
33
34
+
For custom devnet configurations, go to `lean-quickstart/local-devnet/genesis/validator-config.yaml` and edit the file before running the command above. See `lean-quickstart`'s documentation for more details on how to configure the devnet.
35
+
27
36
## Philosophy
28
37
29
38
Many long-established clients accumulate bloat over time. This often occurs due to the need to support legacy features for existing users or through attempts to implement overly ambitious software. The result is often complex, difficult-to-maintain, and error-prone systems.
Copy file name to clipboardExpand all lines: docs/metrics.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
We collect various metrics and serve them via a Prometheus-compatible HTTP endpoint at `http://<metrics_address>:<metrics_port>/metrics` (default: `http://127.0.0.1:5054/metrics`).
4
4
5
-
We provide a ready-to-use Grafana + Prometheus monitoring stack in the [`metrics/`](../metrics/) directory. It includes pre-configured dashboards from the [leanMetrics](https://github.com/leanEthereum/leanMetrics)repository for visualizing the metrics described below. See the [metrics README](../metrics/README.md) for setup instructions.
5
+
A ready-to-use Grafana + Prometheus monitoring stack with pre-configured [leanMetrics](https://github.com/leanEthereum/leanMetrics)dashboards is available in [lean-quickstart](https://github.com/blockblaz/lean-quickstart).
6
6
7
7
The exposed metrics follow [the leanMetrics specification](https://github.com/leanEthereum/leanMetrics/blob/3b32b300cca5ed7a7a2b3f142273fae9dbc171bf/metrics.md), with some metrics not yet implemented. We have a full list of implemented metrics below, with a checkbox indicating whether each metric is currently supported or not.
0 commit comments