Class describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed. More...
Public Types | |
| enum | Category { normal = 0, blocker } |
| Describes how the transaction affects subsequent transactions. More... | |
Public Member Functions | |
| TxConsequences (NotTEC pfresult) | |
| TxConsequences (STTx const &tx) | |
| Constructor if the STTx has no notable consequences for the TxQ. More... | |
| TxConsequences (STTx const &tx, Category category) | |
| Constructor for a blocker. More... | |
| TxConsequences (STTx const &tx, XRPAmount potentialSpend) | |
| Constructor for an STTx that may consume more XRP than the fee. More... | |
| TxConsequences (STTx const &tx, std::uint32_t sequencesConsumed) | |
| Constructor for an STTx that consumes more than the usual sequences. More... | |
| TxConsequences (TxConsequences const &)=default | |
| Copy constructor. More... | |
| TxConsequences & | operator= (TxConsequences const &)=default |
| Copy assignment operator. More... | |
| TxConsequences (TxConsequences &&)=default | |
| Move constructor. More... | |
| TxConsequences & | operator= (TxConsequences &&)=default |
| Move assignment operator. More... | |
| XRPAmount | fee () const |
| Fee. More... | |
| XRPAmount const & | potentialSpend () const |
| Potential Spend. More... | |
| SeqProxy | seqProxy () const |
| SeqProxy. More... | |
| std::uint32_t | sequencesConsumed () const |
| Sequences consumed. More... | |
| bool | isBlocker () const |
| Returns true if the transaction is a blocker. More... | |
| SeqProxy | followingSeq () const |
Private Attributes | |
| bool | isBlocker_ |
| Describes how the transaction affects subsequent transactions. More... | |
| XRPAmount | fee_ |
| Transaction fee. More... | |
| XRPAmount | potentialSpend_ |
| Does NOT include the fee. More... | |
| SeqProxy | seqProx_ |
| SeqProxy of transaction. More... | |
| std::uint32_t | sequencesConsumed_ |
| Number of sequences consumed. More... | |
Detailed Description
Class describing the consequences to the account of applying a transaction if the transaction consumes the maximum XRP allowed.
Definition at line 45 of file applySteps.h.
Member Enumeration Documentation
◆ Category
Describes how the transaction affects subsequent transactions.
| Enumerator | |
|---|---|
| normal | Moves currency around, creates offers, etc. |
| blocker | Affects the ability of subsequent transactions to claim a fee. Eg. |
Definition at line 50 of file applySteps.h.
Constructor & Destructor Documentation
◆ TxConsequences() [1/7]
|
explicit |
Definition at line 320 of file applySteps.cpp.
◆ TxConsequences() [2/7]
|
explicit |
Constructor if the STTx has no notable consequences for the TxQ.
Definition at line 330 of file applySteps.cpp.
◆ TxConsequences() [3/7]
Constructor for a blocker.
Definition at line 341 of file applySteps.cpp.
◆ TxConsequences() [4/7]
Constructor for an STTx that may consume more XRP than the fee.
Definition at line 347 of file applySteps.cpp.
◆ TxConsequences() [5/7]
| ripple::TxConsequences::TxConsequences | ( | STTx const & | tx, |
| std::uint32_t | sequencesConsumed | ||
| ) |
Constructor for an STTx that consumes more than the usual sequences.
Definition at line 353 of file applySteps.cpp.
◆ TxConsequences() [6/7]
|
default |
Copy constructor.
◆ TxConsequences() [7/7]
|
default |
Move constructor.
Member Function Documentation
◆ operator=() [1/2]
|
default |
Copy assignment operator.
◆ operator=() [2/2]
|
default |
Move assignment operator.
◆ fee()
| XRPAmount ripple::TxConsequences::fee | ( | ) | const |
Fee.
Definition at line 101 of file applySteps.h.
◆ potentialSpend()
| XRPAmount const& ripple::TxConsequences::potentialSpend | ( | ) | const |
Potential Spend.
Definition at line 108 of file applySteps.h.
◆ seqProxy()
| SeqProxy ripple::TxConsequences::seqProxy | ( | ) | const |
Definition at line 115 of file applySteps.h.
◆ sequencesConsumed()
| std::uint32_t ripple::TxConsequences::sequencesConsumed | ( | ) | const |
Sequences consumed.
Definition at line 122 of file applySteps.h.
◆ isBlocker()
| bool ripple::TxConsequences::isBlocker | ( | ) | const |
Returns true if the transaction is a blocker.
Definition at line 129 of file applySteps.h.
◆ followingSeq()
| SeqProxy ripple::TxConsequences::followingSeq | ( | ) | const |
Definition at line 136 of file applySteps.h.
Member Data Documentation
◆ isBlocker_
|
private |
Describes how the transaction affects subsequent transactions.
Definition at line 61 of file applySteps.h.
◆ fee_
|
private |
Transaction fee.
Definition at line 63 of file applySteps.h.
◆ potentialSpend_
|
private |
Does NOT include the fee.
Definition at line 65 of file applySteps.h.
◆ seqProx_
|
private |
SeqProxy of transaction.
Definition at line 67 of file applySteps.h.
◆ sequencesConsumed_
|
private |
Number of sequences consumed.
Definition at line 69 of file applySteps.h.
