initial documentation

Author: simzzz

Cargo.lock

@@ -32,12 +32,14 @@ required-features = ["test-util"]
 name = "campaign_list_response"
 required-features = ["test-util"]
 
+[[example]]
+name = "create_campaign"
+required-features = ["test-util"]
+
 [dependencies]
 # (De)Serialization
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-# TODO: Remove once we change `ChannelId` Serialize impl
-serde-hex = "0.1"
 serde_millis = "0.1"
 # Used prefixes on field for targeting::Input, and `campaign::Active`
 serde_with = "1"

primitives/Cargo.toml

@@ -0,0 +1,86 @@
+use primitives::{sentry::campaign_create::CreateCampaign, test_util::DUMMY_CAMPAIGN, CampaignId};
+use std::str::FromStr;
+use serde_json::json;
+
+fn main() {
+    // CreateCampaign in an HTTP request
+    {
+        let create_campaign = CreateCampaign::from_campaign_erased(DUMMY_CAMPAIGN.clone(), None);
+
+        let create_campaign_as_json_str = json!("{
+            \"id\":null,
+            \"channel\":{
+                \"leader\":\"0x80690751969B234697e9059e04ed72195c3507fa\",
+                \"follower\":\"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7\",
+                \"guardian\":\"0xe061E1EB461EaBE512759aa18A201B20Fe90631D\",
+                \"token\":\"0x2BCaf6968aEC8A3b5126FBfAb5Fd419da6E8AD8E\",
+                \"nonce\":\"987654321\"
+            },
+            \"creator\":\"0xaCBaDA2d5830d1875ae3D2de207A1363B316Df2F\",
+            \"budget\":\"100000000000\",
+            \"validators\":[
+                {
+                    \"id\":\"0x80690751969B234697e9059e04ed72195c3507fa\",
+                    \"fee\":\"2000000\",
+                    \"url\":\"http://localhost:8005\"
+                },
+                {
+                    \"id\":\"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7\",
+                    \"fee\":\"3000000\",
+                    \"url\":\"http://localhost:8006\"
+                }
+            ],
+            \"title\":\"Dummy Campaign\",
+            \"pricingBounds\":{\"CLICK\":{\"min\":\"0\",\"max\":\"0\"},\"IMPRESSION\":{\"min\":\"1\",\"max\":\"10\"}},
+            \"eventSubmission\":{\"allow\":[]},
+            \"targetingRules\":[],
+            \"created\":1612162800000,
+            \"active_to\":4073414400000
+        }");
+
+        let create_campaign_from_json = serde_json::from_str(create_campaign_as_json_str).expect("should deserialize");
+
+        assert_eq!(create_campaign, create_campaign_from_json);
+    }
+
+    // CreateCampaign with a provided ID
+    {
+        let mut create_campaign = CreateCampaign::from_campaign_erased(DUMMY_CAMPAIGN.clone(), None);
+        create_campaign.id = Some(CampaignId::from_str("0x936da01f9abd4d9d80c702af85c822a8").expect("Should be valid id"));
+
+        let create_campaign_as_json_str = "{
+            \"id\":\"0x936da01f9abd4d9d80c702af85c822a8\",
+            \"channel\":{
+                \"leader\":\"0x80690751969B234697e9059e04ed72195c3507fa\",
+                \"follower\":\"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7\",
+                \"guardian\":\"0xe061E1EB461EaBE512759aa18A201B20Fe90631D\",
+                \"token\":\"0x2BCaf6968aEC8A3b5126FBfAb5Fd419da6E8AD8E\",
+                \"nonce\":\"987654321\"
+            },
+            \"creator\":\"0xaCBaDA2d5830d1875ae3D2de207A1363B316Df2F\",
+            \"budget\":\"100000000000\",
+            \"validators\":[
+                {
+                    \"id\":\"0x80690751969B234697e9059e04ed72195c3507fa\",
+                    \"fee\":\"2000000\",
+                    \"url\":\"http://localhost:8005\"
+                },
+                {
+                    \"id\":\"0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7\",
+                    \"fee\":\"3000000\",
+                    \"url\":\"http://localhost:8006\"
+                }
+            ],
+            \"title\":\"Dummy Campaign\",
+            \"pricingBounds\":{\"CLICK\":{\"min\":\"0\",\"max\":\"0\"},\"IMPRESSION\":{\"min\":\"1\",\"max\":\"10\"}},
+            \"eventSubmission\":{\"allow\":[]},
+            \"targetingRules\":[],
+            \"created\":1612162800000,
+            \"active_to\":4073414400000
+        }";
+
+        let create_campaign_from_json = serde_json::from_str(create_campaign_as_json_str).expect("should deserialize");
+
+        assert_eq!(create_campaign, create_campaign_from_json);
+    }
+}

primitives/examples/analytics_query.rs

@@ -72,7 +72,7 @@ impl Validator for Campaign {
             .find_chain_of(self.channel.token)
             .ok_or(Validation::UnlistedAsset)?;
 
-        // Check if the campaign budget is above the minimum deposit configured
+        // Check if the campaign budget is above the minimum campaign budget configured
         if self
             .budget
             .to_precision(chain_context.token.precision.get())

primitives/examples/analytics_response.rs

@@ -802,6 +802,12 @@ pub mod campaign_create {
 
     /// All fields are present except the `CampaignId` which is randomly created
     /// This struct defines the Body of the request (in JSON)
+    ///
+    /// # Examples
+    ///
+    /// ```
+    #[doc = include_str!("../examples/create_campaign.rs")]
+    /// ```
     #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
     #[serde(rename_all = "camelCase")]
     pub struct CreateCampaign {
@@ -889,7 +895,12 @@ pub mod campaign_modify {
         AdUnit, Campaign, EventSubmission, UnifiedNum,
     };
 
-    // All editable fields stored in one place, used for checking when a budget is changed
+    /// All editable fields stored in one place, used for checking when a budget is changed
+    ///
+    /// # Examples:
+    /// ```
+    #[doc = include_str!("../examples/modify_campaign.rs")]
+    /// ```
     #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
     pub struct ModifyCampaign {
         pub budget: Option<UnifiedNum>,

primitives/examples/create_campaign.rs

@@ -0,0 +1,9 @@
+[`AllowedKey`](`primitives::query::AllowedKey`)
+
+[`Analytics`](`primitives::Analytics`)
+
+[`Auth`](crate::Auth)
+
+[`ResponseError`](`crate::response::ResponseError`)
+
+[`AnalyticsQuery`](`primitives::AnalyticsQuery`)