README.md

Filecoin Common Node API Specification

This repo is an appendix to the Filecoin Common Node API FIP.

Spec

The main document is the spec.json, which is a description of a set of JSON-RPC methods as an OpenRPC document. You may browse the spec on the OpenRPC playground.

Tooling

This repo also contains tooling for creating, interacting with, and testing against the schema.

• cna-tool
• cna-test-suite
• cna-util

Setup

To get started, you should install rust.

You can compile the utilities with:

make build

Or, install them with:

make install

Example Commands

List the available tests

$ cna-test-suite list

Capture JSON-RPC calls

$ cna-tool json-rpc capture --help

Validate the spec, and perhaps captured calls

$ cna-tool openrpc validate --help