|
xrpld
|
#include <STValidation.h>


Classes | |
| struct | DeserializeOptions |
| Options controlling deserialization of a STValidation. More... | |
Public Types | |
| using | iterator = boost::transform_iterator<Transform, STObject::ListType::const_iterator> |
Public Member Functions | |
| template<class LookupNodeID> | |
| STValidation (SerialIter &sit, LookupNodeID &&lookupNodeID, DeserializeOptions options) | |
| Construct a STValidation from a peer from serialized data. | |
| template<typename F> | |
| STValidation (NetClock::time_point signTime, PublicKey const &pk, SecretKey const &sk, NodeID const &nodeID, F &&f) | |
| Construct, sign and trust a new STValidation issued by this node. | |
| UInt256 | getLedgerHash () const |
| UInt256 | getConsensusHash () const |
| NetClock::time_point | getSignTime () const |
| NetClock::time_point | getSeenTime () const noexcept |
| PublicKey const & | getSignerPublic () const noexcept |
| NodeID const & | getNodeID () const noexcept |
| bool | isValid () const noexcept |
| Whether this validation carries a good signature. | |
| bool | isFull () const noexcept |
| bool | isTrusted () const noexcept |
| UInt256 | getSigningHash () const |
| void | setTrusted () |
| void | setUntrusted () |
| void | setSeen (NetClock::time_point s) |
| Blob | getSerialized () const |
| Blob | getSignature () const |
| std::string | render () const |
| iterator | begin () const |
| iterator | end () const |
| bool | empty () const |
| void | reserve (std::size_t n) |
| void | applyTemplate (SOTemplate const &type) |
| void | applyTemplateFromSField (SField const &) |
| bool | isFree () const |
| void | set (SOTemplate const &) |
| bool | set (SerialIter &u, int depth=0, bool requireCanonicalOrder=false) |
| void | set (std::unique_ptr< STBase > v) |
| Set a field. | |
| void | set (STBase &&v) |
| SerializedTypeID | getSType () const override |
| bool | isEquivalent (STBase const &t) const override |
| bool | isDefault () const override |
| void | add (Serializer &s) const override |
| std::string | getFullText () const override |
| std::string | getText () const override |
| json::Value | getJson (JsonOptions=JsonOptions::Values::None) const override |
| void | addWithoutSigningFields (Serializer &s) const |
| Serializer | getSerializer () const |
| template<class... Args> | |
| std::size_t | emplaceBack (Args &&... args) |
| int | getCount () const |
| bool | setFlag (std::uint32_t) |
| bool | clearFlag (std::uint32_t) |
| bool | isFlag (std::uint32_t) const |
| std::uint32_t | getFlags () const |
| UInt256 | getHash (HashPrefix prefix) const |
| UInt256 | getSigningHash (HashPrefix prefix) const |
| STBase const & | peekAtIndex (int offset) const |
| STBase & | getIndex (int offset) |
| STBase const * | peekAtPIndex (int offset) const |
| STBase * | getPIndex (int offset) |
| int | getFieldIndex (SField const &field) const |
| SField const & | getFieldSType (int index) const |
| STBase const & | peekAtField (SField const &field) const |
| STBase & | getField (SField const &field) |
| STBase const * | peekAtPField (SField const &field) const |
| STBase * | getPField (SField const &field, bool createOkay=false) |
| unsigned char | getFieldU8 (SField const &field) const |
| std::uint16_t | getFieldU16 (SField const &field) const |
| std::uint32_t | getFieldU32 (SField const &field) const |
| std::uint64_t | getFieldU64 (SField const &field) const |
| UInt128 | getFieldH128 (SField const &field) const |
| UInt160 | getFieldH160 (SField const &field) const |
| UInt192 | getFieldH192 (SField const &field) const |
| UInt256 | getFieldH256 (SField const &field) const |
| std::int32_t | getFieldI32 (SField const &field) const |
| AccountID | getAccountID (SField const &field) const |
| Blob | getFieldVL (SField const &field) const |
| STAmount const & | getFieldAmount (SField const &field) const |
| STPathSet const & | getFieldPathSet (SField const &field) const |
| STVector256 const & | getFieldV256 (SField const &field) const |
| STObject | getFieldObject (SField const &field) const |
| STArray const & | getFieldArray (SField const &field) const |
| STCurrency const & | getFieldCurrency (SField const &field) const |
| STNumber const & | getFieldNumber (SField const &field) const |
| template<class T> | |
| T::value_type | operator[] (TypedField< T > const &f) const |
| Get the value of a field. | |
| template<class T> | |
| std::optional< std::decay_t< typename T::value_type > > | operator[] (OptionaledField< T > const &of) const |
| Get the value of a field as a std::optional. | |
| template<class T> | |
| ValueProxy< T > | operator[] (TypedField< T > const &f) |
| Get a modifiable field value. | |
| template<class T> | |
| OptionalProxy< T > | operator[] (OptionaledField< T > const &of) |
| Return a modifiable field value as std::optional. | |
| template<class T> | |
| T::value_type | at (TypedField< T > const &f) const |
| Get the value of a field. | |
| template<class T> | |
| std::optional< std::decay_t< typename T::value_type > > | at (OptionaledField< T > const &of) const |
| Get the value of a field as std::optional. | |
| template<class T> | |
| ValueProxy< T > | at (TypedField< T > const &f) |
| Get a modifiable field value. | |
| template<class T> | |
| OptionalProxy< T > | at (OptionaledField< T > const &of) |
| Return a modifiable field value as std::optional. | |
| void | setFieldU8 (SField const &field, unsigned char) |
| void | setFieldU16 (SField const &field, std::uint16_t) |
| void | setFieldU32 (SField const &field, std::uint32_t) |
| void | setFieldU64 (SField const &field, std::uint64_t) |
| void | setFieldH128 (SField const &field, UInt128 const &) |
| void | setFieldH192 (SField const &field, UInt192 const &) |
| void | setFieldH256 (SField const &field, UInt256 const &) |
| void | setFieldI32 (SField const &field, std::int32_t) |
| void | setFieldVL (SField const &field, Blob const &) |
| void | setFieldVL (SField const &field, Slice const &) |
| void | setAccountID (SField const &field, AccountID const &) |
| void | setFieldAmount (SField const &field, STAmount const &) |
| void | setFieldIssue (SField const &field, STIssue const &) |
| void | setFieldCurrency (SField const &field, STCurrency const &) |
| void | setFieldNumber (SField const &field, STNumber const &) |
| void | setFieldPathSet (SField const &field, STPathSet const &) |
| void | setFieldV256 (SField const &field, STVector256 const &v) |
| void | setFieldArray (SField const &field, STArray const &v) |
| void | setFieldObject (SField const &field, STObject const &v) |
| template<class Tag> | |
| void | setFieldH160 (SField const &field, BaseUInt< 160, Tag > const &v) |
| STObject & | peekFieldObject (SField const &field) |
| STArray & | peekFieldArray (SField const &field) |
| bool | isFieldPresent (SField const &field) const |
| STBase * | makeFieldPresent (SField const &field) |
| void | makeFieldAbsent (SField const &field) |
| bool | delField (SField const &field) |
| void | delField (int index) |
| SOEStyle | getStyle (SField const &field) const |
| bool | hasMatchingEntry (STBase const &) const |
| bool | operator== (STObject const &o) const |
| bool | operator== (STBase const &t) const |
| template<typename T, typename V> | |
| V const & | getFieldByConstRef (SField const &field, V const &empty) const |
| template<class D> | |
| D & | downcast () |
| template<class D> | |
| D const & | downcast () const |
| template<class D> | |
| D const & | downcast () const |
| void | setFName (SField const &n) |
| A STBase is a field. | |
| SField const & | getFName () const |
| void | addFieldID (Serializer &s) const |
Static Public Member Functions | |
| static STObject | makeInnerObject (SField const &name) |
Public Attributes | |
| friend | Object |
| friend | Object |
Static Protected Member Functions | |
| template<class T> | |
| static STBase * | emplace (std::size_t n, void *buf, T &&val) |
Private Types | |
| enum class | WhichFields : bool { OmitSigningFields = false , WithAllFields = true } |
| using | ListType = std::vector<detail::STVar> |
Private Member Functions | |
| STBase * | copy (std::size_t n, void *buf) const override |
| STBase * | move (std::size_t n, void *buf) override |
| void | add (Serializer &s, WhichFields whichFields) const |
| template<typename T, typename V = std::remove_cvref_t<decltype(std::declval<T>().value())>> | |
| V | getFieldByValue (SField const &field) const |
| template<typename T, typename V> | |
| V const & | getFieldByConstRef (SField const &field, V const &empty) const |
| template<typename T, typename V> | |
| void | setFieldUsingSetValue (SField const &field, V value) |
| template<typename T> | |
| void | setFieldUsingAssignment (SField const &field, T const &value) |
| template<typename T> | |
| T & | peekField (SField const &field) |
Static Private Member Functions | |
| static SOTemplate const & | validationFormat () |
| static std::vector< STBase const * > | getSortedFields (STObject const &objToSort, WhichFields whichFields) |
| static auto & | getCounter () noexcept |
Private Attributes | |
| bool | trusted_ = false |
| std::optional< bool > | valid_ |
| PublicKey const | signingPubKey_ |
| NodeID const | nodeID_ |
| NetClock::time_point | seenTime_ |
| ListType | v_ |
| SOTemplate const * | type_ {} |
| SField const * | fName_ |
Friends | |
| class | detail::STVar |
Definition at line 39 of file STValidation.h.
|
privateinherited |
Definition at line 70 of file STObject.h.
|
inherited |
Definition at line 76 of file STObject.h.
|
strongprivateinherited |
| Enumerator | |
|---|---|
| OmitSigningFields | |
| WithAllFields | |
Definition at line 440 of file STObject.h.
| xrpl::STValidation::STValidation | ( | SerialIter & | sit, |
| LookupNodeID && | lookupNodeID, | ||
| DeserializeOptions | options ) |
Construct a STValidation from a peer from serialized data.
| sit | Iterator over serialized data |
| lookupNodeID | Invocable with signature NodeID(PublicKey const&) used to find the Node ID based on the public key that signed the validation. For manifest based validators, this should be the NodeID of the master public key. |
| options | Options controlling deserialization |
Definition at line 189 of file STValidation.h.
| xrpl::STValidation::STValidation | ( | NetClock::time_point | signTime, |
| PublicKey const & | pk, | ||
| SecretKey const & | sk, | ||
| NodeID const & | nodeID, | ||
| F && | f ) |
Construct, sign and trust a new STValidation issued by this node.
| signTime | When the validation is signed |
| publicKey | The current signing public key |
| secretKey | The current signing secret key |
| nodeID | ID corresponding to node's public master key |
| f | callback function to "fill" the validation with necessary data |
Definition at line 221 of file STValidation.h.
|
nodiscard |
Definition at line 77 of file STValidation.cpp.
|
nodiscard |
Definition at line 83 of file STValidation.cpp.
|
nodiscard |
Definition at line 89 of file STValidation.cpp.
|
nodiscardnoexcept |
Definition at line 95 of file STValidation.cpp.
|
nodiscardnoexcept |
Definition at line 264 of file STValidation.h.
|
nodiscardnoexcept |
Definition at line 270 of file STValidation.h.
|
nodiscardnoexcept |
Whether this validation carries a good signature.
Reports false if the signature cannot be checked at all, so a caller cannot tell that apart from a bad signature. Either way the validation is unusable, and the reason is logged. Only a computed answer is remembered.
Definition at line 101 of file STValidation.cpp.
|
nodiscardnoexcept |
Definition at line 151 of file STValidation.cpp.
|
nodiscardnoexcept |
Definition at line 276 of file STValidation.h.
|
nodiscard |
Definition at line 71 of file STValidation.cpp.
| void xrpl::STValidation::setTrusted | ( | ) |
Definition at line 282 of file STValidation.h.
| void xrpl::STValidation::setUntrusted | ( | ) |
Definition at line 288 of file STValidation.h.
| void xrpl::STValidation::setSeen | ( | NetClock::time_point | s | ) |
Definition at line 294 of file STValidation.h.
|
nodiscard |
Definition at line 163 of file STValidation.cpp.
|
nodiscard |
Definition at line 157 of file STValidation.cpp.
|
nodiscard |
Definition at line 162 of file STValidation.h.
|
staticprivate |
Definition at line 37 of file STValidation.cpp.
|
overrideprivatevirtual |
Reimplemented from xrpl::STObject.
Definition at line 25 of file STValidation.cpp.
|
overrideprivatevirtual |
Reimplemented from xrpl::STObject.
Definition at line 31 of file STValidation.cpp.
Definition at line 79 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 963 of file STObject.h.
|
nodiscardinherited |
Definition at line 969 of file STObject.h.
|
nodiscardinherited |
Definition at line 975 of file STObject.h.
|
inherited |
Definition at line 981 of file STObject.h.
|
inherited |
Definition at line 158 of file STObject.cpp.
|
inherited |
Definition at line 207 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 987 of file STObject.h.
|
inherited |
Definition at line 138 of file STObject.cpp.
|
inherited |
Definition at line 216 of file STObject.cpp.
|
inherited |
Set a field.
if the field already exists, it is replaced.
Definition at line 709 of file STObject.cpp.
|
inherited |
Definition at line 715 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Reimplemented in xrpl::STTx.
Definition at line 111 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Definition at line 351 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Definition at line 117 of file STObject.cpp.
|
overridevirtualinherited |
Reimplemented from xrpl::STBase.
Definition at line 123 of file STObject.cpp.
|
privateinherited |
Definition at line 898 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Reimplemented in xrpl::STTx.
Definition at line 295 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Definition at line 332 of file STObject.cpp.
|
nodiscardoverridevirtualinherited |
Reimplemented from xrpl::STBase.
Reimplemented in xrpl::STTx.
Definition at line 845 of file STObject.cpp.
|
inherited |
Definition at line 993 of file STObject.h.
|
nodiscardinherited |
Definition at line 1002 of file STObject.h.
|
inherited |
Definition at line 1011 of file STObject.h.
|
nodiscardinherited |
Definition at line 1018 of file STObject.h.
|
inherited |
Definition at line 487 of file STObject.cpp.
|
inherited |
Definition at line 499 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 511 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 517 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 375 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 384 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 1024 of file STObject.h.
|
inherited |
Definition at line 1030 of file STObject.h.
|
nodiscardinherited |
Definition at line 1036 of file STObject.h.
|
inherited |
Definition at line 1042 of file STObject.h.
|
nodiscardinherited |
Definition at line 393 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 431 of file STObject.cpp.
Definition at line 409 of file STObject.cpp.
Definition at line 420 of file STObject.cpp.
Definition at line 437 of file STObject.cpp.
Definition at line 448 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 589 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 595 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 601 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 607 of file STObject.cpp.
Definition at line 613 of file STObject.cpp.
Definition at line 619 of file STObject.cpp.
Definition at line 625 of file STObject.cpp.
Definition at line 631 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 637 of file STObject.cpp.
Definition at line 643 of file STObject.cpp.
Definition at line 649 of file STObject.cpp.
Definition at line 657 of file STObject.cpp.
Definition at line 664 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 671 of file STObject.cpp.
Definition at line 678 of file STObject.cpp.
Definition at line 688 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 695 of file STObject.cpp.
Definition at line 702 of file STObject.cpp.
|
inherited |
Get the value of a field.
| A | TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed. |
| STObject::FieldErr | if the field is not present. |
Definition at line 1049 of file STObject.h.
|
inherited |
Get the value of a field as a std::optional.
| An | OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField. |
Definition at line 1056 of file STObject.h.
|
inherited |
Get a modifiable field value.
| A | TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed. |
| STObject::FieldErr | if the field is not present. |
Definition at line 1063 of file STObject.h.
|
inherited |
Return a modifiable field value as std::optional.
| An | OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField. |
Definition at line 1070 of file STObject.h.
|
nodiscardinherited |
Get the value of a field.
| A | TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed. |
| STObject::FieldErr | if the field is not present. |
Definition at line 1077 of file STObject.h.
|
nodiscardinherited |
Get the value of a field as std::optional.
| An | OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField. |
Definition at line 1109 of file STObject.h.
|
inherited |
Get a modifiable field value.
| A | TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed. |
| STObject::FieldErr | if the field is not present. |
Definition at line 1137 of file STObject.h.
|
inherited |
Return a modifiable field value as std::optional.
| An | OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField. |
Definition at line 1144 of file STObject.h.
|
inherited |
Definition at line 731 of file STObject.cpp.
|
inherited |
Definition at line 737 of file STObject.cpp.
|
inherited |
Definition at line 743 of file STObject.cpp.
|
inherited |
Definition at line 749 of file STObject.cpp.
Definition at line 755 of file STObject.cpp.
Definition at line 761 of file STObject.cpp.
Definition at line 767 of file STObject.cpp.
|
inherited |
Definition at line 773 of file STObject.cpp.
Definition at line 791 of file STObject.cpp.
Definition at line 797 of file STObject.cpp.
Definition at line 785 of file STObject.cpp.
Definition at line 803 of file STObject.cpp.
Definition at line 815 of file STObject.cpp.
|
inherited |
Definition at line 809 of file STObject.cpp.
Definition at line 821 of file STObject.cpp.
Definition at line 827 of file STObject.cpp.
|
inherited |
Definition at line 779 of file STObject.cpp.
Definition at line 833 of file STObject.cpp.
Definition at line 839 of file STObject.cpp.
|
inherited |
Definition at line 1151 of file STObject.h.
Definition at line 475 of file STObject.cpp.
Definition at line 481 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 464 of file STObject.cpp.
Definition at line 528 of file STObject.cpp.
|
inherited |
Definition at line 550 of file STObject.cpp.
|
inherited |
Definition at line 565 of file STObject.cpp.
|
inherited |
Definition at line 577 of file STObject.cpp.
Definition at line 583 of file STObject.cpp.
|
nodiscardinherited |
Definition at line 284 of file STObject.cpp.
|
inherited |
Definition at line 858 of file STObject.cpp.
|
inherited |
Definition at line 36 of file STBase.cpp.
|
staticprivateinherited |
Definition at line 926 of file STObject.cpp.
|
privateinherited |
Definition at line 1174 of file STObject.h.
|
privateinherited |
|
inherited |
Definition at line 1201 of file STObject.h.
|
privateinherited |
Definition at line 1227 of file STObject.h.
|
privateinherited |
Definition at line 1250 of file STObject.h.
|
privateinherited |
Definition at line 1271 of file STObject.h.
|
inherited |
|
nodiscardinherited |
|
inherited |
|
nodiscardinherited |
Definition at line 120 of file STBase.cpp.
|
inherited |
Definition at line 126 of file STBase.cpp.
|
staticprotectedinherited |
|
staticprivatenoexceptinherited |
Definition at line 113 of file CountedObject.h.
|
friend |
Definition at line 185 of file STValidation.h.
|
private |
Definition at line 41 of file STValidation.h.
|
mutableprivate |
Definition at line 45 of file STValidation.h.
|
private |
Definition at line 48 of file STValidation.h.
|
private |
Definition at line 52 of file STValidation.h.
|
private |
Definition at line 54 of file STValidation.h.
|
privateinherited |
Definition at line 72 of file STObject.h.
|
privateinherited |
Definition at line 73 of file STObject.h.
|
inherited |
Definition at line 138 of file CountedObject.h.
|
inherited |
Definition at line 138 of file CountedObject.h.