sentry - routes - channel - list validator messages

Author: elpiel

sentry/src/routes/channel.rs

@@ -688,6 +688,13 @@ 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`]
 pub async fn channel_dummy_deposit_axum<C: Locked + 'static>(
     Extension(app): Extension<Arc<Application<C>>>,
     Extension(auth): Extension<Auth>,
@@ -778,7 +785,10 @@ pub async fn channel_dummy_deposit<C: Locked + 'static>(
 /// starting with `/v5/channel/0xXXX.../validator-messages`
 ///
 pub mod validator_message {
+    use std::sync::Arc;
+
     use crate::{
+        application::Qs,
         db::validator_message::{get_validator_messages, insert_validator_message},
         Auth,
     };
@@ -787,15 +797,17 @@ pub mod validator_message {
         Application,
     };
     use adapter::client::Locked;
+    use axum::{extract::Path, Extension, Json};
     use futures::future::try_join_all;
     use hyper::{Body, Request, Response};
     use primitives::{
         sentry::{
             SuccessResponse, ValidatorMessagesCreateRequest, ValidatorMessagesListQuery,
             ValidatorMessagesListResponse,
         },
-        ChainOf, Channel, DomainError, ValidatorId,
+        ChainOf, Channel, ChannelId, DomainError, ValidatorId,
     };
+    use serde::Deserialize;
 
     pub fn extract_params(
         from_path: &str,
@@ -827,6 +839,72 @@ pub mod validator_message {
         Ok((validator_id, message_types.unwrap_or_default()))
     }
 
+    #[derive(Debug, Deserialize)]
+    pub struct MessagesListParams {
+        pub id: ChannelId,
+        // Optional filtering by ValidatorId
+        #[serde(default)]
+        pub address: Option<ValidatorId>,
+        /// List of validator message types separated by `+` (urlencoded):
+        /// e.g. `ApproveState+NewState`
+        #[serde(default)]
+        pub message_types: String,
+    }
+
+    /// GET `/v5/channel/0xXXX.../validator-messages`
+    ///
+    /// Full details about the route's API and intend can be found in the [`routes`](crate::routes#get-v5channelidvalidator-messages) module
+    ///
+    /// Request query parameters: [`ValidatorMessagesListQuery`]
+    ///
+    /// Response: [`ValidatorMessagesListResponse`]
+    ///
+    pub async fn list_validator_messages_axum<C: Locked + 'static>(
+        Extension(app): Extension<Arc<Application<C>>>,
+        Extension(channel_context): Extension<ChainOf<Channel>>,
+        Path(params): Path<MessagesListParams>,
+        Qs(query): Qs<ValidatorMessagesListQuery>,
+    ) -> Result<Json<ValidatorMessagesListResponse>, ResponseError> {
+        let message_types = {
+            // We need to strip the `/` prefix from axum
+            let stripped = params
+                .message_types
+                .strip_prefix('/')
+                .unwrap_or(&params.message_types);
+
+            if !stripped.is_empty() {
+                stripped
+                    .split('+')
+                    .map(|s| s.to_string())
+                    .collect::<Vec<_>>()
+            } else {
+                vec![]
+            }
+        };
+
+        let channel = channel_context.context;
+
+        let config_limit = app.config.msgs_find_limit as u64;
+        let limit = query
+            .limit
+            .filter(|n| *n >= 1)
+            .unwrap_or(config_limit)
+            .min(config_limit);
+
+        let validator_messages = get_validator_messages(
+            &app.pool,
+            &channel.id(),
+            &params.address,
+            &message_types,
+            limit,
+        )
+        .await?;
+
+        Ok(Json(ValidatorMessagesListResponse {
+            messages: validator_messages,
+        }))
+    }
+
     /// GET `/v5/channel/0xXXX.../validator-messages`
     ///
     /// Full details about the route's API and intend can be found in the [`routes`](crate::routes#get-v5channelidvalidator-messages) module

sentry/src/routes/routers.rs

@@ -56,7 +56,10 @@ use tower::ServiceBuilder;
 
 use super::{
     analytics::{analytics_axum, GET_ANALYTICS_ALLOWED_KEYS},
-    channel::{channel_dummy_deposit_axum, channel_list_axum, channel_payout_axum},
+    channel::{
+        channel_dummy_deposit_axum, channel_list_axum, channel_payout_axum,
+        validator_message::list_validator_messages_axum,
+    },
     units_for_slot::post_units_for_slot,
 };
 
@@ -146,6 +149,15 @@ pub fn channels_router_axum<C: Locked + 'static>() -> Router {
             post(channel_payout_axum::<C>)
                 .route_layer(middleware::from_fn(authentication_required::<C, _>)),
         )
+        .route(
+            "/validator-messages",
+            get(list_validator_messages_axum::<C>),
+        )
+        // We allow Message Type filtering only when filtering by a ValidatorId
+        .route(
+            "/validator-messages/:address/*message_types",
+            get(list_validator_messages_axum::<C>),
+        )
         .layer(
             // keeps the order from top to bottom!
             ServiceBuilder::new()