JSON-RPC Methods Reference

This page provides a comprehensive reference for all RPC methods supported by Forest across multiple API versions. You can search, filter by namespace, switch between API versions, and expand individual methods to see detailed parameter and return type information.

info

This reference is automatically generated from the OpenRPC specifications in the repository. For the interactive schema explorer, see the Schema Explorer page.

API Versions

Forest supports multiple RPC API versions:

V0 - Deprecated API
V1 - Stable API - Recommended for production use
V2 - Experimental API

Use the version selector to switch between versions and see the methods available in each.

Complete reference for all RPC methods across multiple API versions

API Version:

Namespace:

Showing 269 methods in V0

eth(40 methods)

eth_accounts

Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.

eth_baseFee

Returns the calculated base fee of the upcoming tipset in attoFIL

eth_blockNumber

Returns the height of the latest executed tipset, which is the parent of the current head.

eth_call

Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.

eth_chainId

Returns the EIP-155 chain ID of the current network.

eth_estimateGas

Estimates the amount of gas required to execute the given transaction.

eth_feeHistory

Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.

eth_gasPrice

Returns the current gas price in attoFIL

eth_getBalance

Returns the balance of an Ethereum address at the specified block state

eth_getBlockByHash

Retrieves a block by its hash, optionally including full transaction objects.

eth_getBlockByNumber

Retrieves a block by its number or a special tag.

eth_getBlockReceipts

Retrieves all transaction receipts for a block by its number, hash or a special tag.

eth_getBlockReceiptsLimited

Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution.

eth_getBlockTransactionCountByHash

Returns the number of messages in the tipset identified by the given block hash.

eth_getBlockTransactionCountByNumber

Returns the number of transactions in a block identified by its block number or a special tag.

eth_getCode

Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag.

eth_getFilterChanges

Returns event logs which occurred since the last poll

eth_getFilterLogs

Returns event logs matching the filter with the given ID that have not been collected since the last poll.

eth_getLogs

Returns event logs matching the given filter specification.

eth_getMessageCidByTransactionHash

Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.

eth_getStorageAt

Retrieves the storage value at a specific position for a contract at a given block state, identified by its number, hash, or a special tag.

eth_getTransactionByBlockHashAndIndex

Retrieves a transaction by its block hash and index.

eth_getTransactionByBlockNumberAndIndex

Retrieves a transaction by its block number and index.

eth_getTransactionByHash

Retrieves a transaction by its hash.

eth_getTransactionByHashLimited

Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.

eth_getTransactionCount

Returns the number of transactions sent from an address (its nonce) at the specified block state.

eth_getTransactionHashByCid

Returns the Ethereum transaction hash for the given Filecoin message CID.

eth_getTransactionReceipt

Returns the receipt of a transaction identified by its hash.

eth_getTransactionReceiptLimited

Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.

eth_maxPriorityFeePerGas

Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.

eth_newBlockFilter

Installs a persistent filter that tracks the arrival of new blocks.

eth_newFilter

Installs a persistent filter for matching event logs based on the given filter spec.

eth_newPendingTransactionFilter

Installs a persistent filter that tracks new messages arriving in the message pool.

eth_protocolVersion

Returns the current Filecoin network version, reported as the Ethereum protocol version.

eth_sendRawTransaction

Submits a signed raw transaction to the message pool and returns its transaction hash.

eth_sendRawTransactionUntrusted

Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.

eth_subscribe

Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.

eth_syncing

Returns the node's sync status, or `false` if the node is not currently syncing.

eth_uninstallFilter

Uninstalls the filter with the given ID.

eth_unsubscribe

Cancels an existing websocket subscription identified by its subscription ID.

F3(11 methods)

F3.ExportLatestSnapshot

Exports the latest F3 snapshot to the specified path and returns its CID

F3.Finalize

F3.GetHead

F3.GetParent

F3.GetParticipatingMinerIDs

F3.GetPowerTable

F3.GetRawNetworkName

F3.GetTipset

F3.GetTipsetByEpoch

F3.ProtectPeer

F3.SignMessage

Filecoin(196 methods)

Filecoin.AuthNew

Filecoin.AuthVerify

Filecoin.BeaconGetEntry

Filecoin.ChainExport

Filecoin.ChainGetBlock

Returns the block with the specified CID.

Filecoin.ChainGetBlockMessages

Returns all messages from the specified block.

Filecoin.ChainGetEvents

Returns the events under the given event AMT root CID.

Filecoin.ChainGetGenesis

Filecoin.ChainGetMessage

Returns the message with the specified CID.

Filecoin.ChainGetMessagesInTipset

Filecoin.ChainGetParentMessages

Returns the messages included in the blocks of the parent tipset.

Filecoin.ChainGetParentReceipts

Returns the message receipts included in the blocks of the parent tipset.

Filecoin.ChainGetPath

Returns the path between the two specified tipsets.

Filecoin.ChainGetTipSet

Returns the tipset with the specified CID.

Filecoin.ChainGetTipSetAfterHeight

Looks back and returns the tipset at the specified epoch. If there are no blocks at the given epoch, returns the first non-nil tipset at a later epoch.

Filecoin.ChainGetTipSetByHeight

Returns the tipset at the specified height.

Filecoin.ChainHasObj

Checks if a given CID exists in the chain blockstore.

Filecoin.ChainHead

Returns the chain head (heaviest tipset).

Filecoin.ChainReadObj

Reads IPLD nodes referenced by the specified CID from the chain blockstore and returns raw bytes.

Filecoin.ChainSetHead

Filecoin.ChainStatObj

Filecoin.ChainTipSetWeight

Returns the weight of the specified tipset.

Filecoin.EthAccounts

Returns the list of addresses owned by the client; always empty since Forest does not manage private keys.

Filecoin.EthAddressToFilecoinAddress

Converts an EthAddress into an f410 Filecoin Address

Filecoin.EthBaseFee

Returns the calculated base fee of the upcoming tipset in attoFIL

Filecoin.EthBlockNumber

Returns the height of the latest executed tipset, which is the parent of the current head.

Filecoin.EthCall

Executes a read-only message call against the given block state without creating an on-chain transaction, returning the call output.

Filecoin.EthChainId

Returns the EIP-155 chain ID of the current network.

Filecoin.EthEstimateGas

Estimates the amount of gas required to execute the given transaction.

Filecoin.EthFeeHistory

Returns historical gas information for a range of blocks, including base fee per gas, gas used ratio, and priority fee percentiles.

Filecoin.EthGasPrice

Returns the current gas price in attoFIL

Filecoin.EthGetBalance

Returns the balance of an Ethereum address at the specified block state

Filecoin.EthGetBlockByHash

Retrieves a block by its hash, optionally including full transaction objects.

Filecoin.EthGetBlockByNumber

Retrieves a block by its number or a special tag.

Filecoin.EthGetBlockReceipts

Retrieves all transaction receipts for a block by its number, hash or a special tag.

Filecoin.EthGetBlockReceiptsLimited

Retrieves all transaction receipts for a block identified by its number, hash or a special tag along with an optional limit on the chain epoch for state resolution.

Filecoin.EthGetBlockTransactionCountByHash

Returns the number of messages in the tipset identified by the given block hash.

Filecoin.EthGetBlockTransactionCountByNumber

Returns the number of transactions in a block identified by its block number or a special tag.

Filecoin.EthGetCode

Retrieves the contract code at a specific address and block state, identified by its number, hash, or a special tag.

Filecoin.EthGetFilterChanges

Returns event logs which occurred since the last poll

Filecoin.EthGetFilterLogs

Returns event logs matching the filter with the given ID that have not been collected since the last poll.

Filecoin.EthGetLogs

Returns event logs matching the given filter specification.

Filecoin.EthGetMessageCidByTransactionHash

Returns the CID of the Filecoin message corresponding to the given Ethereum transaction hash.

Filecoin.EthGetStorageAt

Retrieves the storage value at a specific position for a contract at a given block state, identified by its number, hash, or a special tag.

Filecoin.EthGetTransactionByBlockHashAndIndex

Retrieves a transaction by its block hash and index.

Filecoin.EthGetTransactionByBlockNumberAndIndex

Retrieves a transaction by its block number and index.

Filecoin.EthGetTransactionByHash

Retrieves a transaction by its hash.

Filecoin.EthGetTransactionByHashLimited

Retrieves a transaction by its hash, limiting state resolution to the given chain epoch.

Filecoin.EthGetTransactionCount

Returns the number of transactions sent from an address (its nonce) at the specified block state.

Filecoin.EthGetTransactionHashByCid

Returns the Ethereum transaction hash for the given Filecoin message CID.

Filecoin.EthGetTransactionReceipt

Returns the receipt of a transaction identified by its hash.

Filecoin.EthGetTransactionReceiptLimited

Returns the receipt of a transaction identified by its hash, limiting state resolution to the given chain epoch.

Filecoin.EthMaxPriorityFeePerGas

Returns an estimate of the priority fee per gas (tip) needed for timely inclusion, in attoFIL.

Filecoin.EthNewBlockFilter

Installs a persistent filter that tracks the arrival of new blocks.

Filecoin.EthNewFilter

Installs a persistent filter for matching event logs based on the given filter spec.

Filecoin.EthNewPendingTransactionFilter

Installs a persistent filter that tracks new messages arriving in the message pool.

Filecoin.EthProtocolVersion

Returns the current Filecoin network version, reported as the Ethereum protocol version.

Filecoin.EthSendRawTransaction

Submits a signed raw transaction to the message pool and returns its transaction hash.

Filecoin.EthSendRawTransactionUntrusted

Submits a signed raw transaction from an untrusted source to the message pool and returns its transaction hash.

Filecoin.EthSubscribe

Creates a websocket subscription that streams events (new heads, pending transactions, or logs) to the client.

Filecoin.EthSyncing

Returns the node's sync status, or `false` if the node is not currently syncing.

Filecoin.EthTraceBlock

Returns traces created at given block.

Filecoin.EthTraceFilter

Returns the traces for transactions matching the filter criteria.

Filecoin.EthTraceReplayBlockTransactions

Replays all transactions in a block returning the requested traces for each transaction.

Filecoin.EthTraceTransaction

Returns the traces for a specific transaction.

Filecoin.EthUninstallFilter

Uninstalls the filter with the given ID.

Filecoin.EthUnsubscribe

Cancels an existing websocket subscription identified by its subscription ID.

Filecoin.F3GetCertificate

Filecoin.F3GetECPowerTable

Filecoin.F3GetF3PowerTable

Filecoin.F3GetF3PowerTableByInstance

Gets the power table (committee) used to validate the specified instance

Filecoin.F3GetLatestCertificate

Filecoin.F3GetManifest

Filecoin.F3GetOrRenewParticipationTicket

Filecoin.F3GetProgress

Filecoin.F3IsRunning

Filecoin.F3ListParticipants

Filecoin.F3Participate

Filecoin.FilecoinAddressToEthAddress

Converts any Filecoin address to an EthAddress

Filecoin.GasEstimateFeeCap

Returns the estimated fee cap for the given parameters.

Filecoin.GasEstimateGasLimit

Returns the estimated gas limit for the given parameters.

Filecoin.GasEstimateGasPremium

Returns the estimated gas premium for the given parameters.

Filecoin.GasEstimateMessageGas

Returns the estimated gas for the given parameters.

Filecoin.GetActorEventsRaw

Returns all user-programmed and built-in actor events that match the given filter. Results may be limited by MaxFilterResults, MaxFilterHeightRange, and the node's available historical data.

Filecoin.MarketAddBalance

Filecoin.MinerCreateBlock

Fills and signs a block template on behalf of the given miner, returning a suitable block header.

Filecoin.MinerGetBaseInfo

Retrieves the Miner Actor at the given address and tipset, returning basic information such as power and mining eligibility.

Filecoin.MpoolBatchPush

Adds a set of signed messages to the message pool.

Filecoin.MpoolBatchPushUntrusted

Adds a set of messages to the message pool with additional verification checks.

Filecoin.MpoolGetConfig

Returns a copy of the current mpool config.

Filecoin.MpoolGetNonce

Returns the current nonce for the specified address.

Filecoin.MpoolPending

Returns the pending messages for a given tipset.

Filecoin.MpoolPush

Adds a signed message to the message pool.

Filecoin.MpoolPushMessage

Assigns a nonce, signs, and pushes a message to the mempool.

Filecoin.MpoolPushUntrusted

Adds a message to the message pool with verification checks.

Filecoin.MpoolSelect

Returns a list of pending messages for inclusion in the next block.

Filecoin.MsigGetAvailableBalance

Filecoin.MsigGetPending

Filecoin.MsigGetVested

Filecoin.MsigGetVestingSchedule

Filecoin.NetAddrsListen

Returns a list of listening addresses and the peer ID.

Filecoin.NetAgentVersion

Returns the agent version string.

Filecoin.NetAutoNatStatus

Returns the node's AutoNAT reachability status and observed public addresses.

Filecoin.NetConnect

Connects to a specified peer.

Filecoin.NetDisconnect

Disconnects from the specified peer.

Filecoin.NetFindPeer

Returns the known addresses of the peer with the given peer ID.

Filecoin.NetListening

Returns whether the node is listening for network connections (always `true`).

Filecoin.NetPeers

Returns a list of currently connected peers.

Filecoin.NetProtectAdd

Protects a peer from having its connection(s) pruned in the event the libp2p host reaches its maximum number of peers.

Filecoin.NetProtectList

Returns the current list of protected peers.

Filecoin.NetProtectRemove

Remove a peer from the protected list.

Filecoin.NetVersion

Returns the current network ID (the EIP-155 chain ID) as a decimal string.

Filecoin.NodeStatus

Filecoin.Session

Filecoin.Shutdown

Filecoin.StartTime

Filecoin.StateAccountKey

Returns the public key address for the given ID address (secp and bls accounts).

Filecoin.StateCall

Runs the given message and returns its result without persisting changes. The message is applied to the tipset's parent state.

Filecoin.StateCirculatingSupply

Returns the exact circulating supply of Filecoin at the given tipset.

Filecoin.StateCompute

Applies the given messages on the given tipset

Filecoin.StateDealProviderCollateralBounds

Returns the minimum and maximum collateral a storage provider can issue, based on deal size and verified status.

Filecoin.StateDecodeParams

Decode the provided method params.

Filecoin.StateGetActor

Returns the nonce and balance for the specified actor.

Filecoin.StateGetAllAllocations

Returns all allocations available in the verified registry actor.

Filecoin.StateGetAllClaims

Returns all claims available in the verified registry actor.

Filecoin.StateGetAllocation

Returns the allocation for a given address and allocation ID.

Filecoin.StateGetAllocationForPendingDeal

Returns the allocation for the specified pending deal. Returns null if no pending allocation is found.

Filecoin.StateGetAllocationIdForPendingDeal

Returns the allocation ID for the specified pending deal.

Filecoin.StateGetAllocations

Returns all allocations for a given client.

Filecoin.StateGetBeaconEntry

Returns the beacon entries for the specified epoch.

Filecoin.StateGetClaim

Returns the claim for a given address and claim ID.

Filecoin.StateGetClaims

Returns all claims for a given provider.

Filecoin.StateGetNetworkParams

Returns current network parameters.

Filecoin.StateGetRandomnessDigestFromBeacon

Samples the beacon for randomness.

Filecoin.StateGetRandomnessDigestFromTickets

Samples the chain for randomness.

Filecoin.StateGetRandomnessFromBeacon

Returns the beacon entry for the specified Filecoin epoch. If unavailable, the call blocks until it becomes available.

Filecoin.StateGetRandomnessFromTickets

Samples the chain for randomness.

Filecoin.StateGetReceipt

Returns the receipt for the message with the given CID at the specified tipset (deprecated in V1).

Filecoin.StateListActors

Returns the addresses of every actor in the state.

Filecoin.StateListMessages

Returns all messages with a matching to or from address up to the given height.

Filecoin.StateListMiners

Returns the addresses of every miner with claimed power in the Power Actor.

Filecoin.StateLookupID

Retrieves the ID address of the given address.

Filecoin.StateLookupRobustAddress

Returns the public key address for non-account addresses (e.g., multisig, miners).

Filecoin.StateMarketBalance

Returns the Escrow and Locked balances of the specified address in the Storage Market.

Filecoin.StateMarketDeals

Returns information about every deal in the Storage Market.

Filecoin.StateMarketParticipants

Returns the Escrow and Locked balances of all participants in the Storage Market.

Filecoin.StateMarketStorageDeal

Returns information about the specified deal.

Filecoin.StateMinerActiveSectors

Returns information about sectors actively proven by a given miner.

Filecoin.StateMinerAllocated

Returns a bitfield containing all sector numbers marked as allocated to the provided miner ID.

Filecoin.StateMinerAvailableBalance

Returns the portion of a miner's balance available for withdrawal or spending.

Filecoin.StateMinerDeadlines

Returns all proving deadlines for the given miner.

Filecoin.StateMinerFaults

Returns a bitfield of the faulty sectors for the given miner.

Filecoin.StateMinerInfo

Returns information about the specified miner.

Filecoin.StateMinerInitialPledgeCollateral

Returns the initial pledge collateral for the specified miner's sector.

Filecoin.StateMinerInitialPledgeForSector

Returns the initial pledge collateral required to commit a sector with the given duration, size, and verified deal size at the specified tipset.

Filecoin.StateMinerPartitions

Returns all partitions in the specified deadline.

Filecoin.StateMinerPower

Returns the power of the specified miner.

Filecoin.StateMinerPreCommitDepositForPower

Returns the sector precommit deposit for the specified miner.

Filecoin.StateMinerProvingDeadline

Calculates the deadline and related details for a given epoch during a proving period.

Filecoin.StateMinerRecoveries

Returns a bitfield of recovering sectors for the given miner.

Filecoin.StateMinerSectorAllocated

Checks if a sector number is marked as allocated.

Filecoin.StateMinerSectorCount

Returns the number of sectors in a miner's sector and proving sets.

Filecoin.StateMinerSectors

Returns information about the given miner's sectors. If no filter is provided, all sectors are included.

Filecoin.StateNetworkName

Returns the name of the network the node is synced to.

Filecoin.StateNetworkVersion

Returns the network version at the given tipset.

Filecoin.StateReadState

Returns the state of the specified actor.

Filecoin.StateReplay

Replays a given message, assuming it was included in a block in the specified tipset.

Filecoin.StateSearchMsg

Returns the receipt and tipset the specified message was included in, or null if the message was not found.

Filecoin.StateSearchMsgLimited

Looks back up to limit epochs in the chain for a message, and returns its receipt and the tipset where it was executed, or null if it was not found.

Filecoin.StateSectorExpiration

Returns the epoch at which the specified sector will expire.

Filecoin.StateSectorGetInfo

Returns on-chain information for the specified miner's sector. Returns null if not found. Use StateSectorExpiration for accurate expiration epochs.

Filecoin.StateSectorPartition

Finds the deadline/partition for the specified sector.

Filecoin.StateSectorPreCommitInfo

Returns the on-chain pre-commit information for the given miner's sector, erroring if the sector is not precommitted.

Filecoin.StateVerifiedClientStatus

Returns the data cap for the given address. Returns null if no entry exists in the data cap table.

Filecoin.StateVerifiedRegistryRootKey

Returns the address of the Verified Registry's root key.

Filecoin.StateVerifierStatus

Returns the data cap for the given address.

Filecoin.StateVMCirculatingSupplyInternal

Returns an approximation of Filecoin's circulating supply at the given tipset.

Filecoin.StateWaitMsg

Searches the chain for the given message and, if not found, blocks until it appears on-chain and reaches the required confidence depth.

Filecoin.SyncCheckBad

Filecoin.SyncMarkBad

Filecoin.SyncSubmitBlock

Submits a newly created block to the network.

Filecoin.Version

Filecoin.WalletBalance

Returns the balance of a wallet.

Filecoin.WalletDefaultAddress

Returns the default wallet address, or null if no default is set.

Filecoin.WalletDelete

Removes the key for the given address from the wallet.

Filecoin.WalletExport

Exports the key information, including the private key, for the given wallet address.

Filecoin.WalletHas

Indicates whether the given address exists in the wallet.

Filecoin.WalletImport

Imports a key into the wallet and returns its address.

Filecoin.WalletList

Returns a list of all addresses in the wallet.

Filecoin.WalletNew

Generates a new key of the given signature type, adds it to the wallet, and returns its address.

Filecoin.WalletSetDefault

Sets the given address as the default wallet address.

Filecoin.WalletSign

Signs the given bytes using the specified address.

Filecoin.WalletSignMessage

Signs the given message using the specified address.

Filecoin.WalletValidateAddress

Validates the given string as a Filecoin address and returns the parsed address.

Filecoin.WalletVerify

Returns whether the given signature is valid for the message and address.

Filecoin.Web3ClientVersion

Returns the client version string of the running node.

Forest(15 methods)

Forest.BaseFeeByHeight

Returns the calculated upcoming base fee of the tipset at the given height in attoFIL

Forest.ChainExport

Forest.ChainExportCancel

Forest.ChainExportDiff

Forest.ChainExportStatus

Forest.ChainGetMinBaseFee

Forest.ChainGetTipsetByParentState

Forest.NetChainExchange

Internal API for debugging chain exchange.

Forest.NetInfo

Returns peer and connection statistics for the node's libp2p network.

Forest.SnapshotGC

Forest.StateActorInfo

Returns the builtin actor information for the current network.

Forest.StateCompute

Forest-specific RPC method that recomputes tipset state over an epoch range. It reuses cached executed tipsets only when the cached state root is loadable; otherwise it recomputes. Unlike Filecoin.StateCompute, it does not apply caller-supplied messages or return execution traces.

Forest.StateFetchRoot

Traverses the IPLD graph under the given root CID, fetching any missing nodes over the network, and optionally writes them to a CAR file.

Forest.SyncSnapshotProgress

Returns the snapshot download progress. Return Null if the tracking isn't started

Forest.SyncStatus

Returns the current sync status of the node.

net(2 methods)

net_listening

Returns whether the node is listening for network connections (always `true`).

net_version

Returns the current network ID (the EIP-155 chain ID) as a decimal string.

trace(4 methods)

trace_block

Returns traces created at given block.

trace_filter

Returns the traces for transactions matching the filter criteria.

trace_replayBlockTransactions

Replays all transactions in a block returning the requested traces for each transaction.

trace_transaction