From 184d378c9090e59916738e8e5b2291494bec6b46 Mon Sep 17 00:00:00 2001 From: Daniil Polyakov Date: Thu, 26 Feb 2026 16:02:26 +0300 Subject: [PATCH] docs: add just command docs --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b94a68d4..ee2d8097 100644 --- a/README.md +++ b/README.md @@ -142,7 +142,7 @@ The sequencer and logos blockchain node can be run locally: - `./scripts/setup-logos-blockchain-circuits.sh` - `cargo build --all-features` - `./target/debug/logos-blockchain-node --deployment nodes/node/standalone-deployment-config.yaml nodes/node/standalone-node-config.yaml` - + 2. Alternatively (WARNING: This node is outdated) go to ``logos-blockchain/lssa/` repo and run the node from docker: - `cd bedrock` - Change line 14 of `docker-compose.yml` from `"0:18080/tcp"` into `"8080:18080/tcp"` @@ -162,6 +162,48 @@ After stopping services above you need to remove 3 folders to start cleanly: 3. In the `lssa` file `sequencer_runner/bedrock_signing_key` 4. In the `lssa` folder `indexer/service/rocksdb` +### Normal mode (`just` commands) +We provide a `Justfile` for developer and user needs, you can run the whole setup with it. The only difference will be that logos-blockchain (bedrock) will be started from docker. + +#### 1'st Terminal + +```bash +just run-bedrock +``` + +#### 2'nd Terminal + +```bash +just run-indexer +``` + +#### 3'rd Terminal + +```bash +just run-sequencer +``` + +#### 4'th Terminal + +```bash +just run-explorer +``` + +#### 5'th Terminal + +You can run any command our wallet support by passing it as an argument for `just run-wallet`, for example: + +```bash +just run-wallet check-health +``` + +This will use a wallet binary built from this repo and not the one installed in your system if you have some. Also another wallet home directory will be used. This is done to not to mess up with your local wallet and to easily clean generated files (see next section). + +#### Shutdown + +1. Press `ctrl-c` in every terminal +2. Run `just clean` to clean runtime data + ### Standalone mode The sequencer can be run in standalone mode with: ```bash