mirror of
https://github.com/XRPLF/rippled.git
synced 2026-06-03 00:36:48 +00:00
391a1e442c
* XRPLF/develop: (41 commits) release: Bump version to 3.2.0-rc2 (7348) refactor: Enable support for `fixCleanup3_2_0` amendment (7347) release: Bump version to 3.2.0-rc1 (7335) fix: Fix a rounding error at the `Number::maxRep` cusp (7051) ci: Only push docker images in XRPLF/rippled (7330) ci: [DEPENDABOT] bump docker/setup-buildx-action from 4.0.0 to 4.1.0 (7322) ci: [DEPENDABOT] bump codecov/codecov-action from 6.0.0 to 6.0.1 (7321) ci: [DEPENDABOT] bump docker/build-push-action from 7.1.0 to 7.2.0 (7320) ci: [DEPENDABOT] bump docker/metadata-action from 6.0.0 to 6.1.0 (7319) ci: [DEPENDABOT] bump docker/login-action from 4.1.0 to 4.2.0 (7318) fix: Update `clang-tidy` to include `src/tests` directory header check (7307) chore: Pin Python packages for codegen using uv (7329) style: Use shfmt instead of bashate (7326) fix: Fix edge-case where vault-depositor may get stuck (7139) fix: Fix `VaultInvariant` and `VaultDeposit` precision bugs at IOU scale boundaries (7272) ci: Add clang to nix images (7308) fix: Include management-fee delta in doOverpayment assertion (7039) fix: Fix clang-tidy pre-commit hook to locate compile_commands.json from repo root (7325) fix: Use consistent scale for `debtTotal` (7093) fix: Skip deleted book directories and non-root modifications in `ValidBookDirectory` invariant (7312) ...
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.