Skip to content

Commit 2327ebe

Browse files
committed
docs: add failover docs
1 parent a3bdf22 commit 2327ebe

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Etherproxy
22

3-
Etherproxy is a JSON-RPC reverse proxy tool designed for caching requests.
3+
Etherproxy is a robust and lightweight JSON-RPC reverse proxy tool designed for **optimising requests** and **providing failover support**.
44

55
## Usage
66

@@ -16,6 +16,12 @@ The command above starts the JSON-RPC reverse proxy...
1616

1717
Make sure to replace `YOUR_TOKEN` with your actual token.
1818

19+
Supply multiple JSON-RPC `--target` with a comma-separated string:
20+
21+
```
22+
npx etherproxy --target https://gno.getblock.io/YOUR_TOKEN/mainnet/,https://rpc.gnosischain.com
23+
```
24+
1925
## Verify the tool is running
2026

2127
Execute the `curl` command shown below repeatedly and inspect the logs of Etherproxy.
@@ -35,10 +41,16 @@ Cache hit: {"jsonrpc":"2.0","method":"eth_blockNumber","params":[]}
3541

3642
## Benefits
3743

44+
### Caching
45+
3846
Etherproxy provides several benefits in multi-node scenarios. For instance, requests such as `eth_blockNumber` and `eth_getLogs` are frequently called, sometimes generating many unnecessary requests. By using a reverse proxy, the same requests made within a small time period are grouped together and sent to your JSON-RPC endpoint only once.
3947

4048
As a result, all local nodes receive identical correct responses, and the number of actual requests sent is significantly reduced, which helps to **preserve your request quota** in case of a paid third-party, or **reduce the load** when you run your own Ethereum node.
4149

50+
### Failover
51+
52+
Failover is an essential aspect of maintaining high availability and reliability in network services. Etherproxy's seamless failover capability ensures that if one JSON-RPC endpoint becomes unreachable, the traffic is automatically redirected to another configured endpoint without interruption.
53+
4254
## Error handling
4355

4456
Whenever an error is thrown, Etherproxy responds with a `503 Service Unavailable` status.

0 commit comments

Comments
 (0)