xrpld
Loading...
Searching...
No Matches
ProposalHelpers.h
1#pragma once
2
3#include <xrpl/beast/utility/Journal.h>
4#include <xrpl/ledger/ApplyView.h>
5#include <xrpl/ledger/ReadView.h>
6#include <xrpl/protocol/SField.h>
7#include <xrpl/protocol/STLedgerEntry.h>
8#include <xrpl/protocol/STObject.h>
9#include <xrpl/protocol/STTx.h>
10#include <xrpl/protocol/TER.h>
11#include <xrpl/protocol/TxFormats.h>
12
13#include <cstdint>
14#include <optional>
15
16namespace xrpl::proposal {
17
22
29
33inline std::uint32_t
34proposalOwnerCount(STObject const& proposedTx)
35{
36 return proposedTx.getFieldU16(sfTransactionType) == ttBATCH ? kBatchProposalOwnerCount
38}
39
54bool
55isValidProposalTxnType(STObject const& proposedTx);
56
64inline bool
65hasSignatureField(STObject const& proposedTx)
66{
67 return proposedTx.isFieldPresent(sfTxnSignature) || proposedTx.isFieldPresent(sfSigners) ||
68 proposedTx.isFieldPresent(sfBatchSigners) ||
69 proposedTx.isFieldPresent(sfCounterpartySignature) ||
70 proposedTx.isFieldPresent(sfSponsorSignature);
71}
72
78inline bool
80{
81 return proposedTx.isFieldPresent(sfSigningPubKey) &&
82 proposedTx.getFieldVL(sfSigningPubKey).empty();
83}
84
103bool
105 ReadView const& view,
107 STObject const& proposedTx);
108
129TER
130deleteProposal(ApplyView& view, SLE::pointer const& sleProposal, beast::Journal j);
131
155bool
156payloadMatches(STObject const& proposedTx, STObject const& tx);
157
171bool
172canConsumeTicket(ReadView const& view, STTx const& tx);
173
174} // namespace xrpl::proposal
A generic endpoint for log messages.
Definition Journal.h:44
Writeable view to a ledger, for applying a transaction.
Definition ApplyView.h:141
A view into a ledger.
Definition ReadView.h:41
std::shared_ptr< STLedgerEntry > pointer
Blob getFieldVL(SField const &field) const
Definition STObject.cpp:649
bool isFieldPresent(SField const &field) const
Definition STObject.cpp:464
std::uint16_t getFieldU16(SField const &field) const
Definition STObject.cpp:595
T empty(T... args)
bool isTerminal(ReadView const &view, std::optional< std::uint32_t > expiration, STObject const &proposedTx)
Whether the proposal is terminal (On-Chain Cosigner spec ยง4.5).
std::uint32_t proposalOwnerCount(STObject const &proposedTx)
Owner-reserve increments held by a proposal of the given transaction.
bool hasSignatureField(STObject const &proposedTx)
Whether the proposed transaction carries any signature field.
bool payloadMatches(STObject const &proposedTx, STObject const &tx)
Whether tx carries the same payload as a proposal's stored ProposedTransaction (On-Chain Cosigner spe...
bool canConsumeTicket(ReadView const &view, STTx const &tx)
Whether tx may consume its Ticket.
constexpr std::uint32_t kBatchProposalOwnerCount
Owner-reserve increments held by a proposal of a Batch transaction.
bool isValidProposalTxnType(STObject const &proposedTx)
Whether the proposed transaction is independently submittable through the ordinary multi-sign path: n...
constexpr std::uint32_t kProposalOwnerCount
Owner-reserve increments held by a proposal of an ordinary transaction.
TER deleteProposal(ApplyView &view, SLE::pointer const &sleProposal, beast::Journal j)
Delete a TransactionProposal ledger entry.
bool hasEmptySigningPubKey(STObject const &proposedTx)
Whether the proposed transaction's SigningPubKey is present and empty, as unsigned canonical form req...
TERSubset< CanCvtToTER > TER
Definition TER.h:657