Enhancement: run script and readme updates (#84)

* [README/run] Update the run.sh scripts and README to allow configuration in one single .env file

* [justfile] add run-* commands

* Remove references to CHAIN_ID

.env_sample

@@ -1,5 +1,4 @@
 DATABASE_URL=postgres://postgres:password@postgres:5432/namada-indexer
 TENDERMINT_URL=http://host.docker.internal:27657
-CHAIN_ID=local.82f9d1c42fdcadbb287ce393
 CACHE_URL=redis://dragonfly:6379
 WEBSERVER_PORT=5000

README.md

@@ -31,7 +31,6 @@ cp .env_sample .env
 - Get a Namada RPC url
   - [Either create a local chain ](https://github.com/anoma/namada/blob/main/scripts/gen_localnet.py)
   - Or use a Public RPC
-- Change `CHAIN_ID`
 - Install [just](https://github.com/casey/just)
 - Run `just docker-run`
 
@@ -41,7 +40,18 @@ cp .env_sample .env
 - Get a Namada RPC url
   - [Either create a local chain ](https://github.com/anoma/namada/blob/main/scripts/gen_localnet.py)
   - Or use a Public RPC
-- Get a network `CHAIN_ID`
+- Create a `.env` file in the root of the project with the following content:
+  ```env
+  DATABASE_URL=postgres://postgres:[email protected]:5435/namada-indexer
+  TENDERMINT_URL=http://127.0.0.1:27657
+  ```
+  (Change the values to match your setup)
+- For `webserver` only, you may also add the following to the `.env` file:
+  ```env
+  CACHE_URL=redis://[email protected]:6379
+  PORT=5000
+  ```
+  (Change the values to match your setup)
 - Use the `run.sh` script inside each package. Keep in mind that PoS package have to be run always while other service might not
 
 ## Testing via seeder

chain/run.sh

@@ -1 +1,4 @@
-cargo run -- --tendermint-url http://127.0.0.1:27657 --initial-query-retry-time 5 --database-url postgres://postgres:[email protected]:5435/namada-indexer
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run -- --initial-query-retry-time 5

docker-compose.yml

@@ -8,7 +8,6 @@ x-defaults: &defaults
     args: &build-args
       DATABASE_URL: ${DATABASE_URL}
       TENDERMINT_URL: ${TENDERMINT_URL}
-      CHAIN_ID: ${CHAIN_ID}
       CACHE_URL: ${CACHE_URL}
       WEBSERVER_PORT: ${WEBSERVER_PORT}
   environment: &env-vars

governance/run.sh

@@ -1,2 +1,4 @@
-
-cargo run -- --tendermint-url http://127.0.0.1:27657 --database-url postgres://postgres:[email protected]:5435/namada-indexer --sleep-for 15
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run -- --sleep-for 15

justfile

@@ -17,4 +17,28 @@ docker-up:
     docker compose up
 
 clean:
-    cargo clean
+    cargo clean
+
+run-chain:
+    (cd chain && ./run.sh)
+
+run-governance:
+    (cd governance && ./run.sh)
+
+run-parameters:
+    (cd parameters && ./run.sh)
+
+run-pos:
+    (cd pos && ./run.sh)
+
+run-rewards:
+    (cd rewards && ./run.sh)
+
+run-seeder:
+    (cd seeder && ./run.sh)
+
+run-transactions:
+    (cd transactions && ./run.sh)
+
+run-webserver:
+    (cd webserver && ./run.sh)

parameters/run.sh

@@ -1,2 +1,4 @@
-
-cargo run -- --tendermint-url http://127.0.0.1:27657 --database-url postgres://postgres:[email protected]:5435/namada-indexer --sleep-for 15
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run -- --sleep-for 15

pos/run.sh

@@ -1,2 +1,4 @@
-
-cargo run -- --tendermint-url http://127.0.0.1:27657 --database-url postgres://postgres:[email protected]:5435/namada-indexer
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run

rewards/run.sh

@@ -1,2 +1,4 @@
-
-cargo run -- --tendermint-url http://127.0.0.1:27657 --database-url postgres://postgres:[email protected]:5435/namada-indexer --sleep-for 15
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run -- --sleep-for 15

seeder/run.sh

@@ -1,2 +1,4 @@
-
-cargo run -- --cargo-env development --tendermint-url http://127.0.0.1:27657 --database-url postgres://postgres:[email protected]:5435/indexer_local
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run -- --cargo-env development

transactions/run.sh

@@ -1 +1,4 @@
-cargo run -- --database-url postgres://postgres:[email protected]:5435/namada-indexer --tendermint-url http://127.0.0.1:27657
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+cargo run

webserver/run.sh

@@ -1 +1,6 @@
-cargo run -- --database-url postgres://postgres:[email protected]:5435/namada-indexer --cache-url redis://[email protected]:6379 --tendermint-url http://127.0.0.1:27657
+. ../.env
+export TENDERMINT_URL
+export DATABASE_URL
+export CACHE_URL
+export PORT
+cargo run