cleanup

Author: hinto-janai

rpc/interface/README.md

@@ -33,7 +33,7 @@ This crate simply handles:
 - Defining handler function signatures
 - (De)serialization of requests/responses (JSON-RPC, binary, JSON)
 
-The actual server details are all handled by the [`axum`] and [`tower`] ecosystem.a
+The actual server details are all handled by the [`axum`] and [`tower`] ecosystem.
 
 The proper usage of this crate is to:
 1. Implement a [`RpcHandler`]
@@ -45,8 +45,8 @@ The proper usage of this crate is to:
 This is your [`tower::Service`] that converts `Request`s into `Response`s,
 i.e. the "inner handler".
 
-Said concretely, `RpcHandler` is 3 `tower::Service`s where the associated types are
-the 3 endpoint enums from [`cuprate_rpc_types`] and the error type from this crate:
+Said concretely, `RpcHandler` is 3 `tower::Service`s where the request/response types are
+the 3 endpoint enums from [`cuprate_rpc_types`] and the error type is from this crate:
 - [`JsonRpcRequest`](cuprate_rpc_types::json::JsonRpcRequest) & [`JsonRpcResponse`](cuprate_rpc_types::json::JsonRpcResponse)
 - [`BinRequest`](cuprate_rpc_types::bin::BinRequest) & [`BinResponse`](cuprate_rpc_types::bin::BinRequest)
 - [`OtherRequest`](cuprate_rpc_types::other::OtherRequest) & [`OtherResponse`](cuprate_rpc_types::other::OtherRequest)

rpc/interface/src/lib.rs

@@ -7,17 +7,13 @@ mod rpc_error;
 mod rpc_handler;
 #[cfg(feature = "dummy")]
 mod rpc_handler_dummy;
-// mod rpc_request;
-// mod rpc_response;
 mod rpc_service;
 
 pub use router_builder::RouterBuilder;
 pub use rpc_error::RpcError;
 pub use rpc_handler::RpcHandler;
 #[cfg(feature = "dummy")]
 pub use rpc_handler_dummy::RpcHandlerDummy;
-// pub use rpc_request::RpcRequest;
-// pub use rpc_response::RpcResponse;
 pub use rpc_service::RpcService;
 
 // false-positive: used in `README.md`'s doc-test.

rpc/interface/src/rpc_handler.rs

@@ -15,12 +15,12 @@ use crate::RpcService;
 /// This trait represents a type that can turn `Request`s into `Response`s.
 ///
 /// Implementors of this trait must be:
-/// - A [`tower::Service`]s that use [`JsonRpcRequest`] & [`JsonRpcResponse`]
-/// - A [`tower::Service`]s that use [`BinRequest`] & [`BinResponse`]
-/// - A [`tower::Service`]s that use [`OtherRequest`] & [`OtherResponse`]
+/// - A [`tower::Service`] that uses [`JsonRpcRequest`] & [`JsonRpcResponse`]
+/// - A [`tower::Service`] that uses [`BinRequest`] & [`BinResponse`]
+/// - A [`tower::Service`] that uses [`OtherRequest`] & [`OtherResponse`]
 ///
 /// In other words, an [`RpcHandler`] is a type that implements [`tower::Service`] 3 times,
-/// one for each endpoint enum type found in [`cuprate_rpc_types`].
+/// one for each request/response enum type found in [`cuprate_rpc_types`].
 ///
 /// The error type must always be [`RpcError`](crate::RpcError).
 ///
@@ -30,7 +30,7 @@ use crate::RpcService;
 /// Your [`RpcHandler`] must reply to `Request`s with the correct
 /// `Response` or else this crate will panic during routing functions.
 ///
-/// For example, upon a [`JsonRpcRequest::GetBlockCount`] must be replied with
+/// For example, a [`JsonRpcRequest::GetBlockCount`] must be replied with
 /// [`JsonRpcResponse::GetBlockCount`]. If anything else is returned,
 /// this crate may panic.
 pub trait RpcHandler:

rpc/interface/src/rpc_request.rs

@@ -19,6 +19,9 @@ use crate::rpc_error::RpcError;
 ///
 /// The error type is always [`RpcError`].
 ///
+/// There is a blanket implementation that implements this
+/// trait on types that implement `tower::Service` correctly.
+///
 /// See [`RpcHandler`](crate::RpcHandler) for more information.
 pub trait RpcService<Request, Response>:
     Clone