ChannelPayRequest examples

Author: simzzz

primitives/Cargo.toml

@@ -44,6 +44,9 @@ required-features = ["test-util"]
 name = "channel_list_query"
 required-features = ["test-util"]
 
+[[example]]
+name = "channel_pay_request"
+
 [[example]]
 name = "create_campaign_request"
 required-features = ["test-util"]

primitives/examples/channel_pay_request.rs

@@ -0,0 +1,17 @@
+use primitives::sentry::ChannelPayRequest;
+use serde_json::json;
+use std::str::FromStr;
+
+fn main() {
+    let channel_pay_json = json!({
+      "payouts": {
+        "0x80690751969B234697e9059e04ed72195c3507fa": "10000000000",
+        "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7": "20000000000",
+        "0x0e880972A4b216906F05D67EeaaF55d16B5EE4F1": "30000000000",
+      },
+    });
+
+    let channel_pay_json = serde_json::to_string(&channel_pay_json).expect("should serialize");
+
+    assert!(serde_json::from_str::<ChannelPayRequest>(&channel_pay_json).is_ok());
+}

primitives/examples/validator_messages_create_request.rs

@@ -633,6 +633,13 @@ pub struct AllSpendersQuery {
     pub page: u64,
 }
 
+/// Includes all the payouts that need to be done for that channel
+///
+/// # Examples
+///
+/// ```
+#[doc = include_str!("../examples/channel_pay_request.rs")]
+/// ```
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ChannelPayRequest {
     pub payouts: UnifiedMap,

primitives/src/sentry.rs

@@ -155,8 +155,11 @@
 //!
 //! The route is handled by [`channel::channel_payout()`].
 //!
-//! Request JSON body: [`ChannelPayRequest`](primitives::sentry::ChannelPayRequest)
+//! Request JSON body:
 //!
+//! ```
+#![doc = include_str!("../../primitives/examples/channel_pay_request.rs")]
+//! ```
 //! Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
 //!
 //!