mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
b6ef337e45
* XRPLF/ximinez/lending-refactoring-4: fix: Modify jobs to use '>>' instead of 'tee' for GITHUB_OUTPUT (5699) refactor: Revamp CI workflows (5661) refactor: Decouple net from xrpld and move rpc-related classes to the rpc folder (5477) Set version to 2.6.0-rc2 docs: Updates list of maintainers and reviewers (5687) fix: Change log to debug level for AMM offer retrieval and IOU payment check (5686) fix: Add -Wno-deprecated-declarations for Clang only (5680) Update .git-blame-ignore-revs for 5657 (5675) Fix BUILD.md instruction (5676) Set version to 2.6.0-rc1 fix: Improve logging of the reason to refuse a peer connection (5664) fix: Make test suite names match the directory name (5597) chore: Run prettier on all files (5657) chore: Set CONAN_REMOTE_URL also for forks (5662) chore: Cleanup bin/ directory (5660) perf: Optimize hash performance by avoiding allocating hash state object (5469)
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 therippledcodebase.- 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.