@conflux-dev/jsonrpc-spec

Conflux JSON-RPC Specification

The Conflux JSON-RPC is a collection of methods. This interface allows downstream tooling and infrastructure to generate code or build mock server.

Online Viewer

• cfx namespace methods
• eth namespace methods

How to add examples

Edit src/eth/examples.json or src/cfx/examples.json to add examples.

How to add examples schema

Use scripts to generate examples schema:

node scripts/add-examples-to-openrpc.js src/cfx/examples.json src/cfx/cfx.json

How to run MockServer

Prepare a JSON-RPC description file, you can add examples you want to test into it. Then run the mock-server with follow command:

npm run mock-server -d the-openrpc.json

or

npx open-rpc-mock-server -p 3333 -d src/cfx/cfx.json