Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.27 KB

README.md

File metadata and controls

44 lines (28 loc) · 2.27 KB
Raw

Go Substrate RPC Client (GSRPC)

License: Apache v2.0 GoDoc Reference Build Status codecov Go Report Card

Substrate RPC client in Go. It provides APIs and types around Polkadot and any Substrate-based chain RPC calls. This client is modelled after polkadot-js/api.

State

This package is feature complete, but it is relatively new and might still contain bugs. We advice to use it with caution in production. It comes without any warranties, please refer to LICENCE for details.

Requirements

Substrate Key Management requires subkey to be present in your PATH: https://substrate.dev/docs/en/knowledgebase/integrate/subkey

The subkey recommended version: https://github.com/paritytech/substrate/releases/tag/v2.0.0-rc6

Documentation & Usage Examples

Please refer to https://godoc.org/github.com/centrifuge/go-substrate-rpc-client

Contributing

  1. Install dependencies by running make followed by make install
  2. Run tests make test
  3. Lint make lint (you can use make lint-fix to automatically fix issues)

Run tests in a Docker container against the Substrate Default Docker image

  1. Run the docker container make test-dockerized

Run tests locally against the Substrate Default Docker image

  1. Start the Substrate Default Docker image: make run-substrate-docker
  2. In another terminal, run the tests against that image: make test
  3. Visit https://polkadot.js.org/apps for inspection

Run tests locally against any substrate endpoint

  1. Set the endpoint: export RPC_URL="http://example.com:9933"
  2. Run the tests make test