https://github.com/open-web3-stack/jam-rpc-spec
JAM RPC spec
https://github.com/open-web3-stack/jam-rpc-spec
Last synced: 5 months ago
JSON representation
JAM RPC spec
- Host: GitHub
- URL: https://github.com/open-web3-stack/jam-rpc-spec
- Owner: open-web3-stack
- Created: 2024-11-29T05:47:28.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-21T01:43:06.000Z (over 1 year ago)
- Last Synced: 2025-01-21T02:28:56.395Z (over 1 year ago)
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jam-rpc-spec
JSONRPC spec for JAM nodes. Powered by [open-rpc](https://open-rpc.org).
[Playground Link](https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/open-web3-stack/jam-rpc-spec/refs/heads/master/openrpc.json)
# Design Decisions
- Following Polkadot JSON RPC: https://polkadot.js.org/docs/substrate/rpc/
- Return raw encoded bytes instead of human readable JSON types
- Keep it simple and minimal so that it is not too much work for all the implementations to support it
- Assume the RPC node is trusted. Given the target audience, it is safe to assume they all run their own RPC nodes.
Note: JAM node RPCs are strictly for development/testing/operational purposes only.
End users are not expected to use them. Most of the devs also shouldn't need to use them.
The expected users are: JAM chain node developers, JAM chain operators (validators and node operators), JAM chain indexers, JAM chain dashbaord and debugging telemetry.
Some of the non users are: end users, wallets, exchanges, smart contract developers, dApp developers.
# RPC categories
For network operators:
- system: Get information about the node.
- chain: Get heads details.
- state: Get onchain state.
- telemetry: Get telemetry info.
For development & testing:
Those methods are for development & internal testing only. They should not be exposed to the public.
- codec: Encode/decode bytes.
- testing: To perform confirmation tests.
- debug: Debugging related methods.