The package serves JSON-RPC over HTTP and WebSocket, and runs a mirror node from a daily cleaned snapshot. After the first sync, it stays current with the network. Use this when you need your own endpoint instead of the public relay at https://rpc.onyx.org.
Get access
The repository is private: github.com/Onyx-Protocol/onyx-rpc.
Send your GitHub username to the Onyx team and we will invite you. If you want a private channel for setup questions, ask and we will open a dedicated Telegram group.
Requirements
| Resource | Requirement |
|---|---|
| Host | Linux x86_64 |
| CPU | 16 vCPU or more |
| Memory | 128 GiB RAM |
| Disk | 1 TB NVMe recommended (500 GB minimum) |
| Docker Compose | 2.24.4 or newer |
The snapshot is about 16 GB and is published daily by about 02:00 UTC. Start the install before about 05:00 UTC so the node has time to catch up before the next snapshot.
Payer wallet
You need your own ECDSA payer wallet on Onyx (chain ID 327), funded with XCN. An EVM address holding about 500 XCN is enough for heavy, long-term use.
Access key
We send the record-feed access key in a private message. Do not share it in a group chat.
Install
Setup steps are in the repository README. The same instructions are also written for an LLM in docs/AI-INSTALLATION-PROMPT.md.