diff --git a/src/rpc/methods/auth.rs b/src/rpc/methods/auth.rs index be2a2e66953..8374d918c42 100644 --- a/src/rpc/methods/auth.rs +++ b/src/rpc/methods/auth.rs @@ -30,6 +30,7 @@ impl AuthNew { impl RpcMethod<2> for AuthNew { const NAME: &'static str = "Filecoin.AuthNew"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.AuthNew` RPC method."); const N_REQUIRED_PARAMS: usize = 1; // Note: Lotus does not support the optional `expiration_secs` parameter const PARAM_NAMES: [&'static str; 2] = ["permissions", "expirationSecs"]; @@ -57,6 +58,7 @@ impl RpcMethod<2> for AuthNew { pub enum AuthVerify {} impl RpcMethod<1> for AuthVerify { const NAME: &'static str = "Filecoin.AuthVerify"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.AuthVerify` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["headerRaw"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/beacon.rs b/src/rpc/methods/beacon.rs index 9b47056f309..1c98515baa9 100644 --- a/src/rpc/methods/beacon.rs +++ b/src/rpc/methods/beacon.rs @@ -13,6 +13,8 @@ use enumflags2::{BitFlags, make_bitflags}; pub enum BeaconGetEntry {} impl RpcMethod<1> for BeaconGetEntry { const NAME: &'static str = "Filecoin.BeaconGetEntry"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.BeaconGetEntry` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["first"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // Not supported in V1 const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/chain.rs b/src/rpc/methods/chain.rs index 151885df1a0..84a91293cde 100644 --- a/src/rpc/methods/chain.rs +++ b/src/rpc/methods/chain.rs @@ -226,6 +226,10 @@ impl RpcMethod<1> for ChainGetParentReceipts { pub enum ChainGetMessagesInTipset {} impl RpcMethod<1> for ChainGetMessagesInTipset { const NAME: &'static str = "Filecoin.ChainGetMessagesInTipset"; + const DESCRIPTION: Option<&'static str> = Some( + "ChainGetMessagesInTipset returns message stores in current tipset +", + ); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -248,6 +252,7 @@ impl RpcMethod<1> for ChainGetMessagesInTipset { pub enum ChainPruneSnapshot {} impl RpcMethod<1> for ChainPruneSnapshot { const NAME: &'static str = "Forest.SnapshotGC"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Forest.SnapshotGC` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["blocking"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -273,6 +278,7 @@ impl RpcMethod<1> for ChainPruneSnapshot { pub enum ForestChainExport {} impl RpcMethod<1> for ForestChainExport { const NAME: &'static str = "Forest.ChainExport"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Forest.ChainExport` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -412,6 +418,8 @@ impl RpcMethod<1> for ForestChainExport { pub enum ForestChainExportStatus {} impl RpcMethod<0> for ForestChainExportStatus { const NAME: &'static str = "Forest.ChainExportStatus"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Forest.ChainExportStatus` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -456,6 +464,8 @@ impl RpcMethod<0> for ForestChainExportStatus { pub enum ForestChainExportCancel {} impl RpcMethod<0> for ForestChainExportCancel { const NAME: &'static str = "Forest.ChainExportCancel"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Forest.ChainExportCancel` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -480,6 +490,8 @@ impl RpcMethod<0> for ForestChainExportCancel { pub enum ForestChainExportDiff {} impl RpcMethod<1> for ForestChainExportDiff { const NAME: &'static str = "Forest.ChainExportDiff"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Forest.ChainExportDiff` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -539,6 +551,7 @@ impl RpcMethod<1> for ForestChainExportDiff { pub enum ChainExport {} impl RpcMethod<1> for ChainExport { const NAME: &'static str = "Filecoin.ChainExport"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.ChainExport` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -630,6 +643,12 @@ impl RpcMethod<1> for ChainHasObj { pub enum ChainStatObj {} impl RpcMethod<2> for ChainStatObj { const NAME: &'static str = "Filecoin.ChainStatObj"; + const DESCRIPTION: Option<&'static str> = Some( + "ChainStatObj returns statistics about the graph referenced by 'obj'. +If 'base' is also specified, then the returned stat will be a diff +between the two objects. +", + ); const PARAM_NAMES: [&'static str; 2] = ["objCid", "baseCid"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -859,6 +878,10 @@ impl RpcMethod<2> for ChainGetTipSetAfterHeight { pub enum ChainGetGenesis {} impl RpcMethod<0> for ChainGetGenesis { const NAME: &'static str = "Filecoin.ChainGetGenesis"; + const DESCRIPTION: Option<&'static str> = Some( + "ChainGetGenesis returns the genesis tipset. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1227,6 +1250,10 @@ impl RpcMethod<0> for ChainGetTipSetFinalityStatus { pub enum ChainSetHead {} impl RpcMethod<1> for ChainSetHead { const NAME: &'static str = "Filecoin.ChainSetHead"; + const DESCRIPTION: Option<&'static str> = Some( + "ChainSetHead forcefully sets current chain head. Use with caution. +", + ); const PARAM_NAMES: [&'static str; 1] = ["tsk"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -1260,6 +1287,8 @@ impl RpcMethod<1> for ChainSetHead { pub enum ChainGetMinBaseFee {} impl RpcMethod<1> for ChainGetMinBaseFee { const NAME: &'static str = "Forest.ChainGetMinBaseFee"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Forest.ChainGetMinBaseFee` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["lookback"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1314,6 +1343,8 @@ impl RpcMethod<1> for ChainTipSetWeight { pub enum ChainGetTipsetByParentState {} impl RpcMethod<1> for ChainGetTipsetByParentState { const NAME: &'static str = "Forest.ChainGetTipsetByParentState"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Forest.ChainGetTipsetByParentState` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["parentState"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/common.rs b/src/rpc/methods/common.rs index 5c1aee3e41a..a91e8580f67 100644 --- a/src/rpc/methods/common.rs +++ b/src/rpc/methods/common.rs @@ -16,6 +16,7 @@ static SESSION_UUID: LazyLock = LazyLock::new(crate::utils::rand::new_uuid pub enum Session {} impl RpcMethod<0> for Session { const NAME: &'static str = "Filecoin.Session"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.Session` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -31,6 +32,7 @@ impl RpcMethod<0> for Session { pub enum Version {} impl RpcMethod<0> for Version { const NAME: &'static str = "Filecoin.Version"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.Version` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -57,6 +59,7 @@ impl RpcMethod<0> for Version { pub enum Shutdown {} impl RpcMethod<0> for Shutdown { const NAME: &'static str = "Filecoin.Shutdown"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.Shutdown` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -77,6 +80,7 @@ impl RpcMethod<0> for Shutdown { pub enum StartTime {} impl RpcMethod<0> for StartTime { const NAME: &'static str = "Filecoin.StartTime"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.StartTime` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/eth.rs b/src/rpc/methods/eth.rs index c8cac3138e1..f8c3739d103 100644 --- a/src/rpc/methods/eth.rs +++ b/src/rpc/methods/eth.rs @@ -778,6 +778,10 @@ pub enum Web3ClientVersion {} impl RpcMethod<0> for Web3ClientVersion { const NAME: &'static str = "Filecoin.Web3ClientVersion"; const NAME_ALIAS: Option<&'static str> = Some("web3_clientVersion"); + const DESCRIPTION: Option<&'static str> = Some( + "Returns the client version +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -807,6 +811,10 @@ pub enum EthAccounts {} impl RpcMethod<0> for EthAccounts { const NAME: &'static str = "Filecoin.EthAccounts"; const NAME_ALIAS: Option<&'static str> = Some("eth_accounts"); + const DESCRIPTION: Option<&'static str> = Some( + "EthAccounts will always return [] since we don't expect Lotus to manage private keys +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -897,6 +905,10 @@ pub enum EthBlockNumber {} impl RpcMethod<0> for EthBlockNumber { const NAME: &'static str = "Filecoin.EthBlockNumber"; const NAME_ALIAS: Option<&'static str> = Some("eth_blockNumber"); + const DESCRIPTION: Option<&'static str> = Some( + "EthBlockNumber returns the height of the latest (heaviest) TipSet +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -933,6 +945,7 @@ pub enum EthChainId {} impl RpcMethod<0> for EthChainId { const NAME: &'static str = "Filecoin.EthChainId"; const NAME_ALIAS: Option<&'static str> = Some("eth_chainId"); + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.EthChainId` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1446,6 +1459,8 @@ pub enum EthGetBlockByHash {} impl RpcMethod<2> for EthGetBlockByHash { const NAME: &'static str = "Filecoin.EthGetBlockByHash"; const NAME_ALIAS: Option<&'static str> = Some("eth_getBlockByHash"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetBlockByHash` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["blockHash", "fullTxInfo"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1611,6 +1626,10 @@ pub enum EthGetBlockTransactionCountByHash {} impl RpcMethod<1> for EthGetBlockTransactionCountByHash { const NAME: &'static str = "Filecoin.EthGetBlockTransactionCountByHash"; const NAME_ALIAS: Option<&'static str> = Some("eth_getBlockTransactionCountByHash"); + const DESCRIPTION: Option<&'static str> = Some( + "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet +", + ); const PARAM_NAMES: [&'static str; 1] = ["blockHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1666,6 +1685,8 @@ pub enum EthGetMessageCidByTransactionHash {} impl RpcMethod<1> for EthGetMessageCidByTransactionHash { const NAME: &'static str = "Filecoin.EthGetMessageCidByTransactionHash"; const NAME_ALIAS: Option<&'static str> = Some("eth_getMessageCidByTransactionHash"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1727,6 +1748,7 @@ pub enum EthSyncing {} impl RpcMethod<0> for EthSyncing { const NAME: &'static str = "Filecoin.EthSyncing"; const NAME_ALIAS: Option<&'static str> = Some("eth_syncing"); + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.EthSyncing` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1773,6 +1795,8 @@ pub enum EthEstimateGas {} impl RpcMethod<2> for EthEstimateGas { const NAME: &'static str = "Filecoin.EthEstimateGas"; const NAME_ALIAS: Option<&'static str> = Some("eth_estimateGas"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthEstimateGas` RPC method."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 2] = ["tx", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -1981,6 +2005,8 @@ pub enum EthFeeHistory {} impl RpcMethod<3> for EthFeeHistory { const NAME: &'static str = "Filecoin.EthFeeHistory"; const NAME_ALIAS: Option<&'static str> = Some("eth_feeHistory"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthFeeHistory` RPC method."); const N_REQUIRED_PARAMS: usize = 2; const PARAM_NAMES: [&'static str; 3] = ["blockCount", "newestBlockNumber", "rewardPercentiles"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2312,6 +2338,8 @@ pub enum EthGetTransactionCount {} impl RpcMethod<2> for EthGetTransactionCount { const NAME: &'static str = "Filecoin.EthGetTransactionCount"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionCount"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionCount` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["sender", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2368,6 +2396,8 @@ pub enum EthMaxPriorityFeePerGas {} impl RpcMethod<0> for EthMaxPriorityFeePerGas { const NAME: &'static str = "Filecoin.EthMaxPriorityFeePerGas"; const NAME_ALIAS: Option<&'static str> = Some("eth_maxPriorityFeePerGas"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2391,6 +2421,8 @@ pub enum EthProtocolVersion {} impl RpcMethod<0> for EthProtocolVersion { const NAME: &'static str = "Filecoin.EthProtocolVersion"; const NAME_ALIAS: Option<&'static str> = Some("eth_protocolVersion"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthProtocolVersion` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2463,6 +2495,8 @@ pub enum EthGetTransactionByBlockHashAndIndex {} impl RpcMethod<2> for EthGetTransactionByBlockHashAndIndex { const NAME: &'static str = "Filecoin.EthGetTransactionByBlockHashAndIndex"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionByBlockHashAndIndex"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["blockHash", "txIndex"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2507,6 +2541,8 @@ pub enum EthGetTransactionByHash {} impl RpcMethod<1> for EthGetTransactionByHash { const NAME: &'static str = "Filecoin.EthGetTransactionByHash"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionByHash"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionByHash` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2527,6 +2563,8 @@ pub enum EthGetTransactionByHashLimited {} impl RpcMethod<2> for EthGetTransactionByHashLimited { const NAME: &'static str = "Filecoin.EthGetTransactionByHashLimited"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionByHashLimited"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["txHash", "limit"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2629,6 +2667,8 @@ impl EthGetTransactionHashByCid { impl RpcMethod<1> for EthGetTransactionHashByCid { const NAME: &'static str = "Filecoin.EthGetTransactionHashByCid"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionHashByCid"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionHashByCid` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["cid"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2649,6 +2689,7 @@ pub enum EthCall {} impl RpcMethod<2> for EthCall { const NAME: &'static str = "Filecoin.EthCall"; const NAME_ALIAS: Option<&'static str> = Some("eth_call"); + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.EthCall` RPC method."); const N_REQUIRED_PARAMS: usize = 2; const PARAM_NAMES: [&'static str; 2] = ["tx", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2690,6 +2731,10 @@ pub enum EthNewFilter {} impl RpcMethod<1> for EthNewFilter { const NAME: &'static str = "Filecoin.EthNewFilter"; const NAME_ALIAS: Option<&'static str> = Some("eth_newFilter"); + const DESCRIPTION: Option<&'static str> = Some( + "Installs a persistent filter based on given filter spec. +", + ); const PARAM_NAMES: [&'static str; 1] = ["filterSpec"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2712,6 +2757,10 @@ pub enum EthNewPendingTransactionFilter {} impl RpcMethod<0> for EthNewPendingTransactionFilter { const NAME: &'static str = "Filecoin.EthNewPendingTransactionFilter"; const NAME_ALIAS: Option<&'static str> = Some("eth_newPendingTransactionFilter"); + const DESCRIPTION: Option<&'static str> = Some( + "Installs a persistent filter to notify when new messages arrive in the message pool. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2733,6 +2782,10 @@ pub enum EthNewBlockFilter {} impl RpcMethod<0> for EthNewBlockFilter { const NAME: &'static str = "Filecoin.EthNewBlockFilter"; const NAME_ALIAS: Option<&'static str> = Some("eth_newBlockFilter"); + const DESCRIPTION: Option<&'static str> = Some( + "Installs a persistent filter to notify when a new block arrives. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2755,6 +2808,10 @@ pub enum EthUninstallFilter {} impl RpcMethod<1> for EthUninstallFilter { const NAME: &'static str = "Filecoin.EthUninstallFilter"; const NAME_ALIAS: Option<&'static str> = Some("eth_uninstallFilter"); + const DESCRIPTION: Option<&'static str> = Some( + "Uninstalls a filter with given id. +", + ); const PARAM_NAMES: [&'static str; 1] = ["filterId"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2777,6 +2834,10 @@ pub enum EthUnsubscribe {} impl RpcMethod<0> for EthUnsubscribe { const NAME: &'static str = "Filecoin.EthUnsubscribe"; const NAME_ALIAS: Option<&'static str> = Some("eth_unsubscribe"); + const DESCRIPTION: Option<&'static str> = Some( + "Unsubscribe from a websocket subscription +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2803,6 +2864,16 @@ pub enum EthSubscribe {} impl RpcMethod<0> for EthSubscribe { const NAME: &'static str = "Filecoin.EthSubscribe"; const NAME_ALIAS: Option<&'static str> = Some("eth_subscribe"); + const DESCRIPTION: Option<&'static str> = Some( + "Subscribe to different event types using websockets +eventTypes is one or more of: + - newHeads: notify when new blocks arrive. + - pendingTransactions: notify when new messages arrive in the message pool. + - logs: notify new event logs that match a criteria +params contains additional parameters used with the log event type +The client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2944,6 +3015,8 @@ pub enum EthGetTransactionReceipt {} impl RpcMethod<1> for EthGetTransactionReceipt { const NAME: &'static str = "Filecoin.EthGetTransactionReceipt"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionReceipt"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionReceipt` RPC method."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2963,6 +3036,8 @@ pub enum EthGetTransactionReceiptLimited {} impl RpcMethod<2> for EthGetTransactionReceiptLimited { const NAME: &'static str = "Filecoin.EthGetTransactionReceiptLimited"; const NAME_ALIAS: Option<&'static str> = Some("eth_getTransactionReceiptLimited"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 2] = ["txHash", "limit"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2982,6 +3057,8 @@ pub enum EthSendRawTransaction {} impl RpcMethod<1> for EthSendRawTransaction { const NAME: &'static str = "Filecoin.EthSendRawTransaction"; const NAME_ALIAS: Option<&'static str> = Some("eth_sendRawTransaction"); + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.EthSendRawTransaction` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["rawTx"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -3005,6 +3082,9 @@ pub enum EthSendRawTransactionUntrusted {} impl RpcMethod<1> for EthSendRawTransactionUntrusted { const NAME: &'static str = "Filecoin.EthSendRawTransactionUntrusted"; const NAME_ALIAS: Option<&'static str> = Some("eth_sendRawTransactionUntrusted"); + const DESCRIPTION: Option<&'static str> = Some( + "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message.", + ); const PARAM_NAMES: [&'static str; 1] = ["rawTx"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -3265,6 +3345,10 @@ pub enum EthGetLogs {} impl RpcMethod<1> for EthGetLogs { const NAME: &'static str = "Filecoin.EthGetLogs"; const NAME_ALIAS: Option<&'static str> = Some("eth_getLogs"); + const DESCRIPTION: Option<&'static str> = Some( + "Returns event logs matching given filter spec. +", + ); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 1] = ["ethFilter"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -3301,6 +3385,11 @@ pub enum EthGetFilterLogs {} impl RpcMethod<1> for EthGetFilterLogs { const NAME: &'static str = "Filecoin.EthGetFilterLogs"; const NAME_ALIAS: Option<&'static str> = Some("eth_getFilterLogs"); + const DESCRIPTION: Option<&'static str> = Some( + "Returns event logs matching filter with given id. +(requires write perm since timestamp of last filter execution will be written) +", + ); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 1] = ["filterId"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); diff --git a/src/rpc/methods/f3.rs b/src/rpc/methods/f3.rs index 4622adc3e78..010549b0526 100644 --- a/src/rpc/methods/f3.rs +++ b/src/rpc/methods/f3.rs @@ -57,6 +57,7 @@ pub enum GetRawNetworkName {} impl RpcMethod<0> for GetRawNetworkName { const NAME: &'static str = "F3.GetRawNetworkName"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetRawNetworkName` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -82,6 +83,7 @@ impl RpcMethod<0> for GetRawNetworkName { pub enum GetTipsetByEpoch {} impl RpcMethod<1> for GetTipsetByEpoch { const NAME: &'static str = "F3.GetTipsetByEpoch"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetTipsetByEpoch` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["epoch"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -106,6 +108,7 @@ impl RpcMethod<1> for GetTipsetByEpoch { pub enum GetTipset {} impl RpcMethod<1> for GetTipset { const NAME: &'static str = "F3.GetTipset"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetTipset` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -127,6 +130,7 @@ impl RpcMethod<1> for GetTipset { pub enum GetHead {} impl RpcMethod<0> for GetHead { const NAME: &'static str = "F3.GetHead"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetHead` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -146,6 +150,7 @@ impl RpcMethod<0> for GetHead { pub enum GetParent {} impl RpcMethod<1> for GetParent { const NAME: &'static str = "F3.GetParent"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetParent` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -435,6 +440,7 @@ impl GetPowerTable { impl RpcMethod<1> for GetPowerTable { const NAME: &'static str = "F3.GetPowerTable"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.GetPowerTable` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -459,6 +465,7 @@ impl RpcMethod<1> for GetPowerTable { pub enum ProtectPeer {} impl RpcMethod<1> for ProtectPeer { const NAME: &'static str = "F3.ProtectPeer"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.ProtectPeer` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["peerId"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -487,6 +494,8 @@ pub enum GetParticipatingMinerIDs {} impl RpcMethod<0> for GetParticipatingMinerIDs { const NAME: &'static str = "F3.GetParticipatingMinerIDs"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `F3.GetParticipatingMinerIDs` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -511,6 +520,7 @@ impl RpcMethod<0> for GetParticipatingMinerIDs { pub enum Finalize {} impl RpcMethod<1> for Finalize { const NAME: &'static str = "F3.Finalize"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.Finalize` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -591,6 +601,7 @@ impl RpcMethod<1> for Finalize { pub enum SignMessage {} impl RpcMethod<2> for SignMessage { const NAME: &'static str = "F3.SignMessage"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `F3.SignMessage` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["pubkey", "message"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; @@ -647,6 +658,10 @@ impl RpcMethod<1> for F3ExportLatestSnapshot { pub enum F3GetCertificate {} impl RpcMethod<1> for F3GetCertificate { const NAME: &'static str = "Filecoin.F3GetCertificate"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetCertificate returns a finality certificate at given instance. +", + ); const PARAM_NAMES: [&'static str; 1] = ["instance"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -683,6 +698,10 @@ impl F3GetLatestCertificate { impl RpcMethod<0> for F3GetLatestCertificate { const NAME: &'static str = "Filecoin.F3GetLatestCertificate"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetLatestCertificate returns the latest finality certificate. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -702,6 +721,10 @@ impl RpcMethod<0> for F3GetLatestCertificate { pub enum F3GetECPowerTable {} impl RpcMethod<1> for F3GetECPowerTable { const NAME: &'static str = "Filecoin.F3GetECPowerTable"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetECPowerTable returns a F3 specific power table for use in standalone F3 nodes. +", + ); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -722,6 +745,10 @@ impl RpcMethod<1> for F3GetECPowerTable { pub enum F3GetF3PowerTable {} impl RpcMethod<1> for F3GetF3PowerTable { const NAME: &'static str = "Filecoin.F3GetF3PowerTable"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetF3PowerTable returns a F3 specific power table. +", + ); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -782,6 +809,11 @@ impl F3IsRunning { impl RpcMethod<0> for F3IsRunning { const NAME: &'static str = "Filecoin.F3IsRunning"; + const DESCRIPTION: Option<&'static str> = Some( + "F3IsRunning returns true if the F3 instance is running, false if it's not running but +it's enabled, and an error when disabled entirely. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -812,6 +844,9 @@ impl F3GetProgress { impl RpcMethod<0> for F3GetProgress { const NAME: &'static str = "Filecoin.F3GetProgress"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetProgress returns the progress of the current F3 instance in terms of instance ID, round and phase.", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -842,6 +877,10 @@ impl F3GetManifest { impl RpcMethod<0> for F3GetManifest { const NAME: &'static str = "Filecoin.F3GetManifest"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetManifest returns the current manifest being used for F3 operations. +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -862,6 +901,9 @@ impl RpcMethod<0> for F3GetManifest { pub enum F3ListParticipants {} impl RpcMethod<0> for F3ListParticipants { const NAME: &'static str = "Filecoin.F3ListParticipants"; + const DESCRIPTION: Option<&'static str> = Some( + "F3ListParticipants returns the list of miners that are currently participating in F3 via this node.", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -896,6 +938,28 @@ impl F3ListParticipants { pub enum F3GetOrRenewParticipationTicket {} impl RpcMethod<3> for F3GetOrRenewParticipationTicket { const NAME: &'static str = "Filecoin.F3GetOrRenewParticipationTicket"; + const DESCRIPTION: Option<&'static str> = Some( + "F3GetOrRenewParticipationTicket retrieves or renews a participation ticket +necessary for a miner to engage in the F3 consensus process for the given +number of instances. + +This function accepts an optional previous ticket. If provided, a new ticket +will be issued only under one the following conditions: + 1. The previous ticket has expired. + 2. The issuer of the previous ticket matches the node processing this + request. + +If there is an issuer mismatch (ErrF3ParticipationIssuerMismatch), the miner +must retry obtaining a new ticket to ensure it is only participating in one F3 +instance at any time. The number of instances must be at least 1. If the +number of instances is beyond the maximum leasable participation instances +accepted by the node ErrF3ParticipationTooManyInstances is returned. + +Note: Successfully acquiring a ticket alone does not constitute participation. +The retrieved ticket must be used to invoke F3Participate to actively engage +in the F3 consensus process. +", + ); const PARAM_NAMES: [&'static str; 3] = ["minerAddress", "previousLeaseTicket", "instances"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; @@ -932,6 +996,28 @@ impl RpcMethod<3> for F3GetOrRenewParticipationTicket { pub enum F3Participate {} impl RpcMethod<1> for F3Participate { const NAME: &'static str = "Filecoin.F3Participate"; + const DESCRIPTION: Option<&'static str> = Some( + "F3Participate enrolls a storage provider in the F3 consensus process using a +provided participation ticket. This ticket grants a temporary lease that enables +the provider to sign transactions as part of the F3 consensus. + +The function verifies the ticket's validity and checks if the ticket's issuer +aligns with the current node. If there is an issuer mismatch +(ErrF3ParticipationIssuerMismatch), the provider should retry with the same +ticket, assuming the issue is due to transient network problems or operational +deployment conditions. If the ticket is invalid +(ErrF3ParticipationTicketInvalid) or has expired +(ErrF3ParticipationTicketExpired), the provider must obtain a new ticket by +calling F3GetOrRenewParticipationTicket. + +The start instance associated to the given ticket cannot be less than the +start instance of any existing lease held by the miner. Otherwise, +ErrF3ParticipationTicketStartBeforeExisting is returned. In this case, the +miner should acquire a new ticket before attempting to participate again. + +For details on obtaining or renewing a ticket, see F3GetOrRenewParticipationTicket. +", + ); const PARAM_NAMES: [&'static str; 1] = ["leaseTicket"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; diff --git a/src/rpc/methods/market.rs b/src/rpc/methods/market.rs index 4bb936d4cf2..52834accea5 100644 --- a/src/rpc/methods/market.rs +++ b/src/rpc/methods/market.rs @@ -15,6 +15,10 @@ const METHOD_ADD_BALANCE: MethodNum = 2; pub enum MarketAddBalance {} impl RpcMethod<3> for MarketAddBalance { const NAME: &'static str = "Filecoin.MarketAddBalance"; + const DESCRIPTION: Option<&'static str> = Some( + "MarketAddBalance adds funds to the market actor +", + ); const PARAM_NAMES: [&'static str; 3] = ["wallet", "address", "amount"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; diff --git a/src/rpc/methods/msig.rs b/src/rpc/methods/msig.rs index e1c46b01cf5..31651261b2d 100644 --- a/src/rpc/methods/msig.rs +++ b/src/rpc/methods/msig.rs @@ -15,6 +15,9 @@ pub enum MsigGetAvailableBalance {} impl RpcMethod<2> for MsigGetAvailableBalance { const NAME: &'static str = "Filecoin.MsigGetAvailableBalance"; + const DESCRIPTION: Option<&'static str> = Some( + "MsigGetAvailableBalance returns the portion of a multisig's balance that can be withdrawn or spent", + ); const PARAM_NAMES: [&'static str; 2] = ["address", "tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -44,6 +47,12 @@ pub enum MsigGetPending {} impl RpcMethod<2> for MsigGetPending { const NAME: &'static str = "Filecoin.MsigGetPending"; + const DESCRIPTION: Option<&'static str> = Some( + "MsigGetPending returns pending transactions for the given multisig +wallet. Once pending transactions are fully approved, they will no longer +appear here. +", + ); const PARAM_NAMES: [&'static str; 2] = ["address", "tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -79,6 +88,11 @@ impl RpcMethod<2> for MsigGetPending { pub enum MsigGetVested {} impl RpcMethod<3> for MsigGetVested { const NAME: &'static str = "Filecoin.MsigGetVested"; + const DESCRIPTION: Option<&'static str> = Some( + "MsigGetVested returns the amount of FIL that vested in a multisig in a certain period. +It takes the following params: , , +", + ); const PARAM_NAMES: [&'static str; 3] = ["address", "startTipsetKey", "endTipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -119,6 +133,10 @@ impl RpcMethod<3> for MsigGetVested { pub enum MsigGetVestingSchedule {} impl RpcMethod<2> for MsigGetVestingSchedule { const NAME: &'static str = "Filecoin.MsigGetVestingSchedule"; + const DESCRIPTION: Option<&'static str> = Some( + "MsigGetVestingSchedule returns the vesting details of a given multisig. +", + ); const PARAM_NAMES: [&'static str; 2] = ["address", "tsk"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/net.rs b/src/rpc/methods/net.rs index 8c027be21c8..21104563c71 100644 --- a/src/rpc/methods/net.rs +++ b/src/rpc/methods/net.rs @@ -83,6 +83,7 @@ impl RpcMethod<0> for NetPeers { pub enum NetFindPeer {} impl RpcMethod<1> for NetFindPeer { const NAME: &'static str = "Filecoin.NetFindPeer"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.NetFindPeer` RPC method."); const PARAM_NAMES: [&'static str; 1] = ["peerId"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -117,6 +118,7 @@ impl RpcMethod<0> for NetListening { const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; const NAME_ALIAS: Option<&'static str> = Some("net_listening"); + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.NetListening` RPC method."); type Params = (); type Ok = bool; @@ -133,6 +135,7 @@ impl RpcMethod<0> for NetListening { pub enum NetInfo {} impl RpcMethod<0> for NetInfo { const NAME: &'static str = "Forest.NetInfo"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Forest.NetInfo` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -250,6 +253,8 @@ impl RpcMethod<1> for NetAgentVersion { pub enum NetAutoNatStatus {} impl RpcMethod<0> for NetAutoNatStatus { const NAME: &'static str = "Filecoin.NetAutoNatStatus"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.NetAutoNatStatus` RPC method."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -279,6 +284,7 @@ impl RpcMethod<0> for NetVersion { const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; const NAME_ALIAS: Option<&'static str> = Some("net_version"); + const DESCRIPTION: Option<&'static str> = Some("Calls the `Filecoin.NetVersion` RPC method."); type Params = (); type Ok = Arc; diff --git a/src/rpc/methods/node.rs b/src/rpc/methods/node.rs index f406cf666ee..fa094f7bf9e 100644 --- a/src/rpc/methods/node.rs +++ b/src/rpc/methods/node.rs @@ -14,6 +14,8 @@ use serde::{Deserialize, Serialize}; pub enum NodeStatus {} impl RpcMethod<0> for NodeStatus { const NAME: &'static str = "Filecoin.NodeStatus"; + const DESCRIPTION: Option<&'static str> = + Some("Returns sync, peer, and chain status information for the node."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/state.rs b/src/rpc/methods/state.rs index 0fea4d84ffc..b5efd17730c 100644 --- a/src/rpc/methods/state.rs +++ b/src/rpc/methods/state.rs @@ -160,6 +160,10 @@ impl RpcMethod<2> for StateReplay { pub enum StateNetworkName {} impl RpcMethod<0> for StateNetworkName { const NAME: &'static str = "Filecoin.StateNetworkName"; + const DESCRIPTION: Option<&'static str> = Some( + "StateNetworkName returns the name of the network the node is synced to +", + ); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1197,6 +1201,8 @@ pub enum StateGetReceipt {} impl RpcMethod<2> for StateGetReceipt { const NAME: &'static str = "Filecoin.StateGetReceipt"; + const DESCRIPTION: Option<&'static str> = + Some("Calls the `Filecoin.StateGetReceipt` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["cid", "tipsetKey"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // deprecated in V1 const PERMISSION: Permission = Permission::Read; @@ -1222,6 +1228,27 @@ pub enum StateWaitMsgV0 {} impl RpcMethod<2> for StateWaitMsgV0 { const NAME: &'static str = "Filecoin.StateWaitMsg"; + const DESCRIPTION: Option<&'static str> = Some( + "StateWaitMsg looks back up to limit epochs in the chain for a message. +If not found, it blocks until the message arrives on chain, and gets to the +indicated confidence depth. + +NOTE: If a replacing message is found on chain, this method will return +a MsgLookup for the replacing message - the MsgLookup.Message will be a different +CID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the +result of the execution of the replacing message. + +If the caller wants to ensure that exactly the requested message was executed, +they must check that MsgLookup.Message is equal to the provided 'cid', or set the +`allowReplaced` parameter to false. Without this check, and with `allowReplaced` +set to true, both the requested and original message may appear as +successfully executed on-chain, which may look like a double-spend. + +A replacing message is a message with a different CID, any of Gas values, and +different signature, but with all other parameters matching (source/destination, +nonce, params, etc.) +", + ); const PARAM_NAMES: [&'static str; 2] = ["messageCid", "confidence"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // Changed in V1 const PERMISSION: Permission = Permission::Read; @@ -1398,6 +1425,7 @@ pub enum StateFetchRoot {} impl RpcMethod<2> for StateFetchRoot { const NAME: &'static str = "Forest.StateFetchRoot"; + const DESCRIPTION: Option<&'static str> = Some("Calls the `Forest.StateFetchRoot` RPC method."); const PARAM_NAMES: [&'static str; 2] = ["rootCid", "saveToFile"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -2203,6 +2231,9 @@ pub enum StateSectorPreCommitInfoV0 {} impl RpcMethod<3> for StateSectorPreCommitInfoV0 { const NAME: &'static str = "Filecoin.StateSectorPreCommitInfo"; + const DESCRIPTION: Option<&'static str> = Some( + "StateSectorPreCommitInfo returns the PreCommit info for the specified miner's sector. Returns nil and no error if the sector isn't precommitted. Note that the sector number may be allocated while PreCommitInfo is nil. This means that either allocated sector numbers were compacted, and the sector number was marked as allocated in order to reduce size of the allocated sectors bitfield, or that the sector was precommitted, but the precommit has expired.", + ); const PARAM_NAMES: [&'static str; 3] = ["minerAddress", "sectorNumber", "tipsetKey"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // Changed in V1 const PERMISSION: Permission = Permission::Read; @@ -3308,6 +3339,15 @@ impl TryFrom<&ChainConfig> for ForkUpgradeParams { pub enum StateMinerInitialPledgeForSector {} impl RpcMethod<4> for StateMinerInitialPledgeForSector { const NAME: &'static str = "Filecoin.StateMinerInitialPledgeForSector"; + const DESCRIPTION: Option<&'static str> = Some( + "StateMinerInitialPledgeForSector returns the initial pledge collateral for a given sector +duration, size, and combined size of any verified pieces within the sector. This calculation +depends on current network conditions (total power, total pledge and current rewards) at the +given tipset. +Note: The value returned is overestimated by 10% (multiplied by 110/100). +See: node/impl/full/state.go StateMinerInitialPledgeForSector implementation. +", + ); const PARAM_NAMES: [&'static str; 4] = [ "sector_duration", "sector_size", diff --git a/src/rpc/methods/sync.rs b/src/rpc/methods/sync.rs index 4d6075d69ca..cd39e23598b 100644 --- a/src/rpc/methods/sync.rs +++ b/src/rpc/methods/sync.rs @@ -17,6 +17,11 @@ pub use types::*; pub enum SyncCheckBad {} impl RpcMethod<1> for SyncCheckBad { const NAME: &'static str = "Filecoin.SyncCheckBad"; + const DESCRIPTION: Option<&'static str> = Some( + "SyncCheckBad checks if a block was marked as bad, and if it was, returns +the reason. +", + ); const PARAM_NAMES: [&'static str; 1] = ["cid"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -42,6 +47,11 @@ impl RpcMethod<1> for SyncCheckBad { pub enum SyncMarkBad {} impl RpcMethod<1> for SyncMarkBad { const NAME: &'static str = "Filecoin.SyncMarkBad"; + const DESCRIPTION: Option<&'static str> = Some( + "SyncMarkBad marks a blocks as bad, meaning that it won't ever by synced. +Use with extreme caution. +", + ); const PARAM_NAMES: [&'static str; 1] = ["cid"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; diff --git a/src/rpc/methods/wallet.rs b/src/rpc/methods/wallet.rs index 1abf423449e..afa1c793354 100644 --- a/src/rpc/methods/wallet.rs +++ b/src/rpc/methods/wallet.rs @@ -42,6 +42,8 @@ impl RpcMethod<1> for WalletBalance { pub enum WalletDefaultAddress {} impl RpcMethod<0> for WalletDefaultAddress { const NAME: &'static str = "Filecoin.WalletDefaultAddress"; + const DESCRIPTION: Option<&'static str> = + Some("WalletDefaultAddress returns the address marked as default in the wallet."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -62,6 +64,8 @@ impl RpcMethod<0> for WalletDefaultAddress { pub enum WalletExport {} impl RpcMethod<1> for WalletExport { const NAME: &'static str = "Filecoin.WalletExport"; + const DESCRIPTION: Option<&'static str> = + Some("WalletExport returns the private key of an address in the wallet."); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -105,6 +109,9 @@ impl RpcMethod<1> for WalletHas { pub enum WalletImport {} impl RpcMethod<1> for WalletImport { const NAME: &'static str = "Filecoin.WalletImport"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletImport receives a KeyInfo, which includes a private key, and imports it into the wallet.", + ); const PARAM_NAMES: [&'static str; 1] = ["key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -149,6 +156,12 @@ impl RpcMethod<0> for WalletList { pub enum WalletNew {} impl RpcMethod<1> for WalletNew { const NAME: &'static str = "Filecoin.WalletNew"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletNew creates a new address in the wallet with the given sigType. +Available key types: bls, secp256k1, secp256k1-ledger +Support for numerical types: 1 - secp256k1, 2 - BLS is deprecated +", + ); const PARAM_NAMES: [&'static str; 1] = ["signatureType"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -177,6 +190,10 @@ impl RpcMethod<1> for WalletNew { pub enum WalletSetDefault {} impl RpcMethod<1> for WalletSetDefault { const NAME: &'static str = "Filecoin.WalletSetDefault"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletSetDefault marks the given address as the default one. +", + ); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -263,6 +280,9 @@ impl RpcMethod<2> for WalletSignMessage { pub enum WalletValidateAddress {} impl RpcMethod<1> for WalletValidateAddress { const NAME: &'static str = "Filecoin.WalletValidateAddress"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletValidateAddress validates whether a given string can be decoded as a well-formed address", + ); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -282,6 +302,9 @@ impl RpcMethod<1> for WalletValidateAddress { pub enum WalletVerify {} impl RpcMethod<3> for WalletVerify { const NAME: &'static str = "Filecoin.WalletVerify"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid. The address does not have to be in the wallet.", + ); const PARAM_NAMES: [&'static str; 3] = ["address", "message", "signature"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -301,6 +324,10 @@ impl RpcMethod<3> for WalletVerify { pub enum WalletDelete {} impl RpcMethod<1> for WalletDelete { const NAME: &'static str = "Filecoin.WalletDelete"; + const DESCRIPTION: Option<&'static str> = Some( + "WalletDelete deletes an address from the wallet. +", + ); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap index 9e4e3904594..43c49a77d7d 100644 --- a/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v0.snap @@ -8,6 +8,7 @@ info: version: 0.33.6 methods: - name: Filecoin.AuthNew + description: "Calls the `Filecoin.AuthNew` RPC method." params: - name: permissions required: true @@ -31,6 +32,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.AuthVerify + description: "Calls the `Filecoin.AuthVerify` RPC method." params: - name: headerRaw required: true @@ -47,6 +49,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.BeaconGetEntry + description: "Calls the `Filecoin.BeaconGetEntry` RPC method." params: - name: first required: true @@ -60,6 +63,7 @@ methods: $ref: "#/components/schemas/BeaconEntry" paramStructure: by-position - name: Forest.SnapshotGC + description: "Calls the `Forest.SnapshotGC` RPC method." params: - name: blocking required: true @@ -72,6 +76,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.ChainExport + description: "Calls the `Filecoin.ChainExport` RPC method." params: - name: params required: true @@ -127,6 +132,7 @@ methods: $ref: "#/components/schemas/Event" paramStructure: by-position - name: Filecoin.ChainGetGenesis + description: "ChainGetGenesis returns the genesis tipset.\n" params: [] result: name: Filecoin.ChainGetGenesis.Result @@ -150,6 +156,7 @@ methods: $ref: "#/components/schemas/Message" paramStructure: by-position - name: Filecoin.ChainGetMessagesInTipset + description: "ChainGetMessagesInTipset returns message stores in current tipset\n" params: - name: tipsetKey required: true @@ -170,6 +177,7 @@ methods: $ref: "#/components/schemas/ApiMessage" paramStructure: by-position - name: Forest.ChainGetMinBaseFee + description: "Calls the `Forest.ChainGetMinBaseFee` RPC method." params: - name: lookback required: true @@ -335,6 +343,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.ChainSetHead + description: "ChainSetHead forcefully sets current chain head. Use with caution.\n" params: - name: tsk required: true @@ -347,6 +356,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.ChainStatObj + description: "ChainStatObj returns statistics about the graph referenced by 'obj'.\nIf 'base' is also specified, then the returned stat will be a diff\nbetween the two objects.\n" params: - name: objCid required: true @@ -382,6 +392,7 @@ methods: $ref: "#/components/schemas/BigInt" paramStructure: by-position - name: Forest.ChainExport + description: "Calls the `Forest.ChainExport` RPC method." params: - name: params required: true @@ -394,6 +405,7 @@ methods: $ref: "#/components/schemas/ApiExportResult" paramStructure: by-position - name: Forest.ChainExportDiff + description: "Calls the `Forest.ChainExportDiff` RPC method." params: - name: params required: true @@ -406,6 +418,7 @@ methods: type: "null" paramStructure: by-position - name: Forest.ChainExportStatus + description: "Calls the `Forest.ChainExportStatus` RPC method." params: [] result: name: Forest.ChainExportStatus.Result @@ -414,6 +427,7 @@ methods: $ref: "#/components/schemas/ApiExportStatus" paramStructure: by-position - name: Forest.ChainExportCancel + description: "Calls the `Forest.ChainExportCancel` RPC method." params: [] result: name: Forest.ChainExportCancel.Result @@ -422,6 +436,7 @@ methods: type: boolean paramStructure: by-position - name: Forest.ChainGetTipsetByParentState + description: "Calls the `Forest.ChainGetTipsetByParentState` RPC method." params: - name: parentState required: true @@ -436,6 +451,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.Session + description: "Calls the `Filecoin.Session` RPC method." params: [] result: name: Filecoin.Session.Result @@ -445,6 +461,7 @@ methods: format: uuid paramStructure: by-position - name: Filecoin.Shutdown + description: "Calls the `Filecoin.Shutdown` RPC method." params: [] result: name: Filecoin.Shutdown.Result @@ -453,6 +470,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.StartTime + description: "Calls the `Filecoin.StartTime` RPC method." params: [] result: name: Filecoin.StartTime.Result @@ -462,6 +480,7 @@ methods: format: date-time paramStructure: by-position - name: Filecoin.Version + description: "Calls the `Filecoin.Version` RPC method." params: [] result: name: Filecoin.Version.Result @@ -470,6 +489,7 @@ methods: $ref: "#/components/schemas/PublicVersion" paramStructure: by-position - name: Filecoin.EthAccounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: Filecoin.EthAccounts.Result @@ -482,6 +502,7 @@ methods: type: string paramStructure: by-position - name: eth_accounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: eth_accounts.Result @@ -558,6 +579,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthBlockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: Filecoin.EthBlockNumber.Result @@ -566,6 +588,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_blockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: eth_blockNumber.Result @@ -574,6 +597,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthCall + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -590,6 +614,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: eth_call + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -606,6 +631,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthChainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: Filecoin.EthChainId.Result @@ -614,6 +640,7 @@ methods: type: string paramStructure: by-position - name: eth_chainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: eth_chainId.Result @@ -622,6 +649,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthEstimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -640,6 +668,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_estimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -658,6 +687,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthFeeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -683,6 +713,7 @@ methods: $ref: "#/components/schemas/EthFeeHistoryResult" paramStructure: by-position - name: eth_feeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -760,6 +791,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthGetBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -776,6 +808,7 @@ methods: $ref: "#/components/schemas/Block" paramStructure: by-position - name: eth_getBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -904,6 +937,7 @@ methods: $ref: "#/components/schemas/EthTxReceipt" paramStructure: by-position - name: Filecoin.EthGetBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -916,6 +950,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -988,6 +1023,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -1000,6 +1036,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -1012,6 +1049,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -1024,6 +1062,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -1062,6 +1101,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -1076,6 +1116,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -1132,6 +1173,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -1146,6 +1188,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -1160,6 +1203,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -1179,6 +1223,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -1198,6 +1243,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -1214,6 +1260,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -1230,6 +1277,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -1244,6 +1292,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -1296,6 +1345,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -1314,6 +1364,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -1332,6 +1383,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthMaxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: Filecoin.EthMaxPriorityFeePerGas.Result @@ -1340,6 +1392,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: eth_maxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: eth_maxPriorityFeePerGas.Result @@ -1348,6 +1401,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthProtocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: Filecoin.EthProtocolVersion.Result @@ -1356,6 +1410,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_protocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: eth_protocolVersion.Result @@ -1364,6 +1419,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -1378,6 +1434,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -1392,6 +1449,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1411,6 +1469,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1430,6 +1489,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthNewFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1442,6 +1502,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1454,6 +1515,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: Filecoin.EthNewPendingTransactionFilter.Result @@ -1462,6 +1524,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: eth_newPendingTransactionFilter.Result @@ -1470,6 +1533,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: Filecoin.EthNewBlockFilter.Result @@ -1478,6 +1542,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: eth_newBlockFilter.Result @@ -1486,6 +1551,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthUninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1498,6 +1564,7 @@ methods: type: boolean paramStructure: by-position - name: eth_uninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1510,6 +1577,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.EthUnsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: Filecoin.EthUnsubscribe.Result @@ -1518,6 +1586,7 @@ methods: type: "null" paramStructure: by-position - name: eth_unsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: eth_unsubscribe.Result @@ -1526,6 +1595,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSubscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: Filecoin.EthSubscribe.Result @@ -1534,6 +1604,7 @@ methods: type: "null" paramStructure: by-position - name: eth_subscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: eth_subscribe.Result @@ -1542,6 +1613,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSyncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: Filecoin.EthSyncing.Result @@ -1550,6 +1622,7 @@ methods: $ref: "#/components/schemas/EthSyncingResultLotusJson" paramStructure: by-position - name: eth_syncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: eth_syncing.Result @@ -1710,6 +1783,7 @@ methods: $ref: "#/components/schemas/EthReplayBlockTransactionTrace" paramStructure: by-position - name: Filecoin.Web3ClientVersion + description: "Returns the client version\n" params: [] result: name: Filecoin.Web3ClientVersion.Result @@ -1718,6 +1792,7 @@ methods: type: string paramStructure: by-position - name: web3_clientVersion + description: "Returns the client version\n" params: [] result: name: web3_clientVersion.Result @@ -1726,6 +1801,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthSendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1738,6 +1814,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1750,6 +1827,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: Filecoin.EthSendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1762,6 +1840,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1881,6 +1960,7 @@ methods: $ref: "#/components/schemas/Message" paramStructure: by-position - name: Filecoin.MarketAddBalance + description: "MarketAddBalance adds funds to the market actor\n" params: - name: wallet required: true @@ -2098,6 +2178,7 @@ methods: $ref: "#/components/schemas/SignedMessage" paramStructure: by-position - name: Filecoin.MsigGetAvailableBalance + description: "MsigGetAvailableBalance returns the portion of a multisig's balance that can be withdrawn or spent" params: - name: address required: true @@ -2118,6 +2199,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.MsigGetPending + description: "MsigGetPending returns pending transactions for the given multisig\nwallet. Once pending transactions are fully approved, they will no longer\nappear here.\n" params: - name: address required: true @@ -2142,6 +2224,7 @@ methods: $ref: "#/components/schemas/Transaction" paramStructure: by-position - name: Filecoin.MsigGetVested + description: "MsigGetVested returns the amount of FIL that vested in a multisig in a certain period.\nIt takes the following params: , , \n" params: - name: address required: true @@ -2170,6 +2253,7 @@ methods: $ref: "#/components/schemas/BigInt" paramStructure: by-position - name: Filecoin.MsigGetVestingSchedule + description: "MsigGetVestingSchedule returns the vesting details of a given multisig.\n" params: - name: address required: true @@ -2212,6 +2296,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.NetAutoNatStatus + description: "Calls the `Filecoin.NetAutoNatStatus` RPC method." params: [] result: name: Filecoin.NetAutoNatStatus.Result @@ -2246,6 +2331,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.NetFindPeer + description: "Calls the `Filecoin.NetFindPeer` RPC method." params: - name: peerId required: true @@ -2258,6 +2344,7 @@ methods: $ref: "#/components/schemas/AddrInfo" paramStructure: by-position - name: Forest.NetInfo + description: "Calls the `Forest.NetInfo` RPC method." params: [] result: name: Forest.NetInfo.Result @@ -2266,6 +2353,7 @@ methods: $ref: "#/components/schemas/NetInfoResult" paramStructure: by-position - name: Filecoin.NetListening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: Filecoin.NetListening.Result @@ -2274,6 +2362,7 @@ methods: type: boolean paramStructure: by-position - name: net_listening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: net_listening.Result @@ -2342,6 +2431,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.NetVersion + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: Filecoin.NetVersion.Result @@ -2350,6 +2440,7 @@ methods: type: string paramStructure: by-position - name: net_version + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: net_version.Result @@ -2387,6 +2478,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.NodeStatus + description: "Returns sync, peer, and chain status information for the node." params: [] result: name: Filecoin.NodeStatus.Result @@ -2543,6 +2635,7 @@ methods: $ref: "#/components/schemas/DealCollateralBounds" paramStructure: by-position - name: Forest.StateFetchRoot + description: "Calls the `Forest.StateFetchRoot` RPC method." params: - name: rootCid required: true @@ -2913,6 +3006,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.StateGetReceipt + description: "Calls the `Filecoin.StateGetReceipt` RPC method." params: - name: cid required: true @@ -3486,6 +3580,7 @@ methods: $ref: "#/components/schemas/SectorOnChainInfo" paramStructure: by-position - name: Filecoin.StateNetworkName + description: "StateNetworkName returns the name of the network the node is synced to\n" params: [] result: name: Filecoin.StateNetworkName.Result @@ -3727,6 +3822,7 @@ methods: $ref: "#/components/schemas/SectorLocation" paramStructure: by-position - name: Filecoin.StateSectorPreCommitInfo + description: "StateSectorPreCommitInfo returns the PreCommit info for the specified miner's sector. Returns nil and no error if the sector isn't precommitted. Note that the sector number may be allocated while PreCommitInfo is nil. This means that either allocated sector numbers were compacted, and the sector number was marked as allocated in order to reduce size of the allocated sectors bitfield, or that the sector was precommitted, but the precommit has expired." params: - name: minerAddress required: true @@ -3833,6 +3929,7 @@ methods: $ref: "#/components/schemas/CirculatingSupply" paramStructure: by-position - name: Filecoin.StateWaitMsg + description: "StateWaitMsg looks back up to limit epochs in the chain for a message.\nIf not found, it blocks until the message arrives on chain, and gets to the\nindicated confidence depth.\n\nNOTE: If a replacing message is found on chain, this method will return\na MsgLookup for the replacing message - the MsgLookup.Message will be a different\nCID than the one provided in the 'cid' param, MsgLookup.Receipt will contain the\nresult of the execution of the replacing message.\n\nIf the caller wants to ensure that exactly the requested message was executed,\nthey must check that MsgLookup.Message is equal to the provided 'cid', or set the\n`allowReplaced` parameter to false. Without this check, and with `allowReplaced`\nset to true, both the requested and original message may appear as\nsuccessfully executed on-chain, which may look like a double-spend.\n\nA replacing message is a message with a different CID, any of Gas values, and\ndifferent signature, but with all other parameters matching (source/destination,\nnonce, params, etc.)\n" params: - name: messageCid required: true @@ -3850,6 +3947,7 @@ methods: $ref: "#/components/schemas/MessageLookup" paramStructure: by-position - name: Filecoin.StateMinerInitialPledgeForSector + description: "StateMinerInitialPledgeForSector returns the initial pledge collateral for a given sector\nduration, size, and combined size of any verified pieces within the sector. This calculation\ndepends on current network conditions (total power, total pledge and current rewards) at the\ngiven tipset.\nNote: The value returned is overestimated by 10% (multiplied by 110/100).\nSee: node/impl/full/state.go StateMinerInitialPledgeForSector implementation.\n" params: - name: sector_duration required: true @@ -3881,6 +3979,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.SyncCheckBad + description: "SyncCheckBad checks if a block was marked as bad, and if it was, returns\nthe reason.\n" params: - name: cid required: true @@ -3893,6 +3992,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.SyncMarkBad + description: "SyncMarkBad marks a blocks as bad, meaning that it won't ever by synced.\nUse with extreme caution.\n" params: - name: cid required: true @@ -3949,6 +4049,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.WalletDefaultAddress + description: WalletDefaultAddress returns the address marked as default in the wallet. params: [] result: name: Filecoin.WalletDefaultAddress.Result @@ -3959,6 +4060,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.WalletDelete + description: "WalletDelete deletes an address from the wallet.\n" params: - name: address required: true @@ -3971,6 +4073,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.WalletExport + description: WalletExport returns the private key of an address in the wallet. params: - name: address required: true @@ -3996,6 +4099,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.WalletImport + description: "WalletImport receives a KeyInfo, which includes a private key, and imports it into the wallet." params: - name: key required: true @@ -4021,6 +4125,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletNew + description: "WalletNew creates a new address in the wallet with the given sigType.\nAvailable key types: bls, secp256k1, secp256k1-ledger\nSupport for numerical types: 1 - secp256k1, 2 - BLS is deprecated\n" params: - name: signatureType required: true @@ -4033,6 +4138,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletSetDefault + description: "WalletSetDefault marks the given address as the default one.\n" params: - name: address required: true @@ -4079,6 +4185,7 @@ methods: $ref: "#/components/schemas/SignedMessage" paramStructure: by-position - name: Filecoin.WalletValidateAddress + description: WalletValidateAddress validates whether a given string can be decoded as a well-formed address params: - name: address required: true @@ -4091,6 +4198,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletVerify + description: "WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid. The address does not have to be in the wallet." params: - name: address required: true @@ -4111,6 +4219,7 @@ methods: type: boolean paramStructure: by-position - name: F3.GetRawNetworkName + description: "Calls the `F3.GetRawNetworkName` RPC method." params: [] result: name: F3.GetRawNetworkName.Result @@ -4119,6 +4228,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.F3GetCertificate + description: "F3GetCertificate returns a finality certificate at given instance.\n" params: - name: instance required: true @@ -4133,6 +4243,7 @@ methods: $ref: "#/components/schemas/FinalityCertificate" paramStructure: by-position - name: Filecoin.F3GetECPowerTable + description: "F3GetECPowerTable returns a F3 specific power table for use in standalone F3 nodes.\n" params: - name: tipsetKey required: true @@ -4153,6 +4264,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: Filecoin.F3GetF3PowerTable + description: "F3GetF3PowerTable returns a F3 specific power table.\n" params: - name: tipsetKey required: true @@ -4192,6 +4304,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: Filecoin.F3IsRunning + description: "F3IsRunning returns true if the F3 instance is running, false if it's not running but\nit's enabled, and an error when disabled entirely.\n" params: [] result: name: Filecoin.F3IsRunning.Result @@ -4200,6 +4313,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.F3GetProgress + description: "F3GetProgress returns the progress of the current F3 instance in terms of instance ID, round and phase." params: [] result: name: Filecoin.F3GetProgress.Result @@ -4208,6 +4322,7 @@ methods: $ref: "#/components/schemas/F3InstanceProgress" paramStructure: by-position - name: Filecoin.F3GetManifest + description: "F3GetManifest returns the current manifest being used for F3 operations.\n" params: [] result: name: Filecoin.F3GetManifest.Result @@ -4216,6 +4331,7 @@ methods: $ref: "#/components/schemas/F3Manifest" paramStructure: by-position - name: Filecoin.F3ListParticipants + description: F3ListParticipants returns the list of miners that are currently participating in F3 via this node. params: [] result: name: Filecoin.F3ListParticipants.Result @@ -4228,6 +4344,7 @@ methods: $ref: "#/components/schemas/F3Participant" paramStructure: by-position - name: Filecoin.F3GetLatestCertificate + description: "F3GetLatestCertificate returns the latest finality certificate.\n" params: [] result: name: Filecoin.F3GetLatestCertificate.Result @@ -4236,6 +4353,7 @@ methods: $ref: "#/components/schemas/FinalityCertificate" paramStructure: by-position - name: Filecoin.F3GetOrRenewParticipationTicket + description: "F3GetOrRenewParticipationTicket retrieves or renews a participation ticket\nnecessary for a miner to engage in the F3 consensus process for the given\nnumber of instances.\n\nThis function accepts an optional previous ticket. If provided, a new ticket\nwill be issued only under one the following conditions:\n 1. The previous ticket has expired.\n 2. The issuer of the previous ticket matches the node processing this\n request.\n\nIf there is an issuer mismatch (ErrF3ParticipationIssuerMismatch), the miner\nmust retry obtaining a new ticket to ensure it is only participating in one F3\ninstance at any time. The number of instances must be at least 1. If the\nnumber of instances is beyond the maximum leasable participation instances\naccepted by the node ErrF3ParticipationTooManyInstances is returned.\n\nNote: Successfully acquiring a ticket alone does not constitute participation.\nThe retrieved ticket must be used to invoke F3Participate to actively engage\nin the F3 consensus process.\n" params: - name: minerAddress required: true @@ -4258,6 +4376,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.F3Participate + description: "F3Participate enrolls a storage provider in the F3 consensus process using a\nprovided participation ticket. This ticket grants a temporary lease that enables\nthe provider to sign transactions as part of the F3 consensus.\n\nThe function verifies the ticket's validity and checks if the ticket's issuer\naligns with the current node. If there is an issuer mismatch\n(ErrF3ParticipationIssuerMismatch), the provider should retry with the same\nticket, assuming the issue is due to transient network problems or operational\ndeployment conditions. If the ticket is invalid\n(ErrF3ParticipationTicketInvalid) or has expired\n(ErrF3ParticipationTicketExpired), the provider must obtain a new ticket by\ncalling F3GetOrRenewParticipationTicket.\n\nThe start instance associated to the given ticket cannot be less than the\nstart instance of any existing lease held by the miner. Otherwise,\nErrF3ParticipationTicketStartBeforeExisting is returned. In this case, the\nminer should acquire a new ticket before attempting to participate again.\n\nFor details on obtaining or renewing a ticket, see F3GetOrRenewParticipationTicket.\n" params: - name: leaseTicket required: true @@ -4283,6 +4402,7 @@ methods: $ref: "#/components/schemas/Cid" paramStructure: by-position - name: F3.GetHead + description: "Calls the `F3.GetHead` RPC method." params: [] result: name: F3.GetHead.Result @@ -4291,6 +4411,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetParent + description: "Calls the `F3.GetParent` RPC method." params: - name: tipsetKey required: true @@ -4303,6 +4424,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetParticipatingMinerIDs + description: "Calls the `F3.GetParticipatingMinerIDs` RPC method." params: [] result: name: F3.GetParticipatingMinerIDs.Result @@ -4317,6 +4439,7 @@ methods: minimum: 0 paramStructure: by-position - name: F3.GetPowerTable + description: "Calls the `F3.GetPowerTable` RPC method." params: - name: tipsetKey required: true @@ -4333,6 +4456,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: F3.GetTipset + description: "Calls the `F3.GetTipset` RPC method." params: - name: tipsetKey required: true @@ -4345,6 +4469,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetTipsetByEpoch + description: "Calls the `F3.GetTipsetByEpoch` RPC method." params: - name: epoch required: true @@ -4358,6 +4483,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.Finalize + description: "Calls the `F3.Finalize` RPC method." params: - name: tipsetKey required: true @@ -4370,6 +4496,7 @@ methods: type: "null" paramStructure: by-position - name: F3.ProtectPeer + description: "Calls the `F3.ProtectPeer` RPC method." params: - name: peerId required: true @@ -4382,6 +4509,7 @@ methods: type: boolean paramStructure: by-position - name: F3.SignMessage + description: "Calls the `F3.SignMessage` RPC method." params: - name: pubkey required: true diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap index 62c967cf6e9..94927f73bca 100644 --- a/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v1.snap @@ -8,6 +8,7 @@ info: version: 0.33.6 methods: - name: Filecoin.AuthNew + description: "Calls the `Filecoin.AuthNew` RPC method." params: - name: permissions required: true @@ -31,6 +32,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.AuthVerify + description: "Calls the `Filecoin.AuthVerify` RPC method." params: - name: headerRaw required: true @@ -47,6 +49,7 @@ methods: type: string paramStructure: by-position - name: Forest.SnapshotGC + description: "Calls the `Forest.SnapshotGC` RPC method." params: - name: blocking required: true @@ -59,6 +62,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.ChainExport + description: "Calls the `Filecoin.ChainExport` RPC method." params: - name: params required: true @@ -114,6 +118,7 @@ methods: $ref: "#/components/schemas/Event" paramStructure: by-position - name: Filecoin.ChainGetGenesis + description: "ChainGetGenesis returns the genesis tipset.\n" params: [] result: name: Filecoin.ChainGetGenesis.Result @@ -146,6 +151,7 @@ methods: $ref: "#/components/schemas/Message" paramStructure: by-position - name: Filecoin.ChainGetMessagesInTipset + description: "ChainGetMessagesInTipset returns message stores in current tipset\n" params: - name: tipsetKey required: true @@ -166,6 +172,7 @@ methods: $ref: "#/components/schemas/ApiMessage" paramStructure: by-position - name: Forest.ChainGetMinBaseFee + description: "Calls the `Forest.ChainGetMinBaseFee` RPC method." params: - name: lookback required: true @@ -331,6 +338,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.ChainSetHead + description: "ChainSetHead forcefully sets current chain head. Use with caution.\n" params: - name: tsk required: true @@ -343,6 +351,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.ChainStatObj + description: "ChainStatObj returns statistics about the graph referenced by 'obj'.\nIf 'base' is also specified, then the returned stat will be a diff\nbetween the two objects.\n" params: - name: objCid required: true @@ -378,6 +387,7 @@ methods: $ref: "#/components/schemas/BigInt" paramStructure: by-position - name: Forest.ChainExport + description: "Calls the `Forest.ChainExport` RPC method." params: - name: params required: true @@ -390,6 +400,7 @@ methods: $ref: "#/components/schemas/ApiExportResult" paramStructure: by-position - name: Forest.ChainExportDiff + description: "Calls the `Forest.ChainExportDiff` RPC method." params: - name: params required: true @@ -402,6 +413,7 @@ methods: type: "null" paramStructure: by-position - name: Forest.ChainExportStatus + description: "Calls the `Forest.ChainExportStatus` RPC method." params: [] result: name: Forest.ChainExportStatus.Result @@ -410,6 +422,7 @@ methods: $ref: "#/components/schemas/ApiExportStatus" paramStructure: by-position - name: Forest.ChainExportCancel + description: "Calls the `Forest.ChainExportCancel` RPC method." params: [] result: name: Forest.ChainExportCancel.Result @@ -418,6 +431,7 @@ methods: type: boolean paramStructure: by-position - name: Forest.ChainGetTipsetByParentState + description: "Calls the `Forest.ChainGetTipsetByParentState` RPC method." params: - name: parentState required: true @@ -432,6 +446,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.Session + description: "Calls the `Filecoin.Session` RPC method." params: [] result: name: Filecoin.Session.Result @@ -441,6 +456,7 @@ methods: format: uuid paramStructure: by-position - name: Filecoin.Shutdown + description: "Calls the `Filecoin.Shutdown` RPC method." params: [] result: name: Filecoin.Shutdown.Result @@ -449,6 +465,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.StartTime + description: "Calls the `Filecoin.StartTime` RPC method." params: [] result: name: Filecoin.StartTime.Result @@ -458,6 +475,7 @@ methods: format: date-time paramStructure: by-position - name: Filecoin.Version + description: "Calls the `Filecoin.Version` RPC method." params: [] result: name: Filecoin.Version.Result @@ -466,6 +484,7 @@ methods: $ref: "#/components/schemas/PublicVersion" paramStructure: by-position - name: Filecoin.EthAccounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: Filecoin.EthAccounts.Result @@ -478,6 +497,7 @@ methods: type: string paramStructure: by-position - name: eth_accounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: eth_accounts.Result @@ -554,6 +574,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthBlockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: Filecoin.EthBlockNumber.Result @@ -562,6 +583,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_blockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: eth_blockNumber.Result @@ -570,6 +592,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthCall + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -586,6 +609,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: eth_call + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -602,6 +626,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthChainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: Filecoin.EthChainId.Result @@ -610,6 +635,7 @@ methods: type: string paramStructure: by-position - name: eth_chainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: eth_chainId.Result @@ -618,6 +644,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthEstimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -636,6 +663,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_estimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -654,6 +682,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthFeeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -679,6 +708,7 @@ methods: $ref: "#/components/schemas/EthFeeHistoryResult" paramStructure: by-position - name: eth_feeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -756,6 +786,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthGetBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -772,6 +803,7 @@ methods: $ref: "#/components/schemas/Block" paramStructure: by-position - name: eth_getBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -900,6 +932,7 @@ methods: $ref: "#/components/schemas/EthTxReceipt" paramStructure: by-position - name: Filecoin.EthGetBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -912,6 +945,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -984,6 +1018,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -996,6 +1031,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -1008,6 +1044,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -1020,6 +1057,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -1058,6 +1096,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -1072,6 +1111,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -1128,6 +1168,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -1142,6 +1183,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -1156,6 +1198,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -1175,6 +1218,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -1194,6 +1238,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -1210,6 +1255,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -1226,6 +1272,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -1240,6 +1287,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -1292,6 +1340,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -1310,6 +1359,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -1328,6 +1378,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthMaxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: Filecoin.EthMaxPriorityFeePerGas.Result @@ -1336,6 +1387,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: eth_maxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: eth_maxPriorityFeePerGas.Result @@ -1344,6 +1396,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthProtocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: Filecoin.EthProtocolVersion.Result @@ -1352,6 +1405,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_protocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: eth_protocolVersion.Result @@ -1360,6 +1414,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -1374,6 +1429,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -1388,6 +1444,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1407,6 +1464,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1426,6 +1484,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthNewFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1438,6 +1497,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1450,6 +1510,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: Filecoin.EthNewPendingTransactionFilter.Result @@ -1458,6 +1519,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: eth_newPendingTransactionFilter.Result @@ -1466,6 +1528,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: Filecoin.EthNewBlockFilter.Result @@ -1474,6 +1537,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: eth_newBlockFilter.Result @@ -1482,6 +1546,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthUninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1494,6 +1559,7 @@ methods: type: boolean paramStructure: by-position - name: eth_uninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1506,6 +1572,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.EthUnsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: Filecoin.EthUnsubscribe.Result @@ -1514,6 +1581,7 @@ methods: type: "null" paramStructure: by-position - name: eth_unsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: eth_unsubscribe.Result @@ -1522,6 +1590,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSubscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: Filecoin.EthSubscribe.Result @@ -1530,6 +1599,7 @@ methods: type: "null" paramStructure: by-position - name: eth_subscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: eth_subscribe.Result @@ -1538,6 +1608,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSyncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: Filecoin.EthSyncing.Result @@ -1546,6 +1617,7 @@ methods: $ref: "#/components/schemas/EthSyncingResultLotusJson" paramStructure: by-position - name: eth_syncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: eth_syncing.Result @@ -1790,6 +1862,7 @@ methods: $ref: "#/components/schemas/EthReplayBlockTransactionTrace" paramStructure: by-position - name: Filecoin.Web3ClientVersion + description: "Returns the client version\n" params: [] result: name: Filecoin.Web3ClientVersion.Result @@ -1798,6 +1871,7 @@ methods: type: string paramStructure: by-position - name: web3_clientVersion + description: "Returns the client version\n" params: [] result: name: web3_clientVersion.Result @@ -1806,6 +1880,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthSendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1818,6 +1893,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1830,6 +1906,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: Filecoin.EthSendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1842,6 +1919,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1961,6 +2039,7 @@ methods: $ref: "#/components/schemas/Message" paramStructure: by-position - name: Filecoin.MarketAddBalance + description: "MarketAddBalance adds funds to the market actor\n" params: - name: wallet required: true @@ -2178,6 +2257,7 @@ methods: $ref: "#/components/schemas/SignedMessage" paramStructure: by-position - name: Filecoin.MsigGetAvailableBalance + description: "MsigGetAvailableBalance returns the portion of a multisig's balance that can be withdrawn or spent" params: - name: address required: true @@ -2198,6 +2278,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.MsigGetPending + description: "MsigGetPending returns pending transactions for the given multisig\nwallet. Once pending transactions are fully approved, they will no longer\nappear here.\n" params: - name: address required: true @@ -2222,6 +2303,7 @@ methods: $ref: "#/components/schemas/Transaction" paramStructure: by-position - name: Filecoin.MsigGetVested + description: "MsigGetVested returns the amount of FIL that vested in a multisig in a certain period.\nIt takes the following params: , , \n" params: - name: address required: true @@ -2250,6 +2332,7 @@ methods: $ref: "#/components/schemas/BigInt" paramStructure: by-position - name: Filecoin.MsigGetVestingSchedule + description: "MsigGetVestingSchedule returns the vesting details of a given multisig.\n" params: - name: address required: true @@ -2292,6 +2375,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.NetAutoNatStatus + description: "Calls the `Filecoin.NetAutoNatStatus` RPC method." params: [] result: name: Filecoin.NetAutoNatStatus.Result @@ -2326,6 +2410,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.NetFindPeer + description: "Calls the `Filecoin.NetFindPeer` RPC method." params: - name: peerId required: true @@ -2338,6 +2423,7 @@ methods: $ref: "#/components/schemas/AddrInfo" paramStructure: by-position - name: Forest.NetInfo + description: "Calls the `Forest.NetInfo` RPC method." params: [] result: name: Forest.NetInfo.Result @@ -2346,6 +2432,7 @@ methods: $ref: "#/components/schemas/NetInfoResult" paramStructure: by-position - name: Filecoin.NetListening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: Filecoin.NetListening.Result @@ -2354,6 +2441,7 @@ methods: type: boolean paramStructure: by-position - name: net_listening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: net_listening.Result @@ -2422,6 +2510,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.NetVersion + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: Filecoin.NetVersion.Result @@ -2430,6 +2519,7 @@ methods: type: string paramStructure: by-position - name: net_version + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: net_version.Result @@ -2467,6 +2557,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.NodeStatus + description: "Returns sync, peer, and chain status information for the node." params: [] result: name: Filecoin.NodeStatus.Result @@ -2623,6 +2714,7 @@ methods: $ref: "#/components/schemas/DealCollateralBounds" paramStructure: by-position - name: Forest.StateFetchRoot + description: "Calls the `Forest.StateFetchRoot` RPC method." params: - name: rootCid required: true @@ -3546,6 +3638,7 @@ methods: $ref: "#/components/schemas/SectorOnChainInfo" paramStructure: by-position - name: Filecoin.StateNetworkName + description: "StateNetworkName returns the name of the network the node is synced to\n" params: [] result: name: Filecoin.StateNetworkName.Result @@ -3903,6 +3996,7 @@ methods: $ref: "#/components/schemas/MessageLookup" paramStructure: by-position - name: Filecoin.StateMinerInitialPledgeForSector + description: "StateMinerInitialPledgeForSector returns the initial pledge collateral for a given sector\nduration, size, and combined size of any verified pieces within the sector. This calculation\ndepends on current network conditions (total power, total pledge and current rewards) at the\ngiven tipset.\nNote: The value returned is overestimated by 10% (multiplied by 110/100).\nSee: node/impl/full/state.go StateMinerInitialPledgeForSector implementation.\n" params: - name: sector_duration required: true @@ -3934,6 +4028,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.SyncCheckBad + description: "SyncCheckBad checks if a block was marked as bad, and if it was, returns\nthe reason.\n" params: - name: cid required: true @@ -3946,6 +4041,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.SyncMarkBad + description: "SyncMarkBad marks a blocks as bad, meaning that it won't ever by synced.\nUse with extreme caution.\n" params: - name: cid required: true @@ -4002,6 +4098,7 @@ methods: $ref: "#/components/schemas/TokenAmount" paramStructure: by-position - name: Filecoin.WalletDefaultAddress + description: WalletDefaultAddress returns the address marked as default in the wallet. params: [] result: name: Filecoin.WalletDefaultAddress.Result @@ -4012,6 +4109,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.WalletDelete + description: "WalletDelete deletes an address from the wallet.\n" params: - name: address required: true @@ -4024,6 +4122,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.WalletExport + description: WalletExport returns the private key of an address in the wallet. params: - name: address required: true @@ -4049,6 +4148,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.WalletImport + description: "WalletImport receives a KeyInfo, which includes a private key, and imports it into the wallet." params: - name: key required: true @@ -4074,6 +4174,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletNew + description: "WalletNew creates a new address in the wallet with the given sigType.\nAvailable key types: bls, secp256k1, secp256k1-ledger\nSupport for numerical types: 1 - secp256k1, 2 - BLS is deprecated\n" params: - name: signatureType required: true @@ -4086,6 +4187,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletSetDefault + description: "WalletSetDefault marks the given address as the default one.\n" params: - name: address required: true @@ -4132,6 +4234,7 @@ methods: $ref: "#/components/schemas/SignedMessage" paramStructure: by-position - name: Filecoin.WalletValidateAddress + description: WalletValidateAddress validates whether a given string can be decoded as a well-formed address params: - name: address required: true @@ -4144,6 +4247,7 @@ methods: $ref: "#/components/schemas/Address" paramStructure: by-position - name: Filecoin.WalletVerify + description: "WalletVerify takes an address, a signature, and some bytes, and indicates whether the signature is valid. The address does not have to be in the wallet." params: - name: address required: true @@ -4164,6 +4268,7 @@ methods: type: boolean paramStructure: by-position - name: F3.GetRawNetworkName + description: "Calls the `F3.GetRawNetworkName` RPC method." params: [] result: name: F3.GetRawNetworkName.Result @@ -4172,6 +4277,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.F3GetCertificate + description: "F3GetCertificate returns a finality certificate at given instance.\n" params: - name: instance required: true @@ -4186,6 +4292,7 @@ methods: $ref: "#/components/schemas/FinalityCertificate" paramStructure: by-position - name: Filecoin.F3GetECPowerTable + description: "F3GetECPowerTable returns a F3 specific power table for use in standalone F3 nodes.\n" params: - name: tipsetKey required: true @@ -4206,6 +4313,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: Filecoin.F3GetF3PowerTable + description: "F3GetF3PowerTable returns a F3 specific power table.\n" params: - name: tipsetKey required: true @@ -4245,6 +4353,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: Filecoin.F3IsRunning + description: "F3IsRunning returns true if the F3 instance is running, false if it's not running but\nit's enabled, and an error when disabled entirely.\n" params: [] result: name: Filecoin.F3IsRunning.Result @@ -4253,6 +4362,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.F3GetProgress + description: "F3GetProgress returns the progress of the current F3 instance in terms of instance ID, round and phase." params: [] result: name: Filecoin.F3GetProgress.Result @@ -4261,6 +4371,7 @@ methods: $ref: "#/components/schemas/F3InstanceProgress" paramStructure: by-position - name: Filecoin.F3GetManifest + description: "F3GetManifest returns the current manifest being used for F3 operations.\n" params: [] result: name: Filecoin.F3GetManifest.Result @@ -4269,6 +4380,7 @@ methods: $ref: "#/components/schemas/F3Manifest" paramStructure: by-position - name: Filecoin.F3ListParticipants + description: F3ListParticipants returns the list of miners that are currently participating in F3 via this node. params: [] result: name: Filecoin.F3ListParticipants.Result @@ -4281,6 +4393,7 @@ methods: $ref: "#/components/schemas/F3Participant" paramStructure: by-position - name: Filecoin.F3GetLatestCertificate + description: "F3GetLatestCertificate returns the latest finality certificate.\n" params: [] result: name: Filecoin.F3GetLatestCertificate.Result @@ -4289,6 +4402,7 @@ methods: $ref: "#/components/schemas/FinalityCertificate" paramStructure: by-position - name: Filecoin.F3GetOrRenewParticipationTicket + description: "F3GetOrRenewParticipationTicket retrieves or renews a participation ticket\nnecessary for a miner to engage in the F3 consensus process for the given\nnumber of instances.\n\nThis function accepts an optional previous ticket. If provided, a new ticket\nwill be issued only under one the following conditions:\n 1. The previous ticket has expired.\n 2. The issuer of the previous ticket matches the node processing this\n request.\n\nIf there is an issuer mismatch (ErrF3ParticipationIssuerMismatch), the miner\nmust retry obtaining a new ticket to ensure it is only participating in one F3\ninstance at any time. The number of instances must be at least 1. If the\nnumber of instances is beyond the maximum leasable participation instances\naccepted by the node ErrF3ParticipationTooManyInstances is returned.\n\nNote: Successfully acquiring a ticket alone does not constitute participation.\nThe retrieved ticket must be used to invoke F3Participate to actively engage\nin the F3 consensus process.\n" params: - name: minerAddress required: true @@ -4311,6 +4425,7 @@ methods: $ref: "#/components/schemas/Base64String" paramStructure: by-position - name: Filecoin.F3Participate + description: "F3Participate enrolls a storage provider in the F3 consensus process using a\nprovided participation ticket. This ticket grants a temporary lease that enables\nthe provider to sign transactions as part of the F3 consensus.\n\nThe function verifies the ticket's validity and checks if the ticket's issuer\naligns with the current node. If there is an issuer mismatch\n(ErrF3ParticipationIssuerMismatch), the provider should retry with the same\nticket, assuming the issue is due to transient network problems or operational\ndeployment conditions. If the ticket is invalid\n(ErrF3ParticipationTicketInvalid) or has expired\n(ErrF3ParticipationTicketExpired), the provider must obtain a new ticket by\ncalling F3GetOrRenewParticipationTicket.\n\nThe start instance associated to the given ticket cannot be less than the\nstart instance of any existing lease held by the miner. Otherwise,\nErrF3ParticipationTicketStartBeforeExisting is returned. In this case, the\nminer should acquire a new ticket before attempting to participate again.\n\nFor details on obtaining or renewing a ticket, see F3GetOrRenewParticipationTicket.\n" params: - name: leaseTicket required: true @@ -4336,6 +4451,7 @@ methods: $ref: "#/components/schemas/Cid" paramStructure: by-position - name: F3.GetHead + description: "Calls the `F3.GetHead` RPC method." params: [] result: name: F3.GetHead.Result @@ -4344,6 +4460,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetParent + description: "Calls the `F3.GetParent` RPC method." params: - name: tipsetKey required: true @@ -4356,6 +4473,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetParticipatingMinerIDs + description: "Calls the `F3.GetParticipatingMinerIDs` RPC method." params: [] result: name: F3.GetParticipatingMinerIDs.Result @@ -4370,6 +4488,7 @@ methods: minimum: 0 paramStructure: by-position - name: F3.GetPowerTable + description: "Calls the `F3.GetPowerTable` RPC method." params: - name: tipsetKey required: true @@ -4386,6 +4505,7 @@ methods: $ref: "#/components/schemas/F3PowerEntryLotusJson" paramStructure: by-position - name: F3.GetTipset + description: "Calls the `F3.GetTipset` RPC method." params: - name: tipsetKey required: true @@ -4398,6 +4518,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.GetTipsetByEpoch + description: "Calls the `F3.GetTipsetByEpoch` RPC method." params: - name: epoch required: true @@ -4411,6 +4532,7 @@ methods: $ref: "#/components/schemas/F3TipSet" paramStructure: by-position - name: F3.Finalize + description: "Calls the `F3.Finalize` RPC method." params: - name: tipsetKey required: true @@ -4423,6 +4545,7 @@ methods: type: "null" paramStructure: by-position - name: F3.ProtectPeer + description: "Calls the `F3.ProtectPeer` RPC method." params: - name: peerId required: true @@ -4435,6 +4558,7 @@ methods: type: boolean paramStructure: by-position - name: F3.SignMessage + description: "Calls the `F3.SignMessage` RPC method." params: - name: pubkey required: true diff --git a/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap b/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap index f44b2280065..9198a8f84be 100644 --- a/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap +++ b/src/rpc/snapshots/forest__rpc__tests__rpc__v2.snap @@ -30,6 +30,7 @@ methods: $ref: "#/components/schemas/ChainFinalityStatus" paramStructure: by-position - name: Forest.ChainExport + description: "Calls the `Forest.ChainExport` RPC method." params: - name: params required: true @@ -42,6 +43,7 @@ methods: $ref: "#/components/schemas/ApiExportResult" paramStructure: by-position - name: Forest.ChainExportDiff + description: "Calls the `Forest.ChainExportDiff` RPC method." params: - name: params required: true @@ -54,6 +56,7 @@ methods: type: "null" paramStructure: by-position - name: Forest.ChainExportStatus + description: "Calls the `Forest.ChainExportStatus` RPC method." params: [] result: name: Forest.ChainExportStatus.Result @@ -62,6 +65,7 @@ methods: $ref: "#/components/schemas/ApiExportStatus" paramStructure: by-position - name: Forest.ChainExportCancel + description: "Calls the `Forest.ChainExportCancel` RPC method." params: [] result: name: Forest.ChainExportCancel.Result @@ -70,6 +74,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.EthAccounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: Filecoin.EthAccounts.Result @@ -82,6 +87,7 @@ methods: type: string paramStructure: by-position - name: eth_accounts + description: "EthAccounts will always return [] since we don't expect Lotus to manage private keys\n" params: [] result: name: eth_accounts.Result @@ -158,6 +164,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthBlockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: Filecoin.EthBlockNumber.Result @@ -166,6 +173,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_blockNumber + description: "EthBlockNumber returns the height of the latest (heaviest) TipSet\n" params: [] result: name: eth_blockNumber.Result @@ -174,6 +182,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthCall + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -190,6 +199,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: eth_call + description: "Calls the `Filecoin.EthCall` RPC method." params: - name: tx required: true @@ -206,6 +216,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthChainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: Filecoin.EthChainId.Result @@ -214,6 +225,7 @@ methods: type: string paramStructure: by-position - name: eth_chainId + description: "Calls the `Filecoin.EthChainId` RPC method." params: [] result: name: eth_chainId.Result @@ -222,6 +234,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthEstimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -240,6 +253,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_estimateGas + description: "Calls the `Filecoin.EthEstimateGas` RPC method." params: - name: tx required: true @@ -258,6 +272,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthFeeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -283,6 +298,7 @@ methods: $ref: "#/components/schemas/EthFeeHistoryResult" paramStructure: by-position - name: eth_feeHistory + description: "Calls the `Filecoin.EthFeeHistory` RPC method." params: - name: blockCount required: true @@ -360,6 +376,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthGetBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -376,6 +393,7 @@ methods: $ref: "#/components/schemas/Block" paramStructure: by-position - name: eth_getBlockByHash + description: "Calls the `Filecoin.EthGetBlockByHash` RPC method." params: - name: blockHash required: true @@ -504,6 +522,7 @@ methods: $ref: "#/components/schemas/EthTxReceipt" paramStructure: by-position - name: Filecoin.EthGetBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -516,6 +535,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getBlockTransactionCountByHash + description: "EthGetBlockTransactionCountByHash returns the number of messages in the TipSet\n" params: - name: blockHash required: true @@ -588,6 +608,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -600,6 +621,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getLogs + description: "Returns event logs matching given filter spec.\n" params: - name: ethFilter required: true @@ -612,6 +634,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -624,6 +647,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: eth_getFilterLogs + description: "Returns event logs matching filter with given id.\n(requires write perm since timestamp of last filter execution will be written)\n" params: - name: filterId required: true @@ -662,6 +686,7 @@ methods: $ref: "#/components/schemas/EthFilterResult" paramStructure: by-position - name: Filecoin.EthGetMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -676,6 +701,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getMessageCidByTransactionHash + description: "Calls the `Filecoin.EthGetMessageCidByTransactionHash` RPC method." params: - name: txHash required: true @@ -732,6 +758,7 @@ methods: $ref: "#/components/schemas/EthBytes" paramStructure: by-position - name: Filecoin.EthGetTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -746,6 +773,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHash + description: "Calls the `Filecoin.EthGetTransactionByHash` RPC method." params: - name: txHash required: true @@ -760,6 +788,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -779,6 +808,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByHashLimited + description: "Calls the `Filecoin.EthGetTransactionByHashLimited` RPC method." params: - name: txHash required: true @@ -798,6 +828,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -814,6 +845,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_getTransactionCount + description: "Calls the `Filecoin.EthGetTransactionCount` RPC method." params: - name: sender required: true @@ -830,6 +862,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -844,6 +877,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionHashByCid + description: "Calls the `Filecoin.EthGetTransactionHashByCid` RPC method." params: - name: cid required: true @@ -896,6 +930,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -914,6 +949,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionByBlockHashAndIndex + description: "Calls the `Filecoin.EthGetTransactionByBlockHashAndIndex` RPC method." params: - name: blockHash required: true @@ -932,6 +968,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthMaxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: Filecoin.EthMaxPriorityFeePerGas.Result @@ -940,6 +977,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: eth_maxPriorityFeePerGas + description: "Calls the `Filecoin.EthMaxPriorityFeePerGas` RPC method." params: [] result: name: eth_maxPriorityFeePerGas.Result @@ -948,6 +986,7 @@ methods: $ref: "#/components/schemas/EthBigInt" paramStructure: by-position - name: Filecoin.EthProtocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: Filecoin.EthProtocolVersion.Result @@ -956,6 +995,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: eth_protocolVersion + description: "Calls the `Filecoin.EthProtocolVersion` RPC method." params: [] result: name: eth_protocolVersion.Result @@ -964,6 +1004,7 @@ methods: $ref: "#/components/schemas/EthUint64" paramStructure: by-position - name: Filecoin.EthGetTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -978,6 +1019,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceipt + description: "Calls the `Filecoin.EthGetTransactionReceipt` RPC method." params: - name: txHash required: true @@ -992,6 +1034,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthGetTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1011,6 +1054,7 @@ methods: - type: "null" paramStructure: by-position - name: eth_getTransactionReceiptLimited + description: "Calls the `Filecoin.EthGetTransactionReceiptLimited` RPC method." params: - name: txHash required: true @@ -1030,6 +1074,7 @@ methods: - type: "null" paramStructure: by-position - name: Filecoin.EthNewFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1042,6 +1087,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newFilter + description: "Installs a persistent filter based on given filter spec.\n" params: - name: filterSpec required: true @@ -1054,6 +1100,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: Filecoin.EthNewPendingTransactionFilter.Result @@ -1062,6 +1109,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newPendingTransactionFilter + description: "Installs a persistent filter to notify when new messages arrive in the message pool.\n" params: [] result: name: eth_newPendingTransactionFilter.Result @@ -1070,6 +1118,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthNewBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: Filecoin.EthNewBlockFilter.Result @@ -1078,6 +1127,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: eth_newBlockFilter + description: "Installs a persistent filter to notify when a new block arrives.\n" params: [] result: name: eth_newBlockFilter.Result @@ -1086,6 +1136,7 @@ methods: $ref: "#/components/schemas/FilterID" paramStructure: by-position - name: Filecoin.EthUninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1098,6 +1149,7 @@ methods: type: boolean paramStructure: by-position - name: eth_uninstallFilter + description: "Uninstalls a filter with given id.\n" params: - name: filterId required: true @@ -1110,6 +1162,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.EthUnsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: Filecoin.EthUnsubscribe.Result @@ -1118,6 +1171,7 @@ methods: type: "null" paramStructure: by-position - name: eth_unsubscribe + description: "Unsubscribe from a websocket subscription\n" params: [] result: name: eth_unsubscribe.Result @@ -1126,6 +1180,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSubscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: Filecoin.EthSubscribe.Result @@ -1134,6 +1189,7 @@ methods: type: "null" paramStructure: by-position - name: eth_subscribe + description: "Subscribe to different event types using websockets\neventTypes is one or more of:\n - newHeads: notify when new blocks arrive.\n - pendingTransactions: notify when new messages arrive in the message pool.\n - logs: notify new event logs that match a criteria\nparams contains additional parameters used with the log event type\nThe client will receive a stream of EthSubscriptionResponse values until EthUnsubscribe is called.\n" params: [] result: name: eth_subscribe.Result @@ -1142,6 +1198,7 @@ methods: type: "null" paramStructure: by-position - name: Filecoin.EthSyncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: Filecoin.EthSyncing.Result @@ -1150,6 +1207,7 @@ methods: $ref: "#/components/schemas/EthSyncingResultLotusJson" paramStructure: by-position - name: eth_syncing + description: "Calls the `Filecoin.EthSyncing` RPC method." params: [] result: name: eth_syncing.Result @@ -1394,6 +1452,7 @@ methods: $ref: "#/components/schemas/EthReplayBlockTransactionTrace" paramStructure: by-position - name: Filecoin.Web3ClientVersion + description: "Returns the client version\n" params: [] result: name: Filecoin.Web3ClientVersion.Result @@ -1402,6 +1461,7 @@ methods: type: string paramStructure: by-position - name: web3_clientVersion + description: "Returns the client version\n" params: [] result: name: web3_clientVersion.Result @@ -1410,6 +1470,7 @@ methods: type: string paramStructure: by-position - name: Filecoin.EthSendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1422,6 +1483,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransaction + description: "Calls the `Filecoin.EthSendRawTransaction` RPC method." params: - name: rawTx required: true @@ -1434,6 +1496,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: Filecoin.EthSendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1446,6 +1509,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: eth_sendRawTransactionUntrusted + description: "EthSendRawTransactionUntrusted sends a transaction from an untrusted source, using MpoolPushUntrusted to submit the message." params: - name: rawTx required: true @@ -1458,6 +1522,7 @@ methods: $ref: "#/components/schemas/EthHash" paramStructure: by-position - name: Filecoin.NetListening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: Filecoin.NetListening.Result @@ -1466,6 +1531,7 @@ methods: type: boolean paramStructure: by-position - name: net_listening + description: "Calls the `Filecoin.NetListening` RPC method." params: [] result: name: net_listening.Result @@ -1474,6 +1540,7 @@ methods: type: boolean paramStructure: by-position - name: Filecoin.NetVersion + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: Filecoin.NetVersion.Result @@ -1482,6 +1549,7 @@ methods: type: string paramStructure: by-position - name: net_version + description: "Calls the `Filecoin.NetVersion` RPC method." params: [] result: name: net_version.Result