Skip to content

Latest commit

 

History

History
342 lines (276 loc) · 17.7 KB

README.md

File metadata and controls

342 lines (276 loc) · 17.7 KB
Raw

Clio

Clio is an XRP Ledger API server. Clio is optimized for RPC calls, over WebSocket or JSON-RPC. Validated historical ledger and transaction data are stored in a more space-efficient format, using up to 4 times less space than rippled. Clio can be configured to store data in Apache Cassandra or ScyllaDB, allowing for scalable read throughput. Multiple Clio nodes can share access to the same dataset, allowing for a highly available cluster of Clio nodes, without the need for redundant data storage or computation.

Clio offers the full rippled API, with the caveat that Clio by default only returns validated data. This means that ledger_index defaults to validated instead of current for all requests. Other non-validated data is also not returned, such as information about queued transactions. For requests that require access to the p2p network, such as fee or submit, Clio automatically forwards the request to a rippled node and propagates the response back to the client. To access non-validated data for any request, simply add ledger_index: "current" to the request, and Clio will forward the request to rippled.

Clio does not connect to the peer-to-peer network. Instead, Clio extracts data from a group of specified rippled nodes. Running Clio requires access to at least one rippled node from which data can be extracted. The rippled node does not need to be running on the same machine as Clio.

Help

Feel free to open an issue if you have a feature request or something doesn't work as expected. If you have any questions about building, running, contributing, using clio or any other, you could always start a new discussion.

Requirements

  1. Access to a Cassandra cluster or ScyllaDB cluster. Can be local or remote.
  2. Access to one or more rippled nodes. Can be local or remote.

Building

Clio is built with CMake and uses Conan for managing dependencies. It is written in C++20 and therefore requires a modern compiler.

Prerequisites

Minimum Requirements

Compiler Version
GCC 11
Clang 14
Apple Clang 14.0.3

Conan configuration

Clio does not require anything but default settings in your (~/.conan/profiles/default) Conan profile. It's best to have no extra flags specified.

Mac example:

[settings]
os=Macos
os_build=Macos
arch=armv8
arch_build=armv8
compiler=apple-clang
compiler.version=14
compiler.libcxx=libc++
build_type=Release
compiler.cppstd=20

Linux example:

[settings]
os=Linux
os_build=Linux
arch=x86_64
arch_build=x86_64
compiler=gcc
compiler.version=11
compiler.libcxx=libstdc++11
build_type=Release
compiler.cppstd=20

Artifactory

  1. Make sure artifactory is setup with Conan
conan remote add --insert 0 conan-non-prod http://18.143.149.228:8081/artifactory/api/conan/conan-non-prod

Now you should be able to download prebuilt xrpl package on some platforms.

  1. Remove old packages you may have cached:
conan remove -f xrpl

Building Clio

Navigate to Clio's root directory and perform

mkdir build && cd build
conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True
cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build . --parallel 8 # or without the number if you feel extra adventurous

If all goes well, conan install will find required packages and cmake will do the rest. you should end up with clio_server and clio_tests in the build directory (the current directory).

Tip: You can omit the -o tests=True in conan install command above if you don't want to build clio_tests.

Tip: To generate a Code Coverage report, include -o coverage=True in the conan install command above, along with -o tests=True to enable tests. After running the cmake commands, execute make clio_tests-ccov. The coverage report will be found at clio_tests-llvm-cov/index.html.

Running

./clio_server config.json

Clio needs access to a rippled server. The config files of rippled and Clio need to match in a certain sense. Clio needs to know:

  • the IP of rippled
  • the port on which rippled is accepting unencrypted WebSocket connections
  • the port on which rippled is handling gRPC requests

rippled needs to open:

  • a port to accept unencrypted websocket connections
  • a port to handle gRPC requests, with the IP(s) of Clio specified in the secure_gateway entry

The example configs of rippled and Clio are setups such that minimal changes are required. When running locally, the only change needed is to uncomment the port_grpc section of the rippled config. When running Clio and rippled on separate machines, in addition to uncommenting the port_grpc section, a few other steps must be taken:

  1. change the ip of the first entry of etl_sources to the IP where your rippled server is running
  2. open a public, unencrypted WebSocket port on your rippled server
  3. change the IP specified in secure_gateway of port_grpc section of the rippled config to the IP of your Clio server. This entry can take the form of a comma-separated list if you are running multiple Clio nodes.

In addition, the parameter start_sequence can be included and configured within the top level of the config file. This parameter specifies the sequence of first ledger to extract if the database is empty. Note that ETL extracts ledgers in order and that no backfilling functionality currently exists, meaning Clio will not retroactively learn ledgers older than the one you specify. Choosing to specify this or not will yield the following behavior:

  • If this setting is absent and the database is empty, ETL will start with the next ledger validated by the network.
  • If this setting is present and the database is not empty, an exception is thrown.

In addition, the optional parameter finish_sequence can be added to the json file as well, specifying where the ledger can stop.

To add start_sequence and/or finish_sequence to the config.json file appropriately, they will be on the same top level of precedence as other parameters (such as database, etl_sources, read_only, etc.) and be specified with an integer. Here is an example snippet from the config file:

"start_sequence": 12345,
"finish_sequence": 54321

The parameters ssl_cert_file and ssl_key_file can also be added to the top level of precedence of our Clio config. ssl_cert_file specifies the filepath for your SSL cert while ssl_key_file specifies the filepath for your SSL key. It is up to you how to change ownership of these folders for your designated Clio user. Your options include:

  • Copying the two files as root somewhere that's accessible by the Clio user, then running sudo chown to your user
  • Changing the permissions directly so it's readable by your Clio user
  • Running Clio as root (strongly discouraged)

An example of how to specify ssl_cert_file and ssl_key_file in the config:

"server": {
    "ip": "0.0.0.0",
    "port": 51233
},
"ssl_cert_file": "/full/path/to/cert.file",
"ssl_key_file": "/full/path/to/key.file"

Once your config files are ready, start rippled and Clio. It doesn't matter which you start first, and it's fine to stop one or the other and restart at any given time.

Clio will wait for rippled to sync before extracting any ledgers. If there is already data in Clio's database, Clio will begin extraction with the ledger whose sequence is one greater than the greatest sequence currently in the database. Clio will wait for this ledger to be available. Be aware that the behavior of rippled is to sync to the most recent ledger on the network, and then backfill. If Clio is extracting ledgers from rippled, and then rippled is stopped for a significant amount of time and then restarted, rippled will take time to backfill to the next ledger that Clio wants. The time it takes is proportional to the amount of time rippled was offline for. Also be aware that the amount rippled backfills are dependent on the online_delete and ledger_history config values; if these values are small, and rippled is stopped for a significant amount of time, rippled may never backfill to the ledger that Clio wants. To avoid this situation, it is advised to keep history proportional to the amount of time that you expect rippled to be offline. For example, if you expect rippled to be offline for a few days from time to time, you should keep at least a few days of history. If you expect rippled to never be offline, then you can keep a very small amount of history.

Clio can use multiple rippled servers as a data source. Simply add more entries to the etl_sources section. Clio will load balance requests across the servers specified in this list. As long as one rippled server is up and synced, Clio will continue extracting ledgers.

In contrast to rippled, Clio will answer RPC requests for the data already in the database as soon as the server starts. Clio doesn't wait to sync to the network, or for rippled to sync.

When starting Clio with a fresh database, Clio needs to download a ledger in full. This can take some time, and depends on database throughput. With a moderately fast database, this should take less than 10 minutes. If you did not properly set secure_gateway in the port_grpc section of rippled, this step will fail. Once the first ledger is fully downloaded, Clio only needs to extract the changed data for each ledger, so extraction is much faster and Clio can keep up with rippled in real-time. Even under intense load, Clio should not lag behind the network, as Clio is not processing the data, and is simply writing to a database. The throughput of Clio is dependent on the throughput of your database, but a standard Cassandra or Scylla deployment can handle the write load of the XRP Ledger without any trouble. Generally the performance considerations come on the read side, and depends on the number of RPC requests your Clio nodes are serving. Be aware that very heavy read traffic can impact write throughput. Again, this is on the database side, so if you are seeing this, upgrade your database.

It is possible to run multiple Clio nodes that share access to the same database. The Clio nodes don't need to know about each other. You can simply spin up more Clio nodes pointing to the same database as you wish, and shut them down as you wish. On startup, each Clio node queries the database for the latest ledger. If this latest ledger does not change for some time, the Clio node begins extracting ledgers and writing to the database. If the Clio node detects a ledger that it is trying to write has already been written, the Clio node will backoff and stop writing. If later the Clio node sees no ledger written for some time, it will start writing again. This algorithm ensures that at any given time, one and only one Clio node is writing to the database.

It is possible to force Clio to only read data, and to never become a writer. To do this, set read_only: true in the config. One common setup is to have a small number of writer nodes that are inaccessible to clients, with several read only nodes handling client requests. The number of read only nodes can be scaled up or down in response to request volume.

When using multiple rippled servers as data sources and multiple Clio nodes, each Clio node should use the same set of rippled servers as sources. The order doesn't matter. The only reason not to do this is if you are running servers in different regions, and you want the Clio nodes to extract from servers in their region. However, if you are doing this, be aware that database traffic will be flowing across regions, which can cause high latencies. A possible alternative to this is to just deploy a database in each region, and the Clio nodes in each region use their region's database. This is effectively two systems.

Clio supports API versioning as described here. It's possible to configure minimum, maximum and default version like so:

"api_version": {
    "min": 1,
    "max": 2,
    "default": 1
}

All of the above are optional. Clio will fallback to hardcoded defaults when not specified in the config file or configured values are outside of the minimum and maximum supported versions hardcoded in src/rpc/common/APIVersion.h.

Note: See example-config.json for more details.

Admin rights for requests

By default clio checks admin privileges by IP address from request (only 127.0.0.1 is considered to be an admin). It is not very secure because the IP could be spoofed. For a better security admin_password could be provided in the server section of clio's config:

"server": {
    "admin_password": "secret"
}

If the password is presented in the config, clio will check the Authorization header (if any) in each request for the password. The Authorization header should contain type Password and the password from the config, e.g. Password secret. Exactly equal password gains admin rights for the request or a websocket connection.

Prometheus metrics collection

Clio natively supports Prometheus metrics collection. It accepts Prometheus requests on the port configured in server section of config. Prometheus metrics are enabled by default. To disable it add "prometheus_enabled": false to the config. It is important to know that clio responds to Prometheus request only if they are admin requests, so Prometheus should be configured to send admin password in header. There is an example of docker-compose file, Prometheus and Grafana configs in examples/infrastructure.

Using clang-tidy for static analysis

Minimum clang-tidy version required is 16.0. Clang-tidy could be run by cmake during building the project. For that provide the option -o lint=True for conan install command:

conan install .. --output-folder . --build missing --settings build_type=Release -o tests=True -o lint=True

By default cmake will try to find clang-tidy automatically in your system. To force cmake use desired binary set CLIO_CLANG_TIDY_BIN environment variable as path to clang-tidy binary. E.g.:

export CLIO_CLANG_TIDY_BIN=/opt/homebrew/opt/llvm@16/bin/clang-tidy

Developing against rippled in standalone mode

If you wish you develop against a rippled instance running in standalone mode there are a few quirks of both clio and rippled you need to keep in mind. You must:

  1. Advance the rippled ledger to at least ledger 256
  2. Wait 10 minutes before first starting clio against this standalone node.

Logging

Clio provides several logging options, all are configurable via the config file and are detailed below.

log_level: The minimum level of severity at which the log message will be outputted by default. Severity options are trace, debug, info, warning, error, fatal. Defaults to info.

log_format: The format of log lines produced by clio. Defaults to "%TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message%". Each of the variables expands like so

  • TimeStamp: The full date and time of the log entry
  • SourceLocation: A partial path to the c++ file and the line number in said file (source/file/path:linenumber)
  • ThreadID: The ID of the thread the log entry is written from
  • Channel: The channel that this log entry was sent to
  • Severity: The severity (aka log level) the entry was sent at
  • Message: The actual log message

log_channels: An array of json objects, each overriding properties for a logging channel. At the moment of writing, only log_level can be overriden using this mechanism.

Each object is of this format:

{
    "channel": "Backend",
    "log_level": "fatal"
}

If no override is present for a given channel, that channel will log at the severity specified by the global log_level. Overridable log channels: Backend, WebServer, Subscriptions, RPC, ETL and Performance.

Note: See example-config.json for more details.

log_to_console: Enable/disable log output to console. Options are true/false. Defaults to true.

log_directory: Path to the directory where log files are stored. If such directory doesn't exist, Clio will create it. If not specified, logs are not written to a file.

log_rotation_size: The max size of the log file in megabytes before it will rotate into a smaller file. Defaults to 2GB.

log_directory_max_size: The max size of the log directory in megabytes before old log files will be deleted to free up space. Defaults to 50GB.

log_rotation_hour_interval: The time interval in hours after the last log rotation to automatically rotate the current log file. Defaults to 12 hours.

Note, time-based log rotation occurs dependently on size-based log rotation, where if a size-based log rotation occurs, the timer for the time-based rotation will reset.

log_tag_style: Tag implementation to use. Must be one of:

  • uint: Lock free and threadsafe but outputs just a simple unsigned integer
  • uuid: Threadsafe and outputs a UUID tag
  • none: Don't use tagging at all

Cassandra / Scylla Administration

Since Clio relies on either Cassandra or Scylla for its database backend, here are some important considerations: