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 264 methods in V0

eth(39 methods)

eth_accounts

eth_blockNumber

eth_call

eth_chainId

eth_estimateGas

eth_feeHistory

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

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

eth_getBlockTransactionCountByNumber

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

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

eth_getLogs

eth_getMessageCidByTransactionHash

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

eth_getTransactionByBlockNumberAndIndex

Retrieves a transaction by its block number and index.

eth_getTransactionByHash

eth_getTransactionByHashLimited

eth_getTransactionCount

eth_getTransactionHashByCid

eth_getTransactionReceipt

eth_getTransactionReceiptLimited

eth_maxPriorityFeePerGas

eth_newBlockFilter

eth_newFilter

eth_newPendingTransactionFilter

eth_protocolVersion

eth_sendRawTransaction

eth_sendRawTransactionUntrusted

eth_subscribe

eth_syncing

eth_uninstallFilter

eth_unsubscribe

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(194 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

Filecoin.EthAddressToFilecoinAddress

Converts an EthAddress into an f410 Filecoin Address

Filecoin.EthBlockNumber

Filecoin.EthCall

Filecoin.EthChainId

Filecoin.EthEstimateGas

Filecoin.EthFeeHistory

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

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

Filecoin.EthGetBlockTransactionCountByNumber

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

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

Filecoin.EthGetLogs

Filecoin.EthGetMessageCidByTransactionHash

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

Filecoin.EthGetTransactionByBlockNumberAndIndex

Retrieves a transaction by its block number and index.

Filecoin.EthGetTransactionByHash

Filecoin.EthGetTransactionByHashLimited

Filecoin.EthGetTransactionCount

Filecoin.EthGetTransactionHashByCid

Filecoin.EthGetTransactionReceipt

Filecoin.EthGetTransactionReceiptLimited

Filecoin.EthMaxPriorityFeePerGas

Filecoin.EthNewBlockFilter

Filecoin.EthNewFilter

Filecoin.EthNewPendingTransactionFilter

Filecoin.EthProtocolVersion

Filecoin.EthSendRawTransaction

Filecoin.EthSendRawTransactionUntrusted

Filecoin.EthSubscribe

Filecoin.EthSyncing

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

Filecoin.EthUnsubscribe

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.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

Filecoin.NetConnect

Connects to a specified peer.

Filecoin.NetDisconnect

Disconnects from the specified peer.

Filecoin.NetFindPeer

Filecoin.NetListening

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

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

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

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

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.

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.

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

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

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

Filecoin.WalletDelete

Filecoin.WalletExport

Filecoin.WalletHas

Indicates whether the given address exists in the wallet.

Filecoin.WalletImport

Filecoin.WalletList

Returns a list of all addresses in the wallet.

Filecoin.WalletNew

Filecoin.WalletSetDefault

Filecoin.WalletSign

Signs the given bytes using the specified address.

Filecoin.WalletSignMessage

Signs the given message using the specified address.

Filecoin.WalletValidateAddress

Filecoin.WalletVerify

Filecoin.Web3ClientVersion

Forest(13 methods)

Forest.ChainExport

Forest.ChainExportCancel

Forest.ChainExportDiff

Forest.ChainExportStatus

Forest.ChainGetMinBaseFee

Forest.ChainGetTipsetByParentState

Forest.NetInfo

Forest.SnapshotGC

Forest.StateActorInfo

Returns the builtin actor information for the current network.

Forest.StateCompute

Forest.StateFetchRoot

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

net_version

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

Returns the traces for a specific transaction.

web3(1 methods)

web3_clientVersion

API Versions​