A reverse proxy for Geth intended for use within Web3Pi ecosystem.

RPC Reverse Proxy comes out-of-the-box with several features:

• Multiple geth nodes - you can hide multiple Geth nodes under single instance of reverse proxy
• JSON-RPC parser - our custom parser validates JSON-RPC requests before they reach the nodes
• Admin portal - comes embedded in, allowing you the following:
  • Authentication - generate API-keys and control access to your reverse proxy
  • User plans - control how much data users can process
  • Activity stats - see how much data each user processes, monitor node usage
  • Admin API - use JSON-RPC based API to perform various operations on your reverse proxy

You can install web3pi-proxy in one of two ways:

Simply install web3pi-proxy package using your Python package manager, using pip for example:

pip install web3pi-proxy

To install the package from source, follow these steps:

git clone https://github.com/Web3-Pi/web3-reverse-proxy.git
cd web3-reverse-proxy
python3 -m venv venv
source venv/bin/activate
pip install poetry
poetry install

You can define the following environment variables, and you can place them in the .env file (all are optional):

You can run your reverse proxy with command:

web3pi-proxy

Admin service starts alongside the reverse proxy.

You can access admin webpage with your browser using admin server's URL and providing admin auth token as a 'token' query param, like so:

http://0.0.0.0:6561/?token=<ADMIN_AUTH_TOKEN>

The admin auth token will be output to your terminal, during the launch.

Token is not stored and will be randomly generated on each launch, unless it has been defined as an environment variable or in the .env file.

Outside of admin portal, the admin service allows several operations, performed by submitting JSON-RPC requests. Use admin auth token in Authorization header of your HTTP POST request for authentication.

Get list of currently configured endpoints, no parameters required.

Add new endpoint at runtime by providing its name and URL. For example, in order to add endpoint local under URL localhost:8545 :

{"jsonrpc": "2.0", "method": "add_endpoint", "params": ["local", "http://localhost:8545/"], "id": 0}

IMPORTANT: Resulting changes are saved in local .env file for reuse.

Change existing endpoint's configuration at runtime by providing its name and URL. For example, in order to change endpoint's local port to 8546 :

{"jsonrpc": "2.0", "method": "update_endpoint", "params": ["local", "http://localhost:8546/"], "id": 0}

IMPORTANT: Resulting changes are saved in local .env file for reuse.

Remove endpoint at runtime by providing its name. For example, in order to remove endpoint local :

{"jsonrpc": "2.0", "method": "remove_endpoint", "params": ["local"], "id": 0}

IMPORTANT: Resulting changes are saved in local .env file for reuse.

Any client can connet RPC Reverse Proxy. A web client, scripting tools, backend servers etc. It is the same as with other Ethereum RPC providers: you need to use a user's access URL containing API key. The proxy supports CORS, which enables usage within web browsers.

Users may wish to integrate the proxy with wallet applications, e.g. Metamask. Below is the example of a proper configuration. It is convenient to create a duplicate of Mainnet network configuration. The only specific piece of setup is the RPC URL, which needs to be set to the access URL (that contains proxy's RPC endpoint and user's API key). See the example below.

In case of any problems with the verification of the newly added network, the best place to start the investigation is to check the network traffic, for instance with the web browser's dev tools/developers tools (Ctrl+Shift+C).