rippled
Loading...
Searching...
No Matches
protocol_autogen/transactions/CheckCash.h
1// This file is auto-generated. Do not edit.
2#pragma once
3
4#include <xrpl/protocol/STTx.h>
5#include <xrpl/protocol/STParsedJSON.h>
6#include <xrpl/protocol/jss.h>
7#include <xrpl/protocol_autogen/TransactionBase.h>
8#include <xrpl/protocol_autogen/TransactionBuilderBase.h>
9#include <xrpl/json/json_value.h>
10
11#include <stdexcept>
12#include <optional>
13
14namespace xrpl::transactions {
15
16class CheckCashBuilder;
17
30{
31public:
32 static constexpr xrpl::TxType txType = ttCHECK_CASH;
33
39 : TransactionBase(std::move(tx))
40 {
41 // Verify transaction type
42 if (tx_->getTxnType() != txType)
43 {
44 throw std::runtime_error("Invalid transaction type for CheckCash");
45 }
46 }
47
48 // Transaction-specific field getters
49
54 [[nodiscard]]
55 SF_UINT256::type::value_type
56 getCheckID() const
57 {
58 return this->tx_->at(sfCheckID);
59 }
60
65 [[nodiscard]]
67 getAmount() const
68 {
69 if (hasAmount())
70 {
71 return this->tx_->at(sfAmount);
72 }
73 return std::nullopt;
74 }
75
80 [[nodiscard]]
81 bool
82 hasAmount() const
83 {
84 return this->tx_->isFieldPresent(sfAmount);
85 }
86
91 [[nodiscard]]
94 {
95 if (hasDeliverMin())
96 {
97 return this->tx_->at(sfDeliverMin);
98 }
99 return std::nullopt;
100 }
101
106 [[nodiscard]]
107 bool
109 {
110 return this->tx_->isFieldPresent(sfDeliverMin);
111 }
112};
113
121class CheckCashBuilder : public TransactionBuilderBase<CheckCashBuilder>
122{
123public:
131 CheckCashBuilder(SF_ACCOUNT::type::value_type account,
134)
135 : TransactionBuilderBase<CheckCashBuilder>(ttCHECK_CASH, account, sequence, fee)
136 {
137 setCheckID(checkID);
138 }
139
146 {
147 if (tx->getTxnType() != ttCHECK_CASH)
148 {
149 throw std::runtime_error("Invalid transaction type for CheckCashBuilder");
150 }
151 object_ = *tx;
152 }
153
162 {
163 object_[sfCheckID] = value;
164 return *this;
165 }
166
173 {
174 object_[sfAmount] = value;
175 return *this;
176 }
177
184 {
185 object_[sfDeliverMin] = value;
186 return *this;
187 }
188
196 build(PublicKey const& publicKey, SecretKey const& secretKey)
197 {
198 sign(publicKey, secretKey);
199 return CheckCash{std::make_shared<STTx>(std::move(object_))};
200 }
201};
202
203} // namespace xrpl::transactions
A public key.
Definition PublicKey.h:42
A secret key.
Definition SecretKey.h:18
CheckCashBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_UINT256::type::value_type > const &checkID, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
Construct a new CheckCashBuilder with required fields.
CheckCashBuilder & setDeliverMin(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Set sfDeliverMin (soeOPTIONAL)
CheckCashBuilder & setAmount(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Set sfAmount (soeOPTIONAL)
CheckCash build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the CheckCash wrapper.
CheckCashBuilder & setCheckID(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Transaction-specific field setters.
CheckCashBuilder(std::shared_ptr< STTx const > tx)
Construct a CheckCashBuilder from an existing STTx object.
protocol_autogen::Optional< SF_AMOUNT::type::value_type > getAmount() const
Get sfAmount (soeOPTIONAL)
protocol_autogen::Optional< SF_AMOUNT::type::value_type > getDeliverMin() const
Get sfDeliverMin (soeOPTIONAL)
bool hasDeliverMin() const
Check if sfDeliverMin is present.
CheckCash(std::shared_ptr< STTx const > tx)
Construct a CheckCash transaction wrapper from an existing STTx object.
SF_UINT256::type::value_type getCheckID() const
Get sfCheckID (soeREQUIRED)
bool hasAmount() const
Check if sfAmount is present.
Base class for all transaction wrapper types.
std::shared_ptr< STTx const > tx_
The underlying transaction object being wrapped.
Base class for all transaction builders.
CheckCashBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
Sign the transaction with the given keys.
T is_same_v
STL namespace.
TxType
Transaction type identifiers.
Definition TxFormats.h:39