JSON-RPC API

엔드포인트 노드는 JSON-RPC API로 접근할 수 있습니다. 다음과 같이 API를 활성화하거나 비활성화할 수 있습니다. For the detailed API specification, please refer to the JSON-RPC APIs.

NOTE: HTTP (rpc) 또는 웹소켓 (ws) 인터페이스를 통한 API를 제공하는 것은 인터페이스 (dApp, 브라우저 탭 등)에 접근할 수 있는 누구에게나 API에 접근할 수 있도록 하는 것입니다. 활성화한 API들에 대해 주의하세요. 기본적으로 Klaytn에서는 IPC (ipc) 인터페이스를 통한 모든 API가 활성화되어 있지만, rpc와 ws의 경우 모듈을 직접 활성화해야 합니다.

API 활성화

커맨드라인을 통한 활성화

Klaytn RPC 엔드포인트를 통해 API를 제공하려면 커맨드라인의 --${interface}api 인자를 통해 지정해주세요. 즉 ${interface}을 HTTP 엔드포인트의 경우 rpc으로, 웹소켓 엔드포인트의 경우 ws로 설정해주세요.

ipc는 플래그 없이 unix 소켓 (Unix) 또는 명명된 파이프 (Windows) 엔드포인트를 통한 API를 제공합니다.

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.

예시) klay와 net 모듈을 활성화하며 Klaytn 노드 실행하기

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

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

환경설정을 통한 활성화

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

활성화된 API 조회

To determine which APIs an interface provides, the modules JSON-RPC method can be invoked. 예를 들어 rpc 인터페이스의 경우 다음과 같습니다.

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)

• 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"