forks/go-ethereum
1
0
Fork 1
mirror of https://github.com/ethereum/go-ethereum.git synced 2026-07-22 12:46:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: clarify that gRPC is disabled by default and runs alongside JSON-RPC, not as a replacement, requiring explicit --grpc flag to enable low-latency trading APIs

Browse source
This commit is contained in:
floor-licker 2025-11-25 22:45:58 -05:00
parent 2683994f02
commit 16cc5ed8e0
No known key found for this signature in database
GPG key ID: 00CAB0DF8891321D
1 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
api/grpc/README.md
View file

@ -4,13 +4,16 @@ Low-latency binary API for high-frequency trading and MEV operations on Mandarin
## Overview ## Overview
This package provides a Protocol Buffer-based gRPC API that replaces slow JSON-RPC for performance-critical operations. Key features: This package provides a Protocol Buffer-based gRPC API that **runs alongside JSON-RPC** for performance-critical operations. Key features:
- **Binary protocol**: 10x performance improvement over JSON-RPC - **Binary protocol**: 10x performance improvement over JSON-RPC
- **Bundle operations**: Submit and simulate transaction bundles with profit calculation - **Bundle operations**: Submit and simulate transaction bundles with profit calculation
- **Batch operations**: Read multiple storage slots in a single call - **Batch operations**: Read multiple storage slots in a single call
- **Low latency**: Direct integration with miner and state database - **Low latency**: Direct integration with miner and state database
- **Type safety**: Strongly-typed interfaces via Protocol Buffers - **Type safety**: Strongly-typed interfaces via Protocol Buffers
- **Additive**: JSON-RPC continues to work for all standard operations
**Note:** gRPC is **disabled by default** and must be explicitly enabled.
## Architecture ## Architecture
@ -22,7 +25,20 @@ This package provides a Protocol Buffer-based gRPC API that replaces slow JSON-R
## Configuration ## Configuration
Enable gRPC in your node configuration: **Important:** gRPC is **disabled by default**. You must explicitly enable it to use these high-performance trading APIs.
### Via Command-Line Flags (Recommended)
```bash
# Enable gRPC alongside standard JSON-RPC
geth --http --http.port 8545 \
--grpc --grpc.addr localhost --grpc.port 9090
# JSON-RPC will run on port 8545 (standard Ethereum API)
# gRPC will run on port 9090 (low-latency trading API)
```
### Via Configuration File
```toml ```toml
[Eth] [Eth]
@ -31,11 +47,12 @@ GRPCHost = "localhost"
GRPCPort = 9090 GRPCPort = 9090
``` ```
Or via command-line flags: ### What This Enables
```bash When you add the `--grpc` flag:
geth --grpc --grpc.addr localhost --grpc.port 9090 - ✅ **JSON-RPC continues to work** on port 8545 (eth_*, debug_*, etc.)
``` - ✅ **gRPC becomes available** on port 9090 (bundle, batch operations)
- ✅ **Both run simultaneously** - use each for its strengths
## Usage Example ## Usage Example
@ -193,8 +210,3 @@ go test -bench=. -benchtime=10s ./api/grpc/...
5. **Shared memory**: Zero-copy data sharing for co-located bots 5. **Shared memory**: Zero-copy data sharing for co-located bots
6. **Authentication**: mTLS, JWT, or API key support 6. **Authentication**: mTLS, JWT, or API key support
7. **Metrics**: Prometheus integration for latency and throughput monitoring 7. **Metrics**: Prometheus integration for latency and throughput monitoring
## License
LGPL-3.0-or-later (same as go-ethereum)