mirror of
https://github.com/XRPLF/rippled.git
synced 2026-09-27 23:38:08 +00:00
637f9ae3d0
Nine files conflicted. Resolutions, and why: Telemetry.cpp - upstream carried its own initMetrics(), makeResource() and makeMetricExporter(); this branch already has an initMetrics() that builds the exporter inline and uses makeMetricsResource(), which stamps xrpl.node.id only when it is already known. Keeping both would have defined initMetrics() twice. Kept this branch's, then pointed its reader at setup_.metricExportInterval and setup_.metricExportTimeout: upstream turned those constants into [telemetry] keys and removed the old ones, so the previous spelling no longer resolves. OTelCollector.h - kept upstream's parameter docs. This branch's text promised instanceId, serviceName and networkType become resource attributes; the constructor marks all three [[maybe_unused]] and the .cpp already says they are not read. CollectorManager.cpp - kept upstream's comment for the same reason. node-health.json - kept this branch's 60 panels. Upstream's only change to the file was job_count to jobq_job_count, which this branch already had. cfg/xrpld-example.cfg - composed. Kept this branch's warning that service_instance_id must be set explicitly for the metrics pipeline, took upstream's traces_endpoint rename, and removed a duplicate metrics_endpoint entry along with the claim that metrics derive from the traces URL by rewriting the signal path. Nothing derives it; both metric exporters read metrics_endpoint. 17 keys, one entry each. 05-configuration-reference.md - both sides misdescribed the parser. Kept this branch's fuller text, corrected the endpoint default to traces_endpoint, and replaced the "resolve their URL differently" table with what the code does now. 09-data-collection-reference.md, 06-implementation-phases.md, Phase7_taskList.md - kept this branch's versions, which drop a metric that was never implemented, correct the state encoding to 0-6, and rename nudb_bytes to stored_object_bytes. Re-applied upstream's rpc_requests_total fix, which taking this side had reverted.
The XRP Ledger
The XRP Ledger is a decentralized cryptographic ledger powered by a network of peer-to-peer nodes. The XRP Ledger uses a novel Byzantine Fault Tolerant consensus algorithm to settle and record transactions in a secure distributed database without a central operator.
XRP
XRP is a public, counterparty-free crypto-asset native to the XRP Ledger, and is designed as a gas token for network services and to bridge different currencies. XRP is traded on the open-market and is available for anyone to access. The XRP Ledger was created in 2012 with a finite supply of 100 billion units of XRP.
xrpld
The server software that powers the XRP Ledger is called xrpld and is available in this repository under the permissive ISC open-source license. The xrpld server software is written primarily in C++ and runs on a variety of platforms. The xrpld server software can run in several modes depending on its configuration.
If you are interested in running an API Server (including a Full History Server), take a look at Clio. (xrpld Reporting Mode has been replaced by Clio.)
Build from Source
- Read the build instructions in
BUILD.md - If you encounter any issues, please open an issue
Key Features of the XRP Ledger
- Censorship-Resistant Transaction Processing: No single party decides which transactions succeed or fail, and no one can "roll back" a transaction after it completes. As long as those who choose to participate in the network keep it healthy, they can settle transactions in seconds.
- Fast, Efficient Consensus Algorithm: The XRP Ledger's consensus algorithm settles transactions in 4 to 5 seconds, processing at a throughput of up to 1500 transactions per second. These properties put XRP at least an order of magnitude ahead of other top digital assets.
- Finite XRP Supply: When the XRP Ledger began, 100 billion XRP were created, and no more XRP will ever be created. The available supply of XRP decreases slowly over time as small amounts are destroyed to pay transaction fees.
- Responsible Software Governance: A team of full-time developers at Ripple & other organizations maintain and continually improve the XRP Ledger's underlying software with contributions from the open-source community. Ripple acts as a steward for the technology and an advocate for its interests.
- Secure, Adaptable Cryptography: The XRP Ledger relies on industry standard digital signature systems like ECDSA (the same scheme used by Bitcoin) but also supports modern, efficient algorithms like Ed25519. The extensible nature of the XRP Ledger's software makes it possible to add and disable algorithms as the state of the art in cryptography advances.
- Modern Features: Features like Escrow, Checks, and Payment Channels support financial applications atop of the XRP Ledger. This toolbox of advanced features comes with safety features like a process for amending the network and separate checks against invariant constraints.
- On-Ledger Decentralized Exchange: In addition to all the features that make XRP useful on its own, the XRP Ledger also has a fully-functional accounting system for tracking and trading obligations denominated in any way users want, and an exchange built into the protocol. The XRP Ledger can settle long, cross-currency payment paths and exchanges of multiple currencies in atomic transactions, bridging gaps of trust with XRP.
Source Code
Here are some good places to start learning the source code:
- Read the markdown files in the source tree:
src/xrpld/**/*.md. - Read the levelization document to get an idea of the internal dependency graph.
- In the big picture, the
mainfunction constructs anApplicationImpobject, which implements theApplicationvirtual interface. Almost every component in the application takes anApplication¶meter in its constructor, typically namedappand stored as a member variableapp_. This allows most components to depend on any other component.
Repository Contents
| Folder | Contents |
|---|---|
./bin |
Scripts and data files for XRPL developers. |
./Builds |
Platform-specific guides for building xrpld. |
./docs |
Source documentation files and doxygen config. |
./cfg |
Example configuration files. |
./src |
Source code. |
./crates |
Rust source code. |
Some of the directories under src are external repositories included using
git-subtree. See those directories' README files for more details.