Skip to main content

JSON-RPC APIs

Endpoint Node exposes JSON-RPC APIs. You can enable/disable APIs as follows. For the detailed API specification, please refer to the JSON-RPC APIs.

NOTE: Offering an API over the HTTP (rpc) or WebSocket (ws) interfaces will give everyone access to the APIs who can access this interface (DApps, browser tabs, etc). Be careful about which APIs you enable. By default, Klaytn enables all APIs over the IPC (ipc) interface but for rpc and ws required modules have to be explicitly enabled.

Enabling APIs ​

From Commandline ​

To offer the APIs over the Klaytn RPC endpoints, please specify them with the --${interface}api command-line argument where ${interface} can be rpc for the HTTP endpoint or ws for the WebSocket endpoint.

ipc offers all APIs over the unix socket (Unix) or named pipe (Windows) endpoint without any flag.

You can launch a Klaytn node with specific APIs you want to add like the example below. But keep in mind that you can't change APIs once you launch the node.

Example) launching a Klaytn node with klay and net modules enabled:


$ ken --rpcapi klay,net --rpc --{other options}

The HTTP RPC interface must be explicitly enabled using the --rpc flag.

Using Configuration ​

Please update the RPC_ENABLE, RPC_API, WS_ENABLE and WS_API properties in the Configuration File.

Querying Enabled APIs ​

To determine which APIs an interface provides, the modules JSON-RPC method can be invoked. For example over an rpc interface:

IPC


$ echo '{"jsonrpc":"2.0","method":"rpc_modules","params":[],"id":1}' | nc -U klay.ipc

HTTP


$ curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"rpc_modules","params":[],"id":1}' https://public-en-baobab.klaytn.net

will give all enabled modules including the version number:


{
"jsonrpc":"2.0",
"id":1,
"result":{
"admin":"1.0",
"debug":"1.0",
"klay":"1.0",
"miner":"1.0",
"net":"1.0",
"personal":"1.0",
"rpc":"1.0",
"txpool":"1.0",
"web3":"1.0"
}
}

Disabling unsafe debug APIs ​

Some debug namespace APIs are unsafe/unappropriate to be opened to public. We recommend you to provide the debug namespace APIs to authorized users only. However, if you want to maintain a public EN and provide debug namespace APIs to the public, we strongly recommend you to set the rpc.unsafe-debug.disable flag which will disable APIs that are unsafe/unappropriate to be opened to the public and enable only a subset of the debug namespace APIs.

The enabled APIs are as follows:

  • VM Tracing APIs, however with limited functionality (only pre-defined tracers are allowed. See params/tracingOptions)
  • debug_dumpBlock, debug_dumpStateTrie, debug_getBlockRlp, debug_getModifiedAccountsByHash, debug_getModifiedAccountsByNumber, debug_getBadBlocks, debug_getModifiedStorageNodesByNumber
  • debug_metrics

To set the rpc.unsafe-debug.disable flag, append the following line in the kend.conf file.


ADDITIONAL="$ADDITIONAL --rpc.unsafe-debug.disable"

Make this page better