https://github.com/ethersphere/ethproxy

Ethproxy is a websocket reverse proxy for ethereum JsonRPC calls.
https://github.com/ethersphere/ethproxy

ethereum golang jrpc proxy

Last synced: 6 days ago
JSON representation

Ethproxy is a websocket reverse proxy for ethereum JsonRPC calls.

• Host: GitHub
• URL: https://github.com/ethersphere/ethproxy
• Owner: ethersphere
• License: bsd-3-clause
• Created: 2021-07-15T16:03:40.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-12T10:09:35.000Z (about 2 years ago)
• Last Synced: 2024-06-19T14:51:19.116Z (5 months ago)
• Topics: ethereum, golang, jrpc, proxy
• Language: Go
• Homepage:
• Size: 9.13 MB
• Stars: 6
• Watchers: 13
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ethereum Backend Proxy

Ethproxy is a websocket reverse proxy for ethereum JsonRPC calls. It can log response and requests for debugging and observability. It also features an internal state that can be interacted with by running rpc methods listed below.  

To locally run the example client, proxy, and backend:

- `make binary`

- `./dist/backend`

- `PROXY_BACKEND_ENDPOINT=ws://localhost:7000 ./dist/proxy`

- `./dist/client`

Env Flags Needed for the proxy

- `PROXY_API_PORT` Endpoint for executing proxy methods 

- `PROXY_BACKEND_ENDPOINT` Backend endpoint to proxy requests to

- `PROXY_WS_PORT` Websocket port to connect to

- `PROXY_LOG_LEVEL` "info" is default, "debug" prints all `jsonRPC` requests and responses

## Proxy RPC Methods

Methods can be found in /pkg/api/api.go

To interact with the proxy and execute internal commands to, for example,

record or alter the `block number` of the chain, a json RPC call may be sent to the proxy API as such:

```

POST /execute

{"method": "blockNumberRecord"}

```

This command will cause the proxy to start recording the eth block number as responses to block number requests are proxied. This request is required to run before the `blockNumberFreeze` can be called, otherwise, nodes will be frozen at block number `0`. 

```

POST /execute

{"method": "blockNumberFreeze", "params": ["some-ip4-address"]}}

```

If an IP address is provided, the node with that IP, when it queries the current eth block number, will receive the block number that was recorded at the time when this command was executed. Executing this command without `params` will cause all nodes to receive the old block number.

To get the ip address of a Bee node, you may query the debug api at `/addresses` and use the public ip4 address.

To cancel the above executions, grab the id in the response and cancel it as such:

```

DELETE /cancel/{id}

```

Example commands:

```bash

curl --data '{"method": "blockNumberRecord"}' ethproxy.localhost/execute

curl --data '{"method": "blockNumberFreeze", "params": ["10.42.0.37"]}' ethproxy.localhost/execute

curl -X DELETE ethproxy.localhost/cancel/5

```

## Deployment and Testing Locally

### ethersphere/beelocal

```bash

OPTS=skip-vet ./beelocal.sh

```

### ethersphere/ethproxy

```bash

cd deploy

helmsman -apply -f ethproxy.yaml

```

### ethersphere/beekeeper

Copy `beekeeper/config/local.yml` to `~/.beekeeper/local.yaml` and change `swap-endpoint` to `ws://ethproxy:8546`

```bash

beekeeper create bee-cluster --cluster-name local

```

### Logs

```bash

kubectl get pods -n local

kubectl logs -n local -f {proxy container name}

```