API Methods
Last updated
Last updated
ADMIN methodsThe ADMIN API methods provide administrative functionality to manage your node.
Note
The ADMIN API methods are not enabled by default for JSON-RPC. To enable the ADMIN API methods, use the or options.
admin_addPeerAdds a .
Caution
If connections are timing out, ensure the node ID in the is correct.
Parameters
enode: string - of peer to add
Returns
result: boolean - true if peer added or false if peer already a
Example
curl HTTP request
wscat WS requestJSON result
admin_changeLogLevelChanges the log level without restarting Besu. You can change the log level for all logs, or you can change the log level for specific packages or classes.
You can specify only one log level per RPC call.
Parameters
log_filter: array - (optional) packages or classes for which to change the log level
Returns
result: string - Success if the log level has changed, otherwise error
Example
The following example changes the debug level for specified classes to DEBUG.
curl HTTP request
wscat WS requestJSON result
The following example changes the debug level of all logs to WARN.
curl HTTP request
wscat WS requestJSON result
admin_generateLogBloomCacheTip
Note
Each index file contains 100000 blocks. The last fragment of blocks less than 100000 are not indexed.
Parameters
startBlock: string - block to start generating indexes
endBlock: string - block to stop generating indexes
Returns
result: object - log bloom index details:
startBlock: string - starting block for the last requested cache generation
endBlock: string - ending block for the last requested cache generation
currentBlock: string - most recent block added to the cache
indexing: boolean - indicates if indexing is in progress
boolean - indicates acceptance of the request from this call to generate the cache
Example
curl HTTP request
wscat WS requestJSON result
admin_logsRemoveCacheRemoves cache files for the specified range of blocks.
Parameters
You can skip a parameter by using an empty string, "". If you specify:
No parameters, the call removes cache files for all blocks.
Only fromBlock, the call removes cache files for the specified block.
Only toBlock, the call removes cache files from the genesis block to the specified block.
Returns
result: object - Cache Removed status or error.
Example
curl HTTP request
wscat WS requestJSON result
admin_logsRepairCacheRepairs cached logs by fixing all segments starting with the specified block number.
Parameters
startBlock: string - decimal index of the starting block to fix; defaults to the head block
Returns
result: object - status of the repair request; Started or Already running
Example
curl HTTP request
wscat WS requestJSON result
admin_nodeInfoReturns networking information about the node. The information includes general information about the node and specific information from each running Ethereum sub-protocol (for example, eth).
Parameters
None
Returns
result: object - node object with the following fields:
listenAddr: string - host and port for the node
name: string - client name
protocols: object - list of objects containing information for each Ethereum sub-protocol
Note
Example
curl HTTP request
wscat WS requestJSON result
admin_peersReturns networking information about connected remote nodes.
Parameters
None
Returns
result: array of objects - list of objects returned for each remote node, with the following fields.
version: string - P2P protocol version
name: string - client name
caps: array of strings - list of Ethereum sub-protocol capabilities
network: object - local and remote addresses established at time of bonding with the peer (the remote address might not match the hex value for port; it depends on which node initiated the connection.)
port: string - port on the remote node on which P2P discovery is listening
enode: string - enode URL of the remote node
Example
curl HTTP request
wscat WS requestJSON result
admin_removePeerParameters
Returns
Example
curl HTTP request
wscat WS requestJSON result
CLIQUE methodsNote
clique_discardParameters
address: string - 20-byte address of proposed signer
Returns
result: boolean - indicates if the proposal is discarded
Example
curl HTTP request
wscat WS requestJSON result
clique_getSignersParameters
Returns
result: array of string - list of 20-byte addresses of signers
Example
curl HTTP request
wscat WS requestJSON result
clique_getSignerMetricsProvides the following validator metrics for the specified range:
Number of blocks from each validator
Block number of the last block proposed by each validator (if any proposed in the specified range)
All validators present in the last block
Parameters
If you specify:
No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.
Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.
Returns
result: array of objects - list of validator objects
Note
The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.
Example
curl HTTP
wscat WSJSON result
clique_getSignersAtHashLists signers for the specified block.
Parameters
hash: string - 32-byte block hash
Returns
result: array of string - list of 20-byte addresses of signers
Example
curl HTTP request
wscat WS requestJSON result
clique_proposalsParameters
None
Returns
result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the proposal for each account (if true, the proposal is to add a signer; if false, the proposal is to remove a signer.)
Example
curl HTTP request
wscat WS requestJSON result
clique_proposeParameters
address: string - 20-byte address
proposal: boolean - true to propose adding signer or false to propose removing signer
Returns
result: boolean - true
Example
curl HTTP request
wscat WS requestJSON result
DEBUG methodsNote
debug_accountRangeReturns the accounts for a specified block.
Parameters
blockHashOrNumber: string - block hash or number
txIndex: number - transaction index from which to start
address: string - address hash from which to start
limit: integer - maximum number of account entries to return
Returns
result: object - account details object with the following fields:
addressMap: map of strings to strings - map of address hashes and account addresses
nextKey: string - hash of the next address if any addresses remain in the state, otherwise zero
Example
curl HTTP request
wscat WS requestJSON result
debug_batchSendRawTransactionParameters
data: string - signed transaction data array
Returns
result: array of objects - object returned for each transaction, with the following fields:
index: string - index of the transaction in the request parameters array
success: boolean - indicates whether or not the transaction has been added to the transaction pool
errorMessage: string - (optional) error message
Example
curl HTTP
wscat WSJSON result
debug_getBadBlocksReturns a list of invalid blocks. This is used to detect and analyze consensus flaws.
Parameters
None
Returns
Example
curl HTTP
wscat WSJSON result
debug_standardTraceBlockToFileGenerates files containing the block trace. A separate file is generated for each transaction in the block.
You can also specify a trace file for a specific transaction in a block.
Parameters
blockHash: string - block hash
txHash: string - (optional) transaction hash; if omitted, a trace file is generated for each transaction in the block.
disableMemory: boolean - (optional) specifies whether to capture EVM memory during the trace; defaults to true
Returns
result: string - location of the generated trace files
Example
curl HTTP request
wscat WS requestJSON result
debug_standardTraceBadBlockToFileGenerates files containing the block trace of invalid blocks. A separate file is generated for each transaction in the block.
Parameters
blockHash: string - block hash
Returns
result: string - location of the generated trace files
Example
curl HTTP request
wscat WS requestJSON result
debug_storageRangeAtReturns the contract storage for the specified range.
Parameters
blockHash: string - block hash
txIndex: number - transaction index from which to start
address: string - contract address
startKey: string - start key
limit: number - number of storage entries to return
Returns
Example
curl HTTP request
wscat WS requestJSON result
debug_metricsReturns metrics providing information on the internal operation of Besu.
The available metrics might change over time. The JVM metrics might vary based on the JVM implementation used.
The metric types are:
Timer
Counter
Gauge
Parameters
None
Returns
result: object - metrics object
Example
curl HTTP request
wscat WS requestJSON result
debug_traceTransactionReruns the transaction with the same state as when the transaction executed.
Parameters
transactionHash: string - transaction hash
options: object - request options object with the following fields (all optional and default to false):
disableStorage: boolean - true disables storage capture.
disableMemory: boolean - true disables memory capture.
disableStack : boolean - true disables stack capture.
Returns
Example
curl HTTP request
wscat WS requestJSON result
debug_traceBlockReturns full trace of all invoked opcodes of all transactions included in the block.
Parameters
block: string - RLP of the block
options: object - request options object with the following fields (all optional and default to false):
disableStorage: boolean - true disables storage capture.
disableMemory: boolean - true disables memory capture.
disableStack : boolean - true disables stack capture.
Returns
Example
curl HTTP request
wscat WS requestJSON result
debug_traceBlockByHashReturns full trace of all invoked opcodes of all transactions included in the block.
Parameters
blockHash: string - block hash
options: object - request options object with the following fields (all optional and default to false):
disableStorage: boolean - true disables storage capture.
disableMemory: boolean - true disables memory capture.
disableStack : boolean - true disables stack capture.
Returns
Example
curl HTTP request
wscat WS requestJSON result
debug_traceBlockByNumberReturns full trace of all invoked opcodes of all transactions included in the block.
Parameters
options: object - request options object with the following fields (all optional and default to false):
disableStorage: boolean - true disables storage capture.
disableMemory: boolean - true disables memory capture.
disableStack : boolean - true disables stack capture.
Returns
Example
curl HTTP request
wscat WS requestJSON result
EEA methodsNote
eea_sendRawTransactionTo avoid exposing your private key, create signed transactions offline and send the signed transaction data using eea_sendRawTransaction.
Important
Parameters
transaction: string - signed RLP-encoded private transaction
Returns
Tip
Example
curl HTTP request
wscat WS requestJSON result
ETH methodsThe ETH API methods allow you to interact with the blockchain.
Note
eth_accountsReturns a list of account addresses a client owns.
Note
Parameters
None
Returns
result: array of strings - list of 20-byte account addresses owned by the client
Example
curl HTTP request
wscat WS requestJSON result
eth_blockNumberReturns the index corresponding to the block number of the current chain head.
Parameters
None
Returns
result: string - hexadecimal integer representing the index corresponding to the block number of the current chain head
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_callInvokes a contract function locally and does not change the state of the blockchain.
Parameters
Note
Returns
result: string - return value of the executed contract
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_chainIdParameters
None
Returns
result: string - chain ID in hexadecimal
Example
curl HTTP request
wscat WS requestJSON result
eth_coinbaseReturns the client coinbase address. The coinbase address is the account to pay mining rewards to.
To set a coinbase address, start Besu with the --miner-coinbase option set to a valid Ethereum account address. You can get the Ethereum account address from a client such as MetaMask or Etherscan. For example:
Example
Parameters
None
Returns
result: string - coinbase address
Example
curl HTTP request
wscat WS requestJSON result
eth_estimateGasReturns an estimate of the gas required for a transaction to complete. The estimation process does not use gas and the transaction is not added to the blockchain. The resulting estimate can be greater than the amount of gas the transaction ends up using, for reasons including EVM mechanics and node performance.
Parameters
For eth_estimateGas, all fields are optional because setting a gas limit is irrelevant to the estimation process (unlike transactions, in which gas limits apply).
Returns
result: string - amount of gas used
Example of cost estimate of a value transaction
The following example returns an estimate of 21000 wei (0x5208) for the transaction.
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
Example of cost estimate of deploying a simple storage smart contract
The following example request estimates the cost of deploying a simple storage smart contract to the network. The data field contains the hash of the compiled contract you want to deploy. (You can get the compiled contract hash from your IDE, for example, Remix > Compile tab > details > WEB3DEPLOY.) The result is 113355 wei.
curl HTTP request
JSON result
eth_feeHistoryReturns base fee per gas and transaction effective priority fee per gas history for the requested block range, allowing you to track trends over time.
Parameters
blockCount: integer - Number of blocks in the requested range. Between 1 and 1024 blocks can be requested in a single query. If blocks in the specified block range are not available, then only the fee history for available blocks is returned.
Returns
Example
curl HTTP
wscat WSJSON result
eth_gasPriceReturns a percentile gas unit price for the most recent blocks, in Wei. By default, the last 100 blocks are examined and the 50th percentile gas unit price (that is, the median value) is returned.
Parameters
None
Returns
result: string - percentile gas unit price for the most recent blocks, in Wei, as a hexadecimal value
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getBalanceReturns the account balance of the specified address.
Parameters
address: string - 20-byte account address from which to retrieve the balance
Returns
result: string - current balance, in Wei, as a hexadecimal value
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getBlockByHashReturns information about the block matching the specified block hash.
Parameters
hash: string - 32-byte hash of a block
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getBlockByNumberReturns information about the block matching the specified block number.
Parameters
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getBlockTransactionCountByHashReturns the number of transactions in the block matching the specified block hash.
Parameters
hash: string - 32-byte block hash
Returns
result: number - integer representing the number of transactions in the specified block, or null if no matching block hash is found
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getBlockTransactionCountByNumberReturns the number of transactions in a block matching the specified block number.
Parameters
Returns
result: string - integer representing the number of transactions in the specified block, or null if no matching block number is found
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getCodeReturns the code of the smart contract at the specified address. Besu stores compiled smart contract code as a hexadecimal value.
Parameters
address: string - 20-byte contract address
Returns
result: data - code stored at the specified address
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getFilterChangesPolls the specified filter and returns an array of changes that have occurred since the last poll.
Parameters
filterId: string - filter ID
Returns
result: array of strings or objects - if nothing changed since the last poll, an empty list; otherwise:
For filters created with eth_newBlockFilter, returns block hashes.
For filters created with eth_newPendingTransactionFilter, returns transaction hashes.
Example
curl HTTP request
wscat WS requestJSON result
eth_getFilterLogsNote
eth_getFilterLogs is only used for filters created with eth_newFilter. To specify a filter object and get logs without creating a filter, use eth_getLogs .
Parameters
filterId: string - filter ID
Returns
Example
curl HTTP request
wscat WS requestJSON result
eth_getLogsAttention
Using eth_getLogs to get the logs from a large range of blocks, especially an entire chain from its genesis block, can cause Besu to hang and never return a response. We recommend splitting one large query into multiple ones for better performance.
Parameters
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getMinerDataByBlockHashReturns miner data for the specified block.
Parameters
hash: string - 32-byte block hash
Returns
Example
curl HTTP
wscat WSJSON result
eth_getMinerDataByBlockNumberReturns miner data for the specified block.
Parameters
Returns
Example
curl HTTP
wscat WSJSON result
eth_getProofReturns the account and storage values of the specified account, including the Merkle proof.
The API allows IoT devices or mobile apps which are unable to run light clients to verify responses from untrusted sources, by using a trusted block hash.
Parameters
address: string - 20-byte address of the account or contract
keys: array of strings - list of 32-byte storage keys to generate proofs for
Returns
result: object - account details object with the following fields:
balance: string - account balance
codeHash: string - 32-byte hash of the account code
nonce: string - number of transactions sent from the account
storageHash: string - 32-byte SHA3 of the storageRoot
accountProof: array of strings - list of RLP-encoded Merkle tree nodes, starting with the stateRoot
storageProof: array of objects - list of storage entry objects with the following fields:
key: string - storage key
value: string - storage value
proof: array of strings - list of RLP-encoded Merkle tree nodes, starting with the storageHash
Example
curl HTTP
wscat WSJSON result
eth_getQuorumPayloadParameters
id: string - the generated SHA3-512 hash of the encrypted payload from Tessera, in hex (the input value in the transaction)
Returns
result: string - unencrypted transaction payload in hex
Example
curl HTTP
wscat WSJSON result
eth_getStorageAtReturns the value of a storage position at a specified address.
Parameters
address: string - 20-byte storage address
index: string - integer index of the storage position
Returns
result : string - value at the specified storage position
Example
Calculating the correct position depends on the storage you want to retrieve.
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getTransactionByBlockHashAndIndexReturns transaction information for the specified block hash and transaction index position.
Parameters
block: string - 32-byte hash of a block
index: string - integer representing the transaction index position
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getTransactionByBlockNumberAndIndexReturns transaction information for the specified block number and transaction index position.
Parameters
index: string - transaction index position
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getTransactionByHashReturns transaction information for the specified transaction hash.
Parameters
transaction: string - 32-byte transaction hash
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getTransactionCountReturns the number of transactions sent from a specified address. Use the pending tag to get the next account nonce not used by any pending transactions.
Parameters
address: string - 20-byte account address
Returns
result: string - integer representing the number of transactions sent from the specified address
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getTransactionReceiptReturns the receipt of a transaction by transaction hash. Receipts for pending transactions are not available.
Parameters
transaction: string - 32-byte hash of a transaction
Returns
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getUncleByBlockHashAndIndexReturns uncle specified by block hash and index.
Parameters
block: string - 32-byte block hash
uncleIndex: string - index of the uncle
Returns
Note
Uncles do not contain individual transactions.
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getUncleByBlockNumberAndIndexReturns uncle specified by block number and index.
Parameters
uncleIndex: string - index of the uncle
Returns
Note
Uncles do not contain individual transactions.
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getUncleCountByBlockHashReturns the number of uncles in a block from a block matching the given block hash.
Parameters
block: string - 32-byte block hash
Returns
result: string - integer representing the number of uncles in the specified block
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getUncleCountByBlockNumberReturns the number of uncles in a block matching the specified block number.
Parameters
Returns
result: string - integer representing the number of uncles in the specified block
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_getWorkReturns the hash of the current block, the seed hash, and the required target boundary condition.
Parameters
None
Returns
result: array of strings - array with the following items:
header: string - 32-byte hash of the current block header (PoW-hash)
seed: string - 32-byte seed hash used for the DAG
target: string - 32-byte required target boundary condition: 2^256 / difficulty
blockNumber: string - hexadecimal integer representing the current block number
Example
curl HTTP request
wscat WS requestJSON result
eth_hashrateReturns the number of hashes per second with which the node is mining.
When the stratum server is enabled, this method returns the cumulative hashrate of all sealers reporting their hashrate.
Parameters
None
Returns
result: string - number of hashes per second
Example
curl HTTP request
wscat WS requestJSON result
eth_miningWhether the client is actively mining new blocks. Besu pauses mining while the client synchronizes with the network regardless of command settings or methods called.
Parameters
None
Returns
result: boolean - indicates if the client is actively mining new blocks
Example
curl HTTP request
wscat WS requestJSON result
eth_newBlockFilterParameters
None
Returns
result: string - filter ID
Example
curl HTTP request
wscat WS requestJSON result
eth_newFilterParameters
Note
fromBlock and toBlock in the filter options object default to latest.
Returns
result: string - filter ID
Example
curl HTTP request
wscat WS requestJSON result
eth_newPendingTransactionFilterParameters
None
Returns
result: string - filter ID
Example
curl HTTP request
wscat WS requestJSON result
eth_protocolVersionReturns current Ethereum protocol version.
Parameters
None
Returns
result: string - Ethereum protocol version
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_sendRawTransactionTo avoid exposing your private key, create signed transactions offline and send the signed transaction data using eth_sendRawTransaction.
Important
Parameters
Note
Returns
result: string - 32-byte transaction hash
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_submitHashrateParameters
hashrate: string - 32-byte hexadecimal string representation of the hashrate
id: string - 32-byte random hexadecimal ID identifying the client
Returns
result: boolean - indicates if submission is successful
Example
curl HTTP request
wscat WS requestJSON result
eth_submitWorkParameters
nonce: string - retrieved 8-byte nonce
header: string - 32-byte hash of the block header (PoW-hash)
digest: string - 32-bytes mix digest
Returns
result: boolean - indicates if the provided solution is valid
Example
curl HTTP request
wscat WS requestJSON result
eth_syncingReturns an object with data about the synchronization status, or false if not synchronizing.
Note
Once the node reaches the head of the chain, eth_syncing returns false, indicating that there is no active syncing target.
Parameters
None
Returns
result: object or boolean - synchronization status data object with the following fields, or false if not synchronizing:
startingBlock: string - index of the highest block on the blockchain when the network synchronization starts
highestBlock: string - index of the highest known block in the peer network (that is, the highest block so far discovered among peer nodes. This is the same value as currentBlock if the current node has no peers.)
pulledStates: string - if fast synchronizing, the number of state entries fetched so far, or null if this is not known or not relevant (if full synchronizing or fully synchronized, this field is not returned.)
knownStates: string - if fast synchronizing, the number of states the node knows of so far, or null if this is not known or not relevant (if full synchronizing or fully synchronized, this field is not returned.)
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
eth_uninstallFilterUninstalls a filter with the specified ID. When a filter is no longer required, call this method.
Parameters
filterId: string - filter ID
Returns
result: boolean - indicates if the filter is successfully uninstalled
Example
curl HTTP request
wscat WS requestJSON result
IBFT 2.0 methodsNote
ibft_discardValidatorVoteParameters
address: string - 20-byte address of proposed validator
Returns
result: boolean - indicates if the proposal is discarded
Example
curl HTTP request
wscat WS requestJSON result
ibft_getPendingVotesParameters
None
Returns
result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the vote for each account; if true, the vote is to add a validator. If false, the proposal is to remove a validator.
Example
curl HTTP request
wscat WS requestJSON result
ibft_getSignerMetricsProvides the following validator metrics for the specified range:
Number of blocks from each validator
Block number of the last block proposed by each validator (if any proposed in the specified range)
All validators present in the last block of the range
Parameters
If you specify:
No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.
Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.
Returns
result: array of objects - list of validator objects
Note
The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.
Example
curl HTTP
wscat WSJSON result
ibft_getValidatorsByBlockHashLists the validators defined in the specified block.
Parameters
block: string - 32-byte block hash
Returns
result: array of strings - list of validator addresses
Example
curl HTTP request
wscat WS requestJSON result
ibft_getValidatorsByBlockNumberLists the validators defined in the specified block.
Parameters
Returns
result: array of strings - list of validator addresses
Example
curl HTTP request
wscat WS requestJSON result
ibft_proposeValidatorVoteParameters
address: string - account address
proposal: boolean - true to propose adding validator or false to propose removing validator
Returns
result: boolean - true
Example
curl HTTP request
wscat WS requestJSON result
MINER methodsThe MINER API methods allow you to control the node’s mining operation.
Note
miner_changeTargetGasLimitParameters
gasPrice: number - target gas price in Wei
Returns
result: string - Success or error
Example
curl HTTP request
wscat WS requestJSON result
miner_startParameters
None
Returns
result: boolean - true if mining starts, or if the node is already mining
Example
curl HTTP request
wscat WS requestJSON result
miner_stopStops the mining process on the client.
Parameters
None
Returns
result: boolean - true if mining stops, or if the node is not mining
Example
curl HTTP request
wscat WS requestJSON result
NET methodsThe NET API methods provide network-related information.
net_enodeParameters
None
Returns
Example
curl HTTP request
wscat WS requestJSON result
net_listeningWhether the client is actively listening for network connections.
Parameters
None
Returns
result: boolean - indicates if the client is actively listening for network connections
Example
curl HTTP request
wscat WS requestJSON result
net_peerCountReturns the number of peers currently connected to the client.
Parameters
None
Returns
result: string - number of connected peers in hexadecimal
Example
curl HTTP request
wscat WS requestJSON result
net_servicesReturns enabled services (for example, jsonrpc) and the host and port for each service.
Note
Parameters
None
Returns
result: object - enabled services
Example
curl HTTP request
wscat WS requestJSON result
net_versionParameters
None
Returns
result: string - current network ID
1
ETH
Mainnet
Main Ethereum network
3
ETH
Ropsten
PoW test network
4
ETH
Rinkeby
PoA test network using Clique
5
ETH
Goerli
PoA test network using Clique
2018
ETH
Dev
PoW development network
1
ETC
Classic
Main Ethereum Classic network
7
ETC
Mordor
PoW test network
6
ETC
Kotti
PoA test network using Clique
212
ETC
Astor
PoW test network
Note
For almost all networks network ID and chain ID are the same.
The only networks in the table above with different network and chain IDs are Classic with a chain ID of 61 and Mordor with a chain ID of 63.
Example
curl HTTP request
wscat WS requestJSON result for MainnetJSON result for Ropsten
PERM (Permissioning) methodsImportant
perm_addAccountsToAllowlistParameters
addresses: array of strings - list of account addresses
Note
The parameters list contains a list which is why the account addresses are enclosed by double square brackets.
Returns
result: string - Success or error (errors include attempting to add accounts already on the allowlist and including invalid account addresses.)
Example
curl HTTP request
wscat WS requestJSON result
perm_addNodesToAllowlistWarning
Enode URL domain name support is an experimental feature.
Parameters
Note
The parameters list contains a list which is why the enode URLs are enclosed by double square brackets.
Returns
result: string - Success or error; errors include attempting to add nodes already on the allowlist or including invalid enode URLs.
Example
curl HTTP request
wscat WS requestJSON result
perm_getAccountsAllowlistParameters
None
Returns
result: array of strings - list of accounts (participants) in the accounts allowlist
Example
curl HTTP request
wscat WS requestJSON result
perm_getNodesAllowlistParameters
None
Returns
Example
curl HTTP request
wscat WS requestJSON result
perm_reloadPermissionsFromFileParameters
None
Returns
result: string - Success, or error if the permissions configuration file is not valid
Example
curl HTTP request
wscat WS requestJSON result
perm_removeAccountsFromAllowlistParameters
addresses: array of strings - list of account addresses
Note
The parameters list contains a list which is why the account addresses are enclosed by double square brackets.
Returns
result: string - Success or error (errors include attempting to remove accounts not on the allowlist and including invalid account addresses.)
Example
curl HTTP request
wscat WS requestJSON result
perm_removeNodesFromAllowlistParameters
Note
The parameters list contains a list which is why the enode URLs are enclosed by double square brackets.
Returns
result: string - Success or error (errors include attempting to remove nodes not on the allowlist and including invalid enode URLs.)
Example
curl HTTP request
wscat WS requestJSON result
PLUGINS methodsThe PLUGINS API methods provide plugin-related functionality.
Note
plugins_reloadPluginConfigReloads specified plugin configuration.
Parameters
plugin: string - plugin
Returns
result: string - Success
Example
curl HTTP request
wscat WS requestJSON result
PRIV methodsNote
priv_callInvokes a private contract function locally and does not change the privacy group state.
Parameters
Returns
result: data - return value of the executed contract
Example
curl HTTP
wscat WSJSON resultcurl GraphQLGraphQLGraphQL result
priv_createPrivacyGroupParameters
options: object - request options object with the following fields:
name: string - (optional) privacy group name
description: string - (optional) privacy group description
Returns
result: string - privacy group ID
Example
curl HTTP request
wscat WS requestJSON result
priv_debugGetStateRootReturns the state root of the specified privacy group at the specified block.
Parameters
Returns
result: string - 32-byte state root
Example
curl HTTP
wscat WSJSON result
priv_deletePrivacyGroupDeletes the specified privacy group.
Parameters
privacyGroupId: string - privacy group ID
Returns
result: string - deleted privacy group ID
Example
curl HTTP request
wscat WS requestJSON result
priv_distributeRawTransactionTip
Parameters
transaction: string - signed RLP-encoded private transaction
Returns
Example
curl HTTP request
wscat WS requestJSON result
priv_findPrivacyGroupReturns a list of privacy groups containing only the listed members. For example, if the listed members are A and B, a privacy group containing A, B, and C is not returned.
Parameters
Returns
LEGACY for EEA-compliant groups.
PANTHEON for Besu-extended groups.
Example
curl HTTP request
wscat WS requestJSON result
priv_getCodeReturns the code of the private smart contract at the specified address. Compiled smart contract code is stored as a hexadecimal value.
Parameters
address: string - 20-byte contract address
Returns
result: data - code stored at the specified address
Example
curl HTTP
wscat WSJSON result
priv_getEeaTransactionCountImportant
If sending more than one transaction to be mined in the same block (that is, you are not waiting for the transaction receipt), you must calculate the private transaction nonce outside Besu instead of using priv_getEeaTransactionCount.
Parameters
address: string - account address
sender: string - base64-encoded Tessera address of the sender
recipients: array of strings - base64-encoded Tessera addresses of recipients
Returns
result: string - integer representing the number of private transactions sent from the address to the specified group of sender and recipients
Example
curl HTTP request
wscat WS requestJSON result
priv_getFilterChangesPolls the specified filter for a private contract and returns an array of changes that have occurred since the last poll.
Parameters
filterId: string - filter ID
Returns
Example
curl HTTP request
wscat WS requestJSON result
priv_getFilterLogsNote
Parameters
filterId: string - filter ID
Returns
Example
curl HTTP request
wscat WS requestJSON result
priv_getLogsParameters
Returns
Example
curl HTTP
wscat WSJSON result
priv_getPrivacyPrecompileAddressParameters
None
Returns
result: string - address of the privacy precompile
Example
curl HTTP request
wscat WS requestJSON result
priv_getPrivateTransactionReturns the private transaction if you are a participant, otherwise, null.
Parameters
Returns
Example
curl HTTP request
wscat WS requestJSON result
priv_getTransactionCountReturns the private transaction count for specified account and privacy group.
Important
If sending more than one transaction to be mined in the same block (that is, you are not waiting for the transaction receipt), you must calculate the private transaction nonce outside Besu instead of using priv_getTransactionCount.
Parameters
address: string - account address
privacyGroupId: string - privacy group ID
Returns
result: string - integer representing the number of private transactions sent from the address to the specified privacy group
Example
curl HTTP request
wscat WS requestJSON result
priv_getTransactionReceiptReturns information about the private transaction after mining the transaction. Receipts for pending transactions are not available.
Parameters
transaction: string - 32-byte hash of a transaction
Returns
Example
curl HTTP request
wscat WS requestJSON result
priv_newFilterParameters
Note
fromBlock and toBlock in the filter options object default to latest.
Returns
result: string - filter ID
Example
curl HTTP request
wscat WS requestJSON result
priv_uninstallFilterUninstalls a filter for a private contract with the specified ID. When a filter is no longer required, call this method.
Parameters
filterId: string - filter ID
Returns
result: boolean - indicates if the filter is successfully uninstalled
Example
curl HTTP request
wscat WS requestJSON result
QBFT methodsNote
qbft_discardValidatorVoteParameters
address: string - 20-byte address of proposed validator
Returns
result: boolean - indicates if the proposal is discarded
Example
curl HTTP request
wscat WS requestJSON result
qbft_getPendingVotesParameters
None
Returns
result: map of strings to booleans - map of account addresses to corresponding boolean values indicating the vote for each account; if true, the vote is to add a validator. If false, the proposal is to remove a validator.
Example
curl HTTP request
wscat WS requestJSON result
qbft_getSignerMetricsProvides the following validator metrics for the specified range:
Number of blocks from each validator
Block number of the last block proposed by each validator (if any proposed in the specified range)
All validators present in the last block of the range
Parameters
If you specify:
No parameters, the call provides metrics for the last 100 blocks, or all blocks if there are less than 100 blocks.
Only the first parameter, the call provides metrics for all blocks from the block specified to the latest block.
Returns
result: array of objects - list of validator objects
Note
The proposer of the genesis block has address 0x0000000000000000000000000000000000000000.
Example
curl HTTP
wscat WSJSON result
qbft_getValidatorsByBlockHashLists the validators defined in the specified block.
Parameters
block: string - 32-byte block hash
Returns
result: array of strings - list of validator addresses
Example
curl HTTP request
wscat WS requestJSON result
qbft_getValidatorsByBlockNumberLists the validators defined in the specified block.
Parameters
Returns
result: array of strings - list of validator addresses
Example
curl HTTP request
wscat WS requestJSON result
qbft_proposeValidatorVoteParameters
address: string - account address
proposal: boolean - true to propose adding validator or false to propose removing validator
Returns
result: boolean - true
Example
curl HTTP request
wscat WS requestJSON result
TRACE methodsNote
trace_blockImportant
Parameters
Returns
Example
curl HTTP request
wscat WS requestJSON result
trace_replayBlockTransactionsProvides transaction processing tracing per block.
Important
Parameters
Returns
Example
curl HTTP request
wscat WS requestJSON result
trace_transactionImportant
Parameters
transaction: string - transaction hash
Returns
Example
curl HTTP request
wscat WS requestJSON result
TXPOOL methodsThe TXPOOL API methods allow you to inspect the contents of the transaction pool.
Note
txpool_besuPendingTransactionsLists pending transactions that match the supplied filter conditions.
Parameters
numResults: number - integer representing the maximum number of results to return
fields: object - object of fields used to create the filter condition
Each field in the object corresponds to a field name containing an operator, and a value for the operator. A field name can only be specified once, and can only contain one operator. For example, you cannot query transactions with a gas price between 8 and 9 Gwei by using both the gt and lt operator in the same field name instance.
All filters must be satisfied for a transaction to be returned.
from
Address of the sender.
Data, 20 bytes
eq
to
Address of the receiver, or "contract_creation".
Data, 20 bytes
eq, action
gas
Gas provided by the sender.
Quantity
eq, gt, lt
gasPrice
Gas price, in wei, provided by the sender.
Quantity
eq, gt, lt
value
Value transferred, in wei.
Quantity
eq, gt, lt
nonce
Number of transactions made by the sender.
Quantity
eq, gt, lt
Supported operators:
eq (equal to)
lt (less than)
gt (greater than)
action
Note
The only supported action is "contract_creation".
Returns
Example
curl HTTP request
wscat WS requestJSON result
txpool_besuStatisticsLists statistics about the node transaction pool.
Parameters
None
Returns
result: object - transaction pool statistics object with the following fields:
localCount: number - number of transactions submitted directly to this node
remoteCount: number - number of transactions received from remote nodes
Example
curl HTTP request
wscat WS requestJSON result
txpool_besuTransactionsLists transactions in the node transaction pool.
Parameters
None
Returns
result: array of objects - list of transactions
Example
curl HTTP request
wscat WS requestJSON result
WEB3 methodsThe WEB3 API methods provide functionality for the Ethereum ecosystem.
web3_clientVersionReturns the current client version.
Parameters
None
Returns
result: string - current client version
Example
curl HTTP request
wscat WS requestJSON result
web3_sha3Parameters
data: string - data to convert to a SHA3 hash
Returns
result: string - SHA3 result of the input data
Example
curl HTTP request
wscat WS requestJSON result
rpc_modulesParameters
None
Returns
result: map of strings to strings - enabled APIs and their versions
level: string -
Generates cached log bloom indexes for blocks. APIs such as and use the cache for improved performance.
Manually executing admin_generateLogBloomCache is not required unless the command line option is set to false.
fromBlock: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
toBlock: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
enode: string - of the node
id: string -
ports: object - peer discovery and listening
If the node is running locally, the host of the enode and listenAddr display as [::] in the result. When advertising externally, the external address displayed for the enode and listenAddr is defined by .
id: string - node public key (excluding the 0x prefix, the node public key is the ID in the enode://<id ex 0x>@<host>:<port>.)
protocols: object - including difficulty and head (head is the hash of the highest known block for the peer.)
Removes a .
enode: string - of peer to remove
result: boolean - true if peer removed or false if peer not a
The CLIQUE API methods provide access to the consensus engine.
The CLIQUE API methods are not enabled by default for JSON-RPC. To enable the CLIQUE API methods use the or options.
Discards a proposal to .
Lists .
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
fromBlockNumber: string - integer representing a block number or the string tag earliest, as described in
toBlockNumber: string - integer representing a block number or one of the string tags latest or pending, as described in
Returns .
Proposes to .
The DEBUG API methods allow you to inspect and debug the network. The DEBUG API is a more verbose alternative to the , and its main purpose is compatibility with tools such as . We recommend using the for production use over the DEBUG API.
The DEBUG API methods are not enabled by default for JSON-RPC. To enable the DEBUG API methods, use the or options.
uses debug_accountRange to implement debugging.
Sends a list of . This is used to quickly load a network with a lot of transactions. This does the same thing as calling multiple times.
result: array of objects - list of
Use to view the trace for an invalid block.
Use to view the trace for a valid block.
uses debug_storageRangeAt to implement debugging. Use the Debugger tab in Remix instead of calling debug_storageRangeAt directly.
result: object - .
uses debug_traceTransaction to implement debugging. Use the Debugger tab in Remix instead of calling debug_traceTransaction directly.
result: object -
result: object -
result: array of objects - list of
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: array of objects - list of
The EEA API methods provide functionality for and .
The EEA API methods are not enabled by default for JSON-RPC. To enable the EEA API methods, use the or options.
Distributes the , generates the and submits it to the transaction pool, and returns the transaction hash of the .
The signed transaction passed as an input parameter includes the privateFrom, , and restriction fields.
The gas and gasPrice are used by the not the private transaction itself.
For production systems requiring private transactions, use a network with a consensus mechanism supporting transaction finality to make sure the private state does not become inconsistent with the chain. For example, and provide the required finality.
Using private transactions with or is not supported.
Besu does not implement .
provides transaction signing and implements .
result: string - 32-byte transaction hash of the
If creating a contract, use to retrieve the contract address after the transaction is finalized.
Methods with an equivalent query include a GraphQL request and result in the method example. The parameter and result descriptions apply to the JSON-RPC requests. The GraphQL specification is defined in the .
This method returns an empty object because Besu inside the client.
To provide access to your key store and and then sign transactions, use with Besu.
You can interact with contracts using or eth_call.
If revert reason is enabled with , the eth_call error response includes the .
call: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
By default, eth_call does not fail if the sender account has an insufficient balance. This is done by setting the balance of the account to a large amount of ether. To enforce balance rules, set the in the transaction call object to true.
Returns the .
The eth_estimateGas call does not send a transaction. You must call to execute the transaction.
If revert reason is enabled with , the eth_estimateGas error response includes the .
call: object -
newestBlock: string - Integer representing the highest number block of the requested range or one of the string tags latest, earliest, or pending, as described in .
result: object - .
If there are no blocks, the value for is returned. The value returned is restricted to values between and . By default, 1000 Wei and 500GWei.
Use the , , and command line options to configure the eth_gasPrice default values.
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
verbose: boolean - if true, returns the full ; if false, returns the transaction hashes
result: object - , or null when there is no block
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
verbose: boolean - if true, returns the full ; if false, returns only the hashes of the transactions.
result: object - , or null when there is no block.
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
For filters created with eth_newFilter, returns .
Returns an array of for the specified filter.
Leave the command line option at the default value of true to improve log retrieval performance.
result: array of objects - list of
Returns an array of matching a specified filter object.
Leave the command line option at the default value of true to improve log retrieval performance.
filterOptions: object -
result: array of objects - list of
result: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
When using , returns the .
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: object - , or null when there is no transaction
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: object - , or null when there is no transaction
This request returns the third transaction in the 82990 block on the Ropsten testnet. You can also view this and on Etherscan.
result: object - , or null when there is no transaction
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
If you enabled , the receipt includes available revert reasons in the response.
result: object - , or null when there is no receipt
result: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Creates a filter to retrieve new block hashes. To poll for new blocks, use .
Creates a . To poll for logs associated with the created filter, use . To get all logs associated with the filter, use .
filterOptions: object -
Creates a filter to retrieve new pending transactions hashes. To poll for new pending transactions, use .
Sends a . A transaction can send ether, deploy a contract, or interact with a contract. Set the maximum transaction fee for transactions using the CLI option.
You can interact with contracts using eth_sendRawTransaction or .
Besu does not implement .
provides transaction signing and implements .
includes examples of creating signed transactions using the library.
Submits the mining hashrate. This is used by mining software such as .
Submits a proof of work (Ethash) solution. This is used by mining software such as .
currentBlock: string - index of the latest block (also known as the best block) for the current node (this is the same index that returns.)
Filters time out when not requested by or for 10 minutes.
The IBFT API methods provide access to the consensus engine.
The IBFT API methods are not enabled by default for JSON-RPC. To enable the IBFT API methods, use the or options.
Discards a proposal to with the specified address.
Returns cast in the current .
fromBlockNumber: string - integer representing a block number or the string tag earliest as described in
toBlockNumber: string - integer representing a block number or one of the string tags latest or pending, as described in
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Proposes to with the specified address.
The MINER API methods are not enabled by default for JSON-RPC. To enable the MINER API methods, use the or options.
Updates the target gas limit set using the command line option.
Starts the mining process. To start mining, you must first specify a miner coinbase using the command line option.
Returns the .
result: string - of the node
The setting affects the JSON-RPC and P2P host and port values, but not the metrics host and port values.
Returns the .
The PERM API methods provide permissioning functionality. Use these methods for only.
The PERM API methods are not enabled by default for JSON-RPC. To enable the PERM API methods, use the or CLI options.
Adds accounts (participants) to the .
Adds nodes to the .
To use domain names in enode URLs, ensure you to avoid receiving a request contains an invalid node error.
enodes: array of strings - list of
Lists accounts (participants) in the .
Lists nodes in the .
result: array of strings - of nodes in the nodes allowlist
Reloads the accounts and nodes allowlists from the .
Removes accounts (participants) from the .
Removes nodes from the .
enodes: array of strings - list of
The PLUGINS API methods are not enabled by default for JSON-RPC. To enable the PLUGINS API methods, use the or options.
The PRIV API methods provide functionality for and .
The PRIV API methods are not enabled by default for JSON-RPC. To enable the PRIV API methods, use the or options.
For private contracts, priv_call is the same as for public contracts.
privacyGroupId: string - 32-byte
call: object -
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Creates a group of nodes, specified by their public key.
addresses: array of strings - list of nodes specified by public keys
privacyGroupId: string - 32-byte
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Distributes a signed, RLP encoded .
If you want to sign the Privacy Marker Transaction outside of Besu, use instead of .
result: string - 32-byte enclave key (the enclave key is a pointer to the private transaction in .)
members: array of strings - members specified by public keys
result: array of objects - privacy group objects containing only the specified members; privacy groups are or with types:
privacyGroupId: string - 32-byte
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Returns the private transaction count for the specified account and .
Filters for private contracts can only be created by so unlike , priv_getFilterChanges always returns an array of log objects or an empty list.
privacyGroupId: string - 32-byte
result: array of objects - list of , or an empty list if nothing has changed since the last poll
Returns an array of for the specified filter for a private contract.
For private contracts, priv_getFilterLogs is the same as for public contracts except there is no for private contracts.
priv_getFilterLogs is only used for filters created with . To specify a filter object and get logs without creating a filter, use .
privacyGroupId: string - 32-byte
result: array of objects - list of
Returns an array of matching a specified filter object.
For private contracts, priv_getLogs is the same as for public contracts except there is no for private contracts.
privacyGroupId: string - 32-byte
filterOptions: object -
result: array of objects - list of
Returns the address of the . The address is derived and based on the value of the option.
transaction: string - transaction hash returned by or .
result: object - , or null if not a participant in the private transaction
result: object - , or null if no receipt found
Creates a for a private contract. To poll for logs associated with the created filter, use . To get all logs associated with the filter, use .
For private contracts, priv_newFilter is the same as for public contracts.
privacyGroupId: string - 32-byte
filterOptions: object -
Filters time out when not requested by or for 10 minutes.
For private contracts, priv_uninstallFilter is the same as for public contracts.
privacyGroupId: string - 32-byte
The QBFT API methods provide access to the consensus engine.
The QBFT API methods are not enabled by default for JSON-RPC. To enable the QBFT API methods, use the or options.
Discards a proposal to with the specified address.
Returns cast in the current .
fromBlockNumber: string - integer representing a block number or the string tag earliest as described in
toBlockNumber: string - integer representing a block number or one of the string tags latest or pending, as described in
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
Proposes to with the specified address.
The TRACE API is a more concise alternative to the .
The TRACE API methods are not enabled by default for JSON-RPC. To enable the TRACE API methods, use the or options.
Provides transaction processing of for the specified block.
Your node must be an archive node (that is, synchronized without pruning or fast sync) or the requested block must be within (by default, 1024).
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
result: array of objects - list of containing one object per call, in transaction execution order; if revert reason is enabled with , the returned list items include the .
Your node must be an archive node (that is, synchronized without pruning or fast sync) or the requested block must be within (by default, 1024).
blockNumber: string - integer representing a block number or one of the string tags latest, earliest, or pending, as described in
options: array of strings - list of tracing options; tracing options are . Specify any combination of the three options including none of them.
result: array of objects - list of containing one object per transaction, in transaction execution order; if revert reason is enabled with , the list items in the returned transaction trace object include the .
Provides transaction processing of for the specified transaction.
Your node must be an archive node (that is, synchronized without pruning or fast sync) or the requested transaction must be contained in a block within (by default, 1024).
result: array of objects - list of containing one object per call, in the order called by the transaction; if revert reason is enabled with , the returned list items include the .
The TXPOOL API methods are not enabled by default for JSON-RPC. To enable the TXPOOL API methods, use the or options.
result: array of objects - list of objects with
maxSize: number - maximum number of transactions kept in the transaction pool; use the option to configure the maximum size.
Returns a hash of the specified data. The result value is a hash, not the standardized SHA3-256.
Lists and the version of each.