mirror of
https://github.com/XRPLF/rippled.git
synced 2026-09-27 07:26:51 +00:00
a91b2f4e25
tsan.supp turned lock-order checking off wholesale: deadlock:pthread_create, deadlock:pthread_rwlock_rdlock and deadlock:boost::asio name locking primitives rather than source files, so between them they covered every std::shared_mutex read lock and any inversion reached through a strand or a thread start, and detect_deadlocks defaults to true. Seven more named source files, among them ValidatorList.cpp, ValidatorSite.cpp and Manifest.cpp. Drop all ten, because the job cannot fail a build, so a suppression here costs a finding and buys nothing. The Manifest.cpp line alone was hiding a two-thread deadlock between ManifestCache::save() and the validator list, which a run without it reported 52 times on the shutdown path. Also repoint eight patterns at files that moved into libxrpl and the gtest tree, and empty sanitizer-ignorelist.txt of 24 entries that never matched anything, either through suppression syntax a clang ignorelist never consults or through a glob with no leading star. Both rules are now written down in docs/build/sanitizers.md. Add ubuntu-clang-debug-amd64-tsan to the Linux matrix, in a config of its own so TSan stays on clang and Debug, and give the matrix a third tier so it runs at night rather than on every labelled pull request. A Linux config may now declare "extended", which holds it out of both the minimal and the full matrix; generate.py emits those configs only for --extended, which the workflow passes on a schedule or a manual run. The name says which matrix a config belongs to, like "minimal", rather than naming a trigger, because the trigger set already grew from the schedule to manual runs and a config property outlives that. It avoids "maximal", which reads as a synonym for the full matrix it is meant to be larger than. It is a whole hour of runner time, which is too much to spend per pull request, and it reports nothing back anyway, because the workflow appends exitcode=0 to TSAN_OPTIONS. That belongs in the workflow rather than in runtime-tsan-options.txt, which the documented local command also reads and which must keep failing on a finding. Cap the test jobs at 4 under TSan, which is measured rather than chosen. One per core is 30 on the current runner and twice starved it until it lost contact with the server; 12 was killed by the OOM killer with code 137 before a single suite finished; 4 completes the suite. The machine has 32 cores and no swap, so nothing absorbs the peak, and the runner is one pod among several on a node, so the ceiling is not ours alone. Check that a build carries the instrumentation it asked for, by the __asan, __tsan and __ubsan symbols in the binary, since instrumented code references its runtime however that runtime is linked. The version string is checked too, but cannot stand alone, because cmake sets the SANITIZERS macro separately from the flags. Widen the voidstar step for this rather than add a second one, and add ASAN_ENABLED, TSAN_ENABLED and UBSAN_ENABLED so a step needing one sanitizer does not parse the list. Define XRPL_ASAN, XRPL_TSAN and XRPL_UBSAN so a test can skip when its sanitizer is inactive, and drop the -Dcoverage_test_parallelism example from BUILD.md, which neither cmake nor conanfile.py defines.
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.