mirror of
https://github.com/XRPLF/rippled.git
synced 2026-09-27 23:38:08 +00:00
3797b917ec
Removing XChainBridge changed which headers are reachable transitively, so misc-include-cleaner failed on the PR. STXChainBridge.h used to pull in STObject.h and Serializer.h, so STParsedJSON.cpp, LedgerEntry.cpp and LedgerEntry_test.cpp now include them directly. LedgerEntry_test.cpp also needs PublicKey.h. Indexes.cpp no longer uses SField.h, and the tests no longer use envconfig.h or multisign.h, so those includes are dropped. STObject.h needs the complete STAccount type for its Proxy templates, but include-cleaner does not see a direct use, so its STAccount.h include carries an IWYU keep pragma. ApplyStateTable.cpp gets the type from STObject.h and does not need its own include.
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.