Configure gRPC

The 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.

Prerequisites

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.

Steps

To enable gRPC on your server, complete the following steps:

1. Ensure the [port_grpc] stanza is in your rippled config file.

   [port_grpc]
   port = 50051
   ip = 127.0.0.1
   

   • port defines the port the server listens on for gRPC connections from client applications. The recommended port is 50051.
   • ip defines which interfaces the server listens on. 127.0.0.1 limits connections to the local loopback network (same machine) and is enabled by default. Changing the value to 0.0.0.0 listens on all available network interfaces.

   The recommended installation uses the config file /etc/opt/ripple/rippled.cfg by default. Other places you can put a config file include $HOME/.config/ripple/rippled.cfg (where $HOME is the home directory of the user running rippled), $HOME/.local/ripple/rippled.cfg, or the current working directory from where you start rippled.

2. Start (or restart) the rippled service.

   sudo systemctl restart rippled
   

See Also

• Concepts:
  • XRP Ledger Overview
  • rippled Server Modes
• Tutorials:
  • Get Started Using HTTP / WebSocket APIs
  • Reliable Transaction Submission
  • Manage the rippled Server
• References:
  • HTTP / WebSocket API Reference