mirror of
https://github.com/XRPLF/rippled.git
synced 2026-10-04 02:38:02 +00:00
5175fd134e
* XRPLF/develop: (40 commits) perf: Speed up addition time for drastically different exponents (7825) refactor: Collapse transactions.macro settings into a TxSettings struct (8001) fix: Enforce MPT balance invariants under the latest cleanup amendment (7889) fix: Prevent AMM auction slots from being acquired at zero cost when trading fee is zero (7430) docs: Fix yum installation baseurl (8066) fix: Return specific and consistent errors from vault_info (8015) ci: Save cargo cache only from develop by default (8063) fix: Check credential for LoanBrokerCoverWithdraw and VaultWithdraw (7107) build: Suppress MSVC linker warning LNK4099 (8049) chore: [DEPENDABOT] Bump cxx from 1.0.198 to 1.0.199 in /crates in the rust-dependencies group across 1 directory (8050) build: Use debian `any` distribution & signed (hosted) rpm repo (8053) ci: Do not cache cargo binaries (8062) build: Compress the RPM payload with zstd (8047) chore: Rust-C++ cmake and CI integration (7034) refactor: Extract invariant invocation into free checkInvariants runner (7404) docs: Rewrite the install guide (8048) build: Sign RPM packages (8046) fix: Exempt loan default from asset freeze (7932) fix: Reject VaultWithdraw fixed-share amounts that round to zero (7950) build: Use AlmaLinux for the RHEL packaging image (8045) ...
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 thexrpldcodebase.- 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.
- As a consequence of this,
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.