README information & clean-up

elpiel · elpiel · commit cf059ebba894 · 2020-11-23T09:52:20.000+02:00
diff --git a/README.md b/README.md
@@ -49,9 +49,13 @@ For a full list of all available CLI options on Sentry run `--help`:
 cargo run -p sentry -- --help
 ```
 
+Starting the Sentry API in will always run migrations, this will make sure the database is always up to date with the latest migrations, before starting and exposing the web server.
+
+In `development` ( [`ENV` environment variable](#environment-variables) ) it will seed the database as well.
+
 #### Using the `Ethereum Adapter`
 
-The password for the Keystore file can be set using the environment variable `KEYSTORE_PWD`.
+The password for the Keystore file can be set using the [environment variable `KEYSTORE_PWD`](#adapter).
 
 - Leader
     ```bash
@@ -65,27 +69,46 @@ The password for the Keystore file can be set using the environment variable `KE
 
 #### Using the `Dummy Adapter`:
 
-Dummy identities:
+**Dummy** identities:
 
 - Leader: `ce07CbB7e054514D590a0262C93070D838bFBA2e`
 
 ```bash
-POSTGRES_DB="sentry_leader" PORT=8005 cargo run -p sentry -- --adapter dummy --dummyIdentity ce07CbB7e054514D590a0262C93070D838bFBA2e ./docs/config/dev.toml
+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
+POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- \
+    --adapter dummy \
+    --dummyIdentity c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3 \
+    ./docs/config/dev.toml
 ```
 
 For full list, check out (primitives/src/util/tests/prep_db.rs#L29-L43)[./primitives/src/util/tests/prep_db.rs#L29-L43]
 
 #### Environment variables:
 
-- `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`
+- `ENV` - `production` or `development`; *default*: `development` - passing this env. variable will 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`). Otherwise you can pass your own configuration file path to the binary (check `cargo run -p sentry --help` for more information). In `development` it will make sure Sentry to seed the database.
+- `PORT` - *default*: `8005` - The local port that Sentry API will be accessible at
+- `ANALYTICS_RECORDER` - accepts any non-zero value - whether or not to start the `Analytics recorder` that will track analytics stats for payout events (`IMPRESSION` & `CLICK`)
+##### Adapter
+- `KEYSTORE_PWD` - Password for the `Keystore file`, only available when using `Ethereum Adapter` (`--adapter ethereum`)
+
+##### Redis
+- `REDIS_URL` - *default*: `redis://127.0.0.1:6379`
+
+##### Postgres
+- `POSTGRES_HOST` - *default*: `localhost`
+- `POSTGRES_USER` - *default*: `postgres`
+- `POSTGRES_PASSWORD` - *default*: `postgres`
+- `POSTGRES_DB` - *default*: `user` name - Database name in Postgres to be used for this instance
+- `POSTGRES_PORT` - *default*: `5432`
+
+#####
 
 ### Running the Validator Worker
 
@@ -104,15 +127,23 @@ The password for the Keystore file can be set using the environment variable `KE
     Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
 
     ```bash
-    cargo run -p validator_worker --adapter ethereum --keystoreFile ./adapter/resources/keystore.json --sentryUrl http://127.0.0.1:8005 ./docs/config/dev.toml
+    cargo run -p validator_worker
+        --adapter ethereum
+        --keystoreFile ./adapter/resources/keystore.json
+        --sentryUrl http://127.0.0.1:8005
+        ./docs/config/dev.toml
     ```
 
 - 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
+    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`:
@@ -121,17 +152,33 @@ The password for the Keystore file can be set using the environment variable `KE
     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
+    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
+    cargo run -p validator_worker
+        --adapter dummy
+        --dummyIdentity c91763d7f14ac5c5ddfbcd012e0d2a61ab9bded3
+        --sentryUrl http://127.0.0.1:8006
+        ./docs/config/dev.toml
     ```
 
+#### Environment variables:
+
+- `ENV`: `production` or `development` ( *default* ) - passing this env. variable will 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`). Otherwise you can pass your own configuration file path to the binary (check `cargo run -p sentry --help` for more information). In `development` it will make sure Sentry to seed the database.
+- `PORT` - The local port that Sentry API will accessible at
+
+##### Adapter
+- `KEYSTORE_PWD` - Password for the `Keystore file`, only available when using `Ethereum Adapter` (`--adapter ethereum`)
+
 ## Development environment
 
 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
diff --git a/sentry/src/db.rs b/sentry/src/db.rs
@@ -35,7 +35,7 @@ lazy_static! {
 }
 
 pub async fn redis_connection() -> Result<MultiplexedConnection, RedisError> {
-    let client = redis::Client::open(REDIS_URL.as_str()).expect("Wrong redis connection url");
+    let client = redis::Client::open(REDIS_URL.as_str())?;
     let (connection, driver) = client.get_multiplexed_async_connection().await?;
     tokio::spawn(driver);
     Ok(connection)
diff --git a/sentry/src/main.rs b/sentry/src/main.rs
@@ -1,7 +1,7 @@
 #![deny(clippy::all)]
 #![deny(rust_2018_idioms)]
 
-use clap::{App, Arg};
+use clap::{crate_version, App, Arg};
 
 use adapter::{AdapterTypes, DummyAdapter, EthereumAdapter};
 use hyper::service::{make_service_fn, service_fn};
@@ -20,7 +20,7 @@ const DEFAULT_PORT: u16 = 8005;
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let cli = App::new("Sentry")
-        .version("0.1")
+        .version(crate_version!())
         .arg(
             Arg::with_name("config")
                 .help("the config file for the validator worker")
diff --git a/validator_worker/src/main.rs b/validator_worker/src/main.rs
@@ -5,7 +5,7 @@ use std::convert::TryFrom;
 use std::error::Error;
 use std::time::Duration;
 
-use clap::{App, Arg};
+use clap::{crate_version, App, Arg};
 use futures::future::{join, join_all};
 use tokio::runtime::Runtime;
 use tokio::time::{delay_for, timeout};
@@ -29,7 +29,7 @@ struct Args<A: Adapter> {
 
 fn main() -> Result<(), Box<dyn Error>> {
     let cli = App::new("Validator worker")
-        .version("0.1")
+        .version(crate_version!())
         .arg(
             Arg::with_name("config")
                 .help("the config file for the validator worker")

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ lazy_static! {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`pub async fn redis_connection() -> Result<MultiplexedConnection, RedisError> {`
`38`		`- let client = redis::Client::open(REDIS_URL.as_str()).expect("Wrong redis connection url");`
	`38`	`+ let client = redis::Client::open(REDIS_URL.as_str())?;`
`39`	`39`	`let (connection, driver) = client.get_multiplexed_async_connection().await?;`
`40`	`40`	`tokio::spawn(driver);`
`41`	`41`	`Ok(connection)`