JSON RPC
How to access the ClishaChain API using JSON-RPC
JSON-RPC APIs allow you to interact with your node. JSON-RPC endpoints are not enabled by default.
!!! caution
To enable JSON-RPC over HTTP or WebSocket, use the --rpc-http-enabled
and --rpc-ws-enabled
options.
To enable JSON-RPC over an IPC socket, use the --Xrpc-ipc-enabled
option.
Geth console
The geth console is a REPL (Read, Evaluate, & Print Loop) JavaScript console. Use JSON-RPC APIs supported by geth and ClishaChain directly in the console.
To use the geth console with ClishaChain:
Start Besu with the
--rpc-http-enabled
or--Xrpc-ipc-enabled
option.Specify which APIs to enable using the
--rpc-http-api
or--Xrpc-ipc-api
option.Start the geth console specifying the JSON-RPC endpoint:
!!! example
Use the geth console to call JSON-RPC API methods that geth and Besu share.
!!! example
JSON-RPC authentication
Besu disables Authentication by default.
HTTP and WebSocket requests
HTTP
To make RPC requests over HTTP, you can use curl
.
!!! example
You can use curl
to make multiple RPC requests over HTTP at the same time. Send the requests as an array, and receive an array of responses.
!!! example
WebSocket
To make RPC requests over WebSocket, you can use wscat
, a Node.js based command-line tool.
First connect to the WebSocket server using wscat
(you only need to connect once per session):
After you establish a connection, the terminal displays a '>' prompt. Send individual requests as a JSON data package at each prompt.
!!! Example
You can use wscat
to make multiple RPC requests over WebSocket at the same time. Send the requests as an array, and receive an array of responses.
!!! example
!!! note
Readiness and liveness endpoints
Bseu provides readiness and liveness endpoints to confirm the ClishaChain node status. Both return a 200 OK
status when ready or live and a 503 Service Unavailable
status if not ready or live.
Readiness
By default, the readiness check requires a connected peer and the node to be within two blocks of the best known block. If you have disabled P2P communication, you do not need peers. A live node with P2P disabled is always ready.
Use the query parameters minPeers
and maxBlocksBehind
to adjust the number of peers required and the number of blocks tolerance.
=== "Readiness endpoint"
=== "curl request example"
=== "Query parameters example"
Liveness
The liveness check requires the JSON-RPC server to be up. You can use the endpoint to verify that the node can respond to RPC calls. The status in the response will always be UP
.
=== "Liveness endpoint"
=== "curl request example"
API methods enabled by default
Besu enables the ETH
, NET
, and WEB3
API methods by default.
To enable the ADMIN
, CLIQUE
, DEBUG
, EEA
, IBFT
, MINER
, PERM
, PLUGINS
, PRIV
, TRACE
, and TXPOOL
API methods, use the --rpc-http-api
, --rpc-ws-api
, or --Xrpc-ipc-api
options.
!!! caution
Block parameter
When you make requests that might have different results depending on the block accessed, the block parameter specifies the block. Methods such as eth_getTransactionByBlockNumberAndIndex
have a block parameter.
The block parameter can have the following values:
blockNumber
:quantity
- The block number, specified in hexadecimal or decimal. 0 represents the genesis block.earliest
:tag
- The earliest (genesis) block.latest
:tag
- The last block mined.pending
:tag
- The last block mined plus pending transactions. Use only witheth_getTransactionCount
.finalized
:tag
- The most recent crypto-economically secure block. It cannot be reorganized outside manual intervention driven by community coordination.safe
:tag
- The most recent block that is safe from reorganization under honest majority and certain synchronicity assumptions.
Last updated