March.22.2022, RippleX and the XRP Ledger Foundation (XRPLF) are pleased
to announce the first beta release for Clio, an XRP Ledger API server
optimized for WebSocket or HTTP API calls.
A Clio server does not connect to the peer-to-peer network. Instead, it
extracts data from a specified rippled server that is connected to the P2P
network. By handling API calls efficiently, Clio servers can help reduce
the load on rippled servers running in P2P mode.
Clio stores validated historical ledger and transaction data in a
space-efficient format, using up to 4 times less space than rippled. Clio
uses Cassandra or ScyllaDB, allowing for scalable read throughput.
Multiple Clio servers can share access to the same dataset, thereby
enabling you to build a highly available cluster of Clio servers without
the need for redundant data storage or computation.
Clio requires access to a rippled server and the rippled need not be
running on the same machine as Clio.
While Clio offers the complete rippled API, by default, it only returns
validated data. For any requests that require access to the P2P network,
Clio automatically forwards the request to the rippled server on the P2P
network and passes the response back to the requestor.
This beta release of Clio has been built and tested on Ubuntu 20.04 Focal
Fossa.
Run the following commands to install Clio:
sudo apt-get update && sudo apt-get install -y wget
gnupg2
wget -q -O - "https://repos.ripple.com/repos/api/gpg/key/public" | sudo apt-key add -
echo "deb https://repos.ripple.com/repos/rippled-deb-test-mirror focal
unstable" | sudo tee /etc/apt/sources.list.d/clio.list
sudo apt-get update && sudo apt install clio
For more information about running Clio, check out the README in 👉the Clio project repository.
To report an issue, provide feedback, or propose a new idea, please 👉open an issue.
About 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 specified rippled node. Running Clio requires access to a rippled node from which data can be extracted. The rippled node does not need to be running on the same machine as Clio.