xrpld
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
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
66 [[nodiscard]]
68 getAmount() const
69 {
70 if (hasAmount())
71 {
72 return this->tx_->at(sfAmount);
73 }
74 return std::nullopt;
75 }
76
81 [[nodiscard]]
82 bool
83 hasAmount() const
84 {
85 return this->tx_->isFieldPresent(sfAmount);
86 }
87
93 [[nodiscard]]
96 {
97 if (hasDeliverMin())
98 {
99 return this->tx_->at(sfDeliverMin);
100 }
101 return std::nullopt;
102 }
103
108 [[nodiscard]]
109 bool
111 {
112 return this->tx_->isFieldPresent(sfDeliverMin);
113 }
114};
115
123class CheckCashBuilder : public TransactionBuilderBase<CheckCashBuilder>
124{
125public:
133 CheckCashBuilder(SF_ACCOUNT::type::value_type account,
136)
137 : TransactionBuilderBase<CheckCashBuilder>(ttCHECK_CASH, account, sequence, fee)
138 {
139 setCheckID(checkID);
140 }
141
148 {
149 if (tx->getTxnType() != ttCHECK_CASH)
150 {
151 throw std::runtime_error("Invalid transaction type for CheckCashBuilder");
152 }
153 object_ = *tx;
154 }
155
157
164 {
165 object_[sfCheckID] = value;
166 return *this;
167 }
168
176 {
177 object_[sfAmount] = value;
178 return *this;
179 }
180
188 {
189 object_[sfDeliverMin] = value;
190 return *this;
191 }
192
200 build(PublicKey const& publicKey, SecretKey const& secretKey)
201 {
202 sign(publicKey, secretKey);
203 return CheckCash{std::make_shared<STTx>(std::move(object_))};
204 }
205};
206
207} // 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.
std::shared_ptr< STTx const > tx_
The underlying transaction object being wrapped.
TransactionBase(std::shared_ptr< STTx const > tx)
Construct a transaction wrapper from an existing STTx object.
CheckCashBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
T make_shared(T... args)
STL namespace.
std::conditional_t< std::is_reference_v< ValueType >, std::optional< std::reference_wrapper< std::remove_reference_t< ValueType > > >, std::optional< ValueType > > Optional
Definition Utils.h:9
TxType
Transaction type identifiers.
Definition TxFormats.h:41