forest/rpc/
mod.rs

1// Copyright 2019-2026 ChainSafe Systems
2// SPDX-License-Identifier: Apache-2.0, MIT
3
4use crate::rpc::methods::eth::pubsub_trait::EthPubSubApiServer;
5mod auth_layer;
6mod channel;
7mod client;
8mod filter_layer;
9mod filter_list;
10pub mod json_validator;
11mod log_layer;
12mod metrics_layer;
13mod request;
14mod segregation_layer;
15mod set_extension_layer;
16mod validation_layer;
17
18use crate::rpc::eth::types::RandomHexStringIdProvider;
19use crate::shim::clock::ChainEpoch;
20use clap::ValueEnum as _;
21pub use client::Client;
22pub use error::ServerError;
23use eth::filter::EthEventHandler;
24use filter_layer::FilterLayer;
25pub use filter_list::FilterList;
26use futures::FutureExt as _;
27use jsonrpsee::server::ServerConfig;
28use log_layer::LogLayer;
29use reflect::Ctx;
30pub use reflect::{ApiPaths, Permission, RpcMethod, RpcMethodExt};
31pub use request::Request;
32use schemars::Schema;
33use segregation_layer::SegregationLayer;
34use set_extension_layer::SetExtensionLayer;
35mod error;
36mod reflect;
37use ahash::HashMap;
38mod registry;
39pub mod types;
40
41pub use methods::*;
42
43/// Protocol or transport-specific error
44pub use jsonrpsee::core::ClientError;
45
46/// Sentinel value, indicating no limit on how far back to search in the chain (all the way to genesis epoch).
47pub const LOOKBACK_NO_LIMIT: ChainEpoch = -1;
48
49/// The macro `callback` will be passed in each type that implements
50/// [`RpcMethod`].
51///
52/// This is a macro because there is no way to abstract the `ARITY` on that
53/// trait.
54///
55/// All methods should be entered here.
56#[macro_export]
57macro_rules! for_each_rpc_method {
58    ($callback:path) => {
59        // auth vertical
60        $callback!($crate::rpc::auth::AuthNew);
61        $callback!($crate::rpc::auth::AuthVerify);
62
63        // beacon vertical
64        $callback!($crate::rpc::beacon::BeaconGetEntry);
65
66        // chain vertical
67        $callback!($crate::rpc::chain::ChainPruneSnapshot);
68        $callback!($crate::rpc::chain::ChainExport);
69        $callback!($crate::rpc::chain::ChainGetBlock);
70        $callback!($crate::rpc::chain::ChainGetBlockMessages);
71        $callback!($crate::rpc::chain::ChainGetEvents);
72        $callback!($crate::rpc::chain::ChainGetGenesis);
73        $callback!($crate::rpc::chain::ChainGetFinalizedTipset);
74        $callback!($crate::rpc::chain::ChainGetMessage);
75        $callback!($crate::rpc::chain::ChainGetMessagesInTipset);
76        $callback!($crate::rpc::chain::ChainGetMinBaseFee);
77        $callback!($crate::rpc::chain::ChainGetParentMessages);
78        $callback!($crate::rpc::chain::ChainGetParentReceipts);
79        $callback!($crate::rpc::chain::ChainGetPath);
80        $callback!($crate::rpc::chain::ChainGetTipSet);
81        $callback!($crate::rpc::chain::ChainGetTipSetV2);
82        $callback!($crate::rpc::chain::ChainGetTipSetAfterHeight);
83        $callback!($crate::rpc::chain::ChainGetTipSetByHeight);
84        $callback!($crate::rpc::chain::ChainHasObj);
85        $callback!($crate::rpc::chain::ChainHead);
86        $callback!($crate::rpc::chain::ChainReadObj);
87        $callback!($crate::rpc::chain::ChainSetHead);
88        $callback!($crate::rpc::chain::ChainStatObj);
89        $callback!($crate::rpc::chain::ChainTipSetWeight);
90        $callback!($crate::rpc::chain::ForestChainExport);
91        $callback!($crate::rpc::chain::ForestChainExportDiff);
92        $callback!($crate::rpc::chain::ForestChainExportStatus);
93        $callback!($crate::rpc::chain::ForestChainExportCancel);
94        $callback!($crate::rpc::chain::ChainGetTipsetByParentState);
95
96        // common vertical
97        $callback!($crate::rpc::common::Session);
98        $callback!($crate::rpc::common::Shutdown);
99        $callback!($crate::rpc::common::StartTime);
100        $callback!($crate::rpc::common::Version);
101
102        // eth vertical
103        $callback!($crate::rpc::eth::EthAccounts);
104        $callback!($crate::rpc::eth::EthAddressToFilecoinAddress);
105        $callback!($crate::rpc::eth::FilecoinAddressToEthAddress);
106        $callback!($crate::rpc::eth::EthBlockNumber);
107        $callback!($crate::rpc::eth::EthCall);
108        $callback!($crate::rpc::eth::EthCallV2);
109        $callback!($crate::rpc::eth::EthChainId);
110        $callback!($crate::rpc::eth::EthEstimateGas);
111        $callback!($crate::rpc::eth::EthEstimateGasV2);
112        $callback!($crate::rpc::eth::EthFeeHistory);
113        $callback!($crate::rpc::eth::EthFeeHistoryV2);
114        $callback!($crate::rpc::eth::EthGasPrice);
115        $callback!($crate::rpc::eth::EthGetBalance);
116        $callback!($crate::rpc::eth::EthGetBalanceV2);
117        $callback!($crate::rpc::eth::EthGetBlockByHash);
118        $callback!($crate::rpc::eth::EthGetBlockByNumber);
119        $callback!($crate::rpc::eth::EthGetBlockByNumberV2);
120        $callback!($crate::rpc::eth::EthGetBlockReceipts);
121        $callback!($crate::rpc::eth::EthGetBlockReceiptsV2);
122        $callback!($crate::rpc::eth::EthGetBlockReceiptsLimited);
123        $callback!($crate::rpc::eth::EthGetBlockReceiptsLimitedV2);
124        $callback!($crate::rpc::eth::EthGetBlockTransactionCountByHash);
125        $callback!($crate::rpc::eth::EthGetBlockTransactionCountByNumber);
126        $callback!($crate::rpc::eth::EthGetBlockTransactionCountByNumberV2);
127        $callback!($crate::rpc::eth::EthGetCode);
128        $callback!($crate::rpc::eth::EthGetCodeV2);
129        $callback!($crate::rpc::eth::EthGetLogs);
130        $callback!($crate::rpc::eth::EthGetFilterLogs);
131        $callback!($crate::rpc::eth::EthGetFilterChanges);
132        $callback!($crate::rpc::eth::EthGetMessageCidByTransactionHash);
133        $callback!($crate::rpc::eth::EthGetStorageAt);
134        $callback!($crate::rpc::eth::EthGetStorageAtV2);
135        $callback!($crate::rpc::eth::EthGetTransactionByHash);
136        $callback!($crate::rpc::eth::EthGetTransactionByHashLimited);
137        $callback!($crate::rpc::eth::EthGetTransactionCount);
138        $callback!($crate::rpc::eth::EthGetTransactionCountV2);
139        $callback!($crate::rpc::eth::EthGetTransactionHashByCid);
140        $callback!($crate::rpc::eth::EthGetTransactionByBlockNumberAndIndex);
141        $callback!($crate::rpc::eth::EthGetTransactionByBlockNumberAndIndexV2);
142        $callback!($crate::rpc::eth::EthGetTransactionByBlockHashAndIndex);
143        $callback!($crate::rpc::eth::EthMaxPriorityFeePerGas);
144        $callback!($crate::rpc::eth::EthProtocolVersion);
145        $callback!($crate::rpc::eth::EthGetTransactionReceipt);
146        $callback!($crate::rpc::eth::EthGetTransactionReceiptLimited);
147        $callback!($crate::rpc::eth::EthNewFilter);
148        $callback!($crate::rpc::eth::EthNewPendingTransactionFilter);
149        $callback!($crate::rpc::eth::EthNewBlockFilter);
150        $callback!($crate::rpc::eth::EthUninstallFilter);
151        $callback!($crate::rpc::eth::EthUnsubscribe);
152        $callback!($crate::rpc::eth::EthSubscribe);
153        $callback!($crate::rpc::eth::EthSyncing);
154        $callback!($crate::rpc::eth::EthTraceBlock);
155        $callback!($crate::rpc::eth::EthTraceBlockV2);
156        $callback!($crate::rpc::eth::EthTraceCall);
157        $callback!($crate::rpc::eth::EthTraceFilter);
158        $callback!($crate::rpc::eth::EthTraceTransaction);
159        $callback!($crate::rpc::eth::EthTraceReplayBlockTransactions);
160        $callback!($crate::rpc::eth::EthTraceReplayBlockTransactionsV2);
161        $callback!($crate::rpc::eth::Web3ClientVersion);
162        $callback!($crate::rpc::eth::EthSendRawTransaction);
163        $callback!($crate::rpc::eth::EthSendRawTransactionUntrusted);
164
165        // gas vertical
166        $callback!($crate::rpc::gas::GasEstimateFeeCap);
167        $callback!($crate::rpc::gas::GasEstimateGasLimit);
168        $callback!($crate::rpc::gas::GasEstimateGasPremium);
169        $callback!($crate::rpc::gas::GasEstimateMessageGas);
170
171        // market vertical
172        $callback!($crate::rpc::market::MarketAddBalance);
173
174        // miner vertical
175        $callback!($crate::rpc::miner::MinerCreateBlock);
176        $callback!($crate::rpc::miner::MinerGetBaseInfo);
177
178        // mpool vertical
179        $callback!($crate::rpc::mpool::MpoolBatchPush);
180        $callback!($crate::rpc::mpool::MpoolBatchPushUntrusted);
181        $callback!($crate::rpc::mpool::MpoolGetNonce);
182        $callback!($crate::rpc::mpool::MpoolPending);
183        $callback!($crate::rpc::mpool::MpoolPush);
184        $callback!($crate::rpc::mpool::MpoolPushMessage);
185        $callback!($crate::rpc::mpool::MpoolPushUntrusted);
186        $callback!($crate::rpc::mpool::MpoolSelect);
187
188        // msig vertical
189        $callback!($crate::rpc::msig::MsigGetAvailableBalance);
190        $callback!($crate::rpc::msig::MsigGetPending);
191        $callback!($crate::rpc::msig::MsigGetVested);
192        $callback!($crate::rpc::msig::MsigGetVestingSchedule);
193
194        // net vertical
195        $callback!($crate::rpc::net::NetAddrsListen);
196        $callback!($crate::rpc::net::NetAgentVersion);
197        $callback!($crate::rpc::net::NetAutoNatStatus);
198        $callback!($crate::rpc::net::NetConnect);
199        $callback!($crate::rpc::net::NetDisconnect);
200        $callback!($crate::rpc::net::NetFindPeer);
201        $callback!($crate::rpc::net::NetInfo);
202        $callback!($crate::rpc::net::NetListening);
203        $callback!($crate::rpc::net::NetPeers);
204        $callback!($crate::rpc::net::NetProtectAdd);
205        $callback!($crate::rpc::net::NetProtectList);
206        $callback!($crate::rpc::net::NetProtectRemove);
207        $callback!($crate::rpc::net::NetVersion);
208
209        // node vertical
210        $callback!($crate::rpc::node::NodeStatus);
211
212        // state vertical
213        $callback!($crate::rpc::state::StateAccountKey);
214        $callback!($crate::rpc::state::StateCall);
215        $callback!($crate::rpc::state::StateCirculatingSupply);
216        $callback!($crate::rpc::state::ForestStateCompute);
217        $callback!($crate::rpc::state::StateCompute);
218        $callback!($crate::rpc::state::StateDealProviderCollateralBounds);
219        $callback!($crate::rpc::state::StateFetchRoot);
220        $callback!($crate::rpc::state::StateGetActor);
221        $callback!($crate::rpc::state::StateGetActorV2);
222        $callback!($crate::rpc::state::StateGetID);
223        $callback!($crate::rpc::state::StateGetAllAllocations);
224        $callback!($crate::rpc::state::StateGetAllClaims);
225        $callback!($crate::rpc::state::StateGetAllocation);
226        $callback!($crate::rpc::state::StateGetAllocationForPendingDeal);
227        $callback!($crate::rpc::state::StateGetAllocationIdForPendingDeal);
228        $callback!($crate::rpc::state::StateGetAllocations);
229        $callback!($crate::rpc::state::StateGetBeaconEntry);
230        $callback!($crate::rpc::state::StateGetClaim);
231        $callback!($crate::rpc::state::StateGetClaims);
232        $callback!($crate::rpc::state::StateGetNetworkParams);
233        $callback!($crate::rpc::state::StateGetRandomnessDigestFromBeacon);
234        $callback!($crate::rpc::state::StateGetRandomnessDigestFromTickets);
235        $callback!($crate::rpc::state::StateGetRandomnessFromBeacon);
236        $callback!($crate::rpc::state::StateGetRandomnessFromTickets);
237        $callback!($crate::rpc::state::StateGetReceipt);
238        $callback!($crate::rpc::state::StateListActors);
239        $callback!($crate::rpc::state::StateListMessages);
240        $callback!($crate::rpc::state::StateListMiners);
241        $callback!($crate::rpc::state::StateLookupID);
242        $callback!($crate::rpc::state::StateLookupRobustAddress);
243        $callback!($crate::rpc::state::StateMarketBalance);
244        $callback!($crate::rpc::state::StateMarketDeals);
245        $callback!($crate::rpc::state::StateMarketParticipants);
246        $callback!($crate::rpc::state::StateMarketStorageDeal);
247        $callback!($crate::rpc::state::StateMinerActiveSectors);
248        $callback!($crate::rpc::state::StateMinerAllocated);
249        $callback!($crate::rpc::state::StateMinerAvailableBalance);
250        $callback!($crate::rpc::state::StateMinerDeadlines);
251        $callback!($crate::rpc::state::StateMinerFaults);
252        $callback!($crate::rpc::state::StateMinerInfo);
253        $callback!($crate::rpc::state::StateMinerInitialPledgeCollateral);
254        $callback!($crate::rpc::state::StateMinerPartitions);
255        $callback!($crate::rpc::state::StateMinerPower);
256        $callback!($crate::rpc::state::StateMinerPreCommitDepositForPower);
257        $callback!($crate::rpc::state::StateMinerProvingDeadline);
258        $callback!($crate::rpc::state::StateMinerRecoveries);
259        $callback!($crate::rpc::state::StateMinerSectorAllocated);
260        $callback!($crate::rpc::state::StateMinerSectorCount);
261        $callback!($crate::rpc::state::StateMinerSectors);
262        $callback!($crate::rpc::state::StateNetworkName);
263        $callback!($crate::rpc::state::StateNetworkVersion);
264        $callback!($crate::rpc::state::StateActorInfo);
265        $callback!($crate::rpc::state::StateReadState);
266        $callback!($crate::rpc::state::StateDecodeParams);
267        $callback!($crate::rpc::state::StateReplay);
268        $callback!($crate::rpc::state::StateSearchMsg);
269        $callback!($crate::rpc::state::StateSearchMsgLimited);
270        $callback!($crate::rpc::state::StateSectorExpiration);
271        $callback!($crate::rpc::state::StateSectorGetInfo);
272        $callback!($crate::rpc::state::StateSectorPartition);
273        $callback!($crate::rpc::state::StateSectorPreCommitInfo);
274        $callback!($crate::rpc::state::StateSectorPreCommitInfoV0);
275        $callback!($crate::rpc::state::StateVerifiedClientStatus);
276        $callback!($crate::rpc::state::StateVerifiedRegistryRootKey);
277        $callback!($crate::rpc::state::StateVerifierStatus);
278        $callback!($crate::rpc::state::StateVMCirculatingSupplyInternal);
279        $callback!($crate::rpc::state::StateWaitMsg);
280        $callback!($crate::rpc::state::StateWaitMsgV0);
281        $callback!($crate::rpc::state::StateMinerInitialPledgeForSector);
282
283        // sync vertical
284        $callback!($crate::rpc::sync::SyncCheckBad);
285        $callback!($crate::rpc::sync::SyncMarkBad);
286        $callback!($crate::rpc::sync::SyncSnapshotProgress);
287        $callback!($crate::rpc::sync::SyncStatus);
288        $callback!($crate::rpc::sync::SyncSubmitBlock);
289
290        // wallet vertical
291        $callback!($crate::rpc::wallet::WalletBalance);
292        $callback!($crate::rpc::wallet::WalletDefaultAddress);
293        $callback!($crate::rpc::wallet::WalletDelete);
294        $callback!($crate::rpc::wallet::WalletExport);
295        $callback!($crate::rpc::wallet::WalletHas);
296        $callback!($crate::rpc::wallet::WalletImport);
297        $callback!($crate::rpc::wallet::WalletList);
298        $callback!($crate::rpc::wallet::WalletNew);
299        $callback!($crate::rpc::wallet::WalletSetDefault);
300        $callback!($crate::rpc::wallet::WalletSign);
301        $callback!($crate::rpc::wallet::WalletSignMessage);
302        $callback!($crate::rpc::wallet::WalletValidateAddress);
303        $callback!($crate::rpc::wallet::WalletVerify);
304
305        // f3
306        $callback!($crate::rpc::f3::GetRawNetworkName);
307        $callback!($crate::rpc::f3::F3GetCertificate);
308        $callback!($crate::rpc::f3::F3GetECPowerTable);
309        $callback!($crate::rpc::f3::F3GetF3PowerTable);
310        $callback!($crate::rpc::f3::F3GetF3PowerTableByInstance);
311        $callback!($crate::rpc::f3::F3IsRunning);
312        $callback!($crate::rpc::f3::F3GetProgress);
313        $callback!($crate::rpc::f3::F3GetManifest);
314        $callback!($crate::rpc::f3::F3ListParticipants);
315        $callback!($crate::rpc::f3::F3GetLatestCertificate);
316        $callback!($crate::rpc::f3::F3GetOrRenewParticipationTicket);
317        $callback!($crate::rpc::f3::F3Participate);
318        $callback!($crate::rpc::f3::F3ExportLatestSnapshot);
319        $callback!($crate::rpc::f3::GetHead);
320        $callback!($crate::rpc::f3::GetParent);
321        $callback!($crate::rpc::f3::GetParticipatingMinerIDs);
322        $callback!($crate::rpc::f3::GetPowerTable);
323        $callback!($crate::rpc::f3::GetTipset);
324        $callback!($crate::rpc::f3::GetTipsetByEpoch);
325        $callback!($crate::rpc::f3::Finalize);
326        $callback!($crate::rpc::f3::ProtectPeer);
327        $callback!($crate::rpc::f3::SignMessage);
328
329        // misc
330        $callback!($crate::rpc::misc::GetActorEventsRaw);
331    };
332}
333pub(crate) use for_each_rpc_method;
334use sync::SnapshotProgressTracker;
335use tower_http::compression::CompressionLayer;
336use tower_http::sensitive_headers::SetSensitiveRequestHeadersLayer;
337
338#[allow(unused)]
339/// All handler definitions.
340///
341/// Usage guide:
342/// ```ignore
343/// use crate::rpc::{self, prelude::*};
344///
345/// let client = rpc::Client::from(..);
346/// ChainHead::call(&client, ()).await?;
347/// fn foo() -> rpc::ClientError {..}
348/// fn bar() -> rpc::ServerError {..}
349/// ```
350pub mod prelude {
351    use super::*;
352
353    pub use reflect::RpcMethodExt as _;
354
355    macro_rules! export {
356        ($ty:ty) => {
357            pub use $ty;
358        };
359    }
360
361    for_each_rpc_method!(export);
362}
363
364/// Collects all the RPC method names and permission available in the Forest
365pub fn collect_rpc_method_info() -> Vec<(&'static str, Permission)> {
366    use crate::rpc::RpcMethod;
367
368    let mut methods = Vec::new();
369
370    macro_rules! add_method {
371        ($ty:ty) => {
372            methods.push((<$ty>::NAME, <$ty>::PERMISSION));
373        };
374    }
375
376    for_each_rpc_method!(add_method);
377
378    methods
379}
380
381/// All the methods live in their own folder
382///
383/// # Handling types
384/// - If a `struct` or `enum` is only used in the RPC API, it should live in `src/rpc`.
385///   - If it is used in only one API vertical (i.e `auth` or `chain`), then it should live
386///     in either:
387///     - `src/rpc/methods/auth.rs` (if there are only a few).
388///     - `src/rpc/methods/auth/types.rs` (if there are so many that they would cause clutter).
389///   - If it is used _across_ API verticals, it should live in `src/rpc/types.rs`
390///
391/// # Interactions with the [`lotus_json`] APIs
392/// - Types may have fields which must go through [`LotusJson`],
393///   and MUST reflect that in their [`JsonSchema`].
394///   You have two options for this:
395///   - Use `#[attributes]` to control serialization and schema generation:
396///     ```ignore
397///     #[derive(Deserialize, Serialize, JsonSchema)]
398///     struct Foo {
399///         #[serde(with = "crate::lotus_json")] // perform the conversion
400///         #[schemars(with = "LotusJson<Cid>")] // advertise the schema to be converted
401///         cid: Cid, // use the native type in application logic
402///     }
403///     ```
404///   - Use [`LotusJson`] directly. This means that serialization and the [`JsonSchema`]
405///     will never go out of sync.
406///     ```ignore
407///     #[derive(Deserialize, Serialize, JsonSchema)]
408///     struct Foo {
409///         cid: LotusJson<Cid>, // use the shim type in application logic, manually performing conversions
410///     }
411///     ```
412///
413/// [`lotus_json`]: crate::lotus_json
414/// [`HasLotusJson`]: crate::lotus_json::HasLotusJson
415/// [`LotusJson`]: crate::lotus_json::LotusJson
416/// [`JsonSchema`]: schemars::JsonSchema
417mod methods {
418    pub mod auth;
419    pub mod beacon;
420    pub mod chain;
421    pub mod common;
422    pub mod eth;
423    pub mod f3;
424    pub mod gas;
425    pub mod market;
426    pub mod miner;
427    pub mod misc;
428    pub mod mpool;
429    pub mod msig;
430    pub mod net;
431    pub mod node;
432    pub mod state;
433    pub mod sync;
434    pub mod wallet;
435}
436
437use crate::rpc::auth_layer::AuthLayer;
438pub use crate::rpc::channel::CANCEL_METHOD_NAME;
439use crate::rpc::channel::RpcModule as FilRpcModule;
440use crate::rpc::eth::pubsub::EthPubSub;
441use crate::rpc::metrics_layer::MetricsLayer;
442use crate::{chain_sync::network_context::SyncNetworkContext, key_management::KeyStore};
443
444use crate::blocks::FullTipset;
445use fvm_ipld_blockstore::Blockstore;
446use jsonrpsee::{
447    Methods,
448    core::middleware::RpcServiceBuilder,
449    server::{RpcModule, Server, StopHandle, TowerServiceBuilder},
450};
451use parking_lot::RwLock;
452use std::env;
453use std::sync::{Arc, LazyLock};
454use std::time::Duration;
455use tokio::sync::mpsc;
456use tower::Service;
457
458use crate::rpc::sync::SnapshotProgressState;
459use openrpc_types::{self, ParamStructure};
460
461pub const DEFAULT_PORT: u16 = 2345;
462
463/// Request timeout read from environment variables
464static DEFAULT_REQUEST_TIMEOUT: LazyLock<Duration> = LazyLock::new(|| {
465    env::var("FOREST_RPC_DEFAULT_TIMEOUT")
466        .ok()
467        .and_then(|it| Duration::from_secs(it.parse().ok()?).into())
468        .unwrap_or(Duration::from_secs(60))
469});
470
471/// Default maximum connections for the RPC server. This needs to be high enough to
472/// accommodate the regular usage for RPC providers.
473static DEFAULT_MAX_CONNECTIONS: LazyLock<u32> = LazyLock::new(|| {
474    env::var("FOREST_RPC_MAX_CONNECTIONS")
475        .ok()
476        .and_then(|it| it.parse().ok())
477        .unwrap_or(1000)
478});
479
480const MAX_REQUEST_BODY_SIZE: u32 = 64 * 1024 * 1024;
481const MAX_RESPONSE_BODY_SIZE: u32 = MAX_REQUEST_BODY_SIZE;
482
483/// This is where you store persistent data, or at least access to stateful
484/// data.
485pub struct RPCState<DB> {
486    pub keystore: Arc<RwLock<KeyStore>>,
487    pub state_manager: Arc<crate::state_manager::StateManager<DB>>,
488    pub mpool: Arc<crate::message_pool::MessagePool<crate::message_pool::MpoolRpcProvider<DB>>>,
489    pub bad_blocks: Option<Arc<crate::chain_sync::BadBlockCache>>,
490    pub msgs_in_tipset: Arc<crate::chain::store::MsgsInTipsetCache>,
491    pub sync_status: crate::chain_sync::SyncStatus,
492    pub eth_event_handler: Arc<EthEventHandler>,
493    pub sync_network_context: SyncNetworkContext<DB>,
494    pub tipset_send: flume::Sender<FullTipset>,
495    pub start_time: chrono::DateTime<chrono::Utc>,
496    pub snapshot_progress_tracker: SnapshotProgressTracker,
497    pub shutdown: mpsc::Sender<()>,
498}
499
500impl<DB: Blockstore> RPCState<DB> {
501    pub fn beacon(&self) -> &Arc<crate::beacon::BeaconSchedule> {
502        self.state_manager.beacon_schedule()
503    }
504
505    pub fn chain_store(&self) -> &Arc<crate::chain::ChainStore<DB>> {
506        self.state_manager.chain_store()
507    }
508
509    pub fn chain_index(&self) -> &Arc<crate::chain::index::ChainIndex<Arc<DB>>> {
510        self.chain_store().chain_index()
511    }
512
513    pub fn chain_config(&self) -> &Arc<crate::networks::ChainConfig> {
514        self.state_manager.chain_config()
515    }
516
517    pub fn store(&self) -> &Arc<DB> {
518        self.chain_store().blockstore()
519    }
520
521    pub fn store_owned(&self) -> Arc<DB> {
522        self.state_manager.blockstore_owned()
523    }
524
525    pub fn network_send(&self) -> &flume::Sender<crate::libp2p::NetworkMessage> {
526        self.sync_network_context.network_send()
527    }
528
529    pub fn get_snapshot_progress_tracker(&self) -> SnapshotProgressState {
530        self.snapshot_progress_tracker.state()
531    }
532}
533
534#[derive(Clone)]
535struct PerConnection<RpcMiddleware, HttpMiddleware> {
536    stop_handle: StopHandle,
537    svc_builder: TowerServiceBuilder<RpcMiddleware, HttpMiddleware>,
538    keystore: Arc<RwLock<KeyStore>>,
539}
540
541pub async fn start_rpc<DB>(
542    state: RPCState<DB>,
543    rpc_listener: tokio::net::TcpListener,
544    stop_handle: StopHandle,
545    filter_list: Option<FilterList>,
546) -> anyhow::Result<()>
547where
548    DB: Blockstore + Send + Sync + 'static,
549{
550    let filter_list = filter_list.unwrap_or_default();
551    // `Arc` is needed because we will share the state between two modules
552    let state = Arc::new(state);
553    let keystore = state.keystore.clone();
554    let mut modules = create_modules(state.clone());
555
556    let mut pubsub_module = FilRpcModule::default();
557    pubsub_module.register_channel("Filecoin.ChainNotify", {
558        let state_clone = state.clone();
559        move |params| chain::chain_notify(params, &state_clone)
560    })?;
561
562    for module in modules.values_mut() {
563        // register eth subscription APIs
564        module.merge(EthPubSub::new(state.clone()).into_rpc())?;
565        module.merge(pubsub_module.clone())?;
566    }
567
568    let methods: Arc<HashMap<ApiPaths, Methods>> =
569        Arc::new(modules.into_iter().map(|(k, v)| (k, v.into())).collect());
570
571    let per_conn = PerConnection {
572        stop_handle: stop_handle.clone(),
573        svc_builder: Server::builder()
574            .set_config(
575                ServerConfig::builder()
576                    // Default size (10 MiB) is not enough for methods like `Filecoin.StateMinerActiveSectors`
577                    .max_request_body_size(MAX_REQUEST_BODY_SIZE)
578                    .max_response_body_size(MAX_RESPONSE_BODY_SIZE)
579                    .max_connections(*DEFAULT_MAX_CONNECTIONS)
580                    .set_id_provider(RandomHexStringIdProvider::new())
581                    .build(),
582            )
583            .set_http_middleware(
584                tower::ServiceBuilder::new()
585                    .layer(CompressionLayer::new())
586                    // Mark the `Authorization` request header as sensitive so it doesn't show in logs
587                    .layer(SetSensitiveRequestHeadersLayer::new(std::iter::once(
588                        http::header::AUTHORIZATION,
589                    ))),
590            )
591            .to_service_builder(),
592        keystore,
593    };
594    tracing::info!("Ready for RPC connections");
595    loop {
596        let sock = tokio::select! {
597        res = rpc_listener.accept() => {
598            match res {
599              Ok((stream, _remote_addr)) => stream,
600              Err(e) => {
601                tracing::error!("failed to accept v4 connection: {:?}", e);
602                continue;
603              }
604            }
605          }
606          _ = per_conn.stop_handle.clone().shutdown() => break,
607        };
608
609        let svc = tower::service_fn({
610            let methods = methods.clone();
611            let per_conn = per_conn.clone();
612            let filter_list = filter_list.clone();
613            move |req| {
614                let is_websocket = jsonrpsee::server::ws::is_upgrade_request(&req);
615                let path = if let Ok(p) = ApiPaths::from_uri(req.uri()) {
616                    p
617                } else {
618                    return async move {
619                        Ok(http::Response::builder()
620                            .status(http::StatusCode::NOT_FOUND)
621                            .body(Default::default())
622                            .unwrap_or_else(|_| http::Response::new(Default::default())))
623                    }
624                    .boxed();
625                };
626                let methods = methods.get(&path).cloned().unwrap_or_default();
627                let PerConnection {
628                    stop_handle,
629                    svc_builder,
630                    keystore,
631                } = per_conn.clone();
632                // NOTE, the rpc middleware must be initialized here to be able to be created once per connection
633                // with data from the connection such as the headers in this example
634                let headers = req.headers().clone();
635                let rpc_middleware = RpcServiceBuilder::new()
636                    .layer(SetExtensionLayer { path })
637                    .layer(SegregationLayer)
638                    .layer(FilterLayer::new(filter_list.clone()))
639                    .layer(validation_layer::JsonValidationLayer)
640                    .layer(AuthLayer {
641                        headers,
642                        keystore: keystore.clone(),
643                    })
644                    .layer(LogLayer::default())
645                    .layer(MetricsLayer::default());
646                let mut jsonrpsee_svc = svc_builder
647                    .set_rpc_middleware(rpc_middleware)
648                    .build(methods, stop_handle);
649
650                if is_websocket {
651                    // Utilize the session close future to know when the actual WebSocket
652                    // session was closed.
653                    let session_close = jsonrpsee_svc.on_session_closed();
654
655                    // A little bit weird API but the response to HTTP request must be returned below
656                    // and we spawn a task to register when the session is closed.
657                    tokio::spawn(async move {
658                        session_close.await;
659                        tracing::trace!("Closed WebSocket connection");
660                    });
661
662                    async move {
663                        tracing::trace!("Opened WebSocket connection");
664                        // https://github.com/rust-lang/rust/issues/102211 the error type can't be inferred
665                        // to be `Box<dyn std::error::Error + Send + Sync>` so we need to convert it to a concrete type
666                        // as workaround.
667                        jsonrpsee_svc
668                            .call(req)
669                            .await
670                            .map_err(|e| anyhow::anyhow!("{:?}", e))
671                    }
672                    .boxed()
673                } else {
674                    // HTTP.
675                    async move {
676                        tracing::trace!("Opened HTTP connection");
677                        let rp = jsonrpsee_svc.call(req).await;
678                        tracing::trace!("Closed HTTP connection");
679                        // https://github.com/rust-lang/rust/issues/102211 the error type can't be inferred
680                        // to be `Box<dyn std::error::Error + Send + Sync>` so we need to convert it to a concrete type
681                        // as workaround.
682                        rp.map_err(|e| anyhow::anyhow!("{:?}", e))
683                    }
684                    .boxed()
685                }
686            }
687        });
688
689        tokio::spawn(jsonrpsee::server::serve_with_graceful_shutdown(
690            sock,
691            svc,
692            stop_handle.clone().shutdown(),
693        ));
694    }
695
696    Ok(())
697}
698
699fn create_modules<DB>(state: Arc<RPCState<DB>>) -> HashMap<ApiPaths, RpcModule<RPCState<DB>>>
700where
701    DB: Blockstore + Send + Sync + 'static,
702{
703    let mut modules = HashMap::default();
704    for api_version in ApiPaths::value_variants() {
705        modules.insert(*api_version, RpcModule::from_arc(state.clone()));
706    }
707    macro_rules! register {
708        ($ty:ty) => {
709            // Register only non-subscription RPC methods.
710            // Subscription methods are registered separately in the RPC module.
711            if !<$ty>::SUBSCRIPTION {
712                <$ty>::register(&mut modules, ParamStructure::ByPosition).unwrap();
713            }
714        };
715    }
716    for_each_rpc_method!(register);
717    modules
718}
719
720/// If `include` is not [`None`], only methods that are listed will be returned
721pub fn openrpc(path: ApiPaths, include: Option<&[&str]>) -> openrpc_types::OpenRPC {
722    use schemars::generate::{SchemaGenerator, SchemaSettings};
723
724    let mut methods = vec![];
725    // spec says draft07
726    let mut settings = SchemaSettings::draft07();
727    // ..but uses `components`
728    settings.definitions_path = "#/components/schemas/".into();
729    let mut generator = SchemaGenerator::new(settings);
730    macro_rules! callback {
731        ($ty:ty) => {
732            if <$ty>::API_PATHS.contains(path) {
733                match include {
734                    Some(include) => match include.contains(&<$ty>::NAME) {
735                        true => {
736                            methods.push(openrpc_types::ReferenceOr::Item(<$ty>::openrpc(
737                                &mut generator,
738                                ParamStructure::ByPosition,
739                                &<$ty>::NAME,
740                            )));
741                            if let Some(alias) = &<$ty>::NAME_ALIAS {
742                                methods.push(openrpc_types::ReferenceOr::Item(<$ty>::openrpc(
743                                    &mut generator,
744                                    ParamStructure::ByPosition,
745                                    &alias,
746                                )));
747                            }
748                        }
749                        false => {}
750                    },
751                    None => {
752                        methods.push(openrpc_types::ReferenceOr::Item(<$ty>::openrpc(
753                            &mut generator,
754                            ParamStructure::ByPosition,
755                            &<$ty>::NAME,
756                        )));
757                        if let Some(alias) = &<$ty>::NAME_ALIAS {
758                            methods.push(openrpc_types::ReferenceOr::Item(<$ty>::openrpc(
759                                &mut generator,
760                                ParamStructure::ByPosition,
761                                &alias,
762                            )));
763                        }
764                    }
765                }
766            }
767        };
768    }
769    for_each_rpc_method!(callback);
770    openrpc_types::OpenRPC {
771        methods,
772        components: Some(openrpc_types::Components {
773            schemas: Some(
774                generator
775                    .take_definitions(false)
776                    .into_iter()
777                    .filter_map(|(k, v)| {
778                        if let Ok(v) = Schema::try_from(v) {
779                            Some((k, v))
780                        } else {
781                            None
782                        }
783                    })
784                    .collect(),
785            ),
786            ..Default::default()
787        }),
788        openrpc: openrpc_types::OPEN_RPC_SPECIFICATION_VERSION,
789        info: openrpc_types::Info {
790            title: String::from("forest"),
791            version: env!("CARGO_PKG_VERSION").into(),
792            ..Default::default()
793        },
794        ..Default::default()
795    }
796}
797
798#[cfg(test)]
799mod tests {
800    use super::*;
801    use crate::{
802        db::MemoryDB, networks::NetworkChain, rpc::common::ShiftingVersion,
803        tool::offline_server::server::offline_rpc_state,
804    };
805    use jsonrpsee::server::stop_channel;
806    use std::net::{Ipv4Addr, SocketAddr};
807    use tokio::task::JoinSet;
808
809    // To update RPC specs:
810    // `cargo test --lib -- rpc::tests::openrpc`
811    // `cargo insta review`
812
813    #[test]
814    fn openrpc_v0() {
815        openrpc(ApiPaths::V0);
816    }
817
818    #[test]
819    fn openrpc_v1() {
820        openrpc(ApiPaths::V1);
821    }
822
823    #[test]
824    fn openrpc_v2() {
825        openrpc(ApiPaths::V2);
826    }
827
828    fn openrpc(path: ApiPaths) {
829        let spec = super::openrpc(path, None);
830        insta::assert_yaml_snapshot!(path.path(), spec);
831    }
832
833    #[tokio::test(flavor = "multi_thread")]
834    async fn test_rpc_server() {
835        let chain = NetworkChain::Calibnet;
836        let db = Arc::new(MemoryDB::default());
837        let mut services = JoinSet::new();
838        let (state, mut shutdown_recv) = offline_rpc_state(chain, db, None, None, &mut services)
839            .await
840            .unwrap();
841        let block_delay_secs = state.chain_config().block_delay_secs;
842        let shutdown_send = state.shutdown.clone();
843        let jwt_read_permissions = vec!["read".to_owned()];
844        let jwt_read = super::methods::auth::AuthNew::create_token(
845            &state.keystore.read(),
846            chrono::Duration::hours(1),
847            jwt_read_permissions.clone(),
848        )
849        .unwrap();
850        let rpc_listener =
851            tokio::net::TcpListener::bind(SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 0))
852                .await
853                .unwrap();
854        let rpc_address = rpc_listener.local_addr().unwrap();
855        let (stop_handle, server_handle) = stop_channel();
856
857        // Start an RPC server
858
859        let handle = tokio::spawn(start_rpc(state, rpc_listener, stop_handle, None));
860
861        // Send a few http requests
862
863        let client = Client::from_url(
864            format!("http://{}:{}/", rpc_address.ip(), rpc_address.port())
865                .parse()
866                .unwrap(),
867        );
868
869        let response = super::methods::common::Version::call(&client, ())
870            .await
871            .unwrap();
872        assert_eq!(
873            &response.version,
874            &*crate::utils::version::FOREST_VERSION_STRING
875        );
876        assert_eq!(response.block_delay, block_delay_secs);
877        assert_eq!(response.api_version, ShiftingVersion::new(2, 3, 0));
878
879        let response = super::methods::auth::AuthVerify::call(&client, (jwt_read.clone(),))
880            .await
881            .unwrap();
882        assert_eq!(response, jwt_read_permissions);
883
884        // Send a few websocket requests
885
886        let client = Client::from_url(
887            format!("ws://{}:{}/", rpc_address.ip(), rpc_address.port())
888                .parse()
889                .unwrap(),
890        );
891
892        let response = super::methods::auth::AuthVerify::call(&client, (jwt_read,))
893            .await
894            .unwrap();
895        assert_eq!(response, jwt_read_permissions);
896
897        // Explicitly drop the WebSocket client to close the connection
898        drop(client);
899
900        // Gracefully shutdown the RPC server
901        shutdown_send.send(()).await.unwrap();
902        shutdown_recv.recv().await;
903        server_handle.stop().unwrap();
904        handle.await.unwrap().unwrap();
905    }
906}
forest/rpc/mod.rs

forest/rpc/
mod.rs
