Merge pull request #388 from AdExNetwork/issue-381-spender-aggregates

Issue #381 Spender aggregates - structs and setup

Author: elpiel

Cargo.lock

@@ -0,0 +1,22 @@
+[tasks.dev-test-flow]
+description = "Development testing flow will first format the code, and than run cargo build and test"
+category = "Development"
+dependencies = [
+  "format-flow",
+  "format-toml-conditioned-flow",
+  "pre-build",
+  "build",
+  "post-build",
+  "services-up",
+  "test-flow",
+  "services-down",
+]
+
+[tasks.test]
+env = { "POSTGRES_DB" = "sentry_leader" }
+
+[tasks.services-up]
+script = "docker-compose -f ../docker-compose.ci.yml up -d postgres-leader"
+
+[tasks.services-down]
+script = "docker-compose -f ../docker-compose.ci.yml down"

primitives/Makefile.toml

@@ -1,6 +1,6 @@
 use crate::{
     channel_v5::Channel, targeting::Rules, AdUnit, Address, EventSubmission, UnifiedNum,
-    ValidatorDesc,
+    ValidatorDesc, ValidatorId,
 };
 
 use chrono::{
@@ -184,6 +184,14 @@ pub struct Campaign {
 }
 
 impl Campaign {
+    pub fn find_validator(&self, validator: ValidatorId) -> Option<&'_ ValidatorDesc> {
+        match (self.leader(), self.follower()) {
+            (Some(leader), _) if leader.id == validator => Some(leader),
+            (_, Some(follower)) if follower.id == validator => Some(follower),
+            _ => None,
+        }
+    }
+
     /// Matches the Channel.leader to the Campaign.spec.leader
     /// If they match it returns `Some`, otherwise, it returns `None`
     pub fn leader(&self) -> Option<&'_ ValidatorDesc> {

primitives/src/campaign.rs

@@ -35,6 +35,7 @@ pub mod ipfs;
 pub mod market;
 pub mod merkle_tree;
 pub mod sentry;
+pub mod spender;
 pub mod supermarket;
 pub mod targeting;
 mod unified_num;

primitives/src/lib.rs

@@ -172,13 +172,6 @@ impl fmt::Display for Event {
     }
 }
 
-#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
-pub struct Earner {
-    #[serde(rename = "publisher")]
-    pub address: String,
-    pub promilles: u64,
-}
-
 #[derive(Debug, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct EventAggregate {

primitives/src/sentry.rs

@@ -0,0 +1,49 @@
+use crate::{channel_v5::Channel, Address, BalancesMap, UnifiedNum};
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct Deposit {
+    pub total: UnifiedNum,
+    pub still_on_create2: UnifiedNum,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
+pub struct Spendable {
+    pub spender: Address,
+    pub channel: Channel,
+    #[serde(flatten)]
+    pub deposit: Deposit,
+}
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct Aggregate {
+    pub spender: Address,
+    pub channel: Channel,
+    pub balances: BalancesMap,
+    pub created: DateTime<Utc>,
+}
+#[cfg(feature = "postgres")]
+mod postgres {
+    use std::convert::TryFrom;
+    use tokio_postgres::{Error, Row};
+
+    use super::*;
+
+    impl TryFrom<Row> for Spendable {
+        type Error = Error;
+
+        fn try_from(row: Row) -> Result<Self, Self::Error> {
+            Ok(Spendable {
+                spender: row.try_get("spender")?,
+                channel: row.try_get("channel")?,
+                deposit: Deposit {
+                    total: row.try_get("total")?,
+                    still_on_create2: row.try_get("still_on_create2")?,
+                },
+            })
+        }
+    }
+}

primitives/src/spender.rs

@@ -106,10 +106,13 @@ impl TryFrom<Value> for ValidatorId {
 #[serde(rename_all = "camelCase")]
 pub struct ValidatorDesc {
     pub id: ValidatorId,
+    /// The validator fee in pro milles (per 1000)
+    pub fee: UnifiedNum,
     #[serde(default, skip_serializing_if = "Option::is_none")]
+    /// The address which will receive the fees
     pub fee_addr: Option<Address>,
+    /// The url of the Validator on which is the API
     pub url: String,
-    pub fee: UnifiedNum,
 }
 
 /// Validator Message Types

primitives/src/validator.rs

@@ -1,7 +1,7 @@
 [package]
 name = "sentry"
 version = "0.1.0"
-authors = ["Omidiora Samuel <[email protected]>"]
+authors = ["Lachezar Lechev <[email protected]>", "Omidiora Samuel <[email protected]>"]
 edition = "2018"
 
 [dependencies]
@@ -27,7 +27,7 @@ bb8 = "0.7"
 bb8-postgres = { version = "0.7", features = ["with-chrono-0_4", "with-serde_json-1"] }
 
 # Migrations
-migrant_lib = { version = "^0.30", features = ["d-postgres"] }
+migrant_lib = { version = "^0.32", features = ["d-postgres"] }
 # Logger
 slog = { version = "^2.2.3", features = ["max_level_trace"] }
 # Serde
@@ -37,5 +37,10 @@ serde_urlencoded = "^0.7"
 # Other
 lazy_static = "1.4.0"
 thiserror = "^1.0"
+tokio-postgres = { version = "0.7.0", features = ["with-chrono-0_4", "with-serde_json-1"] }
+
+[dev-dependencies]
+# todo: Replace `bb8` once we update all places.
 deadpool = "0.7.0"
+deadpool-postgres = "0.7.0"
 once_cell = "1.5.2"

sentry/Cargo.toml

@@ -12,8 +12,11 @@ dependencies = [
   "services-down",
 ]
 
+[tasks.test]
+env = { "POSTGRES_DB" = "sentry_leader" }
+
 [tasks.services-up]
-script = "docker-compose -f ../docker-compose.ci.yml up -d redis-leader"
+script = "docker-compose -f ../docker-compose.ci.yml up -d redis-leader postgres-leader"
 
 [tasks.services-down]
 script = "docker-compose -f ../docker-compose.ci.yml down"