arieltm / starknet-specs

StarkNet Specifications

This repository publishes different technical specifications pertaining to the implementation and interaction with StarkNet.

API

The JSON-RPC API can be found under the api/ folder. You can view it more conveniently using the OpenRPC playground here.

A guide to the API can be found here.

Tooling

When developing the schema, you can validate the OpenRPC schema file, by running the provided script. Note this requires node.js installed.

The command:

./validate.js api/starknet_api_openrpc.json

will run a validation on the api/starknet_api_openrpc.json schema file. If everything is ok, an appropriate message is displayed; otherwise errors are output to standard error.