Merge branch 'aip-61-adex-v5' into clean-up-todos

simzzz · simzzz · commit bfa42b6d8285 · 2022-11-17T17:11:21.000+02:00
diff --git a/adview-manager/src/manager.rs b/adview-manager/src/manager.rs
@@ -104,6 +104,7 @@ impl Size {
 #[derive(Debug, Clone)]
 pub struct NextAdUnit {
     pub unit: AdUnit,
+    // Price per 1 event
     pub price: UnifiedNum,
     pub accepted_referrers: Vec<Url>,
     pub html: String,
diff --git a/docs/config/ganache.toml b/docs/config/ganache.toml
@@ -29,10 +29,10 @@ ip_rate_limit = { type = 'ip', timeframe = 1200000 }
 # The maximum number of campaigns a publisher can earn from
 # This will limit the returned Campaigns to the set number
 max_campaigns_earning_from = 25
-# 0.0001 (UnifiedNum) per 1000 impressions
-# 10 * (per) 1_000 / 10^8 = 0.0001
-# 0.00010000
-global_min_impression_price = '10000'
+
+# 0.0000001 (UnifiedNum) per 1 impression
+# 10 / 10^8 = 0.0000001
+global_min_impression_price = '10'
 
 [sentry]
 # in milliseconds
diff --git a/docs/config/prod.toml b/docs/config/prod.toml
@@ -14,9 +14,10 @@ ip_rate_limit = { type = 'ip', timeframe = 7200000 }
 # The maximum number of campaigns a publisher can earn from
 # This will limit the returned Campaigns to the set number
 max_campaigns_earning_from = 25
-# 0.01 (UnifiedNum) per 1000 impressions
-# 1_000 * (per) 1_000 / 10^8 = 0.01
-global_min_impression_price = '1000000'
+
+# 0.00001 (UnifiedNum) per 1 impression
+# 1_000 / 10^8 = 0.00001
+global_min_impression_price = '1000'
 
 [sentry]
 # in milliseconds
diff --git a/primitives/examples/campaign_list_response.rs b/primitives/examples/campaign_list_response.rs
@@ -30,12 +30,12 @@ fn main() {
           "title": "Dummy Campaign",
           "pricingBounds": {
             "CLICK": {
-              "min": "6000000",
-              "max": "10000000"
+              "min": "6000",
+              "max": "10000"
             },
             "IMPRESSION": {
-              "min": "4000000",
-              "max": "5000000"
+              "min": "4000",
+              "max": "5000"
             }
           },
           "eventSubmission": {
@@ -97,12 +97,12 @@ fn main() {
           "title": "Dummy Campaign 2 in Chain #1337",
           "pricingBounds": {
             "CLICK": {
-              "min": "300000000",
-              "max": "500000000"
+              "min": "300000",
+              "max": "500000"
             },
             "IMPRESSION": {
-              "min": "100000000",
-              "max": "200000000"
+              "min": "100000",
+              "max": "200000"
             }
           },
           "eventSubmission": {
@@ -165,12 +165,12 @@ fn main() {
           "title": "Dummy Campaign 3 in Chain #1",
           "pricingBounds": {
             "CLICK": {
-              "min": "3500000",
-              "max": "6500000"
+              "min": "3500",
+              "max": "6500"
             },
             "IMPRESSION": {
-              "min": "1500000",
-              "max": "2500000"
+              "min": "1500",
+              "max": "2500"
             }
           },
           "eventSubmission": {
diff --git a/primitives/examples/create_campaign_request.rs b/primitives/examples/create_campaign_request.rs
@@ -24,12 +24,12 @@ fn main() {
             "validators":[
                 {
                     "id":"0x80690751969B234697e9059e04ed72195c3507fa",
-                    "fee":"3000000",
+                    "fee":"3000",
                     "url":"http://localhost:8005"
                 },
                 {
                     "id":"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
-                    "fee":"2000000",
+                    "fee":"2000",
                     "url":"http://localhost:8006"
                 }
             ],
@@ -75,12 +75,12 @@ fn main() {
             "validators":[
                 {
                     "id":"0x80690751969B234697e9059e04ed72195c3507fa",
-                    "fee":"3000000",
+                    "fee":"3000",
                     "url":"http://localhost:8005"
                 },
                 {
                     "id":"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
-                    "fee":"2000000",
+                    "fee":"2000",
                     "url":"http://localhost:8006"
                 }
             ],
diff --git a/primitives/examples/get_cfg_response.rs b/primitives/examples/get_cfg_response.rs
@@ -45,7 +45,7 @@ fn main() {
       "limits": {
         "units_for_slot": {
           "max_campaigns_earning_from": 25,
-          "global_min_impression_price": "10000"
+          "global_min_impression_price": "10"
         },
         "channels_find": 200,
         "campaigns_find": 200,
diff --git a/primitives/src/campaign.rs b/primitives/src/campaign.rs
@@ -179,7 +179,7 @@ pub struct Campaign {
     pub validators: Validators,
     #[serde(default, skip_serializing_if = "Option::is_none")]
     pub title: Option<String>,
-    /// Events pricing bounds
+    /// Events pricing bounds, per 1 event
     #[serde(default, skip_serializing_if = "PricingBounds::is_empty")]
     pub pricing_bounds: PricingBounds,
     /// EventSubmission object, applied to event submission
diff --git a/primitives/src/targeting.rs b/primitives/src/targeting.rs
@@ -33,6 +33,7 @@ pub struct Output {
     /// price.{eventType}
     /// For example: price.IMPRESSION
     /// The default is the min of the bound of event type:
+    /// The price is per one event
     /// Default: pricingBounds.IMPRESSION.min
     pub price: HashMap<EventType, UnifiedNum>,
 }
diff --git a/primitives/src/test_util.rs b/primitives/src/test_util.rs
@@ -149,14 +149,14 @@ mod logger {
 pub static DUMMY_VALIDATOR_LEADER: Lazy<ValidatorDesc> = Lazy::new(|| ValidatorDesc {
     id: IDS[&LEADER],
     url: "http://localhost:8005".to_string(),
-    fee: UnifiedNum::from_whole(0.03),
+    fee: UnifiedNum::from_whole(0.00003),
     fee_addr: None,
 });
 
 pub static DUMMY_VALIDATOR_FOLLOWER: Lazy<ValidatorDesc> = Lazy::new(|| ValidatorDesc {
     id: IDS[&FOLLOWER],
     url: "http://localhost:8006".to_string(),
-    fee: UnifiedNum::from_whole(0.02),
+    fee: UnifiedNum::from_whole(0.00002),
     fee_addr: None,
 });
 
@@ -315,12 +315,12 @@ pub static CAMPAIGNS: Lazy<[ChainOf<Campaign>; 3]> = Lazy::new(|| {
         };
 
         let leader_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.5),
+            fee: UnifiedNum::from_whole(0.0005),
             ..DUMMY_VALIDATOR_LEADER.clone()
         };
 
         let follower_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.4),
+            fee: UnifiedNum::from_whole(0.0004),
             ..DUMMY_VALIDATOR_FOLLOWER.clone()
         };
 
@@ -378,12 +378,12 @@ pub static CAMPAIGNS: Lazy<[ChainOf<Campaign>; 3]> = Lazy::new(|| {
         };
 
         let leader_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.1),
+            fee: UnifiedNum::from_whole(0.0001),
             ..DUMMY_VALIDATOR_FOLLOWER.clone()
         };
 
         let follower_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.05),
+            fee: UnifiedNum::from_whole(0.00005),
             ..DUMMY_VALIDATOR_LEADER.clone()
         };
         let validators = Validators::new((leader_desc, follower_desc));
@@ -440,12 +440,12 @@ pub static CAMPAIGNS: Lazy<[ChainOf<Campaign>; 3]> = Lazy::new(|| {
         };
 
         let leader_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.02),
+            fee: UnifiedNum::from_whole(0.00002),
             ..DUMMY_VALIDATOR_LEADER.clone()
         };
 
         let follower_desc = ValidatorDesc {
-            fee: UnifiedNum::from_whole(0.0175),
+            fee: UnifiedNum::from_whole(0.0000175),
             ..DUMMY_VALIDATOR_FOLLOWER.clone()
         };
 
diff --git a/primitives/src/validator.rs b/primitives/src/validator.rs
@@ -113,14 +113,14 @@ impl TryFrom<Value> for ValidatorId {
 
 #[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
 #[serde(rename_all = "camelCase")]
-/// A Validator description which includes the identity, fee (pro milles) and the Sentry URL.
+/// A Validator description which includes the identity, fee (per event) and the Sentry URL.
 pub struct ValidatorDesc {
     pub id: ValidatorId,
-    /// The validator fee in pro milles (per 1000)
+    /// The validator fee per event
     ///
     /// Each fee is calculated based on the payout for an event.
     ///
-    /// payout * fee / 1000 = event fee payout
+    /// payout * fee = event fee payout
     pub fee: UnifiedNum,
     #[serde(default, skip_serializing_if = "Option::is_none")]
     /// The address which will receive the fees
diff --git a/sentry/src/routes/campaign.rs b/sentry/src/routes/campaign.rs
@@ -1006,12 +1006,12 @@ pub mod insert_events {
                     "Campaign budget has no remaining funds to spend or an error occurred"
                 );
 
-                // Payout: 0.03 (min pricing bound)
+                // Payout: 0.00003 (min pricing bound per 1 event)
                 // Leader fee: 0.03
-                // Leader payout: 0.03 * 0.03 / 1000.0 = 0.00 000 090 = UnifiedNum(90)
+                // Leader payout: 0.00003 * 0.03 = 0.00 000 090 = UnifiedNum(90)
                 //
                 // Follower fee: 0.02
-                // Follower payout: 0.03 * 0.02 / 1000.0 = 0.00 000 060 = UnifiedNum(60)
+                // Follower payout: 0.00003 * 0.02 = 0.00 000 060 = UnifiedNum(60)
                 //
                 // campaign budget left - payout - leader fee - follower fee
                 // 1000.0 - 0.03 - 0.00 000 090 - 0.00 000 060 = 999.9699985
diff --git a/sentry/src/routes/units_for_slot_test.rs b/sentry/src/routes/units_for_slot_test.rs
@@ -58,11 +58,11 @@ const TEST_AD_SLOT: Lazy<(AdSlot, AdUnit)> = Lazy::new(|| {
             [
                 (
                     GANACHE_INFO_1.tokens["Mocked TOKEN 1"].address,
-                    UnifiedNum::from_whole(0.010),
+                    UnifiedNum::from_whole(0.000010),
                 ),
                 (
                     GANACHE_INFO_1337.tokens["Mocked TOKEN 1337"].address,
-                    UnifiedNum::from_whole(0.001),
+                    UnifiedNum::from_whole(0.000001),
                 ),
             ]
             .into_iter()
@@ -808,7 +808,6 @@ async fn test_price_is_less_than_min_per_impression() {
                 total: UnifiedNum::from_whole(200_000)
                     .to_precision(campaign.token.precision.into()),
             };
-
             app.adapter.client.set_deposit(
                 &campaign.of_channel(),
                 campaign.context.creator,
@@ -843,9 +842,9 @@ async fn test_price_is_less_than_min_per_impression() {
             // override the pricing bound
             let pricing_less_than_global = Pricing {
                 min: app.config.limits.units_for_slot.global_min_impression_price
-                    - UnifiedNum::from_whole(0.00003),
+                    - UnifiedNum::from_whole(0.00000003),
                 max: app.config.limits.units_for_slot.global_min_impression_price
-                    - UnifiedNum::from_whole(0.00001),
+                    - UnifiedNum::from_whole(0.00000001),
             };
             assert!(
                 pricing_less_than_global.min
@@ -860,7 +859,6 @@ async fn test_price_is_less_than_min_per_impression() {
                 .pricing_bounds
                 .insert(IMPRESSION, pricing_less_than_global)
                 .expect("Should have a pricing bound for IMPRESSION before we've overwritten it");
-
             let deposit = Deposit {
                 total: UnifiedNum::from_whole(200_000)
                     .to_precision(campaign.token.precision.into()),
@@ -908,7 +906,7 @@ async fn test_price_is_less_than_min_per_impression() {
             .as_mut()
             .expect("Should have min_per_impression set");
 
-        let min_per_impression = UnifiedNum::from_whole(0.00001);
+        let min_per_impression = UnifiedNum::from_whole(0.00000001);
         assert!(
             min_per_impression < campaign_0.context.pricing_bounds[&IMPRESSION].min,
             "AdSlot.min_per_impression should be less than Campaign 0 pricing bound in order to match it"
diff --git a/sentry/src/spender.rs b/sentry/src/spender.rs
@@ -2,9 +2,6 @@ pub mod fee {
 
     use primitives::{Address, DomainError, UnifiedNum, ValidatorDesc};
 
-    /// Pro mile (per thousands, `1000`) in `UnifiedNum` precision, i.e. `1_000.00_000_000`.
-    pub const PRO_MILLE: UnifiedNum = UnifiedNum::from_u64(1_000 * UnifiedNum::MULTIPLIER);
-
     /// Calculates the fee for a given payout of the specified validator
     /// This function will return None if the provided validator is not part of the Campaign / Channel
     /// In the case of overflow when calculating the payout, an error will be returned
@@ -13,17 +10,16 @@ pub mod fee {
         validator: &ValidatorDesc,
     ) -> Result<UnifiedNum, DomainError> {
         // should never overflow, but we guard against overflow
-        // `UnifiedNum::checked_div` will accurately floor the inner `u64` for the `UnifiedNum::PRECISION`
         payout
             .checked_mul(&validator.fee)
-            .and_then(|pro_mille_fee| pro_mille_fee.checked_div(&PRO_MILLE))
             .ok_or_else(|| DomainError::InvalidArgument("payout calculation overflow".to_string()))
     }
 
     #[cfg(test)]
     mod test {
         use primitives::{
             test_util::{DUMMY_VALIDATOR_LEADER, PUBLISHER},
+            unified_num::FromWhole,
             UnifiedNum, ValidatorDesc,
         };
 
@@ -32,36 +28,26 @@ pub mod fee {
         #[test]
         fn test_calculation_of_fee() {
             let mut dummy_leader = DUMMY_VALIDATOR_LEADER.clone();
-            dummy_leader.fee = UnifiedNum::from(10_000_000);
+            dummy_leader.fee = UnifiedNum::from_whole(0.1);
 
             // normal payout - no flooring
             {
-                // 30 000 * 10 000 000 / 1 000 00 000 000 = 3
+                // 30 000 * 10 000 000 / 100 000 000 = 3000
 
-                // 0.0003 * 0.1 / 1000.0 = 0.00000003 = UnifiedNum(3)
-                // 0.00 030 000 * 0.10 000 000 / 1 000 = 0.00 000 003
-                let payout = (*PUBLISHER, UnifiedNum::from(30_000));
+                // 0.0003 * 0.1 = 0.00000003 = UnifiedNum(3)
+                // 0.00 030 000 * 0.10 000 000  = 0.00003
+                let payout = (*PUBLISHER, UnifiedNum::from_whole(0.0003));
 
                 let validator_fee =
                     calculate_fee(payout, &dummy_leader).expect("Should not overflow");
 
                 assert_eq!(
-                    UnifiedNum::from(3),
+                    UnifiedNum::from_whole(0.00003),
                     validator_fee,
-                    "fee should be 0.00000003 in UnifiedNum"
+                    "fee should be 0.00003 in UnifiedNum"
                 );
             }
 
-            // payout with flooring
-            {
-                // 66 000 * 10 000 000 / 100 000 000 000 = 6.6 = 6
-                let payout = (*PUBLISHER, UnifiedNum::from(66_000));
-                let validator_fee =
-                    calculate_fee(payout, &dummy_leader).expect("Should not overflow");
-
-                assert_eq!(UnifiedNum::from(6), validator_fee);
-            }
-
             // Overflow - even using `Ratio` for `UnifiedNum`, this should overflow
             {
                 let very_high_fee = ValidatorDesc {
@@ -79,13 +65,12 @@ pub mod fee {
                 // e.g. 3 TOKENs
                 let payout = (*PUBLISHER, UnifiedNum::from(300_000_000_u64));
 
-                // 300 000 000 × 10 000 000 / 100 000 000 000
+                // 300 000 000 × 10 000 000 / 100 000 000 = 30 000 000
                 let validator_fee =
                     calculate_fee(payout, &dummy_leader).expect("Should not overflow");
 
-                // : 3 000 000 000 000
-                // 0.000003
-                assert_eq!(UnifiedNum::from(30_000), validator_fee);
+                // 0.3
+                assert_eq!(UnifiedNum::from_whole(0.3), validator_fee);
             }
         }
     }
diff --git a/test_harness/src/lib.rs b/test_harness/src/lib.rs

Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@ fn main() {`
`24`	`24`	`"validators":[`
`25`	`25`	`{`
`26`	`26`	`"id":"0x80690751969B234697e9059e04ed72195c3507fa",`
`27`		`- "fee":"3000000",`
	`27`	`+ "fee":"3000",`
`28`	`28`	`"url":"http://localhost:8005"`
`29`	`29`	`},`
`30`	`30`	`{`
`31`	`31`	`"id":"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",`
`32`		`- "fee":"2000000",`
	`32`	`+ "fee":"2000",`
`33`	`33`	`"url":"http://localhost:8006"`
`34`	`34`	`}`
`35`	`35`	`],`
`@@ -75,12 +75,12 @@ fn main() {`
`75`	`75`	`"validators":[`
`76`	`76`	`{`
`77`	`77`	`"id":"0x80690751969B234697e9059e04ed72195c3507fa",`
`78`		`- "fee":"3000000",`
	`78`	`+ "fee":"3000",`
`79`	`79`	`"url":"http://localhost:8005"`
`80`	`80`	`},`
`81`	`81`	`{`
`82`	`82`	`"id":"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",`
`83`		`- "fee":"2000000",`
	`83`	`+ "fee":"2000",`
`84`	`84`	`"url":"http://localhost:8006"`
`85`	`85`	`}`
`86`	`86`	`],`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ pub struct Output {`
`33`	`33`	`/// price.{eventType}`
`34`	`34`	`/// For example: price.IMPRESSION`
`35`	`35`	`/// The default is the min of the bound of event type:`
	`36`	`+ /// The price is per one event`
`36`	`37`	`/// Default: pricingBounds.IMPRESSION.min`
`37`	`38`	`pub price: HashMap<EventType, UnifiedNum>,`
`38`	`39`	`}`