get-leaf documentation

Author: simzzz

primitives/Cargo.toml

@@ -63,6 +63,9 @@ name = "modify_campaign_request"
 [[example]]
 name = "spender_response"
 
+[[example]]
+name = "get_leaf_response"
+
 [[example]]
 name = "validator_messages_create_request"
 

primitives/examples/get_leaf_response.rs

@@ -0,0 +1,10 @@
+use primitives::sentry::GetLeafResponse;
+use serde_json::{from_value, json};
+
+fn main() {
+    let json = json!({
+        "merkleProof": "8ea7760ca2dbbe00673372afbf8b05048717ce8a305f1f853afac8c244182e0c",
+    });
+
+    assert!(from_value::<GetLeafResponse>(json).is_ok());
+}

primitives/src/sentry.rs

@@ -722,6 +722,13 @@ pub struct ValidationErrorResponse {
     pub validation: Vec<String>,
 }
 
+/// Returns the merkle_proof for the spender/earner
+///
+/// # Examples
+///
+/// ```
+#[doc = include_str!("../examples/get_leaf_response.rs")]
+/// ```
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(rename_all = "camelCase")]
 pub struct GetLeafResponse {

sentry/src/routes.rs

@@ -237,27 +237,32 @@
 //! ```
 //!
 //!
-//! #### GET `/v5/channel/:id/get-leaf`
-//!
-//! TODO: implement and document as part of issue #382
+//! #### GET `/v5/channel/:id/get-leaf/spender` and GET `/v5/channel/:id/get-leaf/earner`
 //!
 //! This route gets the latest approved state ([`NewState`]/[`ApproveState`] pair),
 //! and finds the given `spender`/`earner` in the balances tree, and produce a merkle proof for it.
 //! This is useful for the Platform to verify if a spender leaf really exists.
 //!
-//! The route is handled by `todo`.
-//!
-//! Request query parameters:
-//!
-//! - `spender=[0x...]` or `earner=[0x...]` (required)
+//! The route is handled by [`channel::get_leaf()`].
 //!
 //! Example Spender:
 //!
-//! `/get-leaf?spender=0x...`
+//! `/get-leaf/spender/0x...`
 //!
 //! Example Earner:
 //!
-//! `/get-leaf?earner=0x....`
+//! `/get-leaf/earner/0x....`
+//!
+//! Response: [`GetLeafResponse`](primitives::sentry::GetLeafResponse)
+//!
+//! ##### Examples:
+//!
+//! Response:
+//!
+//! ```
+#![doc = include_str!("../../primitives/examples/spender_response.rs")]
+//! ```
+//!
 //! This module includes all routes for `Sentry` and the documentation of each Request/Response.
 //!
 //! #### POST `/v5/channel/dummy-deposit` (auth required)

sentry/src/routes/channel.rs

@@ -504,6 +504,10 @@ pub async fn channel_payout<C: Locked + 'static>(
     Ok(Json(SuccessResponse { success: true }))
 }
 
+/// GET `/v5/channel/0xXXX.../get-leaf/spender` request and
+/// GET `/v5/channel/0xXXX.../get-leaf/earner` request
+///
+/// Response: [`GetLeafResponse`]
 pub async fn get_leaf<C: Locked + 'static>(
     Extension(app): Extension<Arc<Application<C>>>,
     Extension(channel_context): Extension<ChainOf<Channel>>,