amarachukwu1 / ethereum-json-rpc-specification Goto Github PK

View Code? Open in Web Editor NEW

🧱 A specification of JSON-RPC methods that an EVM-based blockchain client must implement.

License: Apache License 2.0

Shell 15.13% JavaScript 84.87%

ethereum-json-rpc-specification's Introduction

ethereum-json-rpc-specification

Overview

This repository is the home of the Ethereum OpenRPC document that describes the JSON-RPC interface to be implemented by client developers. It contains the tooling and scripts to automate producing artifacts for consuming the JSON-RPC API (docs, clients, etc).

Introduction

Both Ethereum client developers and downstream dapp developers lack a formal Ethereum RPC specification. This proposal attempts to standardize such a specification in a way that's versionable, human-readable and machine-readable. It will improve the accuracy of documentation, API, and clients.

Ethereum clients can expose RPC endpoints with differing method signatures; this forces applications to work around method inconsistencies to maintain compatibility with various Ethereum RPC implementations.

Much of Ethereums effectiveness as an enterprise-grade application platform depends on its ability to provide a reliable and predictable developer experience.

Specification

You can view the specification in documentation form here or the raw OpenRPC Document here.

Preview

Clients

The clients are generated from the OpenRPC Document openrpc.json in this repository, and can be used as an alternative to web3.js or ethers.js but for various languages:

Javascript/Typescript

npm install @etclabscore/ethereum-json-rpc --save

Usage:

Rust

Add this to your Cargo.toml:

[dependencies]
ethereum-json-rpc = "*"

Documentation

View the Documentation.

Contributing

Proposals to make method changes should be made as an issue.

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

Resources

Recommend Projects

amarachukwu1 / ethereum-json-rpc-specification Goto Github PK