Interface Definition of Chainweaver API

Build Flow

Data Flow

The data flow chart between REST API and Ethereum's JSON RPC is shown below.

Some things to note:

The fields that set wei are properly handled by Custom Mashaler so that they do not overflow when responding to the REST API. The flow chart is annotated with the example of how balance as a typical field of wei is converted.

For developer

In this project you can develop by preparing the following environment.

• Be able to use the make command
• Docker daemon is running on your machine

Build

make build

Render Protocol Buffers Document

make render-protobuf-document

Render OpenAPI Document

make render-openapi-document

Test REST API with postman

export BASE_URL=URL
export TOKEN=YOUR_TOKEN
make test

Document

Protocol Buffers

• Bitcoin
• Ethereum

OpenAPI

• Bitcoin
• Ethereum

Reference

• https://grpc.io/
• https://developers.google.com/protocol-buffers/
• https://github.com/grpc-ecosystem/grpc-gateway
• https://github.com/golang/protobuf
• https://github.com/pseudomuto/protoc-gen-doc
• https://www.getpostman.com/

License Scan