refactor: Improve DevX

.gitignore

@@ -45,4 +45,8 @@ based/temp_registry.json
 temp
 webcontrol
 data
-*.py
+
+*.py
+
+/dist
+/.local

Justfile

@@ -0,0 +1,86 @@
+set dotenv-load
+
+export LOCAL_DATA := canonicalize(env("LOCAL_DATA", shell('mkdir -p .local && echo ".local"')))
+
+mod deps
+
+# Verifies that system dependencies are present
+@check:
+    echo "jq: {{require('jq')}}"
+    echo "docker: {{require('docker')}}"
+    echo "cast: {{require('cast')}}"
+    echo "rustup: {{require('rustup')}}"
+
+# Prepare the local environment: fetch deps, build them, setup toolchains...
+@prepare:
+    just deps::fetch
+    cd docs && npm i
+    cd based && rustup toolchain install 
+
+# 🏗️ Build
+@build: deps::build
+    just -f based/docker/Justfile all
+
+# 📚 Build local docs
+docs:
+    just -f docs/Justfile serve
+
+# Build and link rabby in the configured output folder
+rabby out="./dist":
+    just -f deps/rabby.just build
+    ln -s deps/rabby/dist {{out}}/rabby
+    ln -s deps/rabby/dist-mv2 {{out}}/rabby-mv2
+
+## Component access (component verb)
+
+# Run recipes from scripts/spamoor.just
+spamoor *args=("start ./spamoor-config.yml"):
+    just -f scripts/spamoor.just {{args}}
+
+# Run recipes from scripts/overseer.just
+overseer *args=("start"):
+    just -f based/overseer.just {{args}}
+
+# Run recipes from based/portal.just
+portal *args:
+    just -f based/portal.just {{args}}
+
+# Run recipes from based/registry.just
+registry *args:
+    just -f based/registry.just {{args}}
+
+# Run recipes from based/main-node.just
+main-node *args:
+    just -f based/main-node.just {{args}}
+
+# Run recipes from based/follower-node.just
+follower-node *args:
+    just -f based/follower-node.just {{args}}
+
+# Run recipes from based/monitoring.just
+monitoring *args:
+    just -f scripts/monitoring.just {{args}}
+
+## Action access (verb component)
+
+# View logs for the given service
+logs name:
+    just -f scripts/logs.just {{name}}
+
+# Start the given service 
+start name:
+    just -f {{justfile()}} {{name}} start
+
+# Stop the given service 
+stop name:
+    just -f {{justfile()}} {{name}} stop
+
+# Run a test recipe described in scripts/test.just
+test name:
+    just -f scripts/test.just {{name}}
+
+# TODO: setup main node, start main node, setup follower-node, start follower-node (& gateway) 
+# 
+# TODO: consider some sort of interactive config if needed
+quick-start:
+    exit 1

README.md

@@ -7,26 +7,26 @@
 The following steps have been tested on Sepolia, with a previously deployed L2 chain
 
 1. locate your `rollup.json`, `genesis.json` and `state.json` files
-2. run `make config-main-node OP_NODE_DATA_DIR=<path/to/op-node/data> OP_GETH_DATA_DIR=<path/to/op-geth/data> ROLLUP_JSON=<path/to/rollup.json> GENESIS_JSON=<path/to/genesis.json> STATE_JSON=<path/to/state.json>`
-3. there should be some files set up in `.local_main_node`
-4. start sequencing the main chain with `make start-main-node OP_BATCHER_KEY=<op-batcher-private-key> OP_PROPOSER_KEY=<op-proposer-private-key> MAIN_KEY=<vault-key/main-sequencing key>`
+2. run `just main-node create-config /path/to/folder/with/{rollup.json, genesis.json, state.json}`
+3. there should be some files set up in `.local/local_main_node`
+4. start sequencing the main chain with `just start main-node`, ensuring `OP_PROPOSER_KEY`, `OP_BATCHER_KEY` and `OP_SEQUENCER_KEY` environment variables are set with the private key of the corresponding entity for the chain
 5. Normally you should see some logs starting
 6. `blockscout` should be up and running at `http://0.0.0.0:4000`
-   7a. `make stop-main-node` to stop all the sequencing services
-   7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
-   7c. `make logs-main-node` to output logs of all the main services
+   7a. `just stop main-node` to stop all the sequencing services
+   7b. `just stop monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
+   7c. `just logs main-node` to output logs of all the main services
 
 ### Deploy a new l2 chain on Sepolia
 
 1. To deploy a new chain on l2, make sure to have an address on Sepolia with some funds. This will be used as the `MAIN`/`vault` address.
-2. create 2 more accounts, deposit ~0.2 eth in them. One will be used for the `op-batcher` one for the `op-proposer.
-3. run `make deploy-chain OP_BATCHER_KEY=<op-batcher private key> OP_PROPOSER_KEY=<op-proposer private key> MAIN_KEY=<vault key>`
-4. start sequencing the main chain with `make start-main-node OP_BATCHER_KEY=<op-batcher-private-key> OP_PROPOSER_KEY=<op-proposer-private-key> MAIN_KEY=<vault-key/main-sequencing key> L1_RPC_URL=<sepolia rpc url> L1_BEACON_RPC_URL=<sepolia beacon rpc url>`
+2. create 2 more accounts, deposit ~0.2 eth in them. One will be used for the `op-batcher` one for the `op-proposer`.
+3. run `just main-node config-with-deploy`, ensuring `OP_BATCHER_KEY`, `OP_PROPOSER_KEY` and `OP_SEQUENCER_KEY` environment variables are set with the private key of the corresponding entity for your new chain
+4. start sequencing the main chain with `just main-node start`, ensuring the same environment variables as set
 5. Normally you should see some logs starting
 6. `blockscout` should be up and running at `http://0.0.0.0:4000`
-   7a. `make stop-main-node` to stop all the sequencing services
-   7b. `make stop-monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
-   7c. `make logs-main-node` to output logs of all the main services
+   7a. `just stop main-node` to stop all the sequencing services
+   7b. `just stop monitoring` to stop all monitoring services (Grafana, Prometheus, etc)
+   7c. `just logs main-node` to output logs of all the main services
 
 ### Run a Based Gateway
 
@@ -35,7 +35,7 @@ With that default config, a new `private-key` and `wallet` combo will be generat
 The `wallet` is communicated back to the `Portal` to be gossiped around to the rest of the network for signature verification.
 
 The following single command sets up everything and will start your `Gateway`, `Based OP-node`, `Based OP-geth`:
-`git clone https://github.com/gattaca-com/based-op && cd based-op && make start-gateway`
+`git clone https://github.com/gattaca-com/based-op && cd based-op && just start follower-node`
 
 If everything went well, you should see a terminal UI appear, called the `Overseer`:
 
@@ -44,29 +44,29 @@ If everything went well, you should see a terminal UI appear, called the `Overse
 This shows you the status of your local `Gateway` and a general overview of the chain.
 You can press left and right keys to cycle between the different tabs and explore all the information!
 
-The configuration that was generated can be found in `based-op/.local_gateway_and_follower`, mainly the `.env` and `compose.yml` files.
+The configuration that was generated can be found in `based-op/.local/gateway_and_follower`, mainly the `.env` and `compose.yml` files.
 
 When you [spam some transactions with `based-bmf`](https://based-bmf.gattaca.com), you should see them appear in the `Transaction Pool` of your `Gateway`.
 
 A couple of commands tend to come in handy (from the top `based-op` directory):
 
-- `make stop-gateway`
-- `make start-gateway`
-- `make start-overseer`
-- `make logs-gateway`
-- `make logs-based-op-node`
-- `make logs-based-op-geth`
+- `just stop follower-node`
+- `just start follower-node`
+- `just start overseer`
+- `just logs follower-node`
+- `just logs based-op-node`
+- `just logs based-op-geth`
 
 ### Add/Update based-gateways to Registry
 
-When a based-gateway is started with `make start-gateway`, it will register itself to the Registry behind the `PORTAL`. For now, the Registry is kept in a simple json file in `.local_main_node/config/registry.json`. You can add/update/remove gateways there, the Registry and Portal will pick up on the changes every minute.
+When a based-gateway is started with `just follower-node start`, it will register itself to the Registry behind the `PORTAL`. For now, the Registry is kept in a simple json file in `.local_main_node/config/registry.json`. You can add/update/remove gateways there, the Registry and Portal will pick up on the changes every minute.
 
 If you have started both the main sequencing node and the gateway on the same machine, you might need to change the ip to `0.0.0.0`, by default `curl ifconfig.me` is used to populate
 your url.
 
 ### Send your first tx
 
-You can now test sending a transaction with `make test-tx`.
+You can now test sending a transaction with `just test tx`.
 The transaction will be sent to the Portal, and forwarded to the gateway, which will sequence the transaction in a new Frag, and broacast it via p2p to follower nodes.
 
 > [!IMPORTANT]
@@ -78,10 +78,10 @@ The transaction will be sent to the Portal, and forwarded to the gateway, which
 Wallets commonly use a high polling interval for the transaction receipt. To be able to see the preconfirmation speed, we modify Rabby to speed up that interval. You can test it compiling it:
 
 ```sh
-make build-rabby-chrom
+just rabby 
 ```
 
-And importing it to your browser locally (see [Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) or [Chrome](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world?hl=es-419#load-unpacked) references). The compiled extension directory is `rabby/dist` for Google Chrome, and `rabby/dist-mv2` for Mozilla Firefox.
+And importing it to your browser locally (see [Firefox](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) or [Chrome](https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world?hl=es-419#load-unpacked) references). The compiled extension directory is `dist/rabby` for Google Chrome, and `dist/rabby-mv2` for Mozilla Firefox.
 
 ### Connecting your local wallet to your local follower node
 

based/docker/Justfile

@@ -0,0 +1,23 @@
+set quiet
+
+suppress_output := env("QUIET", "true")
+quiet := if suppress_output == "true" { "--quiet > /dev/null 2>&1 " } else { "" }
+
+# Build the docker image from the corresponding `.Dockerfile`
+build image *args:
+    echo "Building {{image}}..."
+    docker build -t local_based_{{image}} -f ./{{image}}.Dockerfile ../ {{args}} \
+    {{quiet}}
+
+build-portal: (build "portal")
+build-registry: (build "registry")
+build-gateway: (build "gateway")
+build-txproxy: (build "txproxy")
+build-metrics-exporter: (build "metrics-exporter" "--load")
+
+[parallel]
+all: build-portal build-registry build-gateway build-txproxy build-metrics-exporter
+
+# Creates the docker network `name` if it doesn't already exist
+create-network name="based_op_net":
+    docker network inspect {{name}} > /dev/null 2>&1 || docker network create {{name}}

based/metrics-exporter.Dockerfile → based/docker/metrics-exporter.Dockerfile

@@ -7,15 +7,15 @@ RUN apt-get update && apt-get install -y clang
 
 FROM chef AS planner
 COPY . .
-RUN --mount=from=reth,target=/reth cargo chef prepare --recipe-path recipe.json
+RUN cargo chef prepare --recipe-path recipe.json
 
 FROM chef AS builder 
 COPY --from=planner /app/recipe.json recipe.json
 
-RUN --mount=from=reth,target=/reth cargo chef cook --release --recipe-path recipe.json
+RUN cargo chef cook --release --recipe-path recipe.json
 
 COPY . .
-RUN --mount=from=reth,target=/reth cargo build --release --bin bop-metrics-exporter
+RUN cargo build --release --bin bop-metrics-exporter
 
 
 FROM debian:stable-slim AS runtime