Configure gRPC

The rippled server has an experimental gRPC API . Currently, this API provides a subset of the full rippled API. You can enable the gRPC API on your server with a new configuration stanza. New in: rippled 1.5.0

Caution: gRPC support in rippled v1.5.0 is experimental. Configuration settings and API formats are likely to have breaking changes in forthcoming versions.

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. The recommended port for gRPC is 50051.

Steps

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

  1. In your rippled's config file, add a [port_grpc] configuration stanza.

    [port_grpc]
port = 50051
ip = 0.0.0.0

    The configurable fields are as follows:

    • port field 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. The value 0.0.0.0 listens on all available network interfaces. To limit connections to just the local loopback network (same machine), use 127.0.0.1 instead.

    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