forest/rpc/reflect/
mod.rs

1// Copyright 2019-2026 ChainSafe Systems
2// SPDX-License-Identifier: Apache-2.0, MIT
3
4//! Forest wishes to provide [OpenRPC](http://open-rpc.org) definitions for
5//! Filecoin APIs.
6//! To do this, it needs:
7//! - [JSON Schema](https://json-schema.org/) definitions for all the argument
8//!   and return types.
9//! - The number of arguments ([arity](https://en.wikipedia.org/wiki/Arity)) and
10//!   names of those arguments for each RPC method.
11//!
12//! As a secondary objective, we wish to provide an RPC client for our CLI, and
13//! internal tests against Lotus.
14//!
15//! The [`RpcMethod`] trait encapsulates all the above at a single site.
16//! - [`schemars::JsonSchema`] provides schema definitions,
17//! - [`RpcMethod`] defining arity and actually dispatching the function calls.
18
19pub mod jsonrpc_types;
20
21mod parser;
22mod util;
23
24use crate::lotus_json::HasLotusJson;
25
26use self::{jsonrpc_types::RequestParameters, util::Optional as _};
27use super::error::ServerError as Error;
28use ahash::HashMap;
29use anyhow::Context as _;
30use enumflags2::{BitFlags, bitflags, make_bitflags};
31use fvm_ipld_blockstore::Blockstore;
32use http::{Extensions, Uri};
33use jsonrpsee::RpcModule;
34use openrpc_types::{ContentDescriptor, Method, ParamStructure, ReferenceOr};
35use parser::Parser;
36use schemars::{JsonSchema, Schema, SchemaGenerator};
37use serde::{
38    Deserialize, Serialize,
39    de::{Error as _, Unexpected},
40};
41use std::{future::Future, str::FromStr, sync::Arc};
42use strum::EnumString;
43
44/// Type to be used by [`RpcMethod::handle`].
45pub type Ctx<T> = Arc<crate::rpc::RPCState<T>>;
46
47/// A definition of an RPC method handler which:
48/// - can be [registered](RpcMethodExt::register) with an [`RpcModule`].
49/// - can describe itself in OpenRPC.
50///
51/// Note, an earlier draft of this trait had an additional type parameter for `Ctx`
52/// for generality.
53/// However, fixing it as [`Ctx<...>`] saves on complexity/confusion for implementors,
54/// at the expense of handler flexibility, which could come back to bite us.
55/// - All handlers accept the same type.
56/// - All `Ctx`s must be `Send + Sync + 'static` due to bounds on [`RpcModule`].
57/// - Handlers don't specialize on top of the given bounds, but they MAY relax them.
58pub trait RpcMethod<const ARITY: usize> {
59    /// Number of required parameters, defaults to `ARITY`.
60    const N_REQUIRED_PARAMS: usize = ARITY;
61    /// Method name.
62    const NAME: &'static str;
63    /// Alias for `NAME`. Note that currently this is not reflected in the OpenRPC spec.
64    const NAME_ALIAS: Option<&'static str> = None;
65    /// Name of each argument, MUST be unique.
66    const PARAM_NAMES: [&'static str; ARITY];
67    /// See [`ApiPaths`].
68    const API_PATHS: BitFlags<ApiPaths>;
69    /// See [`Permission`]
70    const PERMISSION: Permission;
71    /// Becomes [`openrpc_types::Method::summary`].
72    const SUMMARY: Option<&'static str> = None;
73    /// Becomes [`openrpc_types::Method::description`].
74    const DESCRIPTION: Option<&'static str> = None;
75    /// Types of each argument. [`Option`]-al arguments MUST follow mandatory ones.
76    type Params: Params<ARITY>;
77    /// Return value of this method.
78    type Ok: HasLotusJson;
79    /// Logic for this method.
80    fn handle(
81        ctx: Ctx<impl Blockstore + Send + Sync + 'static>,
82        params: Self::Params,
83        ext: &Extensions,
84    ) -> impl Future<Output = Result<Self::Ok, Error>> + Send;
85    /// If it a subscription method. Defaults to false.
86    const SUBSCRIPTION: bool = false;
87}
88
89/// The permission required to call an RPC method.
90#[derive(
91    Debug,
92    Clone,
93    Copy,
94    PartialEq,
95    Eq,
96    PartialOrd,
97    Ord,
98    Hash,
99    derive_more::Display,
100    Serialize,
101    Deserialize,
102)]
103#[serde(rename_all = "snake_case")]
104pub enum Permission {
105    /// admin
106    Admin,
107    /// sign
108    Sign,
109    /// write
110    Write,
111    /// read
112    Read,
113}
114
115/// Which paths should this method be exposed on?
116///
117/// This information is important when using [`crate::rpc::client`].
118#[bitflags]
119#[repr(u8)]
120#[derive(
121    Debug,
122    Default,
123    Clone,
124    Copy,
125    Hash,
126    Eq,
127    PartialEq,
128    Ord,
129    PartialOrd,
130    clap::ValueEnum,
131    EnumString,
132    Deserialize,
133    Serialize,
134)]
135pub enum ApiPaths {
136    /// Only expose this method on `/rpc/v0`
137    #[strum(ascii_case_insensitive)]
138    V0 = 0b00000001,
139    /// Only expose this method on `/rpc/v1`
140    #[strum(ascii_case_insensitive)]
141    #[default]
142    V1 = 0b00000010,
143    /// Only expose this method on `/rpc/v2`
144    #[strum(ascii_case_insensitive)]
145    V2 = 0b00000100,
146}
147
148impl ApiPaths {
149    pub const fn all() -> BitFlags<Self> {
150        // Not containing V2 until it's released in Lotus.
151        make_bitflags!(Self::{ V0 | V1 })
152    }
153
154    // Remove this helper once all RPC methods are migrated to V2.
155    // We're incrementally migrating methods to V2 support. Once complete,
156    // update all() to include V2 and remove this temporary helper.
157    pub const fn all_with_v2() -> BitFlags<Self> {
158        Self::all().union_c(make_bitflags!(Self::{ V2 }))
159    }
160
161    pub fn from_uri(uri: &Uri) -> anyhow::Result<Self> {
162        Ok(Self::from_str(uri.path().trim_start_matches("/rpc/"))?)
163    }
164
165    pub fn path(&self) -> &'static str {
166        match self {
167            Self::V0 => "rpc/v0",
168            Self::V1 => "rpc/v1",
169            Self::V2 => "rpc/v2",
170        }
171    }
172}
173
174/// Utility methods, defined as an extension trait to avoid having to specify
175/// `ARITY` in user code.
176pub trait RpcMethodExt<const ARITY: usize>: RpcMethod<ARITY> {
177    /// Convert from typed handler parameters to un-typed JSON-RPC parameters.
178    ///
179    /// Exposes errors from [`Params::unparse`]
180    fn build_params(
181        params: Self::Params,
182        calling_convention: ConcreteCallingConvention,
183    ) -> Result<RequestParameters, serde_json::Error> {
184        let args = params.unparse()?;
185        match calling_convention {
186            ConcreteCallingConvention::ByPosition => {
187                Ok(RequestParameters::ByPosition(Vec::from(args)))
188            }
189            ConcreteCallingConvention::ByName => Ok(RequestParameters::ByName(
190                itertools::zip_eq(Self::PARAM_NAMES.into_iter().map(String::from), args).collect(),
191            )),
192        }
193    }
194
195    fn parse_params(
196        params_raw: Option<impl AsRef<str>>,
197        calling_convention: ParamStructure,
198    ) -> anyhow::Result<Self::Params> {
199        Ok(Self::Params::parse(
200            params_raw
201                .map(|s| serde_json::from_str(s.as_ref()))
202                .transpose()?,
203            Self::PARAM_NAMES,
204            calling_convention,
205            Self::N_REQUIRED_PARAMS,
206        )?)
207    }
208
209    /// Generate a full `OpenRPC` method definition for this endpoint.
210    fn openrpc<'de>(
211        g: &mut SchemaGenerator,
212        calling_convention: ParamStructure,
213        method_name: &'static str,
214    ) -> Method
215    where
216        <Self::Ok as HasLotusJson>::LotusJson: JsonSchema + Deserialize<'de>,
217    {
218        Method {
219            name: String::from(method_name),
220            params: itertools::zip_eq(Self::PARAM_NAMES, Self::Params::schemas(g))
221                .enumerate()
222                .map(|(pos, (name, (schema, nullable)))| {
223                    let required = pos <= Self::N_REQUIRED_PARAMS;
224                    if !required && !nullable {
225                        panic!("Optional parameter at position {pos} should be of an optional type. method={method_name}, param_name={name}");
226                    }
227                    ReferenceOr::Item(ContentDescriptor {
228                        name: String::from(name),
229                        schema,
230                        required: Some(required),
231                        ..Default::default()
232                    })
233                })
234                .collect(),
235            param_structure: Some(calling_convention),
236            result: Some(ReferenceOr::Item(ContentDescriptor {
237                name: format!("{method_name}.Result"),
238                schema: g.subschema_for::<<Self::Ok as HasLotusJson>::LotusJson>(),
239                required: Some(!<Self::Ok as HasLotusJson>::LotusJson::optional()),
240                ..Default::default()
241            })),
242            summary: Self::SUMMARY.map(Into::into),
243            description: Self::DESCRIPTION.map(Into::into),
244            ..Default::default()
245        }
246    }
247
248    /// Register a method with an [`RpcModule`].
249    fn register(
250        modules: &mut HashMap<
251            ApiPaths,
252            RpcModule<crate::rpc::RPCState<impl Blockstore + Send + Sync + 'static>>,
253        >,
254        calling_convention: ParamStructure,
255    ) -> Result<(), jsonrpsee::core::RegisterMethodError>
256    where
257        <Self::Ok as HasLotusJson>::LotusJson: Clone + 'static,
258    {
259        use clap::ValueEnum as _;
260
261        assert!(
262            Self::N_REQUIRED_PARAMS <= ARITY,
263            "N_REQUIRED_PARAMS({}) can not be greater than ARITY({ARITY}) in {}",
264            Self::N_REQUIRED_PARAMS,
265            Self::NAME
266        );
267
268        for api_version in ApiPaths::value_variants() {
269            if Self::API_PATHS.contains(*api_version)
270                && let Some(module) = modules.get_mut(api_version)
271            {
272                module.register_async_method(
273                    Self::NAME,
274                    move |params, ctx, extensions| async move {
275                        let params = Self::parse_params(params.as_str(), calling_convention)
276                            .map_err(|e| Error::invalid_params(e, None))?;
277                        let ok = Self::handle(ctx, params, &extensions).await?;
278                        Result::<_, jsonrpsee::types::ErrorObjectOwned>::Ok(ok.into_lotus_json())
279                    },
280                )?;
281                if let Some(alias) = Self::NAME_ALIAS {
282                    module.register_alias(alias, Self::NAME)?
283                }
284            }
285        }
286        Ok(())
287    }
288    /// Returns [`Err`] if any of the parameters fail to serialize.
289    fn request(params: Self::Params) -> Result<crate::rpc::Request<Self::Ok>, serde_json::Error> {
290        // hardcode calling convention because lotus is by-position only
291        let params = Self::request_params(params)?;
292        Ok(crate::rpc::Request {
293            method_name: Self::NAME.into(),
294            params,
295            result_type: std::marker::PhantomData,
296            api_paths: Self::API_PATHS,
297            timeout: *crate::rpc::DEFAULT_REQUEST_TIMEOUT,
298        })
299    }
300
301    fn request_params(params: Self::Params) -> Result<serde_json::Value, serde_json::Error> {
302        // hardcode calling convention because lotus is by-position only
303        Ok(
304            match Self::build_params(params, ConcreteCallingConvention::ByPosition)? {
305                RequestParameters::ByPosition(mut it) => {
306                    // Omit optional parameters when they are null
307                    // This can be refactored into using `while pop_if`
308                    // when the API is stablized.
309                    while Self::N_REQUIRED_PARAMS < it.len() {
310                        match it.last() {
311                            Some(last) if last.is_null() => it.pop(),
312                            _ => break,
313                        };
314                    }
315                    serde_json::Value::Array(it)
316                }
317                RequestParameters::ByName(it) => serde_json::Value::Object(it),
318            },
319        )
320    }
321
322    /// Creates a request, using the alias method name if `use_alias` is `true`.
323    fn request_with_alias(
324        params: Self::Params,
325        use_alias: bool,
326    ) -> anyhow::Result<crate::rpc::Request<Self::Ok>> {
327        let params = Self::request_params(params)?;
328        let name = if use_alias {
329            Self::NAME_ALIAS.context("alias is None")?
330        } else {
331            Self::NAME
332        };
333
334        Ok(crate::rpc::Request {
335            method_name: name.into(),
336            params,
337            result_type: std::marker::PhantomData,
338            api_paths: Self::API_PATHS,
339            timeout: *crate::rpc::DEFAULT_REQUEST_TIMEOUT,
340        })
341    }
342    fn call_raw(
343        client: &crate::rpc::client::Client,
344        params: Self::Params,
345    ) -> impl Future<Output = Result<<Self::Ok as HasLotusJson>::LotusJson, jsonrpsee::core::ClientError>>
346    {
347        async {
348            // TODO(forest): https://github.com/ChainSafe/forest/issues/4032
349            //               Client::call has an inappropriate HasLotusJson
350            //               bound, work around it for now.
351            let json = client.call(Self::request(params)?.map_ty()).await?;
352            Ok(serde_json::from_value(json)?)
353        }
354    }
355    fn call(
356        client: &crate::rpc::client::Client,
357        params: Self::Params,
358    ) -> impl Future<Output = Result<Self::Ok, jsonrpsee::core::ClientError>> {
359        async {
360            Self::call_raw(client, params)
361                .await
362                .map(Self::Ok::from_lotus_json)
363        }
364    }
365}
366impl<const ARITY: usize, T> RpcMethodExt<ARITY> for T where T: RpcMethod<ARITY> {}
367
368/// A tuple of `ARITY` arguments.
369///
370/// This should NOT be manually implemented.
371pub trait Params<const ARITY: usize>: HasLotusJson {
372    /// A [`Schema`] and [`Optional::optional`](`util::Optional::optional`)
373    /// schema-nullable pair for argument, in-order.
374    fn schemas(g: &mut SchemaGenerator) -> [(Schema, bool); ARITY];
375    /// Convert from raw request parameters, to the argument tuple required by
376    /// [`RpcMethod::handle`]
377    fn parse(
378        raw: Option<RequestParameters>,
379        names: [&str; ARITY],
380        calling_convention: ParamStructure,
381        n_required: usize,
382    ) -> Result<Self, Error>
383    where
384        Self: Sized;
385    /// Convert from an argument tuple to un-typed JSON.
386    ///
387    /// Exposes de-serialization errors, or mis-implementation of this trait.
388    fn unparse(self) -> Result<[serde_json::Value; ARITY], serde_json::Error> {
389        match self.into_lotus_json_value() {
390            Ok(serde_json::Value::Array(args)) => match args.try_into() {
391                Ok(it) => Ok(it),
392                Err(_) => Err(serde_json::Error::custom("ARITY mismatch")),
393            },
394            Ok(serde_json::Value::Null) if ARITY == 0 => {
395                Ok(std::array::from_fn(|_ix| Default::default()))
396            }
397            Ok(it) => Err(serde_json::Error::invalid_type(
398                unexpected(&it),
399                &"a Vec with an item for each argument",
400            )),
401            Err(e) => Err(e),
402        }
403    }
404}
405
406fn unexpected(v: &serde_json::Value) -> Unexpected<'_> {
407    match v {
408        serde_json::Value::Null => Unexpected::Unit,
409        serde_json::Value::Bool(it) => Unexpected::Bool(*it),
410        serde_json::Value::Number(it) => match (it.as_f64(), it.as_i64(), it.as_u64()) {
411            (None, None, None) => Unexpected::Other("Number"),
412            (Some(it), _, _) => Unexpected::Float(it),
413            (_, Some(it), _) => Unexpected::Signed(it),
414            (_, _, Some(it)) => Unexpected::Unsigned(it),
415        },
416        serde_json::Value::String(it) => Unexpected::Str(it),
417        serde_json::Value::Array(_) => Unexpected::Seq,
418        serde_json::Value::Object(_) => Unexpected::Map,
419    }
420}
421
422macro_rules! do_impls {
423    ($arity:literal $(, $arg:ident)* $(,)?) => {
424        const _: () = {
425            let _assert: [&str; $arity] = [$(stringify!($arg)),*];
426        };
427
428        impl<$($arg),*> Params<$arity> for ($($arg,)*)
429        where
430            $($arg: HasLotusJson + Clone, <$arg as HasLotusJson>::LotusJson: JsonSchema, )*
431        {
432            fn parse(
433                raw: Option<RequestParameters>,
434                arg_names: [&str; $arity],
435                calling_convention: ParamStructure,
436                n_required: usize,
437            ) -> Result<Self, Error> {
438                let mut _parser = Parser::new(raw, &arg_names, calling_convention, n_required)?;
439                Ok(($(_parser.parse::<crate::lotus_json::LotusJson<$arg>>()?.into_inner(),)*))
440            }
441            fn schemas(_gen: &mut SchemaGenerator) -> [(Schema, bool); $arity] {
442                [$((_gen.subschema_for::<$arg::LotusJson>(), $arg::LotusJson::optional())),*]
443            }
444        }
445    };
446}
447
448do_impls!(0);
449do_impls!(1, T0);
450do_impls!(2, T0, T1);
451do_impls!(3, T0, T1, T2);
452do_impls!(4, T0, T1, T2, T3);
453// do_impls!(5, T0, T1, T2, T3, T4);
454// do_impls!(6, T0, T1, T2, T3, T4, T5);
455// do_impls!(7, T0, T1, T2, T3, T4, T5, T6);
456// do_impls!(8, T0, T1, T2, T3, T4, T5, T6, T7);
457// do_impls!(9, T0, T1, T2, T3, T4, T5, T6, T7, T8);
458// do_impls!(10, T0, T1, T2, T3, T4, T5, T6, T7, T8, T9);
459
460/// [`openrpc_types::ParamStructure`] describes accepted param format.
461/// This is an actual param format, used to decide how to construct arguments.
462pub enum ConcreteCallingConvention {
463    ByPosition,
464    #[allow(unused)] // included for completeness
465    ByName,
466}
467
468#[cfg(test)]
469mod tests {
470    use super::*;
471
472    #[test]
473    fn test_api_paths_from_uri() {
474        let v0 = ApiPaths::from_uri(&"http://127.0.0.1:2345/rpc/v0".parse().unwrap()).unwrap();
475        assert_eq!(v0, ApiPaths::V0);
476        let v1 = ApiPaths::from_uri(&"http://127.0.0.1:2345/rpc/v1".parse().unwrap()).unwrap();
477        assert_eq!(v1, ApiPaths::V1);
478        let v2 = ApiPaths::from_uri(&"http://127.0.0.1:2345/rpc/v2".parse().unwrap()).unwrap();
479        assert_eq!(v2, ApiPaths::V2);
480
481        ApiPaths::from_uri(&"http://127.0.0.1:2345/rpc/v3".parse().unwrap()).unwrap_err();
482    }
483}
forest/rpc/reflect/mod.rs

forest/rpc/reflect/
mod.rs
