eth-proxy proxies Ethereum JSON RPC queries exposing a RESTful API that can be easily consumed by http clients. The server is built for scale and can handle hundreds of concurrent requests per second (using free rate-limited Ethereum API endpoints) with in-memory request/response benchmarks handling O(1000) req/s.
- Go HTTP microservice exposing a RESTful API built with httprouter.
- Prometheus metrics server endpoint.
- Lightweight Ethereum JSON RPC client implementation using go-ethereum's
ethclientlibrary. - Integration testing with go-ethereum's simulation package.
Start the application
~/go/src/github.com/ATMackay/eth-proxy$ make run
Open a new terminal to interact with the application. Use the /status endpoint to probe for liveness (it will always return OK)
~$ curl localhost:8080/status
{"message":"OK","version":"0.1.0-992d0028","service":"eth-proxy"}
Use the /health endpoint to probe for readiness (an empty failures list indicates that the service is healthy and ready to take requests)
~$ curl localhost:8080/health
{"version":"v0.1.0-992d0028","service":"eth-proxy","failures":[]}
Use the /eth/balance/<addr> to query the ether balance for an address of your choice. For example
~$ curl localhost:8080/eth/balance/0xfe3b557e8fb62b89f4916b721be55ceb828dbd73
{"balance":"14058"}
Check metrics using the Prometheus server /metrics endpoint
~$ curl localhost:8080/metrics
# HELP go_cgo_go_to_c_calls_calls_total Count of calls made from Go to C by the current process.
# TYPE go_cgo_go_to_c_calls_calls_total counter
go_cgo_go_to_c_calls_calls_total 4
...
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 0
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0
Execute unit tests (providing coverage metrics)
~/go/src/github.com/ATMackay/eth-proxy$ make test
Stack tests (mocking eth-proxy Ethereum nodes interactions)
~/go/src/github.com/ATMackay/eth-proxy$ make test-stack
Benchmark testing
~/go/src/github.com/ATMackay/eth-proxy$ make test-benchmarks
go test -benchmem -bench BenchmarkConcurrentRequests ./integrationtests
goos: linux
goarch: amd64
pkg: github.com/ATMackay/eth-proxy/integrationtests
cpu: 13th Gen Intel(R) Core(TM) i9-13900H
BenchmarkConcurrentRequests-20 1291 2905325 ns/op 336093 B/op 3076 allocs/op
--- BENCH: BenchmarkConcurrentRequests-20
benchmark_test.go:60: executed 10 requests in 1.428248ms - mean duration: 1.428248ms per 10 requests (7002.801120448179 req/s)
benchmark_test.go:60: executed 1000 requests in 272.780843ms - mean duration: 2.727808ms per 10 requests (3667.033370003667 req/s)
benchmark_test.go:60: executed 4390 requests in 669.206962ms - mean duration: 1.524389ms per 10 requests (6561.679790026246 req/s)
benchmark_test.go:60: executed 7860 requests in 729.890607ms - mean duration: 928.614µs per 10 requests (10775.862068965518 req/s)
benchmark_test.go:60: executed 12910 requests in 3.750390592s - mean duration: 2.905027ms per 10 requests (3442.340791738382 req/s)
PASS
ok github.com/ATMackay/eth-proxy/integrationtests 6.589s
To run with docker first build the eth-proxy Docker image
~/go/src/github.com/ATMackay/eth-proxy$ make docker
~/go/src/github.com/ATMackay/eth-proxy$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
eth-proxy f38d1fc d50fcb2ad302 2 minutes ago 13.8MB
eth-proxy latest d50fcb2ad302 2 minutes ago 13.8MB
Run a container
~$ docker run -p 8080:8080 -e ETH_PROXY_URLS=https://mainnet.infura.io/v3/4c664372f60943f690c615f182d50c63 eth-proxy