rippled server has a limited gRPC API which P2P mode servers can provide. Reporting mode servers use this API to retrieve data about the latest validated ledgers and transactions. You can enable the gRPC API on your server with a new configuration stanza.
Caution: gRPC support is intended specifically for providing data to reporting mode servers from P2P mode servers. Breaking changes to the gRPC API may occur without warning or it may be removed entirely in future versions of the server.
To enable gRPC, you must meet the following prerequisites:
You must have installed rippled.
Your server must be able to bind to the port you choose. The recommended port for gRPC is
To enable gRPC on your server, complete the following steps:
rippled's config file, add a
[port_grpc] port = 50051 ip = 0.0.0.0
The configurable fields are as follows:
portfield defines the port the server listens on for gRPC connections from client applications. The recommended port is
ipdefines which interfaces the server listens on. The value
0.0.0.0listens on all available network interfaces. To limit connections to the local loopback network (same machine), use
The recommended installation uses the config file
/etc/opt/ripple/rippled.cfgby default. Other places you can put a config file include
$HOMEis the home directory of the user running
$HOME/.local/ripple/rippled.cfg, or the current working directory from where you start
Start (or restart) the
sudo systemctl restart rippled