rippled
SField.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2012, 2013 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/protocol/SField.h>
21 #include <cassert>
22 #include <string>
23 #include <string_view>
24 #include <utility>
25 
26 namespace ripple {
27 
28 // Storage for static const members.
29 SField::IsSigning const SField::notSigning;
30 int SField::num = 0;
31 std::map<int, SField const*> SField::knownCodeToField;
32 
33 // Give only this translation unit permission to construct SFields
34 struct SField::private_access_tag_t
35 {
36  explicit private_access_tag_t() = default;
37 };
38 
39 static SField::private_access_tag_t access;
40 
41 // Construct all compile-time SFields, and register them in the knownCodeToField
42 // database:
43 
44 // Use macros for most SField construction to enforce naming conventions.
45 #pragma push_macro("CONSTRUCT_UNTYPED_SFIELD")
46 #undef CONSTRUCT_UNTYPED_SFIELD
47 
48 // It would be possible to design the macros so that sfName and txtName would
49 // be constructed from a single macro parameter. We chose not to take that
50 // path because then you cannot grep for the exact SField name and find
51 // where it is constructed. These macros allow that grep to succeed.
52 #define CONSTRUCT_UNTYPED_SFIELD(sfName, txtName, stiSuffix, fieldValue, ...) \
53  SField const sfName( \
54  access, STI_##stiSuffix, fieldValue, txtName, ##__VA_ARGS__); \
55  static_assert( \
56  std::string_view(#sfName) == "sf" txtName, \
57  "Declaration of SField does not match its text name")
58 
59 #pragma push_macro("CONSTRUCT_TYPED_SFIELD")
60 #undef CONSTRUCT_TYPED_SFIELD
61 
62 #define CONSTRUCT_TYPED_SFIELD(sfName, txtName, stiSuffix, fieldValue, ...) \
63  SF_##stiSuffix const sfName( \
64  access, STI_##stiSuffix, fieldValue, txtName, ##__VA_ARGS__); \
65  static_assert( \
66  std::string_view(#sfName) == "sf" txtName, \
67  "Declaration of SField does not match its text name")
68 
69 // clang-format off
70 
71 // SFields which, for historical reasons, do not follow naming conventions.
72 SField const sfInvalid(access, -1);
73 SField const sfGeneric(access, 0);
74 SField const sfHash(access, STI_UINT256, 257, "hash");
75 SField const sfIndex(access, STI_UINT256, 258, "index");
76 
77 // Untyped SFields
78 CONSTRUCT_UNTYPED_SFIELD(sfLedgerEntry, "LedgerEntry", LEDGERENTRY, 257);
79 CONSTRUCT_UNTYPED_SFIELD(sfTransaction, "Transaction", TRANSACTION, 257);
80 CONSTRUCT_UNTYPED_SFIELD(sfValidation, "Validation", VALIDATION, 257);
81 CONSTRUCT_UNTYPED_SFIELD(sfMetadata, "Metadata", METADATA, 257);
82 
83 // 8-bit integers
84 CONSTRUCT_TYPED_SFIELD(sfCloseResolution, "CloseResolution", UINT8, 1);
85 CONSTRUCT_TYPED_SFIELD(sfMethod, "Method", UINT8, 2);
86 CONSTRUCT_TYPED_SFIELD(sfTransactionResult, "TransactionResult", UINT8, 3);
87 
88 // 8-bit integers (uncommon)
89 CONSTRUCT_TYPED_SFIELD(sfTickSize, "TickSize", UINT8, 16);
90 CONSTRUCT_TYPED_SFIELD(sfUNLModifyDisabling, "UNLModifyDisabling", UINT8, 17);
91 CONSTRUCT_TYPED_SFIELD(sfHookResult, "HookResult", UINT8, 18);
92 
93 // 16-bit integers
94 CONSTRUCT_TYPED_SFIELD(sfLedgerEntryType, "LedgerEntryType", UINT16, 1, SField::sMD_Never);
95 CONSTRUCT_TYPED_SFIELD(sfTransactionType, "TransactionType", UINT16, 2);
96 CONSTRUCT_TYPED_SFIELD(sfSignerWeight, "SignerWeight", UINT16, 3);
97 CONSTRUCT_TYPED_SFIELD(sfTransferFee, "TransferFee", UINT16, 4);
98 
99 // 16-bit integers (uncommon)
100 CONSTRUCT_TYPED_SFIELD(sfVersion, "Version", UINT16, 16);
101 CONSTRUCT_TYPED_SFIELD(sfHookStateChangeCount, "HookStateChangeCount", UINT16, 17);
102 CONSTRUCT_TYPED_SFIELD(sfHookEmitCount, "HookEmitCount", UINT16, 18);
103 CONSTRUCT_TYPED_SFIELD(sfHookExecutionIndex, "HookExecutionIndex", UINT16, 19);
104 CONSTRUCT_TYPED_SFIELD(sfHookApiVersion, "HookApiVersion", UINT16, 20);
105 
106 // 32-bit integers (common)
107 CONSTRUCT_TYPED_SFIELD(sfNetworkID, "NetworkID", UINT32, 1);
108 CONSTRUCT_TYPED_SFIELD(sfFlags, "Flags", UINT32, 2);
109 CONSTRUCT_TYPED_SFIELD(sfSourceTag, "SourceTag", UINT32, 3);
110 CONSTRUCT_TYPED_SFIELD(sfSequence, "Sequence", UINT32, 4);
111 CONSTRUCT_TYPED_SFIELD(sfPreviousTxnLgrSeq, "PreviousTxnLgrSeq", UINT32, 5, SField::sMD_DeleteFinal);
112 CONSTRUCT_TYPED_SFIELD(sfLedgerSequence, "LedgerSequence", UINT32, 6);
113 CONSTRUCT_TYPED_SFIELD(sfCloseTime, "CloseTime", UINT32, 7);
114 CONSTRUCT_TYPED_SFIELD(sfParentCloseTime, "ParentCloseTime", UINT32, 8);
115 CONSTRUCT_TYPED_SFIELD(sfSigningTime, "SigningTime", UINT32, 9);
116 CONSTRUCT_TYPED_SFIELD(sfExpiration, "Expiration", UINT32, 10);
117 CONSTRUCT_TYPED_SFIELD(sfTransferRate, "TransferRate", UINT32, 11);
118 CONSTRUCT_TYPED_SFIELD(sfWalletSize, "WalletSize", UINT32, 12);
119 CONSTRUCT_TYPED_SFIELD(sfOwnerCount, "OwnerCount", UINT32, 13);
120 CONSTRUCT_TYPED_SFIELD(sfDestinationTag, "DestinationTag", UINT32, 14);
121 
122 // 32-bit integers (uncommon)
123 CONSTRUCT_TYPED_SFIELD(sfHighQualityIn, "HighQualityIn", UINT32, 16);
124 CONSTRUCT_TYPED_SFIELD(sfHighQualityOut, "HighQualityOut", UINT32, 17);
125 CONSTRUCT_TYPED_SFIELD(sfLowQualityIn, "LowQualityIn", UINT32, 18);
126 CONSTRUCT_TYPED_SFIELD(sfLowQualityOut, "LowQualityOut", UINT32, 19);
127 CONSTRUCT_TYPED_SFIELD(sfQualityIn, "QualityIn", UINT32, 20);
128 CONSTRUCT_TYPED_SFIELD(sfQualityOut, "QualityOut", UINT32, 21);
129 CONSTRUCT_TYPED_SFIELD(sfStampEscrow, "StampEscrow", UINT32, 22);
130 CONSTRUCT_TYPED_SFIELD(sfBondAmount, "BondAmount", UINT32, 23);
131 CONSTRUCT_TYPED_SFIELD(sfLoadFee, "LoadFee", UINT32, 24);
132 CONSTRUCT_TYPED_SFIELD(sfOfferSequence, "OfferSequence", UINT32, 25);
133 CONSTRUCT_TYPED_SFIELD(sfFirstLedgerSequence, "FirstLedgerSequence", UINT32, 26);
134 CONSTRUCT_TYPED_SFIELD(sfLastLedgerSequence, "LastLedgerSequence", UINT32, 27);
135 CONSTRUCT_TYPED_SFIELD(sfTransactionIndex, "TransactionIndex", UINT32, 28);
136 CONSTRUCT_TYPED_SFIELD(sfOperationLimit, "OperationLimit", UINT32, 29);
137 CONSTRUCT_TYPED_SFIELD(sfReferenceFeeUnits, "ReferenceFeeUnits", UINT32, 30);
138 CONSTRUCT_TYPED_SFIELD(sfReserveBase, "ReserveBase", UINT32, 31);
139 CONSTRUCT_TYPED_SFIELD(sfReserveIncrement, "ReserveIncrement", UINT32, 32);
140 CONSTRUCT_TYPED_SFIELD(sfSetFlag, "SetFlag", UINT32, 33);
141 CONSTRUCT_TYPED_SFIELD(sfClearFlag, "ClearFlag", UINT32, 34);
142 CONSTRUCT_TYPED_SFIELD(sfSignerQuorum, "SignerQuorum", UINT32, 35);
143 CONSTRUCT_TYPED_SFIELD(sfCancelAfter, "CancelAfter", UINT32, 36);
144 CONSTRUCT_TYPED_SFIELD(sfFinishAfter, "FinishAfter", UINT32, 37);
145 CONSTRUCT_TYPED_SFIELD(sfSignerListID, "SignerListID", UINT32, 38);
146 CONSTRUCT_TYPED_SFIELD(sfSettleDelay, "SettleDelay", UINT32, 39);
147 CONSTRUCT_TYPED_SFIELD(sfTicketCount, "TicketCount", UINT32, 40);
148 CONSTRUCT_TYPED_SFIELD(sfTicketSequence, "TicketSequence", UINT32, 41);
149 CONSTRUCT_TYPED_SFIELD(sfNFTokenTaxon, "NFTokenTaxon", UINT32, 42);
150 CONSTRUCT_TYPED_SFIELD(sfMintedNFTokens, "MintedNFTokens", UINT32, 43);
151 CONSTRUCT_TYPED_SFIELD(sfBurnedNFTokens, "BurnedNFTokens", UINT32, 44);
152 CONSTRUCT_TYPED_SFIELD(sfHookStateCount, "HookStateCount", UINT32, 45);
153 CONSTRUCT_TYPED_SFIELD(sfEmitGeneration, "EmitGeneration", UINT32, 46);
154 // Three field values of 47, 48 and 49 are reserved for
155 // LockCount(Hooks), VoteWeight(AMM), DiscountedFee(AMM)
156 CONSTRUCT_TYPED_SFIELD(sfFirstNFTokenSequence, "FirstNFTokenSequence", UINT32, 50);
157 
158 // 64-bit integers (common)
159 CONSTRUCT_TYPED_SFIELD(sfIndexNext, "IndexNext", UINT64, 1);
160 CONSTRUCT_TYPED_SFIELD(sfIndexPrevious, "IndexPrevious", UINT64, 2);
161 CONSTRUCT_TYPED_SFIELD(sfBookNode, "BookNode", UINT64, 3);
162 CONSTRUCT_TYPED_SFIELD(sfOwnerNode, "OwnerNode", UINT64, 4);
163 CONSTRUCT_TYPED_SFIELD(sfBaseFee, "BaseFee", UINT64, 5);
164 CONSTRUCT_TYPED_SFIELD(sfExchangeRate, "ExchangeRate", UINT64, 6);
165 CONSTRUCT_TYPED_SFIELD(sfLowNode, "LowNode", UINT64, 7);
166 CONSTRUCT_TYPED_SFIELD(sfHighNode, "HighNode", UINT64, 8);
167 CONSTRUCT_TYPED_SFIELD(sfDestinationNode, "DestinationNode", UINT64, 9);
168 CONSTRUCT_TYPED_SFIELD(sfCookie, "Cookie", UINT64, 10);
169 CONSTRUCT_TYPED_SFIELD(sfServerVersion, "ServerVersion", UINT64, 11);
170 CONSTRUCT_TYPED_SFIELD(sfNFTokenOfferNode, "NFTokenOfferNode", UINT64, 12);
171 CONSTRUCT_TYPED_SFIELD(sfEmitBurden, "EmitBurden", UINT64, 13);
172 
173 // 64-bit integers (uncommon)
174 CONSTRUCT_TYPED_SFIELD(sfHookOn, "HookOn", UINT64, 16);
175 CONSTRUCT_TYPED_SFIELD(sfHookInstructionCount, "HookInstructionCount", UINT64, 17);
176 CONSTRUCT_TYPED_SFIELD(sfHookReturnCode, "HookReturnCode", UINT64, 18);
177 CONSTRUCT_TYPED_SFIELD(sfReferenceCount, "ReferenceCount", UINT64, 19);
178 
179 // 128-bit
180 CONSTRUCT_TYPED_SFIELD(sfEmailHash, "EmailHash", UINT128, 1);
181 
182 // 160-bit (common)
183 CONSTRUCT_TYPED_SFIELD(sfTakerPaysCurrency, "TakerPaysCurrency", UINT160, 1);
184 CONSTRUCT_TYPED_SFIELD(sfTakerPaysIssuer, "TakerPaysIssuer", UINT160, 2);
185 CONSTRUCT_TYPED_SFIELD(sfTakerGetsCurrency, "TakerGetsCurrency", UINT160, 3);
186 CONSTRUCT_TYPED_SFIELD(sfTakerGetsIssuer, "TakerGetsIssuer", UINT160, 4);
187 
188 // 256-bit (common)
189 CONSTRUCT_TYPED_SFIELD(sfLedgerHash, "LedgerHash", UINT256, 1);
190 CONSTRUCT_TYPED_SFIELD(sfParentHash, "ParentHash", UINT256, 2);
191 CONSTRUCT_TYPED_SFIELD(sfTransactionHash, "TransactionHash", UINT256, 3);
192 CONSTRUCT_TYPED_SFIELD(sfAccountHash, "AccountHash", UINT256, 4);
193 CONSTRUCT_TYPED_SFIELD(sfPreviousTxnID, "PreviousTxnID", UINT256, 5, SField::sMD_DeleteFinal);
194 CONSTRUCT_TYPED_SFIELD(sfLedgerIndex, "LedgerIndex", UINT256, 6);
195 CONSTRUCT_TYPED_SFIELD(sfWalletLocator, "WalletLocator", UINT256, 7);
196 CONSTRUCT_TYPED_SFIELD(sfRootIndex, "RootIndex", UINT256, 8, SField::sMD_Always);
197 CONSTRUCT_TYPED_SFIELD(sfAccountTxnID, "AccountTxnID", UINT256, 9);
198 CONSTRUCT_TYPED_SFIELD(sfNFTokenID, "NFTokenID", UINT256, 10);
199 CONSTRUCT_TYPED_SFIELD(sfEmitParentTxnID, "EmitParentTxnID", UINT256, 11);
200 CONSTRUCT_TYPED_SFIELD(sfEmitNonce, "EmitNonce", UINT256, 12);
201 CONSTRUCT_TYPED_SFIELD(sfEmitHookHash, "EmitHookHash", UINT256, 13);
202 
203 // 256-bit (uncommon)
204 CONSTRUCT_TYPED_SFIELD(sfBookDirectory, "BookDirectory", UINT256, 16);
205 CONSTRUCT_TYPED_SFIELD(sfInvoiceID, "InvoiceID", UINT256, 17);
206 CONSTRUCT_TYPED_SFIELD(sfNickname, "Nickname", UINT256, 18);
207 CONSTRUCT_TYPED_SFIELD(sfAmendment, "Amendment", UINT256, 19);
208 // 20 is currently unused
209 CONSTRUCT_TYPED_SFIELD(sfDigest, "Digest", UINT256, 21);
210 CONSTRUCT_TYPED_SFIELD(sfChannel, "Channel", UINT256, 22);
211 CONSTRUCT_TYPED_SFIELD(sfConsensusHash, "ConsensusHash", UINT256, 23);
212 CONSTRUCT_TYPED_SFIELD(sfCheckID, "CheckID", UINT256, 24);
213 CONSTRUCT_TYPED_SFIELD(sfValidatedHash, "ValidatedHash", UINT256, 25);
214 CONSTRUCT_TYPED_SFIELD(sfPreviousPageMin, "PreviousPageMin", UINT256, 26);
215 CONSTRUCT_TYPED_SFIELD(sfNextPageMin, "NextPageMin", UINT256, 27);
216 CONSTRUCT_TYPED_SFIELD(sfNFTokenBuyOffer, "NFTokenBuyOffer", UINT256, 28);
217 CONSTRUCT_TYPED_SFIELD(sfNFTokenSellOffer, "NFTokenSellOffer", UINT256, 29);
218 CONSTRUCT_TYPED_SFIELD(sfHookStateKey, "HookStateKey", UINT256, 30);
219 CONSTRUCT_TYPED_SFIELD(sfHookHash, "HookHash", UINT256, 31);
220 CONSTRUCT_TYPED_SFIELD(sfHookNamespace, "HookNamespace", UINT256, 32);
221 CONSTRUCT_TYPED_SFIELD(sfHookSetTxnID, "HookSetTxnID", UINT256, 33);
222 
223 // currency amount (common)
224 CONSTRUCT_TYPED_SFIELD(sfAmount, "Amount", AMOUNT, 1);
225 CONSTRUCT_TYPED_SFIELD(sfBalance, "Balance", AMOUNT, 2);
226 CONSTRUCT_TYPED_SFIELD(sfLimitAmount, "LimitAmount", AMOUNT, 3);
227 CONSTRUCT_TYPED_SFIELD(sfTakerPays, "TakerPays", AMOUNT, 4);
228 CONSTRUCT_TYPED_SFIELD(sfTakerGets, "TakerGets", AMOUNT, 5);
229 CONSTRUCT_TYPED_SFIELD(sfLowLimit, "LowLimit", AMOUNT, 6);
230 CONSTRUCT_TYPED_SFIELD(sfHighLimit, "HighLimit", AMOUNT, 7);
231 CONSTRUCT_TYPED_SFIELD(sfFee, "Fee", AMOUNT, 8);
232 CONSTRUCT_TYPED_SFIELD(sfSendMax, "SendMax", AMOUNT, 9);
233 CONSTRUCT_TYPED_SFIELD(sfDeliverMin, "DeliverMin", AMOUNT, 10);
234 
235 // currency amount (uncommon)
236 CONSTRUCT_TYPED_SFIELD(sfMinimumOffer, "MinimumOffer", AMOUNT, 16);
237 CONSTRUCT_TYPED_SFIELD(sfRippleEscrow, "RippleEscrow", AMOUNT, 17);
238 CONSTRUCT_TYPED_SFIELD(sfDeliveredAmount, "DeliveredAmount", AMOUNT, 18);
239 CONSTRUCT_TYPED_SFIELD(sfNFTokenBrokerFee, "NFTokenBrokerFee", AMOUNT, 19);
240 
241 // Reserve 20 & 21 for Hooks
242 
243 // currency amount (fees)
244 CONSTRUCT_TYPED_SFIELD(sfBaseFeeDrops, "BaseFeeDrops", AMOUNT, 22);
245 CONSTRUCT_TYPED_SFIELD(sfReserveBaseDrops, "ReserveBaseDrops", AMOUNT, 23);
246 CONSTRUCT_TYPED_SFIELD(sfReserveIncrementDrops, "ReserveIncrementDrops", AMOUNT, 24);
247 
248 // variable length (common)
249 CONSTRUCT_TYPED_SFIELD(sfPublicKey, "PublicKey", VL, 1);
250 CONSTRUCT_TYPED_SFIELD(sfMessageKey, "MessageKey", VL, 2);
251 CONSTRUCT_TYPED_SFIELD(sfSigningPubKey, "SigningPubKey", VL, 3);
252 CONSTRUCT_TYPED_SFIELD(sfTxnSignature, "TxnSignature", VL, 4, SField::sMD_Default, SField::notSigning);
253 CONSTRUCT_TYPED_SFIELD(sfURI, "URI", VL, 5);
254 CONSTRUCT_TYPED_SFIELD(sfSignature, "Signature", VL, 6, SField::sMD_Default, SField::notSigning);
255 CONSTRUCT_TYPED_SFIELD(sfDomain, "Domain", VL, 7);
256 CONSTRUCT_TYPED_SFIELD(sfFundCode, "FundCode", VL, 8);
257 CONSTRUCT_TYPED_SFIELD(sfRemoveCode, "RemoveCode", VL, 9);
258 CONSTRUCT_TYPED_SFIELD(sfExpireCode, "ExpireCode", VL, 10);
259 CONSTRUCT_TYPED_SFIELD(sfCreateCode, "CreateCode", VL, 11);
260 CONSTRUCT_TYPED_SFIELD(sfMemoType, "MemoType", VL, 12);
261 CONSTRUCT_TYPED_SFIELD(sfMemoData, "MemoData", VL, 13);
262 CONSTRUCT_TYPED_SFIELD(sfMemoFormat, "MemoFormat", VL, 14);
263 
264 // variable length (uncommon)
265 CONSTRUCT_TYPED_SFIELD(sfFulfillment, "Fulfillment", VL, 16);
266 CONSTRUCT_TYPED_SFIELD(sfCondition, "Condition", VL, 17);
267 CONSTRUCT_TYPED_SFIELD(sfMasterSignature, "MasterSignature", VL, 18, SField::sMD_Default, SField::notSigning);
268 CONSTRUCT_TYPED_SFIELD(sfUNLModifyValidator, "UNLModifyValidator", VL, 19);
269 CONSTRUCT_TYPED_SFIELD(sfValidatorToDisable, "ValidatorToDisable", VL, 20);
270 CONSTRUCT_TYPED_SFIELD(sfValidatorToReEnable, "ValidatorToReEnable", VL, 21);
271 CONSTRUCT_TYPED_SFIELD(sfHookStateData, "HookStateData", VL, 22);
272 CONSTRUCT_TYPED_SFIELD(sfHookReturnString, "HookReturnString", VL, 23);
273 CONSTRUCT_TYPED_SFIELD(sfHookParameterName, "HookParameterName", VL, 24);
274 CONSTRUCT_TYPED_SFIELD(sfHookParameterValue, "HookParameterValue", VL, 25);
275 
276 // account
277 CONSTRUCT_TYPED_SFIELD(sfAccount, "Account", ACCOUNT, 1);
278 CONSTRUCT_TYPED_SFIELD(sfOwner, "Owner", ACCOUNT, 2);
279 CONSTRUCT_TYPED_SFIELD(sfDestination, "Destination", ACCOUNT, 3);
280 CONSTRUCT_TYPED_SFIELD(sfIssuer, "Issuer", ACCOUNT, 4);
281 CONSTRUCT_TYPED_SFIELD(sfAuthorize, "Authorize", ACCOUNT, 5);
282 CONSTRUCT_TYPED_SFIELD(sfUnauthorize, "Unauthorize", ACCOUNT, 6);
283 // 7 is currently unused
284 CONSTRUCT_TYPED_SFIELD(sfRegularKey, "RegularKey", ACCOUNT, 8);
285 CONSTRUCT_TYPED_SFIELD(sfNFTokenMinter, "NFTokenMinter", ACCOUNT, 9);
286 CONSTRUCT_TYPED_SFIELD(sfEmitCallback, "EmitCallback", ACCOUNT, 10);
287 
288 // account (uncommon)
289 CONSTRUCT_TYPED_SFIELD(sfHookAccount, "HookAccount", ACCOUNT, 16);
290 
291 // vector of 256-bit
292 CONSTRUCT_TYPED_SFIELD(sfIndexes, "Indexes", VECTOR256, 1, SField::sMD_Never);
293 CONSTRUCT_TYPED_SFIELD(sfHashes, "Hashes", VECTOR256, 2);
294 CONSTRUCT_TYPED_SFIELD(sfAmendments, "Amendments", VECTOR256, 3);
295 CONSTRUCT_TYPED_SFIELD(sfNFTokenOffers, "NFTokenOffers", VECTOR256, 4);
296 
297 // path set
298 CONSTRUCT_UNTYPED_SFIELD(sfPaths, "Paths", PATHSET, 1);
299 
300 // inner object
301 // OBJECT/1 is reserved for end of object
302 CONSTRUCT_UNTYPED_SFIELD(sfTransactionMetaData, "TransactionMetaData", OBJECT, 2);
303 CONSTRUCT_UNTYPED_SFIELD(sfCreatedNode, "CreatedNode", OBJECT, 3);
304 CONSTRUCT_UNTYPED_SFIELD(sfDeletedNode, "DeletedNode", OBJECT, 4);
305 CONSTRUCT_UNTYPED_SFIELD(sfModifiedNode, "ModifiedNode", OBJECT, 5);
306 CONSTRUCT_UNTYPED_SFIELD(sfPreviousFields, "PreviousFields", OBJECT, 6);
307 CONSTRUCT_UNTYPED_SFIELD(sfFinalFields, "FinalFields", OBJECT, 7);
308 CONSTRUCT_UNTYPED_SFIELD(sfNewFields, "NewFields", OBJECT, 8);
309 CONSTRUCT_UNTYPED_SFIELD(sfTemplateEntry, "TemplateEntry", OBJECT, 9);
310 CONSTRUCT_UNTYPED_SFIELD(sfMemo, "Memo", OBJECT, 10);
311 CONSTRUCT_UNTYPED_SFIELD(sfSignerEntry, "SignerEntry", OBJECT, 11);
312 CONSTRUCT_UNTYPED_SFIELD(sfNFToken, "NFToken", OBJECT, 12);
313 CONSTRUCT_UNTYPED_SFIELD(sfEmitDetails, "EmitDetails", OBJECT, 13);
314 CONSTRUCT_UNTYPED_SFIELD(sfHook, "Hook", OBJECT, 14);
315 
316 // inner object (uncommon)
317 CONSTRUCT_UNTYPED_SFIELD(sfSigner, "Signer", OBJECT, 16);
318 // 17 has not been used yet
319 CONSTRUCT_UNTYPED_SFIELD(sfMajority, "Majority", OBJECT, 18);
320 CONSTRUCT_UNTYPED_SFIELD(sfDisabledValidator, "DisabledValidator", OBJECT, 19);
321 CONSTRUCT_UNTYPED_SFIELD(sfEmittedTxn, "EmittedTxn", OBJECT, 20);
322 CONSTRUCT_UNTYPED_SFIELD(sfHookExecution, "HookExecution", OBJECT, 21);
323 CONSTRUCT_UNTYPED_SFIELD(sfHookDefinition, "HookDefinition", OBJECT, 22);
324 CONSTRUCT_UNTYPED_SFIELD(sfHookParameter, "HookParameter", OBJECT, 23);
325 CONSTRUCT_UNTYPED_SFIELD(sfHookGrant, "HookGrant", OBJECT, 24);
326 
327 // array of objects
328 // ARRAY/1 is reserved for end of array
329 // 2 has never been used
330 CONSTRUCT_UNTYPED_SFIELD(sfSigners, "Signers", ARRAY, 3, SField::sMD_Default, SField::notSigning);
331 CONSTRUCT_UNTYPED_SFIELD(sfSignerEntries, "SignerEntries", ARRAY, 4);
332 CONSTRUCT_UNTYPED_SFIELD(sfTemplate, "Template", ARRAY, 5);
333 CONSTRUCT_UNTYPED_SFIELD(sfNecessary, "Necessary", ARRAY, 6);
334 CONSTRUCT_UNTYPED_SFIELD(sfSufficient, "Sufficient", ARRAY, 7);
335 CONSTRUCT_UNTYPED_SFIELD(sfAffectedNodes, "AffectedNodes", ARRAY, 8);
336 CONSTRUCT_UNTYPED_SFIELD(sfMemos, "Memos", ARRAY, 9);
337 CONSTRUCT_UNTYPED_SFIELD(sfNFTokens, "NFTokens", ARRAY, 10);
338 CONSTRUCT_UNTYPED_SFIELD(sfHooks, "Hooks", ARRAY, 11);
339 
340 // array of objects (uncommon)
341 CONSTRUCT_UNTYPED_SFIELD(sfMajorities, "Majorities", ARRAY, 16);
342 CONSTRUCT_UNTYPED_SFIELD(sfDisabledValidators, "DisabledValidators", ARRAY, 17);
343 CONSTRUCT_UNTYPED_SFIELD(sfHookExecutions, "HookExecutions", ARRAY, 18);
344 CONSTRUCT_UNTYPED_SFIELD(sfHookParameters, "HookParameters", ARRAY, 19);
345 CONSTRUCT_UNTYPED_SFIELD(sfHookGrants, "HookGrants", ARRAY, 20);
346 
347 // clang-format on
348 
349 #undef CONSTRUCT_TYPED_SFIELD
350 #undef CONSTRUCT_UNTYPED_SFIELD
351 
352 #pragma pop_macro("CONSTRUCT_TYPED_SFIELD")
353 #pragma pop_macro("CONSTRUCT_UNTYPED_SFIELD")
354 
355 SField::SField(
356  private_access_tag_t,
357  SerializedTypeID tid,
358  int fv,
359  const char* fn,
360  int meta,
361  IsSigning signing)
362  : fieldCode(field_code(tid, fv))
363  , fieldType(tid)
364  , fieldValue(fv)
365  , fieldName(fn)
366  , fieldMeta(meta)
367  , fieldNum(++num)
368  , signingField(signing)
369  , jsonName(fieldName.c_str())
370 {
371  knownCodeToField[fieldCode] = this;
372 }
373 
374 SField::SField(private_access_tag_t, int fc)
375  : fieldCode(fc)
376  , fieldType(STI_UNKNOWN)
377  , fieldValue(0)
378  , fieldMeta(sMD_Never)
379  , fieldNum(++num)
380  , signingField(IsSigning::yes)
381  , jsonName(fieldName.c_str())
382 {
383  knownCodeToField[fieldCode] = this;
384 }
385 
386 SField const&
387 SField::getField(int code)
388 {
389  auto it = knownCodeToField.find(code);
390 
391  if (it != knownCodeToField.end())
392  {
393  return *(it->second);
394  }
395  return sfInvalid;
396 }
397 
398 int
399 SField::compare(SField const& f1, SField const& f2)
400 {
401  // -1 = f1 comes before f2, 0 = illegal combination, 1 = f1 comes after f2
402  if ((f1.fieldCode <= 0) || (f2.fieldCode <= 0))
403  return 0;
404 
405  if (f1.fieldCode < f2.fieldCode)
406  return -1;
407 
408  if (f2.fieldCode < f1.fieldCode)
409  return 1;
410 
411  return 0;
412 }
413 
414 SField const&
415 SField::getField(std::string const& fieldName)
416 {
417  for (auto const& [_, f] : knownCodeToField)
418  {
419  (void)_;
420  if (f->fieldName == fieldName)
421  return *f;
422  }
423  return sfInvalid;
424 }
425 
426 } // namespace ripple
ripple::sfHookAccount
const SF_ACCOUNT sfHookAccount
ripple::sfIndexNext
const SF_UINT64 sfIndexNext
ripple::sfSignerListID
const SF_UINT32 sfSignerListID
ripple::sfHighQualityIn
const SF_UINT32 sfHighQualityIn
ripple::sfOfferSequence
const SF_UINT32 sfOfferSequence
ripple::sfPreviousTxnLgrSeq
const SF_UINT32 sfPreviousTxnLgrSeq
ripple::sfHookHash
const SF_UINT256 sfHookHash
ripple::sfOwnerCount
const SF_UINT32 sfOwnerCount
ripple::sfFirstNFTokenSequence
const SF_UINT32 sfFirstNFTokenSequence
ripple::sfSignerWeight
const SF_UINT16 sfSignerWeight
ripple::sfHookApiVersion
const SF_UINT16 sfHookApiVersion
ripple::sfHooks
const SField sfHooks
ripple::sfPaths
const SField sfPaths
ripple::sfHookParameterValue
const SF_VL sfHookParameterValue
ripple::sfUNLModifyValidator
const SF_VL sfUNLModifyValidator
ripple::sfRootIndex
const SF_UINT256 sfRootIndex
ripple::sfSourceTag
const SF_UINT32 sfSourceTag
ripple::sfBaseFeeDrops
const SF_AMOUNT sfBaseFeeDrops
ripple::sfReserveBase
const SF_UINT32 sfReserveBase
ripple::sfCreateCode
const SF_VL sfCreateCode
ripple::sfEmitParentTxnID
const SF_UINT256 sfEmitParentTxnID
ripple::SField::IsSigning
IsSigning
Definition: SField.h:126
ripple::sfMetadata
const SField sfMetadata
ripple::sfSendMax
const SF_AMOUNT sfSendMax
std::string
STL class.
ripple::sfSigners
const SField sfSigners
ripple::sfHookExecutionIndex
const SF_UINT16 sfHookExecutionIndex
ripple::sfEmitHookHash
const SF_UINT256 sfEmitHookHash
utility
ripple::sfOwnerNode
const SF_UINT64 sfOwnerNode
ripple::sfHookReturnCode
const SF_UINT64 sfHookReturnCode
ripple::sfMinimumOffer
const SF_AMOUNT sfMinimumOffer
ripple::sfGeneric
const SField sfGeneric(access, 0)
Definition: SField.h:327
ripple::sfLedgerSequence
const SF_UINT32 sfLedgerSequence
ripple::sfNFTokenOffers
const SF_VECTOR256 sfNFTokenOffers
ripple::sfDestination
const SF_ACCOUNT sfDestination
ripple::sfTransactionMetaData
const SField sfTransactionMetaData
ripple::sfAmount
const SF_AMOUNT sfAmount
ripple::sfNFTokenID
const SF_UINT256 sfNFTokenID
ripple::sfWalletSize
const SF_UINT32 sfWalletSize
ripple::sfFirstLedgerSequence
const SF_UINT32 sfFirstLedgerSequence
ripple::sfCheckID
const SF_UINT256 sfCheckID
ripple::SField::sMD_Always
@ sMD_Always
Definition: SField.h:121
ripple::SField::sMD_DeleteFinal
@ sMD_DeleteFinal
Definition: SField.h:119
ripple::sfQualityOut
const SF_UINT32 sfQualityOut
ripple::sfOwner
const SF_ACCOUNT sfOwner
ripple::sfHookStateChangeCount
const SF_UINT16 sfHookStateChangeCount
ripple::sfSequence
const SF_UINT32 sfSequence
ripple::sfRegularKey
const SF_ACCOUNT sfRegularKey
ripple::sfHash
const SField sfHash(access, STI_UINT256, 257, "hash")
ripple::SField::private_access_tag_t
Definition: SField.cpp:34
ripple::sfBookDirectory
const SF_UINT256 sfBookDirectory
ripple::field_code
int field_code(SerializedTypeID id, int index)
Definition: SField.h:90
ripple::SField::fieldName
const std::string fieldName
Definition: SField.h:132
ripple::sfTakerPaysCurrency
const SF_UINT160 sfTakerPaysCurrency
ripple::sfSigningPubKey
const SF_VL sfSigningPubKey
ripple::SerializedTypeID
SerializedTypeID
Definition: SField.h:52
ripple::sfLedgerIndex
const SF_UINT256 sfLedgerIndex
ripple::sfMintedNFTokens
const SF_UINT32 sfMintedNFTokens
ripple::sfHookResult
const SF_UINT8 sfHookResult
ripple::sfHookOn
const SF_UINT64 sfHookOn
ripple::sfQualityIn
const SF_UINT32 sfQualityIn
ripple::sfHookReturnString
const SF_VL sfHookReturnString
ripple::sfSetFlag
const SF_UINT32 sfSetFlag
ripple::sfHookParameters
const SField sfHookParameters
ripple::sfFinalFields
const SField sfFinalFields
ripple::sfCloseTime
const SF_UINT32 sfCloseTime
ripple::sfTicketSequence
const SF_UINT32 sfTicketSequence
ripple::sfParentCloseTime
const SF_UINT32 sfParentCloseTime
ripple::SField::getField
static const SField & getField(int fieldCode)
Definition: SField.cpp:387
ripple::SField::knownCodeToField
static std::map< int, SField const * > knownCodeToField
Definition: SField.h:266
ripple::sfHookStateCount
const SF_UINT32 sfHookStateCount
ripple::sfTakerGetsCurrency
const SF_UINT160 sfTakerGetsCurrency
ripple::sfEmitDetails
const SField sfEmitDetails
ripple::sfDeletedNode
const SField sfDeletedNode
ripple::sfHookInstructionCount
const SF_UINT64 sfHookInstructionCount
ripple::sfHookEmitCount
const SF_UINT16 sfHookEmitCount
ripple::sfInvalid
const SField sfInvalid(access, -1)
Definition: SField.h:326
ripple::sfNFTokenOfferNode
const SF_UINT64 sfNFTokenOfferNode
ripple::sfTransferFee
const SF_UINT16 sfTransferFee
ripple::sfHookStateData
const SF_VL sfHookStateData
ripple::sfLedgerEntry
const SField sfLedgerEntry
ripple::SField::sMD_Default
@ sMD_Default
Definition: SField.h:122
ripple::sfExpiration
const SF_UINT32 sfExpiration
ripple::sfTransactionHash
const SF_UINT256 sfTransactionHash
ripple::sfSignerQuorum
const SF_UINT32 sfSignerQuorum
ripple::sfIndexes
const SF_VECTOR256 sfIndexes
ripple::sfVersion
const SF_UINT16 sfVersion
ripple::sfExpireCode
const SF_VL sfExpireCode
ripple::sfTakerGetsIssuer
const SF_UINT160 sfTakerGetsIssuer
ripple::sfLowNode
const SF_UINT64 sfLowNode
ripple::sfEmitNonce
const SF_UINT256 sfEmitNonce
ripple::sfValidatedHash
const SF_UINT256 sfValidatedHash
ripple::sfTakerPays
const SF_AMOUNT sfTakerPays
ripple::SField::SField
SField(SField const &)=delete
ripple::sfTransactionType
const SF_UINT16 sfTransactionType
ripple::sfHookExecution
const SField sfHookExecution
ripple::sfDeliverMin
const SF_AMOUNT sfDeliverMin
ripple::sfLowQualityOut
const SF_UINT32 sfLowQualityOut
ripple::sfLimitAmount
const SF_AMOUNT sfLimitAmount
ripple::sfLowLimit
const SF_AMOUNT sfLowLimit
ripple::sfHookParameter
const SField sfHookParameter
ripple::sfDeliveredAmount
const SF_AMOUNT sfDeliveredAmount
ripple::sfParentHash
const SF_UINT256 sfParentHash
ripple::SField::private_access_tag_t::private_access_tag_t
private_access_tag_t()=default
ripple::sfSettleDelay
const SF_UINT32 sfSettleDelay
ripple::sfUnauthorize
const SF_ACCOUNT sfUnauthorize
ripple::sfMemos
const SField sfMemos
ripple::sfServerVersion
const SF_UINT64 sfServerVersion
ripple::sfBondAmount
const SF_UINT32 sfBondAmount
ripple::sfLoadFee
const SF_UINT32 sfLoadFee
ripple::sfNFTokenMinter
const SF_ACCOUNT sfNFTokenMinter
ripple::sfNewFields
const SField sfNewFields
ripple::sfReserveIncrement
const SF_UINT32 sfReserveIncrement
ripple::sfMasterSignature
const SF_VL sfMasterSignature
ripple::sfNickname
const SF_UINT256 sfNickname
ripple::sfIndexPrevious
const SF_UINT64 sfIndexPrevious
ripple::sfAffectedNodes
const SField sfAffectedNodes
ripple::sfTemplate
const SField sfTemplate
ripple::sfBookNode
const SF_UINT64 sfBookNode
ripple::sfLedgerHash
const SF_UINT256 sfLedgerHash
ripple::sfFundCode
const SF_VL sfFundCode
ripple::SField::notSigning
static const IsSigning notSigning
Definition: SField.h:127
ripple::sfCookie
const SF_UINT64 sfCookie
ripple::sfLowQualityIn
const SF_UINT32 sfLowQualityIn
ripple::sfDigest
const SF_UINT256 sfDigest
ripple::sfHookStateKey
const SF_UINT256 sfHookStateKey
ripple::STI_UNKNOWN
@ STI_UNKNOWN
Definition: SField.h:54
ripple::sfValidatorToDisable
const SF_VL sfValidatorToDisable
ripple::sfTicketCount
const SF_UINT32 sfTicketCount
ripple::sfRippleEscrow
const SF_AMOUNT sfRippleEscrow
ripple::sfAccountTxnID
const SF_UINT256 sfAccountTxnID
ripple::sfModifiedNode
const SField sfModifiedNode
ripple::sfDestinationNode
const SF_UINT64 sfDestinationNode
ripple::sfTakerGets
const SF_AMOUNT sfTakerGets
ripple::sfMajority
const SField sfMajority
ripple::sfRemoveCode
const SF_VL sfRemoveCode
ripple::sfTransferRate
const SF_UINT32 sfTransferRate
ripple::sfTickSize
const SF_UINT8 sfTickSize
ripple::sfPreviousTxnID
const SF_UINT256 sfPreviousTxnID
ripple::SField::fieldCode
const int fieldCode
Definition: SField.h:129
ripple::sfAuthorize
const SF_ACCOUNT sfAuthorize
ripple::sfHighLimit
const SF_AMOUNT sfHighLimit
ripple::sfExchangeRate
const SF_UINT64 sfExchangeRate
ripple::sfEmitGeneration
const SF_UINT32 sfEmitGeneration
ripple::sfStampEscrow
const SF_UINT32 sfStampEscrow
std::map
STL class.
ripple::sfHookExecutions
const SField sfHookExecutions
ripple::CONSTRUCT_UNTYPED_SFIELD
CONSTRUCT_UNTYPED_SFIELD(sfLedgerEntry, "LedgerEntry", LEDGERENTRY, 257)
ripple::sfSigner
const SField sfSigner
ripple::sfReserveIncrementDrops
const SF_AMOUNT sfReserveIncrementDrops
ripple::sfClearFlag
const SF_UINT32 sfClearFlag
ripple::sfSignerEntry
const SField sfSignerEntry
ripple::sfReserveBaseDrops
const SF_AMOUNT sfReserveBaseDrops
ripple::sfNFToken
const SField sfNFToken
ripple::sfUNLModifyDisabling
const SF_UINT8 sfUNLModifyDisabling
ripple::sfPreviousFields
const SField sfPreviousFields
ripple::sfReferenceCount
const SF_UINT64 sfReferenceCount
ripple::sfTransactionIndex
const SF_UINT32 sfTransactionIndex
ripple::sfEmailHash
const SF_UINT128 sfEmailHash
ripple::sfNFTokens
const SField sfNFTokens
ripple::sfSignerEntries
const SField sfSignerEntries
ripple::sfOperationLimit
const SF_UINT32 sfOperationLimit
ripple::sfBaseFee
const SF_UINT64 sfBaseFee
ripple::CONSTRUCT_TYPED_SFIELD
CONSTRUCT_TYPED_SFIELD(sfCloseResolution, "CloseResolution", UINT8, 1)
ripple::sfHashes
const SF_VECTOR256 sfHashes
ripple::sfMemoData
const SF_VL sfMemoData
ripple::sfNFTokenBuyOffer
const SF_UINT256 sfNFTokenBuyOffer
ripple::sfTxnSignature
const SF_VL sfTxnSignature
ripple::access
static SField::private_access_tag_t access
Definition: SField.cpp:39
ripple::sfURI
const SF_VL sfURI
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::sfHookGrants
const SField sfHookGrants
ripple::sfHookGrant
const SField sfHookGrant
ripple::sfCloseResolution
const SF_UINT8 sfCloseResolution
ripple::sfTransactionResult
const SF_UINT8 sfTransactionResult
ripple::sfWalletLocator
const SF_UINT256 sfWalletLocator
ripple::sfAccountHash
const SF_UINT256 sfAccountHash
ripple::sfTemplateEntry
const SField sfTemplateEntry
ripple::sfLedgerEntryType
const SF_UINT16 sfLedgerEntryType
ripple::SField
Identifies fields.
Definition: SField.h:112
ripple::sfCondition
const SF_VL sfCondition
ripple::SField::num
static int num
Definition: SField.h:265
ripple::sfTakerPaysIssuer
const SF_UINT160 sfTakerPaysIssuer
ripple::sfIssuer
const SF_ACCOUNT sfIssuer
ripple::sfInvoiceID
const SF_UINT256 sfInvoiceID
ripple::sfFlags
const SF_UINT32 sfFlags
cassert
ripple::sfConsensusHash
const SF_UINT256 sfConsensusHash
ripple::sfDisabledValidator
const SField sfDisabledValidator
ripple::sfDestinationTag
const SF_UINT32 sfDestinationTag
ripple::sfCreatedNode
const SField sfCreatedNode
ripple::sfHookParameterName
const SF_VL sfHookParameterName
ripple::sfSignature
const SF_VL sfSignature
ripple::sfBalance
const SF_AMOUNT sfBalance
ripple::sfHook
const SField sfHook
ripple::SField::compare
static int compare(const SField &f1, const SField &f2)
Definition: SField.cpp:399
ripple::sfReferenceFeeUnits
const SF_UINT32 sfReferenceFeeUnits
ripple::sfNextPageMin
const SF_UINT256 sfNextPageMin
ripple::sfCancelAfter
const SF_UINT32 sfCancelAfter
ripple::sfHookDefinition
const SField sfHookDefinition
ripple::sfMessageKey
const SF_VL sfMessageKey
ripple::sfHighQualityOut
const SF_UINT32 sfHighQualityOut
ripple::sfEmitCallback
const SF_ACCOUNT sfEmitCallback
ripple::sfValidation
const SField sfValidation
ripple::sfPreviousPageMin
const SF_UINT256 sfPreviousPageMin
ripple::sfFinishAfter
const SF_UINT32 sfFinishAfter
ripple::sfChannel
const SF_UINT256 sfChannel
ripple::sfNFTokenTaxon
const SF_UINT32 sfNFTokenTaxon
ripple::sfFee
const SF_AMOUNT sfFee
ripple::sfMemo
const SField sfMemo
ripple::sfAccount
const SF_ACCOUNT sfAccount
ripple::sfEmittedTxn
const SField sfEmittedTxn
ripple::sfEmitBurden
const SF_UINT64 sfEmitBurden
ripple::sfNetworkID
const SF_UINT32 sfNetworkID
ripple::sfSufficient
const SField sfSufficient
ripple::sfHookNamespace
const SF_UINT256 sfHookNamespace
ripple::sfDomain
const SF_VL sfDomain
ripple::sfLastLedgerSequence
const SF_UINT32 sfLastLedgerSequence
ripple::sfBurnedNFTokens
const SF_UINT32 sfBurnedNFTokens
ripple::sfIndex
const SField sfIndex(access, STI_UINT256, 258, "index")
ripple::sfAmendment
const SF_UINT256 sfAmendment
ripple::STI_UINT256
@ STI_UINT256
Definition: SField.h:62
ripple::sfMajorities
const SField sfMajorities
ripple::SField::sMD_Never
@ sMD_Never
Definition: SField.h:116
ripple::sfSigningTime
const SF_UINT32 sfSigningTime
ripple::sfDisabledValidators
const SField sfDisabledValidators
ripple::sfFulfillment
const SF_VL sfFulfillment
string_view
ripple::sfPublicKey
const SF_VL sfPublicKey
ripple::sfNecessary
const SField sfNecessary
ripple::sfHighNode
const SF_UINT64 sfHighNode
ripple::sfNFTokenSellOffer
const SF_UINT256 sfNFTokenSellOffer
ripple::sfTransaction
const SField sfTransaction
ripple::sfHookSetTxnID
const SF_UINT256 sfHookSetTxnID
ripple::sfNFTokenBrokerFee
const SF_AMOUNT sfNFTokenBrokerFee
ripple::sfAmendments
const SF_VECTOR256 sfAmendments
ripple::sfMethod
const SF_UINT8 sfMethod
ripple::sfMemoFormat
const SF_VL sfMemoFormat
ripple::sfValidatorToReEnable
const SF_VL sfValidatorToReEnable
ripple::sfMemoType
const SF_VL sfMemoType
string
Generated by   doxygen 1.8.17