xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol_autogen
transactions
protocol_autogen/transactions/VaultClawback.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
VaultClawbackBuilder
;
17
29
class
VaultClawback
:
public
TransactionBase
30
{
31
public
:
32
static
constexpr
xrpl::TxType
txType
= ttVAULT_CLAWBACK;
33
38
explicit
VaultClawback
(
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 VaultClawback"
);
45
}
46
}
47
48
// Transaction-specific field getters
49
54
[[nodiscard]]
55
SF_UINT256::type::value_type
56
getVaultID
()
const
57
{
58
return
this->
tx_
->at(sfVaultID);
59
}
60
65
[[nodiscard]]
66
SF_ACCOUNT::type::value_type
67
getHolder
()
const
68
{
69
return
this->
tx_
->at(sfHolder);
70
}
71
77
[[nodiscard]]
78
protocol_autogen::Optional<SF_AMOUNT::type::value_type>
79
getAmount
()
const
80
{
81
if
(
hasAmount
())
82
{
83
return
this->
tx_
->at(sfAmount);
84
}
85
return
std::nullopt;
86
}
87
92
[[nodiscard]]
93
bool
94
hasAmount
()
const
95
{
96
return
this->
tx_
->isFieldPresent(sfAmount);
97
}
98
};
99
107
class
VaultClawbackBuilder
:
public
TransactionBuilderBase
<VaultClawbackBuilder>
108
{
109
public
:
118
VaultClawbackBuilder
(SF_ACCOUNT::type::value_type account,
119
std::decay_t<typename SF_UINT256::type::value_type>
const
& vaultID,
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& holder,
std::optional<SF_UINT32::type::value_type>
sequence = std::nullopt,
120
std::optional<SF_AMOUNT::type::value_type>
fee = std::nullopt
121
)
122
:
TransactionBuilderBase
<
VaultClawbackBuilder
>(ttVAULT_CLAWBACK, account, sequence, fee)
123
{
124
setVaultID
(vaultID);
125
setHolder
(holder);
126
}
127
133
VaultClawbackBuilder
(
std::shared_ptr<STTx const>
tx)
134
{
135
if
(tx->getTxnType() != ttVAULT_CLAWBACK)
136
{
137
throw
std::runtime_error
(
"Invalid transaction type for VaultClawbackBuilder"
);
138
}
139
object_
= *tx;
140
}
141
145
150
VaultClawbackBuilder
&
151
setVaultID
(
std::decay_t<typename SF_UINT256::type::value_type>
const
& value)
152
{
153
object_
[sfVaultID] = value;
154
return
*
this
;
155
}
156
161
VaultClawbackBuilder
&
162
setHolder
(
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& value)
163
{
164
object_
[sfHolder] = value;
165
return
*
this
;
166
}
167
173
VaultClawbackBuilder
&
174
setAmount
(
std::decay_t<typename SF_AMOUNT::type::value_type>
const
& value)
175
{
176
object_
[sfAmount] = value;
177
return
*
this
;
178
}
179
186
VaultClawback
187
build
(
PublicKey
const
& publicKey,
SecretKey
const
& secretKey)
188
{
189
sign
(publicKey, secretKey);
190
return
VaultClawback
{
std::make_shared<STTx>
(std::move(
object_
))};
191
}
192
};
193
194
}
// namespace xrpl::transactions
xrpl::PublicKey
A public key.
Definition
PublicKey.h:53
xrpl::SecretKey
A secret key.
Definition
SecretKey.h:24
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< VaultClawbackBuilder >::object_
STObject object_
Definition
TransactionBuilderBase.h:266
xrpl::transactions::TransactionBuilderBase< VaultClawbackBuilder >::TransactionBuilderBase
TransactionBuilderBase()=default
xrpl::transactions::TransactionBuilderBase< VaultClawbackBuilder >::sign
VaultClawbackBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
Definition
TransactionBuilderBase.h:248
xrpl::transactions::VaultClawbackBuilder
Builder for VaultClawback transactions.
Definition
protocol_autogen/transactions/VaultClawback.h:108
xrpl::transactions::VaultClawbackBuilder::setAmount
VaultClawbackBuilder & setAmount(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Set sfAmount (SoeOptional).
Definition
protocol_autogen/transactions/VaultClawback.h:174
xrpl::transactions::VaultClawbackBuilder::setVaultID
VaultClawbackBuilder & setVaultID(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Transaction-specific field setters.
Definition
protocol_autogen/transactions/VaultClawback.h:151
xrpl::transactions::VaultClawbackBuilder::VaultClawbackBuilder
VaultClawbackBuilder(std::shared_ptr< STTx const > tx)
Construct a VaultClawbackBuilder from an existing STTx object.
Definition
protocol_autogen/transactions/VaultClawback.h:133
xrpl::transactions::VaultClawbackBuilder::setHolder
VaultClawbackBuilder & setHolder(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Set sfHolder (SoeRequired).
Definition
protocol_autogen/transactions/VaultClawback.h:162
xrpl::transactions::VaultClawbackBuilder::VaultClawbackBuilder
VaultClawbackBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_UINT256::type::value_type > const &vaultID, std::decay_t< typename SF_ACCOUNT::type::value_type > const &holder, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
Construct a new VaultClawbackBuilder with required fields.
Definition
protocol_autogen/transactions/VaultClawback.h:118
xrpl::transactions::VaultClawbackBuilder::build
VaultClawback build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the VaultClawback wrapper.
Definition
protocol_autogen/transactions/VaultClawback.h:187
xrpl::transactions::VaultClawback
Transaction: VaultClawback.
Definition
protocol_autogen/transactions/VaultClawback.h:30
xrpl::transactions::VaultClawback::txType
static constexpr xrpl::TxType txType
Definition
protocol_autogen/transactions/VaultClawback.h:32
xrpl::transactions::VaultClawback::getHolder
SF_ACCOUNT::type::value_type getHolder() const
Get sfHolder (SoeRequired).
Definition
protocol_autogen/transactions/VaultClawback.h:67
xrpl::transactions::VaultClawback::VaultClawback
VaultClawback(std::shared_ptr< STTx const > tx)
Construct a VaultClawback transaction wrapper from an existing STTx object.
Definition
protocol_autogen/transactions/VaultClawback.h:38
xrpl::transactions::VaultClawback::getAmount
protocol_autogen::Optional< SF_AMOUNT::type::value_type > getAmount() const
Get sfAmount (SoeOptional).
Definition
protocol_autogen/transactions/VaultClawback.h:79
xrpl::transactions::VaultClawback::getVaultID
SF_UINT256::type::value_type getVaultID() const
Get sfVaultID (SoeRequired).
Definition
protocol_autogen/transactions/VaultClawback.h:56
xrpl::transactions::VaultClawback::hasAmount
bool hasAmount() const
Check if sfAmount is present.
Definition
protocol_autogen/transactions/VaultClawback.h:94
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