mirror of
https://github.com/XRPLF/rippled.git
synced 2026-10-14 15:48:54 +00:00
989d33fe6a
A top-level JSON array is the batch form the specification defines, accepted from API version 3. Each entry is a request in its own right, nesting its parameters as a lone request does and correlating by its own `id`. The answer is an array of one reply per entry at HTTP 200, as the `method: "batch"` form answers. All entries of one body must name the same `api_version`, or name none and inherit the body's, and a body whose entries disagree is refused whole. For a top-level array the first entry to name a served version of 3 or above decides, and for a `method: "batch"` body the first entry to name a version the server serves does, wherever that entry sits, so the order of the entries does not matter; a `method: "batch"` body naming a version the server cannot serve at its own top level is refused rather than served at version 1. One body then has one version, which is what makes a 100-entry cap answerable: a cap that read a version off one entry could be side-stepped by reordering the entries, or by naming the version where the cap did not look, so the cap reads the body's one version, found wherever dispatch would find it. Refusing a mixed body is a break a version 1 or 2 client can see, recorded as such in `API-CHANGELOG.md`. A `method: "batch"` body whose entries name different versions is served today, each entry at its own version, and is refused from now on; one whose entries agree keeps working, and below version 3 that form stays uncapped. Five conditions reject a whole array: empty, over the cap, holding nothing that could be a request, naming no served version of 3 or above, and naming two different served versions across its entries. Four answer one specification error object with a null `id`, an array naming none; an array holding nothing that could be a request answers one such object per entry, as the specification shows. Each reaches every API version, since no earlier version accepts an array.
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.