Files
rippled/include/xrpl/protocol
Ed Hennis aed8e2b166 Fill in payment computation shortages (#5941)
- Ensures a consistent fixed payment amount for the entire life of the
  loan, except the final payment, which is guaranteed to be the same or
  smaller.
- Convert some Loan structs to compute values that had need manual
  updates to stay consistent.
- Fail the transaction in `LoanPay` if it violates the Vault `assetsAvailable <=
  assetsTotal` invariant.
- Use constexpr to check that min mantissa value for Number and STAmount
  is a power of 10, and compute the max in terms of the min.
- Improve unit tests:
  - Use BrokerParameters and Loan Parameters instead of semi-global
    class values
  - In tests, check that the expected number of loan payments are made.
  - Add LoanBatch manual test to generate a set number of random loans,
    set them up, and pay them off.
  - Add LoanArbitrary manual test to run a single test with specific
    (hard-coded for now) parameters.
  - Add Number support to XRP_t.
2025-11-04 22:56:16 +00:00
..
2025-08-22 10:02:56 -04:00
2024-06-20 13:57:14 -05:00
2025-07-10 18:15:42 +00:00
2024-06-20 13:57:16 -05:00
2025-06-02 09:52:10 -04:00
2025-07-10 18:15:42 +00:00
2024-06-20 13:57:16 -05:00
2024-06-20 13:57:14 -05:00
2024-06-20 13:57:16 -05:00
2025-01-09 11:22:11 -05:00
2024-06-20 13:57:16 -05:00
2024-06-20 13:57:16 -05:00
2024-06-20 13:57:16 -05:00
2024-06-20 13:57:16 -05:00
2024-06-20 13:57:16 -05:00
2025-06-02 09:52:10 -04:00
2024-06-20 13:57:14 -05:00
2024-06-20 13:57:16 -05:00
2025-07-10 18:15:42 +00:00
2025-07-10 18:15:42 +00:00
2025-07-10 18:15:42 +00:00
2025-09-26 20:13:15 +00:00
2024-06-20 13:57:16 -05:00
2025-10-31 19:29:30 +00:00

protocol

Classes and functions for handling data and values associated with the XRP Ledger protocol.

Serialized Objects

Objects transmitted over the network must be serialized into a canonical format. The prefix "ST" refers to classes that deal with the serialized format.

The term "Tx" or "tx" is an abbreviation for "Transaction", a commonly occurring object type.

Optional Fields

Our serialized fields have some "type magic" to make optional fields easier to read:

  • The operation x[sfFoo] means "return the value of 'Foo' if it exists, or the default value if it doesn't."
  • The operation x[~sfFoo] means "return the value of 'Foo' if it exists, or nothing if it doesn't." This usage of the tilde/bitwise NOT operator is not standard outside of the rippled codebase.
    • As a consequence of this, x[~sfFoo] = y[~sfFoo] assigns the value of Foo from y to x, including omitting Foo from x if it doesn't exist in y.

Typically, for things that are guaranteed to exist, you use x[sfFoo] and avoid having to deal with a container that may or may not hold a value. For things not guaranteed to exist, you use x[~sfFoo] because you want such a container. It avoids having to look something up twice, once just to see if it exists and a second time to get/set its value. (Real example)

The source of this "type magic" is in SField.h.