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

forest/rpc/
mod.rs
