sentry - routes - channel dummy-deposit docs:

- sentry - examples - channel_dummy_deposit (request)

Author: elpiel

sentry/examples/channel_dummy_deposit.rs

@@ -0,0 +1,24 @@
+use primitives::{unified_num::FromWhole, UnifiedNum};
+use sentry::routes::channel::ChannelDummyDeposit;
+use serde_json::{from_value, json};
+
+fn main() {
+    let request_json = json!({
+        "channel": {
+            "leader": "0x80690751969B234697e9059e04ed72195c3507fa",
+            "follower": "0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7",
+            "guardian": "0xe061E1EB461EaBE512759aa18A201B20Fe90631D",
+            "token": "0x2bcaf6968aec8a3b5126fbfab5fd419da6e8ad8e",
+            "nonce": "0"
+          },
+        "deposit": {
+            "total": "20000000000000"
+        }
+    });
+
+    let request: ChannelDummyDeposit = from_value(request_json).expect("Should deserialize");
+
+    assert_eq!(UnifiedNum::from_whole(200000.0), request.deposit.total);
+
+    println!("{request:#?}");
+}

sentry/src/routes.rs

@@ -216,14 +216,23 @@
 //!
 //! Set a deposit for a Channel and depositor (the authenticated address) in the Dummy adapter.
 //!
-//! **NOTE:** This route is available **only** when using the Dummy adapter.
+//! **NOTE:** This route is available **only** when using the Dummy adapter and it's not
+//! an official production route!
 //!
 //! The route is handled by [`channel::channel_dummy_deposit()`].
 //!
 //! Request body (json): [`ChannelDummyDeposit`](crate::routes::channel::ChannelDummyDeposit)
 //!
 //! Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
 //!
+//! ##### Examples
+//!
+//! Request:
+//!
+//! ```
+#![doc = include_str!("../examples/channel_dummy_deposit.rs")]
+//! ```
+//!
 //! ## Campaign
 //!
 //! All routes are implemented under the module [campaign].
@@ -245,7 +254,7 @@
 //!
 //! The route is handled by [`campaign::campaign_list()`].
 //!
-//! Request query parameters: [`CampaignListQuery`][primitives::sentry::campaign_list::CampaignListQuery]
+//! Request query parameters: [`CampaignListQuery`](primitives::sentry::campaign_list::CampaignListQuery)
 //!
 //!   - `page=[integer]` (optional) default: `0`
 //!   - `creator=[0x....]` (optional) - address of the creator to be filtered by
@@ -255,7 +264,7 @@
 //!     - `leader=[0x...]` - it will return all `Campaign`s where this address is `Channel.leader`
 //!
 //!
-//! Response: [`CampaignListResponse`][primitives::sentry::campaign_list::CampaignListResponse]
+//! Response: [`CampaignListResponse`](primitives::sentry::campaign_list::CampaignListResponse)
 //!
 //! ##### Examples
 //!

sentry/src/routes/channel.rs

@@ -113,6 +113,7 @@ pub async fn last_approved<C: Locked + 'static>(
     let query = serde_qs::from_str::<LastApprovedQuery>(req.uri().query().unwrap_or(""))?;
     let validators = vec![channel.leader, channel.follower];
     let channel_id = channel.id();
+
     let heartbeats = if query.with_heartbeat.unwrap_or_default() {
         let result = try_join_all(
             validators
@@ -558,6 +559,8 @@ pub async fn channel_payout<C: Locked + 'static>(
 
 /// POST `/v5/channel/dummy-deposit` request
 ///
+/// Full details about the route's API and intend can be found in the [`routes`](crate::routes#post-v5channeldummy-deposit-auth-required) module
+///
 /// Request body (json): [`ChannelDummyDeposit`]
 ///
 /// Response: [`SuccessResponse`]