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

forest/rpc/
mod.rs
