diff --git a/docs/openrpc-specs/v0.json b/docs/openrpc-specs/v0.json index 4b08ff22c00..8e0d2461325 100644 --- a/docs/openrpc-specs/v0.json +++ b/docs/openrpc-specs/v0.json @@ -792,6 +792,7 @@ }, { "name": "Filecoin.EthAccounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "Filecoin.EthAccounts.Result", @@ -844,6 +845,7 @@ }, { "name": "Filecoin.EthBlockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "Filecoin.EthBlockNumber.Result", @@ -856,6 +858,7 @@ }, { "name": "Filecoin.EthCall", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -883,6 +886,7 @@ }, { "name": "Filecoin.EthChainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "Filecoin.EthChainId.Result", @@ -895,6 +899,7 @@ }, { "name": "Filecoin.EthEstimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -929,6 +934,7 @@ }, { "name": "Filecoin.EthFeeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -1011,6 +1017,7 @@ }, { "name": "Filecoin.EthGetBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -1128,6 +1135,7 @@ }, { "name": "Filecoin.EthGetBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -1218,6 +1226,7 @@ }, { "name": "Filecoin.EthGetFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -1238,6 +1247,7 @@ }, { "name": "Filecoin.EthGetLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -1258,6 +1268,7 @@ }, { "name": "Filecoin.EthGetMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -1320,6 +1331,7 @@ }, { "name": "Filecoin.EthGetTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -1389,6 +1401,7 @@ }, { "name": "Filecoin.EthGetTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -1416,6 +1429,7 @@ }, { "name": "Filecoin.EthGetTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -1451,6 +1465,7 @@ }, { "name": "Filecoin.EthGetTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -1478,6 +1493,7 @@ }, { "name": "Filecoin.EthGetTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -1505,6 +1521,7 @@ }, { "name": "Filecoin.EthGetTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -1532,6 +1549,7 @@ }, { "name": "Filecoin.EthGetTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -1567,6 +1585,7 @@ }, { "name": "Filecoin.EthMaxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "Filecoin.EthMaxPriorityFeePerGas.Result", @@ -1579,6 +1598,7 @@ }, { "name": "Filecoin.EthNewBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "Filecoin.EthNewBlockFilter.Result", @@ -1591,6 +1611,7 @@ }, { "name": "Filecoin.EthNewFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -1611,6 +1632,7 @@ }, { "name": "Filecoin.EthNewPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "Filecoin.EthNewPendingTransactionFilter.Result", @@ -1623,6 +1645,7 @@ }, { "name": "Filecoin.EthProtocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "Filecoin.EthProtocolVersion.Result", @@ -1635,6 +1658,7 @@ }, { "name": "Filecoin.EthSendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -1655,6 +1679,7 @@ }, { "name": "Filecoin.EthSendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -1675,6 +1700,7 @@ }, { "name": "Filecoin.EthSubscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "Filecoin.EthSubscribe.Result", @@ -1687,6 +1713,7 @@ }, { "name": "Filecoin.EthSyncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "Filecoin.EthSyncing.Result", @@ -1820,6 +1847,7 @@ }, { "name": "Filecoin.EthUninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -1840,6 +1868,7 @@ }, { "name": "Filecoin.EthUnsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "Filecoin.EthUnsubscribe.Result", @@ -2873,6 +2902,7 @@ }, { "name": "Filecoin.NetAutoNatStatus", + "description": "Returns the node's AutoNAT reachability status and observed public addresses.", "params": [], "result": { "name": "Filecoin.NetAutoNatStatus.Result", @@ -2927,6 +2957,7 @@ }, { "name": "Filecoin.NetFindPeer", + "description": "Returns the known addresses of the peer with the given peer ID.", "params": [ { "name": "peerId", @@ -2947,6 +2978,7 @@ }, { "name": "Filecoin.NetListening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "Filecoin.NetListening.Result", @@ -3051,6 +3083,7 @@ }, { "name": "Filecoin.NetVersion", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "Filecoin.NetVersion.Result", @@ -3920,6 +3953,7 @@ }, { "name": "Filecoin.StateGetReceipt", + "description": "Returns the receipt for the message with the given CID at the specified tipset (deprecated in V1).", "params": [ { "name": "cid", @@ -4522,6 +4556,7 @@ }, { "name": "Filecoin.StateMinerInitialPledgeForSector", + "description": "Returns the initial pledge collateral required to commit a sector with the given duration, size, and verified deal size at the specified tipset.", "params": [ { "name": "sector_duration", @@ -4895,6 +4930,7 @@ }, { "name": "Filecoin.StateNetworkName", + "description": "Returns the name of the network the node is synced to.", "params": [], "result": { "name": "Filecoin.StateNetworkName.Result", @@ -5230,6 +5266,7 @@ }, { "name": "Filecoin.StateSectorPreCommitInfo", + "description": "Returns the on-chain pre-commit information for the given miner's sector, erroring if the sector is not precommitted.", "params": [ { "name": "minerAddress", @@ -5408,6 +5445,7 @@ }, { "name": "Filecoin.StateWaitMsg", + "description": "Searches the chain for the given message and, if not found, blocks until it appears on-chain and reaches the required confidence depth.", "params": [ { "name": "messageCid", @@ -5530,6 +5568,7 @@ }, { "name": "Filecoin.WalletDefaultAddress", + "description": "Returns the default wallet address, or null if no default is set.", "params": [], "result": { "name": "Filecoin.WalletDefaultAddress.Result", @@ -5549,6 +5588,7 @@ }, { "name": "Filecoin.WalletDelete", + "description": "Removes the key for the given address from the wallet.", "params": [ { "name": "address", @@ -5569,6 +5609,7 @@ }, { "name": "Filecoin.WalletExport", + "description": "Exports the key information, including the private key, for the given wallet address.", "params": [ { "name": "address", @@ -5610,6 +5651,7 @@ }, { "name": "Filecoin.WalletImport", + "description": "Imports a key into the wallet and returns its address.", "params": [ { "name": "key", @@ -5649,6 +5691,7 @@ }, { "name": "Filecoin.WalletNew", + "description": "Generates a new key of the given signature type, adds it to the wallet, and returns its address.", "params": [ { "name": "signatureType", @@ -5669,6 +5712,7 @@ }, { "name": "Filecoin.WalletSetDefault", + "description": "Sets the given address as the default wallet address.", "params": [ { "name": "address", @@ -5745,6 +5789,7 @@ }, { "name": "Filecoin.WalletValidateAddress", + "description": "Validates the given string as a Filecoin address and returns the parsed address.", "params": [ { "name": "address", @@ -5765,6 +5810,7 @@ }, { "name": "Filecoin.WalletVerify", + "description": "Returns whether the given signature is valid for the message and address.", "params": [ { "name": "address", @@ -5799,6 +5845,7 @@ }, { "name": "Filecoin.Web3ClientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "Filecoin.Web3ClientVersion.Result", @@ -5991,6 +6038,7 @@ }, { "name": "Forest.NetInfo", + "description": "Returns peer and connection statistics for the node's libp2p network.", "params": [], "result": { "name": "Forest.NetInfo.Result", @@ -6086,6 +6134,7 @@ }, { "name": "Forest.StateFetchRoot", + "description": "Traverses the IPLD graph under the given root CID, fetching any missing nodes over the network, and optionally writes them to a CAR file.", "params": [ { "name": "rootCid", @@ -6142,6 +6191,7 @@ }, { "name": "eth_accounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "eth_accounts.Result", @@ -6173,6 +6223,7 @@ }, { "name": "eth_blockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "eth_blockNumber.Result", @@ -6185,6 +6236,7 @@ }, { "name": "eth_call", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -6212,6 +6264,7 @@ }, { "name": "eth_chainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "eth_chainId.Result", @@ -6224,6 +6277,7 @@ }, { "name": "eth_estimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -6258,6 +6312,7 @@ }, { "name": "eth_feeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -6340,6 +6395,7 @@ }, { "name": "eth_getBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -6457,6 +6513,7 @@ }, { "name": "eth_getBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -6547,6 +6604,7 @@ }, { "name": "eth_getFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -6567,6 +6625,7 @@ }, { "name": "eth_getLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -6587,6 +6646,7 @@ }, { "name": "eth_getMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -6649,6 +6709,7 @@ }, { "name": "eth_getTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -6718,6 +6779,7 @@ }, { "name": "eth_getTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -6745,6 +6807,7 @@ }, { "name": "eth_getTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -6780,6 +6843,7 @@ }, { "name": "eth_getTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -6807,6 +6871,7 @@ }, { "name": "eth_getTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -6834,6 +6899,7 @@ }, { "name": "eth_getTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -6861,6 +6927,7 @@ }, { "name": "eth_getTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -6896,6 +6963,7 @@ }, { "name": "eth_maxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "eth_maxPriorityFeePerGas.Result", @@ -6908,6 +6976,7 @@ }, { "name": "eth_newBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "eth_newBlockFilter.Result", @@ -6920,6 +6989,7 @@ }, { "name": "eth_newFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -6940,6 +7010,7 @@ }, { "name": "eth_newPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "eth_newPendingTransactionFilter.Result", @@ -6952,6 +7023,7 @@ }, { "name": "eth_protocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "eth_protocolVersion.Result", @@ -6964,6 +7036,7 @@ }, { "name": "eth_sendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -6984,6 +7057,7 @@ }, { "name": "eth_sendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -7004,6 +7078,7 @@ }, { "name": "eth_subscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "eth_subscribe.Result", @@ -7016,6 +7091,7 @@ }, { "name": "eth_syncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "eth_syncing.Result", @@ -7028,6 +7104,7 @@ }, { "name": "eth_uninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -7048,6 +7125,7 @@ }, { "name": "eth_unsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "eth_unsubscribe.Result", @@ -7060,6 +7138,7 @@ }, { "name": "net_listening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "net_listening.Result", @@ -7072,6 +7151,7 @@ }, { "name": "net_version", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "net_version.Result", @@ -7205,6 +7285,7 @@ }, { "name": "web3_clientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "web3_clientVersion.Result", diff --git a/docs/openrpc-specs/v1.json b/docs/openrpc-specs/v1.json index c36bc41a878..ff91b9b37b2 100644 --- a/docs/openrpc-specs/v1.json +++ b/docs/openrpc-specs/v1.json @@ -784,6 +784,7 @@ }, { "name": "Filecoin.EthAccounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "Filecoin.EthAccounts.Result", @@ -836,6 +837,7 @@ }, { "name": "Filecoin.EthBlockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "Filecoin.EthBlockNumber.Result", @@ -848,6 +850,7 @@ }, { "name": "Filecoin.EthCall", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -875,6 +878,7 @@ }, { "name": "Filecoin.EthChainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "Filecoin.EthChainId.Result", @@ -887,6 +891,7 @@ }, { "name": "Filecoin.EthEstimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -921,6 +926,7 @@ }, { "name": "Filecoin.EthFeeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -1003,6 +1009,7 @@ }, { "name": "Filecoin.EthGetBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -1120,6 +1127,7 @@ }, { "name": "Filecoin.EthGetBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -1210,6 +1218,7 @@ }, { "name": "Filecoin.EthGetFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -1230,6 +1239,7 @@ }, { "name": "Filecoin.EthGetLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -1250,6 +1260,7 @@ }, { "name": "Filecoin.EthGetMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -1312,6 +1323,7 @@ }, { "name": "Filecoin.EthGetTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -1381,6 +1393,7 @@ }, { "name": "Filecoin.EthGetTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -1408,6 +1421,7 @@ }, { "name": "Filecoin.EthGetTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -1443,6 +1457,7 @@ }, { "name": "Filecoin.EthGetTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -1470,6 +1485,7 @@ }, { "name": "Filecoin.EthGetTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -1497,6 +1513,7 @@ }, { "name": "Filecoin.EthGetTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -1524,6 +1541,7 @@ }, { "name": "Filecoin.EthGetTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -1559,6 +1577,7 @@ }, { "name": "Filecoin.EthMaxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "Filecoin.EthMaxPriorityFeePerGas.Result", @@ -1571,6 +1590,7 @@ }, { "name": "Filecoin.EthNewBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "Filecoin.EthNewBlockFilter.Result", @@ -1583,6 +1603,7 @@ }, { "name": "Filecoin.EthNewFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -1603,6 +1624,7 @@ }, { "name": "Filecoin.EthNewPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "Filecoin.EthNewPendingTransactionFilter.Result", @@ -1615,6 +1637,7 @@ }, { "name": "Filecoin.EthProtocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "Filecoin.EthProtocolVersion.Result", @@ -1627,6 +1650,7 @@ }, { "name": "Filecoin.EthSendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -1647,6 +1671,7 @@ }, { "name": "Filecoin.EthSendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -1667,6 +1692,7 @@ }, { "name": "Filecoin.EthSubscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "Filecoin.EthSubscribe.Result", @@ -1679,6 +1705,7 @@ }, { "name": "Filecoin.EthSyncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "Filecoin.EthSyncing.Result", @@ -1812,6 +1839,7 @@ }, { "name": "Filecoin.EthUninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -1832,6 +1860,7 @@ }, { "name": "Filecoin.EthUnsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "Filecoin.EthUnsubscribe.Result", @@ -2865,6 +2894,7 @@ }, { "name": "Filecoin.NetAutoNatStatus", + "description": "Returns the node's AutoNAT reachability status and observed public addresses.", "params": [], "result": { "name": "Filecoin.NetAutoNatStatus.Result", @@ -2919,6 +2949,7 @@ }, { "name": "Filecoin.NetFindPeer", + "description": "Returns the known addresses of the peer with the given peer ID.", "params": [ { "name": "peerId", @@ -2939,6 +2970,7 @@ }, { "name": "Filecoin.NetListening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "Filecoin.NetListening.Result", @@ -3043,6 +3075,7 @@ }, { "name": "Filecoin.NetVersion", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "Filecoin.NetVersion.Result", @@ -4481,6 +4514,7 @@ }, { "name": "Filecoin.StateMinerInitialPledgeForSector", + "description": "Returns the initial pledge collateral required to commit a sector with the given duration, size, and verified deal size at the specified tipset.", "params": [ { "name": "sector_duration", @@ -4854,6 +4888,7 @@ }, { "name": "Filecoin.StateNetworkName", + "description": "Returns the name of the network the node is synced to.", "params": [], "result": { "name": "Filecoin.StateNetworkName.Result", @@ -5477,6 +5512,7 @@ }, { "name": "Filecoin.WalletDefaultAddress", + "description": "Returns the default wallet address, or null if no default is set.", "params": [], "result": { "name": "Filecoin.WalletDefaultAddress.Result", @@ -5496,6 +5532,7 @@ }, { "name": "Filecoin.WalletDelete", + "description": "Removes the key for the given address from the wallet.", "params": [ { "name": "address", @@ -5516,6 +5553,7 @@ }, { "name": "Filecoin.WalletExport", + "description": "Exports the key information, including the private key, for the given wallet address.", "params": [ { "name": "address", @@ -5557,6 +5595,7 @@ }, { "name": "Filecoin.WalletImport", + "description": "Imports a key into the wallet and returns its address.", "params": [ { "name": "key", @@ -5596,6 +5635,7 @@ }, { "name": "Filecoin.WalletNew", + "description": "Generates a new key of the given signature type, adds it to the wallet, and returns its address.", "params": [ { "name": "signatureType", @@ -5616,6 +5656,7 @@ }, { "name": "Filecoin.WalletSetDefault", + "description": "Sets the given address as the default wallet address.", "params": [ { "name": "address", @@ -5692,6 +5733,7 @@ }, { "name": "Filecoin.WalletValidateAddress", + "description": "Validates the given string as a Filecoin address and returns the parsed address.", "params": [ { "name": "address", @@ -5712,6 +5754,7 @@ }, { "name": "Filecoin.WalletVerify", + "description": "Returns whether the given signature is valid for the message and address.", "params": [ { "name": "address", @@ -5746,6 +5789,7 @@ }, { "name": "Filecoin.Web3ClientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "Filecoin.Web3ClientVersion.Result", @@ -6015,6 +6059,7 @@ }, { "name": "Forest.NetInfo", + "description": "Returns peer and connection statistics for the node's libp2p network.", "params": [], "result": { "name": "Forest.NetInfo.Result", @@ -6110,6 +6155,7 @@ }, { "name": "Forest.StateFetchRoot", + "description": "Traverses the IPLD graph under the given root CID, fetching any missing nodes over the network, and optionally writes them to a CAR file.", "params": [ { "name": "rootCid", @@ -6201,6 +6247,7 @@ }, { "name": "eth_accounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "eth_accounts.Result", @@ -6232,6 +6279,7 @@ }, { "name": "eth_blockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "eth_blockNumber.Result", @@ -6244,6 +6292,7 @@ }, { "name": "eth_call", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -6271,6 +6320,7 @@ }, { "name": "eth_chainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "eth_chainId.Result", @@ -6283,6 +6333,7 @@ }, { "name": "eth_estimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -6317,6 +6368,7 @@ }, { "name": "eth_feeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -6399,6 +6451,7 @@ }, { "name": "eth_getBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -6516,6 +6569,7 @@ }, { "name": "eth_getBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -6606,6 +6660,7 @@ }, { "name": "eth_getFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -6626,6 +6681,7 @@ }, { "name": "eth_getLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -6646,6 +6702,7 @@ }, { "name": "eth_getMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -6708,6 +6765,7 @@ }, { "name": "eth_getTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -6777,6 +6835,7 @@ }, { "name": "eth_getTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -6804,6 +6863,7 @@ }, { "name": "eth_getTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -6839,6 +6899,7 @@ }, { "name": "eth_getTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -6866,6 +6927,7 @@ }, { "name": "eth_getTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -6893,6 +6955,7 @@ }, { "name": "eth_getTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -6920,6 +6983,7 @@ }, { "name": "eth_getTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -6955,6 +7019,7 @@ }, { "name": "eth_maxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "eth_maxPriorityFeePerGas.Result", @@ -6967,6 +7032,7 @@ }, { "name": "eth_newBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "eth_newBlockFilter.Result", @@ -6979,6 +7045,7 @@ }, { "name": "eth_newFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -6999,6 +7066,7 @@ }, { "name": "eth_newPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "eth_newPendingTransactionFilter.Result", @@ -7011,6 +7079,7 @@ }, { "name": "eth_protocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "eth_protocolVersion.Result", @@ -7023,6 +7092,7 @@ }, { "name": "eth_sendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -7043,6 +7113,7 @@ }, { "name": "eth_sendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -7063,6 +7134,7 @@ }, { "name": "eth_subscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "eth_subscribe.Result", @@ -7075,6 +7147,7 @@ }, { "name": "eth_syncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "eth_syncing.Result", @@ -7087,6 +7160,7 @@ }, { "name": "eth_uninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -7107,6 +7181,7 @@ }, { "name": "eth_unsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "eth_unsubscribe.Result", @@ -7119,6 +7194,7 @@ }, { "name": "net_listening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "net_listening.Result", @@ -7131,6 +7207,7 @@ }, { "name": "net_version", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "net_version.Result", @@ -7306,6 +7383,7 @@ }, { "name": "web3_clientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "web3_clientVersion.Result", diff --git a/docs/openrpc-specs/v2.json b/docs/openrpc-specs/v2.json index 217713ceea5..c33745352ad 100644 --- a/docs/openrpc-specs/v2.json +++ b/docs/openrpc-specs/v2.json @@ -41,6 +41,7 @@ }, { "name": "Filecoin.EthAccounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "Filecoin.EthAccounts.Result", @@ -93,6 +94,7 @@ }, { "name": "Filecoin.EthBlockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "Filecoin.EthBlockNumber.Result", @@ -105,6 +107,7 @@ }, { "name": "Filecoin.EthCall", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -132,6 +135,7 @@ }, { "name": "Filecoin.EthChainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "Filecoin.EthChainId.Result", @@ -144,6 +148,7 @@ }, { "name": "Filecoin.EthEstimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -178,6 +183,7 @@ }, { "name": "Filecoin.EthFeeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -260,6 +266,7 @@ }, { "name": "Filecoin.EthGetBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -377,6 +384,7 @@ }, { "name": "Filecoin.EthGetBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -467,6 +475,7 @@ }, { "name": "Filecoin.EthGetFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -487,6 +496,7 @@ }, { "name": "Filecoin.EthGetLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -507,6 +517,7 @@ }, { "name": "Filecoin.EthGetMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -569,6 +580,7 @@ }, { "name": "Filecoin.EthGetTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -638,6 +650,7 @@ }, { "name": "Filecoin.EthGetTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -665,6 +678,7 @@ }, { "name": "Filecoin.EthGetTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -700,6 +714,7 @@ }, { "name": "Filecoin.EthGetTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -727,6 +742,7 @@ }, { "name": "Filecoin.EthGetTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -754,6 +770,7 @@ }, { "name": "Filecoin.EthGetTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -781,6 +798,7 @@ }, { "name": "Filecoin.EthGetTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -816,6 +834,7 @@ }, { "name": "Filecoin.EthMaxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "Filecoin.EthMaxPriorityFeePerGas.Result", @@ -828,6 +847,7 @@ }, { "name": "Filecoin.EthNewBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "Filecoin.EthNewBlockFilter.Result", @@ -840,6 +860,7 @@ }, { "name": "Filecoin.EthNewFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -860,6 +881,7 @@ }, { "name": "Filecoin.EthNewPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "Filecoin.EthNewPendingTransactionFilter.Result", @@ -872,6 +894,7 @@ }, { "name": "Filecoin.EthProtocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "Filecoin.EthProtocolVersion.Result", @@ -884,6 +907,7 @@ }, { "name": "Filecoin.EthSendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -904,6 +928,7 @@ }, { "name": "Filecoin.EthSendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -924,6 +949,7 @@ }, { "name": "Filecoin.EthSubscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "Filecoin.EthSubscribe.Result", @@ -936,6 +962,7 @@ }, { "name": "Filecoin.EthSyncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "Filecoin.EthSyncing.Result", @@ -1069,6 +1096,7 @@ }, { "name": "Filecoin.EthUninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -1089,6 +1117,7 @@ }, { "name": "Filecoin.EthUnsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "Filecoin.EthUnsubscribe.Result", @@ -1136,6 +1165,7 @@ }, { "name": "Filecoin.NetListening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "Filecoin.NetListening.Result", @@ -1148,6 +1178,7 @@ }, { "name": "Filecoin.NetVersion", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "Filecoin.NetVersion.Result", @@ -1223,6 +1254,7 @@ }, { "name": "Filecoin.Web3ClientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "Filecoin.Web3ClientVersion.Result", @@ -1478,6 +1510,7 @@ }, { "name": "eth_accounts", + "description": "Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.", "params": [], "result": { "name": "eth_accounts.Result", @@ -1509,6 +1542,7 @@ }, { "name": "eth_blockNumber", + "description": "Returns the height of the latest executed tipset, which is the parent of the current head.", "params": [], "result": { "name": "eth_blockNumber.Result", @@ -1521,6 +1555,7 @@ }, { "name": "eth_call", + "description": "Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.", "params": [ { "name": "tx", @@ -1548,6 +1583,7 @@ }, { "name": "eth_chainId", + "description": "Returns the EIP-155 chain ID of the current network.", "params": [], "result": { "name": "eth_chainId.Result", @@ -1560,6 +1596,7 @@ }, { "name": "eth_estimateGas", + "description": "Estimates the amount of gas required to execute the given transaction.", "params": [ { "name": "tx", @@ -1594,6 +1631,7 @@ }, { "name": "eth_feeHistory", + "description": "Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.", "params": [ { "name": "blockCount", @@ -1676,6 +1714,7 @@ }, { "name": "eth_getBlockByHash", + "description": "Retrieves a block by its hash, optionally including full transaction objects.", "params": [ { "name": "blockHash", @@ -1793,6 +1832,7 @@ }, { "name": "eth_getBlockTransactionCountByHash", + "description": "Returns the number of messages in the tipset identified by the given block hash.", "params": [ { "name": "blockHash", @@ -1883,6 +1923,7 @@ }, { "name": "eth_getFilterLogs", + "description": "Returns event logs matching the filter with the given ID that have not been collected since the last poll.", "params": [ { "name": "filterId", @@ -1903,6 +1944,7 @@ }, { "name": "eth_getLogs", + "description": "Returns event logs matching the given filter specification.", "params": [ { "name": "ethFilter", @@ -1923,6 +1965,7 @@ }, { "name": "eth_getMessageCidByTransactionHash", + "description": "Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.", "params": [ { "name": "txHash", @@ -1985,6 +2028,7 @@ }, { "name": "eth_getTransactionByBlockHashAndIndex", + "description": "Retrieves a transaction by its block hash and index.", "params": [ { "name": "blockHash", @@ -2054,6 +2098,7 @@ }, { "name": "eth_getTransactionByHash", + "description": "Retrieves a transaction by its hash.", "params": [ { "name": "txHash", @@ -2081,6 +2126,7 @@ }, { "name": "eth_getTransactionByHashLimited", + "description": "Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -2116,6 +2162,7 @@ }, { "name": "eth_getTransactionCount", + "description": "Returns the number of transactions sent from an address (its nonce) at the specified block state.", "params": [ { "name": "sender", @@ -2143,6 +2190,7 @@ }, { "name": "eth_getTransactionHashByCid", + "description": "Returns the Ethereum transaction hash for the given Filecoin message CID.", "params": [ { "name": "cid", @@ -2170,6 +2218,7 @@ }, { "name": "eth_getTransactionReceipt", + "description": "Returns the receipt of a transaction identified by its hash.", "params": [ { "name": "txHash", @@ -2197,6 +2246,7 @@ }, { "name": "eth_getTransactionReceiptLimited", + "description": "Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.", "params": [ { "name": "txHash", @@ -2232,6 +2282,7 @@ }, { "name": "eth_maxPriorityFeePerGas", + "description": "Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.", "params": [], "result": { "name": "eth_maxPriorityFeePerGas.Result", @@ -2244,6 +2295,7 @@ }, { "name": "eth_newBlockFilter", + "description": "Installs a persistent filter that tracks the arrival of new blocks.", "params": [], "result": { "name": "eth_newBlockFilter.Result", @@ -2256,6 +2308,7 @@ }, { "name": "eth_newFilter", + "description": "Installs a persistent filter for matching event logs based on the given filter spec.", "params": [ { "name": "filterSpec", @@ -2276,6 +2329,7 @@ }, { "name": "eth_newPendingTransactionFilter", + "description": "Installs a persistent filter that tracks new messages arriving in the message pool.", "params": [], "result": { "name": "eth_newPendingTransactionFilter.Result", @@ -2288,6 +2342,7 @@ }, { "name": "eth_protocolVersion", + "description": "Returns the current Filecoin network version, reported as the Ethereum protocol version.", "params": [], "result": { "name": "eth_protocolVersion.Result", @@ -2300,6 +2355,7 @@ }, { "name": "eth_sendRawTransaction", + "description": "Submits a signed raw transaction to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -2320,6 +2376,7 @@ }, { "name": "eth_sendRawTransactionUntrusted", + "description": "Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.", "params": [ { "name": "rawTx", @@ -2340,6 +2397,7 @@ }, { "name": "eth_subscribe", + "description": "Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.", "params": [], "result": { "name": "eth_subscribe.Result", @@ -2352,6 +2410,7 @@ }, { "name": "eth_syncing", + "description": "Returns the node's sync status, or `false` if the node is not currently syncing.", "params": [], "result": { "name": "eth_syncing.Result", @@ -2364,6 +2423,7 @@ }, { "name": "eth_uninstallFilter", + "description": "Uninstalls the filter with the given ID.", "params": [ { "name": "filterId", @@ -2384,6 +2444,7 @@ }, { "name": "eth_unsubscribe", + "description": "Cancels an existing websocket subscription identified by its subscription ID.", "params": [], "result": { "name": "eth_unsubscribe.Result", @@ -2396,6 +2457,7 @@ }, { "name": "net_listening", + "description": "Returns whether the node is listening for network connections (always `true`).", "params": [], "result": { "name": "net_listening.Result", @@ -2408,6 +2470,7 @@ }, { "name": "net_version", + "description": "Returns the current network ID (the EIP-155 chain ID) as a decimal string.", "params": [], "result": { "name": "net_version.Result", @@ -2583,6 +2646,7 @@ }, { "name": "web3_clientVersion", + "description": "Returns the client version string of the running node.", "params": [], "result": { "name": "web3_clientVersion.Result",