ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-04-29 15:37:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
62d0b07ee8cd1b65b79490940dd7bf2849ae8bb6
rippled/include/xrpl/protocol
History
Ed Hennis 62d0b07ee8 Merge remote-tracking branch 'XRPLF/develop' into ximinez/number-maxint-range 
* XRPLF/develop: (81 commits)
  ci: Only publish docs in public repos (6687)
  chore: Enable remaining clang-tidy `performance` checks (6648)
  refactor: Address PR comments after the modularisation PRs (6389)
  chore: Fix clang-tidy header filter (6686)
  ci: [DEPENDABOT] bump actions/deploy-pages from 4.0.5 to 5.0.0 (6684)
  ci: [DEPENDABOT] bump codecov/codecov-action from 5.5.3 to 6.0.0 (6685)
  fix: Guard Coro::resume() against completed coroutines (6608)
  refactor: Split LoanInvariant into LoanBrokerInvariant and LoanInvariant (6674)
  ci: Don't publish docs on release branches (6673)
  refactor: Make function naming in ServiceRegistry consistent (6390)
  chore: Shorten job names to stay within Linux 15-char thread limit (6669)
  fix: Improve loan invariant message (6668)
  ci: Upload artifacts only in public repositories (6670)
  ci: Add conflicting-pr workflow (6656)
  chore: Add more AI tools to .gitignore (6658)
  chore: Show warning message if user may need to connect to VPN (6619)
  feat: Add placeholder amendment for assorted bug fixes (6652)
  chore: Update sqlite3->3.51.0, protobuf->6.33.5, openssl->3.6.1, grpc->1.78.1 (6653)
  refactor: Modularise ledger (6536)
  chore: Use unpatched version of soci (6649)
  ...
2026-03-30 22:01:54 -04:00
..
detail
feat: Add placeholder amendment for assorted bug fixes (#6652)
2026-03-25 23:54:33 +00:00
AccountID.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
AMMCore.h
Update formatting
2026-02-20 13:29:51 -05:00
AmountConversions.h
Update formatting
2026-02-20 13:29:51 -05:00
ApiVersion.h
Update formatting
2026-02-20 13:29:51 -05:00
Asset.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Batch.h
chore: Set ColumnLimit to 120 in clang-format (#6288)
2026-01-28 18:09:50 +00:00
Book.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
BuildInfo.h
chore: Add Git information compile-time info to only one file (#6464)
2026-03-04 19:45:28 +00:00
digest.h
refactor: Enable remaining clang-tidy cppcoreguidelines checks (#6538)
2026-03-17 19:09:05 +00:00
ErrorCodes.h
Update formatting
2026-02-20 13:29:51 -05:00
Feature.h
feat: Enforce feature name lengths and character set (#5555)
2026-03-13 13:41:50 -04:00
Fees.h
refactor: Modularise ledger (#6536)
2026-03-25 16:32:45 +00:00
HashPrefix.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Indexes.h
Update formatting
2026-02-20 13:29:51 -05:00
InnerObjectFormats.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
IOUAmount.h
Update formatting
2026-02-20 13:29:51 -05:00
Issue.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
json_get_or_throw.h
Update formatting
2026-02-20 13:29:51 -05:00
jss.h
fix: Peer crawler port field type inconsistency (#6318)
2026-03-17 22:03:56 +00:00
Keylet.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
KeyType.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
KnownFormats.h
Add Formats and Flags to server_definitions (#6321)
2026-03-05 16:11:27 +00:00
LedgerFormats.h
Add Formats and Flags to server_definitions (#6321)
2026-03-05 16:11:27 +00:00
LedgerHeader.h
refactor: Modularise ledger (#6536)
2026-03-25 16:32:45 +00:00
LedgerShortcut.h
refactor: Modularize RelationalDB (#6224)
2026-02-11 16:22:01 +00:00
messages.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
MPTAmount.h
chore: Update clang-format to 21.1.8 (#6352)
2026-02-16 14:31:18 -05:00
MPTIssue.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
MultiApiJson.h
Update formatting
2026-02-20 13:29:51 -05:00
nft.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
NFTokenID.h
Update formatting
2026-02-20 13:29:51 -05:00
NFTokenOfferID.h
Update formatting
2026-02-20 13:29:51 -05:00
nftPageMask.h
Update formatting
2026-02-20 13:29:51 -05:00
NFTSyntheticSerializer.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
PayChan.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Permissions.h
refactor: Enable more clang-tidy readability checks (#6595)
2026-03-24 15:42:12 +00:00
Protocol.h
Merge remote-tracking branch 'XRPLF/develop' into ximinez/number-maxint-range
2026-03-30 22:01:54 -04:00
PublicKey.h
refactor: Enable remaining clang-tidy cppcoreguidelines checks (#6538)
2026-03-17 19:09:05 +00:00
Quality.h
Update formatting
2026-02-20 13:29:51 -05:00
QualityFunction.h
Update formatting
2026-02-20 13:29:51 -05:00
Rate.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
README.md
chore: Run prettier on all files (#5657)
2025-08-11 16:15:42 +00:00
RippleLedgerHash.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
RPCErr.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Rules.h
Update formatting
2026-02-20 13:29:51 -05:00
SecretKey.h
refactor: Enable remaining clang-tidy cppcoreguidelines checks (#6538)
2026-03-17 19:09:05 +00:00
Seed.h
refactor: Enable remaining clang-tidy cppcoreguidelines checks (#6538)
2026-03-17 19:09:05 +00:00
SeqProxy.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
serialize.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Serializer.h
refactor: Enable more clang-tidy readability checks (#6595)
2026-03-24 15:42:12 +00:00
SField.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Sign.h
Update formatting
2026-02-20 13:29:51 -05:00
SOTemplate.h
Add Formats and Flags to server_definitions (#6321)
2026-03-05 16:11:27 +00:00
st.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STAccount.h
refactor: Enable remaining clang-tidy cppcoreguidelines checks (#6538)
2026-03-17 19:09:05 +00:00
STAmount.h
Update formatting
2026-02-20 13:29:51 -05:00
STArray.h
Update formatting
2026-02-20 13:29:51 -05:00
STBase.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STBitString.h
Update formatting
2026-02-20 13:29:51 -05:00
STBlob.h
Update formatting
2026-02-20 13:29:51 -05:00
STCurrency.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STExchange.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STInteger.h
chore: Update clang-format to 21.1.8 (#6352)
2026-02-16 14:31:18 -05:00
STIssue.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STLedgerEntry.h
Update formatting
2026-02-20 13:29:51 -05:00
STNumber.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STObject.h
refactor: Add simple clang-tidy readability checks (#6556)
2026-03-18 16:41:49 +00:00
STParsedJSON.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STPathSet.h
Update formatting
2026-02-20 13:29:51 -05:00
STTakesAsset.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
STTx.h
refactor: Clean up getFeePayer, mSourceBalance, and mPriorBalance (#6478)
2026-03-17 14:12:16 +00:00
STValidation.h
Update formatting
2026-02-20 13:29:51 -05:00
STVector256.h
chore: Enable remaining clang-tidy performance checks (#6648)
2026-03-30 17:08:47 +00:00
STXChainBridge.h
Update formatting
2026-02-20 13:29:51 -05:00
SystemParameters.h
Merge remote-tracking branch 'XRPLF/develop' into ximinez/number-maxint-range
2026-03-30 22:01:54 -04:00
TER.h
Update formatting
2026-02-20 13:29:51 -05:00
tokens.h
Update formatting
2026-02-20 13:29:51 -05:00
TxFlags.h
Add Formats and Flags to server_definitions (#6321)
2026-03-05 16:11:27 +00:00
TxFormats.h
Add Formats and Flags to server_definitions (#6321)
2026-03-05 16:11:27 +00:00
TxMeta.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
TxSearched.h
refactor: Address PR comments after the modularisation PRs (#6389)
2026-03-30 15:22:38 +00:00
UintTypes.h
refactor: Replace include guards by '#pragma once' (#6322)
2026-02-04 09:50:21 -05:00
Units.h
Update formatting
2026-02-20 13:29:51 -05:00
XChainAttestations.h
Update formatting
2026-02-20 13:29:51 -05:00
XRPAmount.h
Update formatting
2026-02-20 13:29:51 -05:00

README.md

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.

Related Resources