XRP Ledger APIs generally use strings, rather than native JSON numbers, to represent numeric amounts of currency for both XRP and issued currencies. This protects against a loss of precision when using JSON parsers, which may automatically try to represent all JSON numbers in a floating-point format. Within the String value, the numbers are serialized in the same way as native JSON numbers:
- May contain
.as a decimal point. For example, ½ is represented as
0.5. (American style, not European)
- May contain
eto indicate being raised to a power of 10 (scientific notation). For example,
1.2E5is equivalent to 1.2×105, or
- No comma (
,) characters are used.
XRP has the same precision as a 64-bit unsigned integer where each unit is equivalent to 0.000001 XRP. Its properties are:
- Minimum value:
- Maximum value:
"100000000000000000"(1017) drops of XRP
- Precise to the nearest
"1"drop of XRP
Issued Currency Precision
Issued currencies in the XRP Ledger are represented with a custom format with the following precision:
- Minimum nonzero absolute value:
- Maximum value:
- Minimum value:
- 15 decimal digits of precision
Issued Currency Math
rippled represents numbers for issued currencies in a custom number format. This format can store a wide variety of assets, including those typically measured in very small or very large denominations. This format uses significant digits and a power-of-ten exponent in a similar way to scientific notation. The format supports positive and negative significant digits and exponents within the specified range. Unlike typical floating-point representations of non-whole numbers, this format uses integer math for all calculations, so it always maintains 15 decimal digits of precision. Multiplication and division have adjustments to compensate for over-rounding in the least significant digits.
Unlike "arbitrary precision" number formats, the custom format can be stored in a fixed size of 64 bits. When serialized this way, the format consists of a "not XRP" bit, a sign bit, significant digits, and an exponent. They are present in order:
- The first (most significant) bit for an issued currency amount is
1to indicate that it is not an XRP amount. (XRP amounts always have the most significant bit set to
0to distinguish them from this format.)
- The sign bit indicates whether the amount is positive or negative. Unlike standard two's complement integers,
1indicates positive in the XRP Ledger format, and
- The next 8 bits represent the exponent as an unsigned integer. The exponent indicates the scale (what power of 10 the significant digits should be multiplied by) in the range -96 to +80 (inclusive). However, when serializing, we add 97 to the exponent to make it possible to serialize as an unsigned integer. Thus, a serialized value of
1indicates an exponent of
-96, a serialized value of
177indicates an exponent of 80, and so on.
- The remaining 54 bits represent the significant digits as an unsigned integer. When serializing, this value is normalized to the range 1015 (
1000000000000000) to 1016-1 (
9999999999999999) inclusive, except for the special case of the value 0. There is a special case for the value 0. In this case, the sign bit, exponent, and mantissa are all zeroes, so the 64-bit value is serialized as
All non-XRP currencies in the XRP Ledger have a 160-bit currency code. The
rippled APIs map 3-character ASCII strings (case-sensitive) to 160-bit currency codes using a standard mapping. The currency code
XRP is disallowed for issued currencies. Currencies with the same code can ripple across connected trustlines. Currency codes have no other behavior built into the XRP Ledger.
Standard Currency Codes
The standard currency mapping allocates the bits as follows:
- The first 8 bits must be
- The next 88 bits are reserved, and should be all
- The next 24 bits represent 3 characters of ASCII.
Ripple recommends using ISO 4217 codes, or popular pseudo-ISO 4217 codes such as "BTC". However, any combination of the following characters is permitted: all uppercase and lowercase letters, digits, as well as the symbols
|. The currency code
XRP(all-uppercase) is reserved for XRP and cannot be used by issued currencies.
- The next 40 bits are reserved and should be all
Usually, XRP amounts are not specified with currency codes. In the rare case that a field specifies a currency code for XRP, the currency code's binary format is all zeroes.
Nonstandard Currency Codes
You can also issue currency of other types by using a 160-bit (40-character) hexadecimal string such as
015841551A748AD2C1F76FF6ECB0CCCD00000000 as the currency code. To prevent this from being treated as a different currency code type, the first 8 bits MUST NOT be
Deprecated: Some previous versions of ripple-lib supported an "interest-bearing" or "demurraging" currency code type. These currencies have the first 8 bits
0x01. Demurraging / interest-bearing currencies are no longer supported, but you may encounter them in ledger data. For more information, see Demurrage.