renaming some functions and files + ValidatorMessagesCreateRequest example

Author: simzzz

primitives/Cargo.toml

@@ -45,15 +45,18 @@ name = "channel_list_query"
 required-features = ["test-util"]
 
 [[example]]
-name = "create_campaign"
+name = "create_campaign_request"
 required-features = ["test-util"]
 
 [[example]]
-name = "modify_campaign"
+name = "modify_campaign_request"
 
 [[example]]
 name = "spender_response"
 
+[[example]]
+name = "validator_messages_create_request"
+
 [dependencies]
 # (De)Serialization
 serde = { version = "1.0", features = ["derive"] }

primitives/examples/create_campaign.rs renamed to primitives/examples/create_campaign_request.rs

@@ -0,0 +1,50 @@
+use primitives::sentry::ValidatorMessagesCreateRequest;
+use serde_json::json;
+use std::str::FromStr;
+
+fn main() {
+
+    let messages_json = json!({
+        "messages": [
+            {
+                "type": "ApproveState",
+                "stateRoot": "b1a4fc6c1a1e1ab908a487e504006edcebea297f61b4b8ce6cad3b29e29454cc",
+                "signature": "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
+                "isHealthy": true,
+            },
+            { // RejectState
+                "type": "RejectState",
+                "reason": "rejected",
+                "stateRoot": "b1a4fc6c1a1e1ab908a487e504006edcebea297f61b4b8ce6cad3b29e29454cc",
+                "signature": "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
+                "earners": {},
+                "spenders": {},
+                "timestamp": "2022-08-09T16:07:18.136334Z",
+            },
+            { // NewState
+                "type": "NewState",
+                "stateRoot": "b1a4fc6c1a1e1ab908a487e504006edcebea297f61b4b8ce6cad3b29e29454cc",
+                "signature": "0x80690751969B234697e9059e04ed72195c3507fa",
+                "earners": {
+                    "0x0e880972A4b216906F05D67EeaaF55d16B5EE4F1": "2000",
+                    "0xE882ebF439207a70dDcCb39E13CA8506c9F45fD9": "2000",
+                },
+                "spenders": {
+                    "0xaCBaDA2d5830d1875ae3D2de207A1363B316Df2F": "2000",
+                    "0xDd589B43793934EF6Ad266067A0d1D4896b0dff0": "2000",
+                },
+            },
+            { // Heartbeat
+                "type": "Heartbeat",
+                "stateRoot": "b1a4fc6c1a1e1ab908a487e504006edcebea297f61b4b8ce6cad3b29e29454cc",
+                "signature": "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
+                "timestamp": "1612162800000",
+            }
+        ]
+    });
+
+    let messages_json =
+        serde_json::to_string(&messages_json).expect("should serialize");
+
+    // assert!(serde_json::from_str::<ValidatorMessagesCreateRequest>(&messages_json).is_ok());
+}

primitives/examples/modify_campaign.rs renamed to primitives/examples/modify_campaign_request.rs

@@ -28,7 +28,7 @@ pub use event::{Event, EventType, CLICK, IMPRESSION};
 /// # Examples
 ///
 /// ```
-#[doc = include_str!("../examples/accounting_response.rs")]
+#[doc = include_str!("../examples/validator_messages_create_request.rs")]
 /// ```
 pub struct AccountingResponse<S: BalancesState> {
     #[serde(flatten, bound = "S: BalancesState")]
@@ -651,6 +651,13 @@ pub struct ValidatorMessagesListResponse {
     pub messages: Vec<ValidatorMessage>,
 }
 
+/// Contains all the different validator messages to be inserted
+///
+/// # Examples
+///
+/// ```
+#[doc = include_str!("../examples/validator_messages_create_request.rs")]
+/// ```
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(rename_all = "camelCase")]
 pub struct ValidatorMessagesCreateRequest {
@@ -846,7 +853,7 @@ pub mod campaign_create {
     /// # Examples
     ///
     /// ```
-    #[doc = include_str!("../examples/create_campaign.rs")]
+    #[doc = include_str!("../examples/create_campaign_request.rs")]
     /// ```
     #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
     #[serde(rename_all = "camelCase")]
@@ -939,7 +946,7 @@ pub mod campaign_modify {
     ///
     /// # Examples:
     /// ```
-    #[doc = include_str!("../examples/modify_campaign.rs")]
+    #[doc = include_str!("../examples/modify_campaign_request.rs")]
     /// ```
     #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
     pub struct ModifyCampaign {

primitives/examples/validator_messages_create_request.rs

@@ -11,7 +11,7 @@ use primitives::{
 use super::{DbPool, PoolError};
 
 /// Inserts a new validator [`MessageTypes`] using the `from` [`ValidatorId`] and `received` at: [`Utc::now()`][Utc]
-pub async fn insert_validator_messages(
+pub async fn insert_validator_message(
     pool: &DbPool,
     channel: &Channel,
     from: &ValidatorId,

primitives/src/sentry.rs

@@ -123,19 +123,15 @@
 //!
 //! #### POST `/v5/channel/:id/validator-messages` (auth required)
 //!
-//! The route is handled by [`channel::validator_message::create_validator_messages()`].
+//! Inserts the validator messages in the request body in the databse for a specific [`Channel`].
+//! The request sender must be a [`Validator`] of the [`Channel`].
 //!
-//! Request body (json): [`ValidatorMessagesCreateRequest`](primitives::sentry::ValidatorMessagesCreateRequest)
+//! The route is handled by [`channel::validator_message::create_validator_messages()`].
 //!
-//! ##### Examples:
+//! Request body (json):
 //!
-//! ```json
-//! {
-//!     "messages": [
-//!         /// validator messages
-//!         ...
-//!     ]
-//! }
+//! ```
+#![doc = include_str!("../../primitives/examples/validator_messages_create_request.rs")]
 //! ```
 //!
 //! Validator messages: [`MessageTypes`]
@@ -264,7 +260,7 @@
 //! ##### Examples
 //!
 //! ```
-#![doc = include_str!("../../primitives/examples/create_campaign.rs")]
+#![doc = include_str!("../../primitives/examples/create_campaign_request.rs")]
 //! ```
 //!
 //! #### POST `/v5/campaign/:id` (auth required)
@@ -282,7 +278,7 @@
 //! ##### Examples
 //!
 //! ```
-#![doc = include_str!("../../primitives/examples/modify_campaign.rs")]
+#![doc = include_str!("../../primitives/examples/modify_campaign_request.rs")]
 //! ```
 //!
 //! #### POST `/v5/campaign/:id/events`

sentry/src/db/validator_message.rs

@@ -608,7 +608,7 @@ pub async fn channel_dummy_deposit<C: Locked + 'static>(
 ///
 pub mod validator_message {
     use crate::{
-        db::validator_message::{get_validator_messages, insert_validator_messages},
+        db::validator_message::{get_validator_messages, insert_validator_message},
         Auth,
     };
     use crate::{
@@ -734,7 +734,7 @@ pub mod validator_message {
             None => Err(ResponseError::Unauthorized),
             _ => {
                 try_join_all(create_request.messages.iter().map(|message| {
-                    insert_validator_messages(&app.pool, &channel, &session.uid, message)
+                    insert_validator_message(&app.pool, &channel, &session.uid, message)
                 }))
                 .await?;