sentry - channel - document & clean dummy-deposit route

Author: elpiel

README.md

@@ -30,7 +30,7 @@ Two services are needed to run `Sentry`: `Postgres` and `Redis`.
 
 The easiest way to run these services locally is by using the provided `docker-compose` file:
 
-`docker-compose -f ../docker-compose.harness.yml up -d adex-redis adex-postgres`
+`docker-compose -f docker-compose.harness.yml up -d adex-redis adex-postgres`
 
 If you want to run them manually without `docker-compose`:
 
@@ -81,7 +81,7 @@ POSTGRES_DB="sentry_leader" PORT=8005 KEYSTORE_PWD=ganache0 \
 cargo run -p sentry -- \
     --adapter ethereum \
     --keystoreFile ./adapter/tests/resources/0x80690751969B234697e9059e04ed72195c3507fa_keystore.json \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 ##### Follower (`0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7`)
@@ -93,11 +93,26 @@ IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/2" \
 POSTGRES_DB="sentry_follower" PORT=8006 KEYSTORE_PWD=ganache1 cargo run -p sentry -- \
     --adapter ethereum \
     --keystoreFile ./adapter/test/resources/0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7_keystore.json
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 #### Using the `Dummy` adapter
 
+Using the dummy adapter you get access to additional route
+for adding deposits to the dummy adapter. The authenticated address
+is used to set the deposit in the adapter for the given Chain id.
+
+##### `POST /v5/channel/dummy-deposit` (auth required)
+
+Request body (`JSON`):
+
+```json
+{
+    "channel": { "leader": "0x000..", ...},
+    "deposit": { "total": "10000000" }
+}
+```
+
 **Dummy** identities:
 
 ##### Leader (`0x80690751969B234697e9059e04ed72195c3507fa`)
@@ -107,7 +122,7 @@ IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/1" \
 POSTGRES_DB="sentry_leader" PORT=8005 cargo run -p sentry -- \
     --adapter dummy \
     --dummyIdentity 0x80690751969B234697e9059e04ed72195c3507fa \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 ##### Follower (`0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7`)
 
@@ -116,12 +131,12 @@ IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/2" \
 POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- \
     --adapter dummy \
     --dummyIdentity 0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7 \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 #### Environment variables
 
-- `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.
+- `ENV` - `production` or `development`; *default*: `development` - passing this env. variable will use the default configuration paths - [`docs/config/ganache.toml`](./docs/config/ganache.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
 - `IP_ADDR` - *default*: `0.0.0.0` - the IP address that the API should be listening to
 
@@ -154,14 +169,14 @@ cargo run -p validator_worker -- --help
 The password for the Keystore file can be set using the environment variable `KEYSTORE_PWD`.
 
 ##### Validator Leader (`0x80690751969B234697e9059e04ed72195c3507fa`)
-    Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
+Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
 
 ```bash
 KEYSTORE_PWD=ganache0 cargo run -p validator_worker -- \
     --adapter ethereum \
     --keystoreFile ./adapter/test/resources/0x80690751969B234697e9059e04ed72195c3507fa_keystore.json \
     --sentryUrl http://127.0.0.1:8005 \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 ##### Validator Follower
@@ -173,7 +188,7 @@ KEYSTORE_PWD=ganache1 cargo run -p validator_worker -- \
     --adapter ethereum \
     --keystoreFile ./adapter/test/resources/0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7_keystore.json \
     --sentryUrl http://127.0.0.1:8006 \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 #### Using the `Dummy` adapter
@@ -187,7 +202,7 @@ cargo run -p validator_worker -- \
     --adapter dummy \
     --dummyIdentity 0x80690751969B234697e9059e04ed72195c3507fa \
     --sentryUrl http://127.0.0.1:8005 \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 ##### Follower: `0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7`
@@ -199,13 +214,12 @@ cargo run -p validator_worker -- \
     --adapter dummy \
     --dummyIdentity 0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7 \
     --sentryUrl http://127.0.0.1:8006 \
-    ./docs/config/prod.toml
+    ./docs/config/ganache.toml
 ```
 
 #### Environment variables
 
-- `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 that Sentry seeds the database.
-- `PORT` - The local port that Sentry API will accessible at
+- `ENV` - `production` or `development`; *default*: `development` - passing this env. variable will use the default configuration paths - [`docs/config/ganache.toml`](./docs/config/ganache.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 that Sentry seeds the database.
 
 ##### Adapter
 

sentry/src/routes.rs

@@ -15,6 +15,7 @@
 //!   - [GET `/v5/channel/:id/last-approved`](#get-v5channelidlast-approved)
 //!   - [POST `/v5/channel/:id/pay`](#post-v5channelidpay-auth-required) (auth required)
 //!   - [GET `/v5/channel/:id/get-leaf`](#get-v5channelidget-leaf)
+//!   - [POST `/v5/channel/dummy-deposit`](#post-v5channeldummy-deposit-auth-required) (auth required) available only with Dummy adapter
 //! - [Campaign](#campaign) routes
 //!     - [GET `/v5/campaign/list`](#get-v5campaignlist)
 //!     - [POST `/v5/campaign`](#post-v5campaign-auth-required) (auth required)
@@ -164,6 +165,18 @@
 //! `/get-leaf?earner=0x....`
 //! This module includes all routes for `Sentry` and the documentation of each Request/Response.
 //!
+//! #### POST `/v5/channel/dummy-deposit` (auth required)
+//!
+//! Set a deposit for a Channel and depositor (the authenticated address) in the Dummy adapter.
+//!
+//! **NOTE:** This route is available **only** when using the Dummy adapter.
+//!
+//! The route is handled by [`channel::channel_dummy_deposit()`].
+//!
+//! Request body (json): [`ChannelDummyDeposit`](crate::routes::channel::ChannelDummyDeposit)
+//!
+//! Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
+//!
 //! ## Campaign
 //!
 //! All routes are implemented under the module [campaign].

sentry/src/routes/channel.rs

@@ -33,6 +33,15 @@ use serde::{Deserialize, Serialize};
 use slog::{error, Logger};
 use std::{any::Any, collections::HashMap, str::FromStr};
 
+/// Request body for Channel deposit when using the Dummy adapter.
+///
+/// **NOTE:** available **only** when using the Dummy adapter!
+#[derive(Debug, Serialize, Deserialize)]
+pub struct ChannelDummyDeposit {
+    pub channel: Channel,
+    pub deposit: Deposit<UnifiedNum>,
+}
+
 /// GET `/v5/channel/list` request
 ///
 /// Query: [`ChannelListQuery`]
@@ -548,19 +557,13 @@ pub async fn channel_payout<C: Locked + 'static>(
 
 /// POST `/v5/channel/dummy-deposit` request
 ///
-/// Body: [`Deposit<BigNum>`]
+/// Request body (json): [`ChannelDummyDeposit`]
 ///
 /// Response: [`SuccessResponse`]
 pub async fn channel_dummy_deposit<C: Locked + 'static>(
     req: Request<Body>,
     app: &Application<C>,
 ) -> Result<Response<Body>, ResponseError> {
-    #[derive(Debug, Serialize, Deserialize)]
-    pub struct ChannelDummyDeposit {
-        pub channel: Channel,
-        pub deposit: Deposit<UnifiedNum>,
-    }
-
     let auth = req
         .extensions()
         .get::<Auth>()
@@ -583,10 +586,10 @@ pub async fn channel_dummy_deposit<C: Locked + 'static>(
     // if this fails, it will cause Bad Request
     insert_channel(&app.pool, &channel_chain).await?;
 
-    // Convert the UnifiedNum to BigNum with the same precision of UnifiedNum::PRECISION
-    let deposit = Deposit {
-        total: request.deposit.total.to_precision(UnifiedNum::PRECISION),
-    };
+    // Convert the UnifiedNum to BigNum with the precision of the token
+    let deposit = request
+        .deposit
+        .to_precision(channel_chain.token.precision.into());
 
     let dummy_adapter = <dyn Any + Send + Sync>::downcast_ref::<Adapter<Dummy>>(&app.adapter)
         .expect("Only Dummy adapter is allowed here!");