rippled
SField.h
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 #ifndef RIPPLE_PROTOCOL_SFIELD_H_INCLUDED
21 #define RIPPLE_PROTOCOL_SFIELD_H_INCLUDED
22 
23 #include <ripple/basics/safe_cast.h>
24 #include <ripple/json/json_value.h>
25 
26 #include <cstdint>
27 #include <map>
28 #include <utility>
29 
30 namespace ripple {
31 
32 /*
33 
34 Some fields have a different meaning for their
35  default value versus not present.
36  Example:
37  QualityIn on a TrustLine
38 
39 */
40 
41 //------------------------------------------------------------------------------
42 
43 // Forwards
44 class STAccount;
45 class STAmount;
46 class STIssue;
47 class STBlob;
48 template <int>
49 class STBitString;
50 template <class>
51 class STInteger;
52 class STXChainBridge;
53 class STVector256;
54 
55 #pragma push_macro("XMACRO")
56 #undef XMACRO
57 
58 #define XMACRO(STYPE) \
59  /* special types */ \
60  STYPE(STI_UNKNOWN, -2) \
61  STYPE(STI_NOTPRESENT, 0) \
62  STYPE(STI_UINT16, 1) \
63  \
64  /* types (common) */ \
65  STYPE(STI_UINT32, 2) \
66  STYPE(STI_UINT64, 3) \
67  STYPE(STI_UINT128, 4) \
68  STYPE(STI_UINT256, 5) \
69  STYPE(STI_AMOUNT, 6) \
70  STYPE(STI_VL, 7) \
71  STYPE(STI_ACCOUNT, 8) \
72  \
73  /* 9-13 are reserved */ \
74  STYPE(STI_OBJECT, 14) \
75  STYPE(STI_ARRAY, 15) \
76  \
77  /* types (uncommon) */ \
78  STYPE(STI_UINT8, 16) \
79  STYPE(STI_UINT160, 17) \
80  STYPE(STI_PATHSET, 18) \
81  STYPE(STI_VECTOR256, 19) \
82  STYPE(STI_UINT96, 20) \
83  STYPE(STI_UINT192, 21) \
84  STYPE(STI_UINT384, 22) \
85  STYPE(STI_UINT512, 23) \
86  STYPE(STI_ISSUE, 24) \
87  STYPE(STI_XCHAIN_BRIDGE, 25) \
88  \
89  /* high-level types */ \
90  /* cannot be serialized inside other types */ \
91  STYPE(STI_TRANSACTION, 10001) \
92  STYPE(STI_LEDGERENTRY, 10002) \
93  STYPE(STI_VALIDATION, 10003) \
94  STYPE(STI_METADATA, 10004)
95 
96 #pragma push_macro("TO_ENUM")
97 #undef TO_ENUM
98 #pragma push_macro("TO_MAP")
99 #undef TO_MAP
100 
101 #define TO_ENUM(name, value) name = value,
102 #define TO_MAP(name, value) {#name, value},
103 
104 enum SerializedTypeID { XMACRO(TO_ENUM) };
105 
106 static std::map<std::string, int> const sTypeMap = {XMACRO(TO_MAP)};
107 
108 #undef XMACRO
109 #undef TO_ENUM
110 
111 #pragma pop_macro("XMACRO")
112 #pragma pop_macro("TO_ENUM")
113 #pragma pop_macro("TO_MAP")
114 
115 // constexpr
116 inline int
117 field_code(SerializedTypeID id, int index)
118 {
119  return (safe_cast<int>(id) << 16) | index;
120 }
121 
122 // constexpr
123 inline int
124 field_code(int id, int index)
125 {
126  return (id << 16) | index;
127 }
128 
139 class SField
140 {
141 public:
142  enum {
143  sMD_Never = 0x00,
144  sMD_ChangeOrig = 0x01, // original value when it changes
145  sMD_ChangeNew = 0x02, // new value when it changes
146  sMD_DeleteFinal = 0x04, // final value when it is deleted
147  sMD_Create = 0x08, // value when it's created
148  sMD_Always = 0x10, // value when node containing it is affected at all
149  sMD_Default =
150  sMD_ChangeOrig | sMD_ChangeNew | sMD_DeleteFinal | sMD_Create
151  };
152 
153  enum class IsSigning : unsigned char { no, yes };
154  static IsSigning const notSigning = IsSigning::no;
155 
156  int const fieldCode; // (type<<16)|index
157  SerializedTypeID const fieldType; // STI_*
158  int const fieldValue; // Code number for protocol
159  std::string const fieldName;
160  int const fieldMeta;
161  int const fieldNum;
162  IsSigning const signingField;
163  Json::StaticString const jsonName;
164 
165  SField(SField const&) = delete;
166  SField&
167  operator=(SField const&) = delete;
168  SField(SField&&) = delete;
169  SField&
170  operator=(SField&&) = delete;
171 
172 public:
173  struct private_access_tag_t; // public, but still an implementation detail
174 
175  // These constructors can only be called from SField.cpp
176  SField(
177  private_access_tag_t,
178  SerializedTypeID tid,
179  int fv,
180  const char* fn,
181  int meta = sMD_Default,
182  IsSigning signing = IsSigning::yes);
183  explicit SField(private_access_tag_t, int fc);
184 
185  static const SField&
186  getField(int fieldCode);
187  static const SField&
188  getField(std::string const& fieldName);
189  static const SField&
190  getField(int type, int value)
191  {
192  return getField(field_code(type, value));
193  }
194 
195  static const SField&
196  getField(SerializedTypeID type, int value)
197  {
198  return getField(field_code(type, value));
199  }
200 
201  std::string const&
202  getName() const
203  {
204  return fieldName;
205  }
206 
207  bool
208  hasName() const
209  {
210  return fieldCode > 0;
211  }
212 
213  Json::StaticString const&
214  getJsonName() const
215  {
216  return jsonName;
217  }
218 
219  bool
220  isInvalid() const
221  {
222  return fieldCode == -1;
223  }
224 
225  bool
226  isUseful() const
227  {
228  return fieldCode > 0;
229  }
230 
231  bool
232  isBinary() const
233  {
234  return fieldValue < 256;
235  }
236 
237  // A discardable field is one that cannot be serialized, and
238  // should be discarded during serialization,like 'hash'.
239  // You cannot serialize an object's hash inside that object,
240  // but you can have it in the JSON representation.
241  bool
242  isDiscardable() const
243  {
244  return fieldValue > 256;
245  }
246 
247  int
248  getCode() const
249  {
250  return fieldCode;
251  }
252  int
253  getNum() const
254  {
255  return fieldNum;
256  }
257  static int
258  getNumFields()
259  {
260  return num;
261  }
262 
263  bool
264  shouldMeta(int c) const
265  {
266  return (fieldMeta & c) != 0;
267  }
268 
269  bool
270  shouldInclude(bool withSigningField) const
271  {
272  return (fieldValue < 256) &&
273  (withSigningField || (signingField == IsSigning::yes));
274  }
275 
276  bool
277  operator==(const SField& f) const
278  {
279  return fieldCode == f.fieldCode;
280  }
281 
282  bool
283  operator!=(const SField& f) const
284  {
285  return fieldCode != f.fieldCode;
286  }
287 
288  static int
289  compare(const SField& f1, const SField& f2);
290 
291  static std::map<int, SField const*> const&
292  getKnownCodeToField()
293  {
294  return knownCodeToField;
295  }
296 
297 private:
298  static int num;
299  static std::map<int, SField const*> knownCodeToField;
300 };
301 
303 template <class T>
304 struct TypedField : SField
305 {
306  using type = T;
307 
308  template <class... Args>
309  explicit TypedField(private_access_tag_t pat, Args&&... args);
310 };
311 
313 template <class T>
314 struct OptionaledField
315 {
316  TypedField<T> const* f;
317 
318  explicit OptionaledField(TypedField<T> const& f_) : f(&f_)
319  {
320  }
321 };
322 
323 template <class T>
324 inline OptionaledField<T>
325 operator~(TypedField<T> const& f)
326 {
327  return OptionaledField<T>(f);
328 }
329 
330 //------------------------------------------------------------------------------
331 
332 //------------------------------------------------------------------------------
333 
334 using SF_UINT8 = TypedField<STInteger<std::uint8_t>>;
335 using SF_UINT16 = TypedField<STInteger<std::uint16_t>>;
336 using SF_UINT32 = TypedField<STInteger<std::uint32_t>>;
337 using SF_UINT64 = TypedField<STInteger<std::uint64_t>>;
338 using SF_UINT96 = TypedField<STBitString<96>>;
339 using SF_UINT128 = TypedField<STBitString<128>>;
340 using SF_UINT160 = TypedField<STBitString<160>>;
341 using SF_UINT192 = TypedField<STBitString<192>>;
342 using SF_UINT256 = TypedField<STBitString<256>>;
343 using SF_UINT384 = TypedField<STBitString<384>>;
344 using SF_UINT512 = TypedField<STBitString<512>>;
345 
346 using SF_ACCOUNT = TypedField<STAccount>;
347 using SF_AMOUNT = TypedField<STAmount>;
348 using SF_ISSUE = TypedField<STIssue>;
349 using SF_VL = TypedField<STBlob>;
350 using SF_VECTOR256 = TypedField<STVector256>;
351 using SF_XCHAIN_BRIDGE = TypedField<STXChainBridge>;
352 
353 //------------------------------------------------------------------------------
354 
355 extern SField const sfInvalid;
356 extern SField const sfGeneric;
357 extern SField const sfLedgerEntry;
358 extern SField const sfTransaction;
359 extern SField const sfValidation;
360 extern SField const sfMetadata;
361 
362 // 8-bit integers (common)
363 extern SF_UINT8 const sfCloseResolution;
364 extern SF_UINT8 const sfMethod;
365 extern SF_UINT8 const sfTransactionResult;
366 extern SF_UINT8 const sfWasLockingChainSend;
367 
368 // 8-bit integers (uncommon)
369 extern SF_UINT8 const sfTickSize;
370 extern SF_UINT8 const sfUNLModifyDisabling;
371 extern SF_UINT8 const sfHookResult;
372 
373 // 16-bit integers (common)
374 extern SF_UINT16 const sfLedgerEntryType;
375 extern SF_UINT16 const sfTransactionType;
376 extern SF_UINT16 const sfSignerWeight;
377 extern SF_UINT16 const sfTransferFee;
378 extern SF_UINT16 const sfTradingFee;
379 
380 // 16-bit integers (uncommon)
381 extern SF_UINT16 const sfVersion;
382 extern SF_UINT16 const sfHookStateChangeCount;
383 extern SF_UINT16 const sfHookEmitCount;
384 extern SF_UINT16 const sfHookExecutionIndex;
385 extern SF_UINT16 const sfHookApiVersion;
386 extern SF_UINT16 const sfDiscountedFee;
387 
388 // 32-bit integers (common)
389 extern SF_UINT32 const sfNetworkID;
390 extern SF_UINT32 const sfFlags;
391 extern SF_UINT32 const sfSourceTag;
392 extern SF_UINT32 const sfSequence;
393 extern SF_UINT32 const sfPreviousTxnLgrSeq;
394 extern SF_UINT32 const sfLedgerSequence;
395 extern SF_UINT32 const sfCloseTime;
396 extern SF_UINT32 const sfParentCloseTime;
397 extern SF_UINT32 const sfSigningTime;
398 extern SF_UINT32 const sfExpiration;
399 extern SF_UINT32 const sfTransferRate;
400 extern SF_UINT32 const sfWalletSize;
401 extern SF_UINT32 const sfOwnerCount;
402 extern SF_UINT32 const sfDestinationTag;
403 
404 // 32-bit integers (uncommon)
405 extern SF_UINT32 const sfHighQualityIn;
406 extern SF_UINT32 const sfHighQualityOut;
407 extern SF_UINT32 const sfLowQualityIn;
408 extern SF_UINT32 const sfLowQualityOut;
409 extern SF_UINT32 const sfQualityIn;
410 extern SF_UINT32 const sfQualityOut;
411 extern SF_UINT32 const sfStampEscrow;
412 extern SF_UINT32 const sfBondAmount;
413 extern SF_UINT32 const sfLoadFee;
414 extern SF_UINT32 const sfOfferSequence;
415 extern SF_UINT32 const sfFirstLedgerSequence;
416 extern SF_UINT32 const sfLastLedgerSequence;
417 extern SF_UINT32 const sfTransactionIndex;
418 extern SF_UINT32 const sfOperationLimit;
419 extern SF_UINT32 const sfReferenceFeeUnits;
420 extern SF_UINT32 const sfReserveBase;
421 extern SF_UINT32 const sfReserveIncrement;
422 extern SF_UINT32 const sfSetFlag;
423 extern SF_UINT32 const sfClearFlag;
424 extern SF_UINT32 const sfSignerQuorum;
425 extern SF_UINT32 const sfCancelAfter;
426 extern SF_UINT32 const sfFinishAfter;
427 extern SF_UINT32 const sfSignerListID;
428 extern SF_UINT32 const sfSettleDelay;
429 extern SF_UINT32 const sfTicketCount;
430 extern SF_UINT32 const sfTicketSequence;
431 extern SF_UINT32 const sfNFTokenTaxon;
432 extern SF_UINT32 const sfMintedNFTokens;
433 extern SF_UINT32 const sfBurnedNFTokens;
434 extern SF_UINT32 const sfHookStateCount;
435 extern SF_UINT32 const sfEmitGeneration;
436 extern SF_UINT32 const sfVoteWeight;
437 extern SF_UINT32 const sfFirstNFTokenSequence;
438 
439 // 64-bit integers (common)
440 extern SF_UINT64 const sfIndexNext;
441 extern SF_UINT64 const sfIndexPrevious;
442 extern SF_UINT64 const sfBookNode;
443 extern SF_UINT64 const sfOwnerNode;
444 extern SF_UINT64 const sfBaseFee;
445 extern SF_UINT64 const sfExchangeRate;
446 extern SF_UINT64 const sfLowNode;
447 extern SF_UINT64 const sfHighNode;
448 extern SF_UINT64 const sfDestinationNode;
449 extern SF_UINT64 const sfCookie;
450 extern SF_UINT64 const sfServerVersion;
451 extern SF_UINT64 const sfNFTokenOfferNode;
452 extern SF_UINT64 const sfEmitBurden;
453 
454 // 64-bit integers (uncommon)
455 extern SF_UINT64 const sfHookOn;
456 extern SF_UINT64 const sfHookInstructionCount;
457 extern SF_UINT64 const sfHookReturnCode;
458 extern SF_UINT64 const sfReferenceCount;
459 extern SF_UINT64 const sfXChainClaimID;
460 extern SF_UINT64 const sfXChainAccountCreateCount;
461 extern SF_UINT64 const sfXChainAccountClaimCount;
462 
463 // 128-bit
464 extern SF_UINT128 const sfEmailHash;
465 
466 // 160-bit (common)
467 extern SF_UINT160 const sfTakerPaysCurrency;
468 extern SF_UINT160 const sfTakerPaysIssuer;
469 extern SF_UINT160 const sfTakerGetsCurrency;
470 extern SF_UINT160 const sfTakerGetsIssuer;
471 
472 // 256-bit (common)
473 extern SF_UINT256 const sfLedgerHash;
474 extern SF_UINT256 const sfParentHash;
475 extern SF_UINT256 const sfTransactionHash;
476 extern SF_UINT256 const sfAccountHash;
477 extern SF_UINT256 const sfPreviousTxnID;
478 extern SF_UINT256 const sfLedgerIndex;
479 extern SF_UINT256 const sfWalletLocator;
480 extern SF_UINT256 const sfRootIndex;
481 extern SF_UINT256 const sfAccountTxnID;
482 extern SF_UINT256 const sfNFTokenID;
483 extern SF_UINT256 const sfEmitParentTxnID;
484 extern SF_UINT256 const sfEmitNonce;
485 extern SF_UINT256 const sfEmitHookHash;
486 extern SF_UINT256 const sfAMMID;
487 
488 // 256-bit (uncommon)
489 extern SF_UINT256 const sfBookDirectory;
490 extern SF_UINT256 const sfInvoiceID;
491 extern SF_UINT256 const sfNickname;
492 extern SF_UINT256 const sfAmendment;
493 extern SF_UINT256 const sfDigest;
494 extern SF_UINT256 const sfChannel;
495 extern SF_UINT256 const sfConsensusHash;
496 extern SF_UINT256 const sfCheckID;
497 extern SF_UINT256 const sfValidatedHash;
498 extern SF_UINT256 const sfPreviousPageMin;
499 extern SF_UINT256 const sfNextPageMin;
500 extern SF_UINT256 const sfNFTokenBuyOffer;
501 extern SF_UINT256 const sfNFTokenSellOffer;
502 extern SF_UINT256 const sfHookStateKey;
503 extern SF_UINT256 const sfHookHash;
504 extern SF_UINT256 const sfHookNamespace;
505 extern SF_UINT256 const sfHookSetTxnID;
506 
507 // currency amount (common)
508 extern SF_AMOUNT const sfAmount;
509 extern SF_AMOUNT const sfBalance;
510 extern SF_AMOUNT const sfLimitAmount;
511 extern SF_AMOUNT const sfTakerPays;
512 extern SF_AMOUNT const sfTakerGets;
513 extern SF_AMOUNT const sfLowLimit;
514 extern SF_AMOUNT const sfHighLimit;
515 extern SF_AMOUNT const sfFee;
516 extern SF_AMOUNT const sfSendMax;
517 extern SF_AMOUNT const sfDeliverMin;
518 extern SF_AMOUNT const sfAmount2;
519 extern SF_AMOUNT const sfEPrice;
520 extern SF_AMOUNT const sfBidMin;
521 extern SF_AMOUNT const sfBidMax;
522 extern SF_AMOUNT const sfPrice;
523 extern SF_AMOUNT const sfLPTokenBalance;
524 
525 // currency amount (uncommon)
526 extern SF_AMOUNT const sfMinimumOffer;
527 extern SF_AMOUNT const sfRippleEscrow;
528 extern SF_AMOUNT const sfDeliveredAmount;
529 extern SF_AMOUNT const sfNFTokenBrokerFee;
530 extern SF_AMOUNT const sfLPTokenOut;
531 extern SF_AMOUNT const sfLPTokenIn;
532 
533 // currency amount (fees)
534 extern SF_AMOUNT const sfBaseFeeDrops;
535 extern SF_AMOUNT const sfReserveBaseDrops;
536 extern SF_AMOUNT const sfReserveIncrementDrops;
537 extern SF_AMOUNT const sfSignatureReward;
538 extern SF_AMOUNT const sfMinAccountCreateAmount;
539 
540 // variable length (common)
541 extern SF_VL const sfPublicKey;
542 extern SF_VL const sfMessageKey;
543 extern SF_VL const sfSigningPubKey;
544 extern SF_VL const sfTxnSignature;
545 extern SF_VL const sfURI;
546 extern SF_VL const sfSignature;
547 extern SF_VL const sfDomain;
548 extern SF_VL const sfFundCode;
549 extern SF_VL const sfRemoveCode;
550 extern SF_VL const sfExpireCode;
551 extern SF_VL const sfCreateCode;
552 extern SF_VL const sfMemoType;
553 extern SF_VL const sfMemoData;
554 extern SF_VL const sfMemoFormat;
555 extern SF_VL const sfDIDDocument;
556 extern SF_VL const sfData;
557 
558 // variable length (uncommon)
559 extern SF_VL const sfFulfillment;
560 extern SF_VL const sfCondition;
561 extern SF_VL const sfMasterSignature;
562 extern SF_VL const sfUNLModifyValidator;
563 extern SF_VL const sfValidatorToDisable;
564 extern SF_VL const sfValidatorToReEnable;
565 extern SF_VL const sfHookStateData;
566 extern SF_VL const sfHookReturnString;
567 extern SF_VL const sfHookParameterName;
568 extern SF_VL const sfHookParameterValue;
569 
570 // account
571 extern SF_ACCOUNT const sfAccount;
572 extern SF_ACCOUNT const sfOwner;
573 extern SF_ACCOUNT const sfDestination;
574 extern SF_ACCOUNT const sfIssuer;
575 extern SF_ACCOUNT const sfAuthorize;
576 extern SF_ACCOUNT const sfUnauthorize;
577 extern SF_ACCOUNT const sfRegularKey;
578 extern SF_ACCOUNT const sfNFTokenMinter;
579 extern SF_ACCOUNT const sfEmitCallback;
580 
581 // account (uncommon)
582 extern SF_ACCOUNT const sfHookAccount;
583 extern SF_ACCOUNT const sfOtherChainSource;
584 extern SF_ACCOUNT const sfOtherChainDestination;
585 extern SF_ACCOUNT const sfAttestationSignerAccount;
586 extern SF_ACCOUNT const sfAttestationRewardAccount;
587 extern SF_ACCOUNT const sfLockingChainDoor;
588 extern SF_ACCOUNT const sfIssuingChainDoor;
589 
590 // path set
591 extern SField const sfPaths;
592 
593 // issue
594 extern SF_ISSUE const sfAsset;
595 extern SF_ISSUE const sfAsset2;
596 extern SF_ISSUE const sfLockingChainIssue;
597 extern SF_ISSUE const sfIssuingChainIssue;
598 
599 // bridge
600 extern SF_XCHAIN_BRIDGE const sfXChainBridge;
601 
602 // vector of 256-bit
603 extern SF_VECTOR256 const sfIndexes;
604 extern SF_VECTOR256 const sfHashes;
605 extern SF_VECTOR256 const sfAmendments;
606 extern SF_VECTOR256 const sfNFTokenOffers;
607 
608 // inner object
609 // OBJECT/1 is reserved for end of object
610 extern SField const sfTransactionMetaData;
611 extern SField const sfCreatedNode;
612 extern SField const sfDeletedNode;
613 extern SField const sfModifiedNode;
614 extern SField const sfPreviousFields;
615 extern SField const sfFinalFields;
616 extern SField const sfNewFields;
617 extern SField const sfTemplateEntry;
618 extern SField const sfMemo;
619 extern SField const sfSignerEntry;
620 extern SField const sfNFToken;
621 extern SField const sfEmitDetails;
622 extern SField const sfHook;
623 extern SField const sfVoteEntry;
624 extern SField const sfAuctionSlot;
625 extern SField const sfAuthAccount;
626 
627 extern SField const sfSigner;
628 extern SField const sfMajority;
629 extern SField const sfDisabledValidator;
630 extern SField const sfEmittedTxn;
631 extern SField const sfHookExecution;
632 extern SField const sfHookDefinition;
633 extern SField const sfHookParameter;
634 extern SField const sfHookGrant;
635 extern SField const sfXChainClaimProofSig;
636 extern SField const sfXChainCreateAccountProofSig;
637 extern SField const sfXChainClaimAttestationCollectionElement;
638 extern SField const sfXChainCreateAccountAttestationCollectionElement;
639 
640 // array of objects (common)
641 // ARRAY/1 is reserved for end of array
642 // extern SField const sfSigningAccounts; // Never been used.
643 extern SField const sfSigners;
644 extern SField const sfSignerEntries;
645 extern SField const sfTemplate;
646 extern SField const sfNecessary;
647 extern SField const sfSufficient;
648 extern SField const sfAffectedNodes;
649 extern SField const sfMemos;
650 extern SField const sfNFTokens;
651 extern SField const sfHooks;
652 extern SField const sfVoteSlots;
653 extern SField const sfAuthAccounts;
654 
655 // array of objects (uncommon)
656 extern SField const sfMajorities;
657 extern SField const sfDisabledValidators;
658 extern SField const sfHookExecutions;
659 extern SField const sfHookParameters;
660 extern SField const sfHookGrants;
661 extern SField const sfXChainClaimAttestations;
662 extern SField const sfXChainCreateAccountAttestations;
663 
664 //------------------------------------------------------------------------------
665 
666 } // namespace ripple
667 
668 #endif
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::sfDiscountedFee
const SF_UINT16 sfDiscountedFee
ripple::sfEmitParentTxnID
const SF_UINT256 sfEmitParentTxnID
ripple::SField::IsSigning
IsSigning
Definition: SField.h:153
ripple::sfMetadata
const SField sfMetadata
ripple::sfAsset
const SF_ISSUE sfAsset
ripple::sfSendMax
const SF_AMOUNT sfSendMax
std::string
STL class.
ripple::sfSigners
const SField sfSigners
ripple::sfHookExecutionIndex
const SF_UINT16 sfHookExecutionIndex
ripple::SField::getField
static const SField & getField(SerializedTypeID type, int value)
Definition: SField.h:196
ripple::sfEmitHookHash
const SF_UINT256 sfEmitHookHash
utility
ripple::sfOwnerNode
const SF_UINT64 sfOwnerNode
ripple::TypedField
A field with a type known at compile time.
Definition: SField.h:304
ripple::sfHookReturnCode
const SF_UINT64 sfHookReturnCode
ripple::sfMinimumOffer
const SF_AMOUNT sfMinimumOffer
ripple::sfGeneric
const SField sfGeneric(access, 0)
Definition: SField.h:356
ripple::SField::fieldValue
const int fieldValue
Definition: SField.h:158
ripple::sfLedgerSequence
const SF_UINT32 sfLedgerSequence
ripple::sfNFTokenOffers
const SF_VECTOR256 sfNFTokenOffers
ripple::sTypeMap
static const std::map< std::string, int > sTypeMap
Definition: SField.h:106
ripple::sfDestination
const SF_ACCOUNT sfDestination
ripple::sfAmount2
const SF_AMOUNT sfAmount2
ripple::sfTransactionMetaData
const SField sfTransactionMetaData
ripple::SField::isBinary
bool isBinary() const
Definition: SField.h:232
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::sfLockingChainDoor
const SF_ACCOUNT sfLockingChainDoor
ripple::SField::sMD_Always
@ sMD_Always
Definition: SField.h:148
ripple::SField::sMD_DeleteFinal
@ sMD_DeleteFinal
Definition: SField.h:146
ripple::SField::isInvalid
bool isInvalid() const
Definition: SField.h:220
ripple::sfVoteSlots
const SField sfVoteSlots
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::sfVoteEntry
const SField sfVoteEntry
ripple::sfLPTokenBalance
const SF_AMOUNT sfLPTokenBalance
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:117
ripple::SField::fieldName
const std::string fieldName
Definition: SField.h:159
ripple::sfTakerPaysCurrency
const SF_UINT160 sfTakerPaysCurrency
ripple::sfSigningPubKey
const SF_VL sfSigningPubKey
ripple::sfEPrice
const SF_AMOUNT sfEPrice
ripple::SField::hasName
bool hasName() const
Definition: SField.h:208
ripple::SerializedTypeID
SerializedTypeID
Definition: SField.h:104
ripple::sfLedgerIndex
const SF_UINT256 sfLedgerIndex
ripple::SField::isUseful
bool isUseful() const
Definition: SField.h:226
ripple::sfMintedNFTokens
const SF_UINT32 sfMintedNFTokens
ripple::SField::getKnownCodeToField
static std::map< int, SField const * > const & getKnownCodeToField()
Definition: SField.h:292
ripple::sfXChainCreateAccountAttestationCollectionElement
const SField sfXChainCreateAccountAttestationCollectionElement
ripple::SField::signingField
const IsSigning signingField
Definition: SField.h:162
ripple::sfHookResult
const SF_UINT8 sfHookResult
ripple::TypedField::TypedField
TypedField(private_access_tag_t pat, Args &&... args)
Definition: SField.cpp:43
ripple::SField::getField
static const SField & getField(int type, int value)
Definition: SField.h:190
ripple::sfHookOn
const SF_UINT64 sfHookOn
ripple::sfOtherChainSource
const SF_ACCOUNT sfOtherChainSource
ripple::sfQualityIn
const SF_UINT32 sfQualityIn
ripple::sfHookReturnString
const SF_VL sfHookReturnString
ripple::SField::operator!=
bool operator!=(const SField &f) const
Definition: SField.h:283
ripple::SField::getNum
int getNum() const
Definition: SField.h:253
ripple::sfSetFlag
const SF_UINT32 sfSetFlag
ripple::sfHookParameters
const SField sfHookParameters
ripple::sfFinalFields
const SField sfFinalFields
ripple::OptionaledField
Indicate std::optional field semantics.
Definition: SField.h:314
ripple::sfCloseTime
const SF_UINT32 sfCloseTime
ripple::sfTicketSequence
const SF_UINT32 sfTicketSequence
ripple::sfParentCloseTime
const SF_UINT32 sfParentCloseTime
ripple::sfWasLockingChainSend
const SF_UINT8 sfWasLockingChainSend
ripple::SField::getField
static const SField & getField(int fieldCode)
Definition: SField.cpp:452
ripple::SField::knownCodeToField
static std::map< int, SField const * > knownCodeToField
Definition: SField.h:299
ripple::sfHookStateCount
const SF_UINT32 sfHookStateCount
ripple::SField::sMD_ChangeOrig
@ sMD_ChangeOrig
Definition: SField.h:144
ripple::sfLPTokenOut
const SF_AMOUNT sfLPTokenOut
ripple::SField::getJsonName
Json::StaticString const & getJsonName() const
Definition: SField.h:214
ripple::sfXChainAccountClaimCount
const SF_UINT64 sfXChainAccountClaimCount
ripple::SField::operator==
bool operator==(const SField &f) const
Definition: SField.h:277
ripple::sfPrice
const SF_AMOUNT sfPrice
ripple::sfTakerGetsCurrency
const SF_UINT160 sfTakerGetsCurrency
ripple::STBitString
Definition: SField.h:49
ripple::SField::operator=
SField & operator=(SField const &)=delete
ripple::SField::jsonName
const Json::StaticString jsonName
Definition: SField.h:163
ripple::sfVoteWeight
const SF_UINT32 sfVoteWeight
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:355
ripple::SField::sMD_Create
@ sMD_Create
Definition: SField.h:147
ripple::sfNFTokenOfferNode
const SF_UINT64 sfNFTokenOfferNode
ripple::sfTradingFee
const SF_UINT16 sfTradingFee
ripple::sfXChainClaimID
const SF_UINT64 sfXChainClaimID
ripple::sfTransferFee
const SF_UINT16 sfTransferFee
ripple::XMACRO
@ XMACRO
Definition: SField.h:104
ripple::sfHookStateData
const SF_VL sfHookStateData
ripple::sfLedgerEntry
const SField sfLedgerEntry
ripple::SField::sMD_Default
@ sMD_Default
Definition: SField.h:149
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::SField::fieldType
const SerializedTypeID fieldType
Definition: SField.h:157
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::OptionaledField::OptionaledField
OptionaledField(TypedField< T > const &f_)
Definition: SField.h:318
ripple::sfDeliveredAmount
const SF_AMOUNT sfDeliveredAmount
ripple::sfAsset2
const SF_ISSUE sfAsset2
ripple::sfParentHash
const SF_UINT256 sfParentHash
ripple::sfSettleDelay
const SF_UINT32 sfSettleDelay
ripple::sfUnauthorize
const SF_ACCOUNT sfUnauthorize
ripple::sfSignatureReward
const SF_AMOUNT sfSignatureReward
ripple::sfMemos
const SField sfMemos
ripple::sfBidMax
const SF_AMOUNT sfBidMax
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::sfLockingChainIssue
const SF_ISSUE sfLockingChainIssue
ripple::sfXChainClaimAttestations
const SField sfXChainClaimAttestations
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::sfAuthAccounts
const SField sfAuthAccounts
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:154
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::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::sfXChainClaimProofSig
const SField sfXChainClaimProofSig
ripple::sfDestinationNode
const SF_UINT64 sfDestinationNode
ripple::sfXChainCreateAccountProofSig
const SField sfXChainCreateAccountProofSig
ripple::sfTakerGets
const SF_AMOUNT sfTakerGets
ripple::sfMajority
const SField sfMajority
cstdint
ripple::sfRemoveCode
const SF_VL sfRemoveCode
ripple::sfTransferRate
const SF_UINT32 sfTransferRate
ripple::sfTickSize
const SF_UINT8 sfTickSize
ripple::sfAttestationSignerAccount
const SF_ACCOUNT sfAttestationSignerAccount
ripple::sfPreviousTxnID
const SF_UINT256 sfPreviousTxnID
ripple::SField::fieldCode
const int fieldCode
Definition: SField.h:156
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
map
ripple::SField::getNumFields
static int getNumFields()
Definition: SField.h:258
ripple::sfHookExecutions
const SField sfHookExecutions
ripple::sfAMMID
const SF_UINT256 sfAMMID
ripple::sfSigner
const SField sfSigner
ripple::sfReserveIncrementDrops
const SF_AMOUNT sfReserveIncrementDrops
ripple::sfClearFlag
const SF_UINT32 sfClearFlag
ripple::sfSignerEntry
const SField sfSignerEntry
ripple::sfBidMin
const SF_AMOUNT sfBidMin
ripple::sfReserveBaseDrops
const SF_AMOUNT sfReserveBaseDrops
ripple::STInteger
Definition: SField.h:51
ripple::sfNFToken
const SField sfNFToken
ripple::sfUNLModifyDisabling
const SF_UINT8 sfUNLModifyDisabling
ripple::STXChainBridge
Definition: STXChainBridge.h:32
ripple::SField::IsSigning::yes
@ yes
ripple::SField::shouldInclude
bool shouldInclude(bool withSigningField) const
Definition: SField.h:270
ripple::TypedField::type
T type
Definition: SField.h:306
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::sfHashes
const SF_VECTOR256 sfHashes
ripple::sfMemoData
const SF_VL sfMemoData
ripple::sfNFTokenBuyOffer
const SF_UINT256 sfNFTokenBuyOffer
ripple::sfTxnSignature
const SF_VL sfTxnSignature
ripple::sfURI
const SF_VL sfURI
ripple::sfMinAccountCreateAmount
const SF_AMOUNT sfMinAccountCreateAmount
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::sfDIDDocument
const SF_VL sfDIDDocument
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:139
ripple::sfAuthAccount
const SField sfAuthAccount
ripple::sfCondition
const SF_VL sfCondition
ripple::SField::num
static int num
Definition: SField.h:298
ripple::sfTakerPaysIssuer
const SF_UINT160 sfTakerPaysIssuer
ripple::sfIssuer
const SF_ACCOUNT sfIssuer
ripple::SField::getName
std::string const & getName() const
Definition: SField.h:202
ripple::sfXChainClaimAttestationCollectionElement
const SField sfXChainClaimAttestationCollectionElement
ripple::sfInvoiceID
const SF_UINT256 sfInvoiceID
Json::StaticString
Lightweight wrapper to tag static string.
Definition: json_value.h:60
ripple::sfFlags
const SF_UINT32 sfFlags
ripple::SField::isDiscardable
bool isDiscardable() const
Definition: SField.h:242
ripple::sfConsensusHash
const SF_UINT256 sfConsensusHash
ripple::sfDisabledValidator
const SField sfDisabledValidator
ripple::sfDestinationTag
const SF_UINT32 sfDestinationTag
ripple::sfOtherChainDestination
const SF_ACCOUNT sfOtherChainDestination
ripple::sfCreatedNode
const SField sfCreatedNode
ripple::sfHookParameterName
const SF_VL sfHookParameterName
ripple::sfXChainAccountCreateCount
const SF_UINT64 sfXChainAccountCreateCount
ripple::sfSignature
const SF_VL sfSignature
ripple::sfData
const SF_VL sfData
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:464
ripple::sfReferenceFeeUnits
const SF_UINT32 sfReferenceFeeUnits
ripple::STVector256
Definition: STVector256.h:29
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::sfXChainCreateAccountAttestations
const SField sfXChainCreateAccountAttestations
ripple::sfEmitCallback
const SF_ACCOUNT sfEmitCallback
ripple::SField::getCode
int getCode() const
Definition: SField.h:248
ripple::sfValidation
const SField sfValidation
ripple::sfPreviousPageMin
const SF_UINT256 sfPreviousPageMin
ripple::SField::fieldMeta
const int fieldMeta
Definition: SField.h:160
ripple::sfFinishAfter
const SF_UINT32 sfFinishAfter
ripple::sfChannel
const SF_UINT256 sfChannel
ripple::OptionaledField::f
TypedField< T > const * f
Definition: SField.h:316
ripple::sfNFTokenTaxon
const SF_UINT32 sfNFTokenTaxon
ripple::sfFee
const SF_AMOUNT sfFee
ripple::sfMemo
const SField sfMemo
ripple::sfAccount
const SF_ACCOUNT sfAccount
ripple::sfIssuingChainDoor
const SF_ACCOUNT sfIssuingChainDoor
ripple::sfEmittedTxn
const SField sfEmittedTxn
ripple::sfEmitBurden
const SF_UINT64 sfEmitBurden
ripple::sfAttestationRewardAccount
const SF_ACCOUNT sfAttestationRewardAccount
ripple::sfLPTokenIn
const SF_AMOUNT sfLPTokenIn
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::sfIssuingChainIssue
const SF_ISSUE sfIssuingChainIssue
ripple::SField::shouldMeta
bool shouldMeta(int c) const
Definition: SField.h:264
ripple::sfBurnedNFTokens
const SF_UINT32 sfBurnedNFTokens
ripple::SField::sMD_ChangeNew
@ sMD_ChangeNew
Definition: SField.h:145
ripple::sfAmendment
const SF_UINT256 sfAmendment
ripple::sfMajorities
const SField sfMajorities
ripple::sfAuctionSlot
const SField sfAuctionSlot
ripple::sfXChainBridge
const SF_XCHAIN_BRIDGE sfXChainBridge
ripple::SField::sMD_Never
@ sMD_Never
Definition: SField.h:143
ripple::sfSigningTime
const SF_UINT32 sfSigningTime
ripple::sfDisabledValidators
const SField sfDisabledValidators
ripple::sfFulfillment
const SF_VL sfFulfillment
ripple::SField::IsSigning::no
@ no
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::SField::fieldNum
const int fieldNum
Definition: SField.h:161
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::operator~
constexpr ApplyFlags operator~(ApplyFlags const &flags)
Definition: ApplyView.h:71
ripple::sfValidatorToReEnable
const SF_VL sfValidatorToReEnable
ripple::sfMemoType
const SF_VL sfMemoType
Generated by   doxygen 1.8.17