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

forest/rpc/
mod.rs
