SKALE Proxy

SKALE Proxy is high performance, easy-to-run public service that provides proxied and load-balanced JSON-RPC endpoints for SKALE chains. It is based on NGINX.

Usage guide

Prerequisites

• Docker
• docker-compose

Repo setup

1. Clone repo & all submodules
2. Put abi.json, server.crt and server.keyfiles in data folder
3. Export all required environment variables (see below)
4. Run scripts/run_proxy.sh

Pre-commit hook

ruff check --config metrics/pyproject.toml metrics/src/

Format code

ruff format src/

Required environment variables

• ETH_ENDPOINT - endpoint of the Ethereum network where skale-manager contracts are deployed

Optional environment variables

• HEARTBEAT_URL - URL for healthcheck endpoint (optional)
• USE_ALB - Set to True if the proxy is deployed behind a load balancer (like AWS ALB) that sets the X-Forwarded-For header. This configures Nginx to correctly identify the client's real IP address for rate limiting. Defaults to False if not set.

License

All contributions to SKALE Proxy are made under the GNU Affero General Public License v3. See LICENSE.

Copyright (C) 2022-Present SKALE Labs.