README.md & Dockerfile update

Author: elpiel

Dockerfile

@@ -7,7 +7,9 @@ WORKDIR /usr/src/app
 
 COPY . .
 
-RUN cargo install --path validator_worker --all-features
+# We intall the validator_worker binary with all features in Release mode
+# Inlcude the full backtrace for easier debugging
+RUN RUST_BACKTRACE=full cargo install --path validator_worker --all-features
 
 WORKDIR /usr/local/bin
 

README.md

@@ -6,64 +6,155 @@ Reference implementation of the [AdEx validator stack](https://github.com/adexne
 
 Components:
 
-* Sentry
-* Validator worker
+* [Sentry](#sentry)
+* [Validator worker](#validator-worker)
 * Adapter
 * AdView manager
 
 ## Local & Testing setup
 
+Requirements:
+
+- Rust
+
+  Check the [`rust-toolchain`](./rust-toolchain) file for specific version of rust.
+  - [`cargo-make`](https://github.com/sagiegurari/cargo-make)
+- Docker
+
 #### Linux
 - `build-essentials` is required to build the project (error: `linker ``cc`` not found`)
 - The crate `openssl-sys` requires `libssl-dev` and `pkg-config` for Ubuntu.
 
-### Run Postgres
+## Sentry
+
+`Sentry` is the REST API that the [`Validator worker`](#validator-worker) uses for storing and retrieving information.
+We need two services to be able to run `Sentry`: `Postgres` and `Redis`.
 
-`docker run --rm  --name pg-docker -e POSTGRES_PASSWORD=docker -d -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres`
+### Running Postgres
+
+`docker run --rm --name adex-validator-postgres -e POSTGRES_PASSWORD=docker -d -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres`
 
 - `$HOME/docker/volumes/postgres` - your local storage for postgres (persist the data when we remove the container)
 - `POSTGRES_PASSWORD=docker` - the password of `postgres` user
 
-### Run Redis:
+### Running Redis
 
-`docker run --name some-redis -d redis`
+`docker run --rm --name adex-validator-redis -d redis`
 
-### Run automated tests
+### Running Sentry Rest API
 
-Since we have integration tests that require Redis & Postgres,
-you need to be running those in order to run the automated tests:
+For a full list of all available CLI options on Sentry run `--help`:
 
-`cargo make test`
+```bash
+cargo run -p sentry -- --help
+```
+
+#### Using the `Ethereum Adapter`
+
+The password for the Keystore file can be set using the environment variable `KEYSTORE_PWD`.
+
+- Leader
+    ```bash
+    POSTGRES_DB="sentry_leader" PORT=8006 cargo run -p sentry -- --adapter ethereum --keystoreFile ./adapter/resources/keystore.json ./docs/config/dev.toml
+    ```
+
+- Follower
+    ```bash
+    POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- --adapter ethereum --keystoreFile ./adapter/resources/keystore.json ./docs/config/dev.toml
+    ```
+
+#### Using the `Dummy Adapter`:
+
+Dummy identities:
+
+- Leader: `ce07CbB7e054514D590a0262C93070D838bFBA2e`
+
+```bash
+POSTGRES_DB="sentry_leader" PORT=8005 cargo run -p sentry -- --adapter dummy --dummyIdentity ce07CbB7e054514D590a0262C93070D838bFBA2e ./docs/config/dev.toml
+```
+- Follower: `c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3`
+
+```bash
+POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- --adapter dummy --dummyIdentity c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3 ./docs/config/dev.toml
+```
 
-### Run Sentry Rest API
+For full list, check out (primitives/src/util/tests/prep_db.rs#L29-L43)[./primitives/src/util/tests/prep_db.rs#L29-L43]
 
-* With the DummyAdapter(replace the `DummyIdentity`):
+#### Environment variables:
 
-`export PORT=8006; cargo run -p sentry -- -a dummy -i DummyIdentity`
+- `ENV`: `production` or `development` - pass this env. variable if you want to use the default configuration paths - [`docs/config/dev.toml`](./docs/config/dev.toml) (for development) or [`docs/config/prod.toml`](./docs/config/prod.toml) (for production)
+- `PORT`
+- `KEYSTORE_PWD`
+- `POSTGRES_DB`
 
-* With the EthereumAdapter:
+### Running the Validator Worker
 
-TODO
+For a full list of all available CLI options on the Validator worker run `--help`:
 
-### Bug
+```bash
+cargo run -p validator_worker -- --help
+```
 
+#### Using the `Ethereum Adapter`:
+TODO: Update Keystore file and Keystore password for Leader/Follower as they are using the same at the moment.
 
+The password for the Keystore file can be set using the environment variable `KEYSTORE_PWD`.
 
+- Leader
+    Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
 
-### Run Validator Worker
+    ```bash
+    cargo run -p validator_worker --adapter ethereum --keystoreFile ./adapter/resources/keystore.json --sentryUrl http://127.0.0.1:8005 ./docs/config/dev.toml
+    ```
 
-TODO
+- Follower
+
+    Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Follower** on port `8006`:
+
+    ```bash
+    cargo run -p validator_worker --adapter ethereum --keystoreFile ./adapter/resources/keystore.json --sentryUrl http://127.0.0.1:8006 ./docs/config/dev.toml
+    ```
+
+#### Using the `Dummy Adapter`:
+- Leader: `ce07CbB7e054514D590a0262C93070D838bFBA2e`
+
+    Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
+
+    ```bash
+    cargo run -p validator_worker --adapter dummy --dummyIdentity ce07CbB7e054514D590a0262C93070D838bFBA2e --sentryUrl http://127.0.0.1:8005 ./docs/config/dev.toml
+    ```
+
+- Follower: `c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3`
+
+    Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Follower** on port `8006`:
+
+    ```bash
+    cargo run -p validator_worker --adapter dummy --dummyIdentity c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3 --sentryUrl http://127.0.0.1:8006 ./docs/config/dev.toml
+    ```
 
 ## Development environment
 
-We use [cargo-make](https://github.com/sagiegurari/cargo-make) for running the checks and build project locally
-as well as on CI. For a complete list of out-of-the-box commands you can check
+We use [`cargo-make`](https://github.com/sagiegurari/cargo-make#overview) for running automated checks (tests, builds, formatting, code linting, etc.) and building the project locally
+as well as on our Continuous Integration (CI). For a complete list of out-of-the-box commands you can check
 [Makefile.stable.toml](https://github.com/sagiegurari/cargo-make/blob/master/src/lib/Makefile.stable.toml).
 
-Locally it's enough to ensure that `cargo make` command (it will execute the default dev. command) is passing.
-It will run `rustfmt` for you, it will fail on `clippy` warnings and it will run all the tests.
+### Local development
 
-*Note:* You need to have setup Redis and Postgres as well.
+Locally it's enough to ensure that the default development command is executing successfully:
+
+```bash
+cargo make
+```
+
+It will run `rustfmt` for you as well as `clippy` (it will fail on warnings) and it will run all the tests thanks to `cargo` (doc tests, unit tests, integration tests, etc.).
+
+This will also run the [Automated tests](#automated-tests), so you must have `Redis` & `Postgres` running.
+
+#### Automated tests
+
+This requires [`cargo-make`](https://github.com/sagiegurari/cargo-make#overview) and since we have integration tests that require `Redis` ([see `Running Redis`](#running-redis)) & `Postgres` (see [`Running Postgres`](#running-postgres)), you need to be running those in order to run the automated tests:
+
+`cargo make test`
 
-You can related to the [Makefile.stable.toml](https://github.com/sagiegurari/cargo-make/blob/master/src/lib/Makefile.stable.toml)
+You can relate to the [`Makefile.stable.toml`](https://github.com/sagiegurari/cargo-make/blob/master/src/lib/Makefile.stable.toml)
 for more commands and cargo-make as a whole.