requested changes

Author: simzzz

primitives/examples/accounting_response.rs

@@ -16,12 +16,12 @@ fn main() {
         // earners sum and spenders sum should always match since balances are CheckedState
         let json = json!({
             "earners": {
-                "0x0000000000000000000000000000000000000000": "10000000000",
-                "0x1111111111111111111111111111111111111111": "20000000000",
-                "0x2222222222222222222222222222222222222222": "30000000000",
+                "0x80690751969B234697e9059e04ed72195c3507fa": "10000000000",
+                "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7": "20000000000",
+                "0xE882ebF439207a70dDcCb39E13CA8506c9F45fD9": "30000000000",
             },
             "spenders": {
-                "0x7777777777777777777777777777777777777777": "60000000000",
+                "0xaCBaDA2d5830d1875ae3D2de207A1363B316Df2F": "60000000000",
             },
         });
         assert!(from_value::<AccountingResponse::<CheckedState>>(json).is_ok());

primitives/examples/all_spenders_response.rs

@@ -4,15 +4,15 @@ use serde_json::{from_value, json};
 fn main() {
     let json = json!({
         "spenders": {
-            "0x0000000000000000000000000000000000000000": {
+            "0xaCBaDA2d5830d1875ae3D2de207A1363B316Df2F": {
                 "totalDeposited": "10000000000",
                 "totalSpent": "100000000",
             },
-            "0x1111111111111111111111111111111111111111": {
+            "0xDd589B43793934EF6Ad266067A0d1D4896b0dff0": {
                 "totalDeposited": "90000000000",
                 "totalSpent": "20000000000",
             },
-            "0x2222222222222222222222222222222222222222": {
+            "0x541b401362Ea1D489D322579552B099e801F3632": {
                 "totalDeposited": "1000000000",
                 "totalSpent": "1000000000",
             },

primitives/src/sentry.rs

@@ -23,12 +23,13 @@ pub use event::{Event, EventType, CLICK, IMPRESSION};
 #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
 /// Channel Accounting response
+///
 /// A collection of all `Accounting`s for a specific [`Channel`](`crate::Channel`)
 ///
 /// # Examples
 ///
 /// ```
-#[doc = include_str!("../examples/validator_messages_create_request.rs")]
+#[doc = include_str!("../examples/accounting_response.rs")]
 /// ```
 pub struct AccountingResponse<S: BalancesState> {
     #[serde(flatten, bound = "S: BalancesState")]
@@ -633,7 +634,7 @@ pub struct SuccessResponse {
     pub success: bool,
 }
 
-/// Spender limits for a spender on a `Channel`
+/// Spender limits for a spender on a `Channel`.
 ///
 /// # Examples
 ///
@@ -646,7 +647,7 @@ pub struct SpenderResponse {
     pub spender: Spender,
 }
 
-/// Spender limits for all spenders on a `Channel`
+/// Spender limits for all spenders on a `Channel`.
 ///
 /// # Examples
 ///
@@ -668,7 +669,7 @@ pub struct AllSpendersQuery {
     pub page: u64,
 }
 
-/// Includes all the payouts that need to be done for that channel
+/// Payouts to be performed for the given [`Channel`](`crate::Channel`).
 ///
 /// # Examples
 ///
@@ -693,7 +694,7 @@ pub struct ValidatorMessagesListResponse {
     pub messages: Vec<ValidatorMessage>,
 }
 
-/// Contains all the different validator messages to be inserted
+/// Contains all the different validator messages to be created.
 ///
 /// # Examples
 ///

sentry/src/routes.rs

@@ -63,6 +63,10 @@
 //!
 //! The route is handled by [`channel::get_accounting_for_channel()`].
 //!
+//! Response: [`AccountingResponse`]
+//!
+//! ##### Examples
+//!
 //! Response:
 //!
 //! ```
@@ -78,6 +82,10 @@
 //!
 //! The route is handled by [`channel::get_spender_limits()`].
 //!
+//! Response: [`SpenderResponse`]
+//!
+//! ##### Examples
+//!
 //! Response:
 //!
 //! ```
@@ -100,6 +108,10 @@
 //!
 //! The route is handled by [`channel::get_all_spender_limits()`].
 //!
+//! Response: [`AllSpendersResponse`]
+//!
+//! ##### Examples
+//!
 //! Response:
 //!
 //! ```
@@ -164,9 +176,6 @@
 //! ```
 #![doc = include_str!("../../primitives/examples/validator_messages_create_request.rs")]
 //! ```
-//! Response: [`SuccessResponse`]
-//!
-//! Validator messages: [`MessageTypes`]
 //!
 //! #### GET `/v5/channel/:id/last-approved`
 //!
@@ -215,12 +224,17 @@
 //!
 //! The route is handled by [`channel::channel_payout()`].
 //!
-//! Request JSON body:
+//! Request JSON body: [`ChannelPayRequest`]
+//!
+//! Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
+//!
+//! ##### Examples
+//!
+//! Request (json):
 //!
 //! ```
 #![doc = include_str!("../../primitives/examples/channel_pay_request.rs")]
 //! ```
-//! Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
 //!
 //!
 //! #### GET `/v5/channel/:id/get-leaf`
@@ -450,6 +464,7 @@
 //! [`ApproveState`]: primitives::validator::ApproveState
 //! [`Accounting`]: crate::db::accounting::Accounting
 //! [`AccountingResponse`]: primitives::sentry::AccountingResponse
+//! [`AllSpendersResponse`]: primitives::sentry::AllSpendersResponse
 //! [`AnalyticsResponse`]: primitives::sentry::AnalyticsResponse
 //! [`AnalyticsQuery`]: primitives::analytics::AnalyticsQuery
 //! [`Auth.uid`]: crate::Auth::uid
@@ -461,12 +476,14 @@
 //! [`Channel.leader`]: primitives::Channel::leader
 //! [`Channel.follower`]: primitives::Channel::follower
 //! [`ChannelId`]: primitives::ChannelId
+//! [`ChannelPayRequest`]: primitives::sentry::ChannelPayRequest
 //! [`check_access()`]: crate::access::check_access
 //! [`Config.msgs_find_limit`]: primitives::Config::msgs_find_limit
 //! [`Event`]: primitives::sentry::Event
 //! [`Heartbeat`]: primitives::validator::Heartbeat
 //! [`MessageTypes`]: primitives::validator::MessageTypes
 //! [`NewState`]: primitives::validator::NewState
+//! [`SpenderResponse`]: primitives::sentry::SpenderResponse
 //! [`SuccessResponse`]: primitives::sentry::SuccessResponse
 //! [`ValidatorId`]: primitives::ValidatorId