diff --git a/src/rpc/methods/auth.rs b/src/rpc/methods/auth.rs index a14d1497bcb0..90bd29a1f436 100644 --- a/src/rpc/methods/auth.rs +++ b/src/rpc/methods/auth.rs @@ -30,6 +30,8 @@ impl AuthNew { impl RpcMethod<2> for AuthNew { const NAME: &'static str = "Filecoin.AuthNew"; + const DESCRIPTION: Option<&'static str> = + Some("Creates a new JWT token with the specified permissions."); const N_REQUIRED_PARAMS: usize = 1; // Note: Lotus does not support the optional `expiration_secs` parameter const PARAM_NAMES: [&'static str; 2] = ["permissions", "expiration_secs"]; @@ -57,6 +59,8 @@ 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("Verifies a JWT token and returns its permissions."); const PARAM_NAMES: [&'static str; 1] = ["header_raw"]; 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 9b47056f3097..8cfdac600d19 100644 --- a/src/rpc/methods/beacon.rs +++ b/src/rpc/methods/beacon.rs @@ -13,6 +13,9 @@ 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( + "Returns the beacon entry for the given Filecoin epoch, blocking until the entry is available.", + ); 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 e2ff0f2e91b0..67f48797dec1 100644 --- a/src/rpc/methods/chain.rs +++ b/src/rpc/methods/chain.rs @@ -302,6 +302,8 @@ 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("Returns all messages included in the specified tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipsetKey"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -324,6 +326,8 @@ 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("Triggers garbage collection of old snapshot data."); const PARAM_NAMES: [&'static str; 1] = ["blocking"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -349,6 +353,8 @@ 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("Exports the chain state to a file using Forest-specific parameters."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -488,6 +494,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("Returns the status of the current chain export operation."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -529,6 +537,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("Cancels an in-progress chain export."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -553,6 +563,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("Exports a diff between two chain states to a file."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -612,6 +624,8 @@ 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("Exports the chain state to a CAR file."); const PARAM_NAMES: [&'static str; 1] = ["params"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -703,6 +717,9 @@ 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( + "Returns statistics about the DAG rooted at the given CID, optionally diffed against a base CID.", + ); const PARAM_NAMES: [&'static str; 2] = ["obj_cid", "base_cid"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -932,6 +949,8 @@ 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("Returns the genesis tipset of the chain."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1264,6 +1283,8 @@ 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("Forcefully sets the current chain head to the specified tipset."); const PARAM_NAMES: [&'static str; 1] = ["tsk"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -1297,6 +1318,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("Returns the minimum base fee over the given number of recent epochs."); const PARAM_NAMES: [&'static str; 1] = ["lookback"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1351,6 +1374,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("Returns the tipset whose parent state root matches the given CID."); 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 5c1aee3e41a4..23b61e06e8d2 100644 --- a/src/rpc/methods/common.rs +++ b/src/rpc/methods/common.rs @@ -16,6 +16,8 @@ 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("Returns a UUID that uniquely identifies the API node session."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -31,6 +33,8 @@ 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("Returns the version of the node and its API."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -57,6 +61,8 @@ 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("Triggers a graceful shutdown of the node."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -77,6 +83,8 @@ 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("Returns the time at which the node was started."); 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 06c645a928ff..dd04fc3fd221 100644 --- a/src/rpc/methods/eth.rs +++ b/src/rpc/methods/eth.rs @@ -758,6 +758,8 @@ 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 current client version string."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -787,6 +789,8 @@ 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("Returns a list of addresses owned by the client."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -842,6 +846,8 @@ 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("Returns the number of the most recent block."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -878,6 +884,8 @@ 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("Returns the chain ID used for signing EIP-155 transactions."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1391,6 +1399,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("Returns the block with the given hash."); const PARAM_NAMES: [&'static str; 2] = ["blockHash", "fullTxInfo"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1553,6 +1563,8 @@ 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("Returns the number of transactions in the block with the given hash."); const PARAM_NAMES: [&'static str; 1] = ["blockHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1608,6 +1620,9 @@ 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( + "Returns the Filecoin message CID corresponding to the given Ethereum transaction hash.", + ); const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1669,6 +1684,8 @@ 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("Returns the sync status of the node, or false if it is fully synced."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -1715,6 +1732,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("Estimates the gas needed to execute the given transaction."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 2] = ["tx", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -1903,6 +1922,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("Returns historical gas fee data for the given block range."); const N_REQUIRED_PARAMS: usize = 2; const PARAM_NAMES: [&'static str; 3] = ["blockCount", "newestBlockNumber", "rewardPercentiles"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2234,6 +2255,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("Returns the number of transactions sent from the given address."); const PARAM_NAMES: [&'static str; 2] = ["sender", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2290,6 +2313,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("Returns the current maximum priority fee per gas in attoFIL."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2313,6 +2338,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("Returns the current Ethereum protocol version."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2385,6 +2412,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("Returns a transaction by block hash and transaction index."); const PARAM_NAMES: [&'static str; 2] = ["blockHash", "txIndex"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2429,6 +2458,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("Returns a transaction by its hash."); const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2449,6 +2480,9 @@ 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( + "Returns a transaction by its hash, limited to a specified number of lookback epochs.", + ); const PARAM_NAMES: [&'static str; 2] = ["txHash", "limit"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2523,6 +2557,9 @@ pub enum 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( + "Returns the Ethereum transaction hash corresponding to the given Filecoin message CID.", + ); const PARAM_NAMES: [&'static str; 1] = ["cid"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2565,6 +2602,8 @@ 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("Executes a message call immediately without creating a transaction."); const N_REQUIRED_PARAMS: usize = 2; const PARAM_NAMES: [&'static str; 2] = ["tx", "blockParam"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2606,6 +2645,8 @@ 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("Creates a filter object based on filter options."); const PARAM_NAMES: [&'static str; 1] = ["filterSpec"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2628,6 +2669,8 @@ 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("Creates a filter that notifies when new pending transactions arrive."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2649,6 +2692,8 @@ 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("Creates a filter that notifies when a new block is added."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2671,6 +2716,8 @@ 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("Removes the filter with the given ID."); const PARAM_NAMES: [&'static str; 1] = ["filterId"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2693,6 +2740,8 @@ 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("Cancels the subscription with the given ID."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2719,6 +2768,8 @@ 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("Creates a subscription to specified events."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2860,6 +2911,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("Returns the receipt of a transaction by its hash."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 1] = ["txHash"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2879,6 +2932,9 @@ 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( + "Returns the receipt of a transaction by its hash, limited to a specified number of lookback epochs.", + ); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 2] = ["txHash", "limit"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -2898,6 +2954,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("Submits a signed transaction to the network."); const PARAM_NAMES: [&'static str; 1] = ["rawTx"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -2921,6 +2979,8 @@ 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("Submits a signed transaction to the network without trusted sender verification."); const PARAM_NAMES: [&'static str; 1] = ["rawTx"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -3183,6 +3243,8 @@ 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 logs matching the given filter criteria."); const N_REQUIRED_PARAMS: usize = 1; const PARAM_NAMES: [&'static str; 1] = ["ethFilter"]; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); @@ -3218,6 +3280,8 @@ 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 logs matching the given filter."); 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 174db788d935..f5f365a8b96b 100644 --- a/src/rpc/methods/f3.rs +++ b/src/rpc/methods/f3.rs @@ -57,6 +57,8 @@ pub enum GetRawNetworkName {} impl RpcMethod<0> for GetRawNetworkName { const NAME: &'static str = "F3.GetRawNetworkName"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the raw network name used by the F3 sidecar."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -82,6 +84,8 @@ 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("Returns the tipset at or before the given epoch."); const PARAM_NAMES: [&'static str; 1] = ["epoch"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -106,6 +110,8 @@ 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("Returns the tipset for the given F3 tipset key."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -127,6 +133,8 @@ 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("Returns the current chain head as an F3 tipset."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -146,6 +154,8 @@ 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("Returns the parent tipset of the given F3 tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -435,6 +445,8 @@ impl GetPowerTable { impl RpcMethod<1> for GetPowerTable { const NAME: &'static str = "F3.GetPowerTable"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the power table for the given F3 tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -459,6 +471,8 @@ 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("Marks the specified peer as protected from connection pruning."); const PARAM_NAMES: [&'static str; 1] = ["peer_id"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -487,6 +501,8 @@ pub enum GetParticipatingMinerIDs {} impl RpcMethod<0> for GetParticipatingMinerIDs { const NAME: &'static str = "F3.GetParticipatingMinerIDs"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the IDs of miners currently participating in F3."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -511,6 +527,8 @@ 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("Signals finalization of an F3 instance at the given tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -591,6 +609,8 @@ 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("Signs a message using the key of the miner identified by the given public key."); const PARAM_NAMES: [&'static str; 2] = ["pubkey", "message"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; @@ -647,6 +667,8 @@ 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("Returns the F3 finality certificate at the given instance number."); const PARAM_NAMES: [&'static str; 1] = ["instance"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -683,6 +705,8 @@ impl F3GetLatestCertificate { impl RpcMethod<0> for F3GetLatestCertificate { const NAME: &'static str = "Filecoin.F3GetLatestCertificate"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the latest F3 finality certificate."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -702,6 +726,8 @@ 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("Returns the EC power table for the given tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -722,6 +748,8 @@ 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("Returns the F3 power table for the given tipset."); const PARAM_NAMES: [&'static str; 1] = ["tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -782,6 +810,8 @@ impl F3IsRunning { impl RpcMethod<0> for F3IsRunning { const NAME: &'static str = "Filecoin.F3IsRunning"; + const DESCRIPTION: Option<&'static str> = + Some("Indicates whether the F3 subsystem is currently running."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -812,6 +842,8 @@ impl F3GetProgress { impl RpcMethod<0> for F3GetProgress { const NAME: &'static str = "Filecoin.F3GetProgress"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the current progress of the F3 instance."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -842,6 +874,8 @@ impl F3GetManifest { impl RpcMethod<0> for F3GetManifest { const NAME: &'static str = "Filecoin.F3GetManifest"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the current F3 manifest."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -862,6 +896,8 @@ 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("Returns the list of currently active F3 participants."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -896,6 +932,8 @@ impl F3ListParticipants { pub enum F3GetOrRenewParticipationTicket {} impl RpcMethod<3> for F3GetOrRenewParticipationTicket { const NAME: &'static str = "Filecoin.F3GetOrRenewParticipationTicket"; + const DESCRIPTION: Option<&'static str> = + Some("Gets or renews a participation ticket for the F3 protocol."); const PARAM_NAMES: [&'static str; 3] = ["miner_address", "previous_lease_ticket", "instances"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Sign; @@ -932,6 +970,8 @@ 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("Enrolls the caller as a participant in the F3 protocol using the given lease ticket."); const PARAM_NAMES: [&'static str; 1] = ["lease_ticket"]; 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 4bb936d4cf22..16301d0b520d 100644 --- a/src/rpc/methods/market.rs +++ b/src/rpc/methods/market.rs @@ -15,6 +15,8 @@ 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("Adds funds to the market actor escrow for the given address."); 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 ff1719cff82e..421f2aff2879 100644 --- a/src/rpc/methods/msig.rs +++ b/src/rpc/methods/msig.rs @@ -15,6 +15,8 @@ pub enum MsigGetAvailableBalance {} impl RpcMethod<2> for MsigGetAvailableBalance { const NAME: &'static str = "Filecoin.MsigGetAvailableBalance"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the portion of a multisig balance that can be immediately spent."); const PARAM_NAMES: [&'static str; 2] = ["address", "tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -44,6 +46,8 @@ pub enum MsigGetPending {} impl RpcMethod<2> for MsigGetPending { const NAME: &'static str = "Filecoin.MsigGetPending"; + const DESCRIPTION: Option<&'static str> = + Some("Returns all pending transactions for a multisig actor."); const PARAM_NAMES: [&'static str; 2] = ["address", "tipset_key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -79,6 +83,9 @@ 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( + "Returns the amount of FIL that has vested in a multisig actor between two tipsets.", + ); const PARAM_NAMES: [&'static str; 3] = ["address", "start_tsk", "end_tsk"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -119,6 +126,8 @@ 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("Returns the vesting schedule of a multisig actor."); 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 8dc798f46dfa..8fef1d5fe389 100644 --- a/src/rpc/methods/net.rs +++ b/src/rpc/methods/net.rs @@ -83,6 +83,8 @@ 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("Finds a peer by ID and returns its multiaddresses."); const PARAM_NAMES: [&'static str; 1] = ["peer_id"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -113,6 +115,8 @@ impl RpcMethod<1> for NetFindPeer { pub enum NetListening {} impl RpcMethod<0> for NetListening { const NAME: &'static str = "Filecoin.NetListening"; + const DESCRIPTION: Option<&'static str> = + Some("Indicates whether the node is currently listening for connections."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; @@ -133,6 +137,8 @@ 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("Returns general information about the libp2p network stack."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -250,6 +256,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("Returns the AutoNAT status of the node."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -275,6 +283,8 @@ impl RpcMethod<0> for NetAutoNatStatus { pub enum NetVersion {} impl RpcMethod<0> for NetVersion { const NAME: &'static str = "Filecoin.NetVersion"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the current network version (chain ID) as a string."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all_with_v2(); const PERMISSION: Permission = Permission::Read; diff --git a/src/rpc/methods/node.rs b/src/rpc/methods/node.rs index f406cf666ee5..58438e96f538 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 and chain health status of 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 e16367ba31f9..59b4ef60af2f 100644 --- a/src/rpc/methods/state.rs +++ b/src/rpc/methods/state.rs @@ -142,6 +142,8 @@ 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("Returns the human-readable name of the Filecoin network."); const PARAM_NAMES: [&'static str; 0] = []; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -1179,6 +1181,8 @@ pub enum StateGetReceipt {} impl RpcMethod<2> for StateGetReceipt { const NAME: &'static str = "Filecoin.StateGetReceipt"; + const DESCRIPTION: Option<&'static str> = + Some("Returns the message receipt for the given message CID."); const PARAM_NAMES: [&'static str; 2] = ["cid", "tipset_key"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // deprecated in V1 const PERMISSION: Permission = Permission::Read; @@ -1204,6 +1208,8 @@ pub enum StateWaitMsgV0 {} impl RpcMethod<2> for StateWaitMsgV0 { const NAME: &'static str = "Filecoin.StateWaitMsg"; + const DESCRIPTION: Option<&'static str> = + Some("Searches for a message on chain, blocking until it appears, then returns its receipt."); const PARAM_NAMES: [&'static str; 2] = ["messageCid", "confidence"]; const API_PATHS: BitFlags = make_bitflags!(ApiPaths::V0); // Changed in V1 const PERMISSION: Permission = Permission::Read; @@ -1380,6 +1386,8 @@ pub enum StateFetchRoot {} impl RpcMethod<2> for StateFetchRoot { const NAME: &'static str = "Forest.StateFetchRoot"; + const DESCRIPTION: Option<&'static str> = + Some("Fetches and ensures the given state root is available in the blockstore."); const PARAM_NAMES: [&'static str; 2] = ["root_cid", "save_to_file"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -2184,6 +2192,8 @@ pub enum StateSectorPreCommitInfoV0 {} impl RpcMethod<3> for StateSectorPreCommitInfoV0 { const NAME: &'static str = "Filecoin.StateSectorPreCommitInfo"; + const DESCRIPTION: Option<&'static str> = + Some("Returns pre-committed sector information for the given miner and sector number."); 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; @@ -3289,6 +3299,8 @@ 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("Returns the initial pledge collateral required for a sector."); 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 f0e45d05fc5f..9cc2b71a9e90 100644 --- a/src/rpc/methods/sync.rs +++ b/src/rpc/methods/sync.rs @@ -17,6 +17,8 @@ pub use types::*; pub enum SyncCheckBad {} impl RpcMethod<1> for SyncCheckBad { const NAME: &'static str = "Filecoin.SyncCheckBad"; + const DESCRIPTION: Option<&'static str> = + Some("Checks whether a block CID is in the bad block cache."); const PARAM_NAMES: [&'static str; 1] = ["cid"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -42,6 +44,8 @@ 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("Marks a block CID as bad, causing the node to ignore it."); 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 6a82b214c595..b4810b1da8f1 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("Returns the default wallet address."); 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("Exports the key info for the given address."); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -105,6 +109,8 @@ 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("Imports a key into the wallet and returns the associated address."); const PARAM_NAMES: [&'static str; 1] = ["key"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Admin; @@ -149,6 +155,8 @@ 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("Creates a new wallet address with the given signature type."); const PARAM_NAMES: [&'static str; 1] = ["signature_type"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -177,6 +185,8 @@ 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("Sets the default wallet address."); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write; @@ -265,6 +275,8 @@ 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("Validates and parses the given address string."); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -284,6 +296,8 @@ 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("Verifies a signature against the given address and data."); const PARAM_NAMES: [&'static str; 3] = ["address", "message", "signature"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Read; @@ -303,6 +317,8 @@ 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("Deletes the key for the given address from the wallet."); const PARAM_NAMES: [&'static str; 1] = ["address"]; const API_PATHS: BitFlags = ApiPaths::all(); const PERMISSION: Permission = Permission::Write;