xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol_autogen
transactions
protocol_autogen/transactions/Clawback.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
14
namespace
xrpl::transactions
{
15
16
class
ClawbackBuilder
;
17
29
class
Clawback
:
public
TransactionBase
30
{
31
public
:
32
static
constexpr
xrpl::TxType
txType
= ttCLAWBACK;
33
38
explicit
Clawback
(
std::shared_ptr<STTx const>
tx)
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 Clawback"
);
45
}
46
}
47
48
// Transaction-specific field getters
49
55
[[nodiscard]]
56
SF_AMOUNT::type::value_type
57
getAmount
()
const
58
{
59
return
this->
tx_
->at(sfAmount);
60
}
61
66
[[nodiscard]]
67
protocol_autogen::Optional<SF_ACCOUNT::type::value_type>
68
getHolder
()
const
69
{
70
if
(
hasHolder
())
71
{
72
return
this->
tx_
->at(sfHolder);
73
}
74
return
std::nullopt;
75
}
76
81
[[nodiscard]]
82
bool
83
hasHolder
()
const
84
{
85
return
this->
tx_
->isFieldPresent(sfHolder);
86
}
87
};
88
96
class
ClawbackBuilder
:
public
TransactionBuilderBase
<ClawbackBuilder>
97
{
98
public
:
106
ClawbackBuilder
(SF_ACCOUNT::type::value_type account,
107
std::decay_t<typename SF_AMOUNT::type::value_type>
const
& amount,
std::optional<SF_UINT32::type::value_type>
sequence = std::nullopt,
108
std::optional<SF_AMOUNT::type::value_type>
fee = std::nullopt
109
)
110
:
TransactionBuilderBase
<
ClawbackBuilder
>(ttCLAWBACK, account, sequence, fee)
111
{
112
setAmount
(amount);
113
}
114
120
ClawbackBuilder
(
std::shared_ptr<STTx const>
tx)
121
{
122
if
(tx->getTxnType() != ttCLAWBACK)
123
{
124
throw
std::runtime_error
(
"Invalid transaction type for ClawbackBuilder"
);
125
}
126
object_
= *tx;
127
}
128
132
138
ClawbackBuilder
&
139
setAmount
(
std::decay_t<typename SF_AMOUNT::type::value_type>
const
& value)
140
{
141
object_
[sfAmount] = value;
142
return
*
this
;
143
}
144
149
ClawbackBuilder
&
150
setHolder
(
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& value)
151
{
152
object_
[sfHolder] = value;
153
return
*
this
;
154
}
155
162
Clawback
163
build
(
PublicKey
const
& publicKey,
SecretKey
const
& secretKey)
164
{
165
sign
(publicKey, secretKey);
166
return
Clawback
{
std::make_shared<STTx>
(std::move(
object_
))};
167
}
168
};
169
170
}
// namespace xrpl::transactions
xrpl::PublicKey
A public key.
Definition
PublicKey.h:53
xrpl::SecretKey
A secret key.
Definition
SecretKey.h:24
xrpl::transactions::ClawbackBuilder
Builder for Clawback transactions.
Definition
protocol_autogen/transactions/Clawback.h:97
xrpl::transactions::ClawbackBuilder::setHolder
ClawbackBuilder & setHolder(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Set sfHolder (SoeOptional).
Definition
protocol_autogen/transactions/Clawback.h:150
xrpl::transactions::ClawbackBuilder::setAmount
ClawbackBuilder & setAmount(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Transaction-specific field setters.
Definition
protocol_autogen/transactions/Clawback.h:139
xrpl::transactions::ClawbackBuilder::ClawbackBuilder
ClawbackBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_AMOUNT::type::value_type > const &amount, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
Construct a new ClawbackBuilder with required fields.
Definition
protocol_autogen/transactions/Clawback.h:106
xrpl::transactions::ClawbackBuilder::ClawbackBuilder
ClawbackBuilder(std::shared_ptr< STTx const > tx)
Construct a ClawbackBuilder from an existing STTx object.
Definition
protocol_autogen/transactions/Clawback.h:120
xrpl::transactions::ClawbackBuilder::build
Clawback build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the Clawback wrapper.
Definition
protocol_autogen/transactions/Clawback.h:163
xrpl::transactions::Clawback
Transaction: Clawback.
Definition
protocol_autogen/transactions/Clawback.h:30
xrpl::transactions::Clawback::txType
static constexpr xrpl::TxType txType
Definition
protocol_autogen/transactions/Clawback.h:32
xrpl::transactions::Clawback::hasHolder
bool hasHolder() const
Check if sfHolder is present.
Definition
protocol_autogen/transactions/Clawback.h:83
xrpl::transactions::Clawback::getAmount
SF_AMOUNT::type::value_type getAmount() const
Get sfAmount (SoeRequired).
Definition
protocol_autogen/transactions/Clawback.h:57
xrpl::transactions::Clawback::getHolder
protocol_autogen::Optional< SF_ACCOUNT::type::value_type > getHolder() const
Get sfHolder (SoeOptional).
Definition
protocol_autogen/transactions/Clawback.h:68
xrpl::transactions::Clawback::Clawback
Clawback(std::shared_ptr< STTx const > tx)
Construct a Clawback transaction wrapper from an existing STTx object.
Definition
protocol_autogen/transactions/Clawback.h:38
xrpl::transactions::TransactionBase::tx_
std::shared_ptr< STTx const > tx_
The underlying transaction object being wrapped.
Definition
TransactionBase.h:456
xrpl::transactions::TransactionBase::TransactionBase
TransactionBase(std::shared_ptr< STTx const > tx)
Construct a transaction wrapper from an existing STTx object.
Definition
TransactionBase.h:31
xrpl::transactions::TransactionBuilderBase< ClawbackBuilder >::object_
STObject object_
Definition
TransactionBuilderBase.h:266
xrpl::transactions::TransactionBuilderBase< ClawbackBuilder >::TransactionBuilderBase
TransactionBuilderBase()=default
xrpl::transactions::TransactionBuilderBase< ClawbackBuilder >::sign
ClawbackBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
Definition
TransactionBuilderBase.h:248
std::decay_t
std::make_shared
T make_shared(T... args)
std
STL namespace.
xrpl::protocol_autogen::Optional
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
xrpl::transactions
Definition
TransactionBase.h:15
xrpl::TxType
TxType
Transaction type identifiers.
Definition
TxFormats.h:45
optional
std::runtime_error
std::shared_ptr
stdexcept
Generated by
1.17.0