xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol_autogen
transactions
protocol_autogen/transactions/VaultDeposit.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
VaultDepositBuilder
;
17
29
class
VaultDeposit
:
public
TransactionBase
30
{
31
public
:
32
static
constexpr
xrpl::TxType
txType
= ttVAULT_DEPOSIT;
33
38
explicit
VaultDeposit
(
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 VaultDeposit"
);
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
66
[[nodiscard]]
67
SF_AMOUNT::type::value_type
68
getAmount
()
const
69
{
70
return
this->
tx_
->at(sfAmount);
71
}
72
};
73
81
class
VaultDepositBuilder
:
public
TransactionBuilderBase
<VaultDepositBuilder>
82
{
83
public
:
92
VaultDepositBuilder
(SF_ACCOUNT::type::value_type account,
93
std::decay_t<typename SF_UINT256::type::value_type>
const
& vaultID,
std::decay_t<typename SF_AMOUNT::type::value_type>
const
& amount,
std::optional<SF_UINT32::type::value_type>
sequence = std::nullopt,
94
std::optional<SF_AMOUNT::type::value_type>
fee = std::nullopt
95
)
96
:
TransactionBuilderBase
<
VaultDepositBuilder
>(ttVAULT_DEPOSIT, account, sequence, fee)
97
{
98
setVaultID
(vaultID);
99
setAmount
(amount);
100
}
101
107
VaultDepositBuilder
(
std::shared_ptr<STTx const>
tx)
108
{
109
if
(tx->getTxnType() != ttVAULT_DEPOSIT)
110
{
111
throw
std::runtime_error
(
"Invalid transaction type for VaultDepositBuilder"
);
112
}
113
object_
= *tx;
114
}
115
119
124
VaultDepositBuilder
&
125
setVaultID
(
std::decay_t<typename SF_UINT256::type::value_type>
const
& value)
126
{
127
object_
[sfVaultID] = value;
128
return
*
this
;
129
}
130
136
VaultDepositBuilder
&
137
setAmount
(
std::decay_t<typename SF_AMOUNT::type::value_type>
const
& value)
138
{
139
object_
[sfAmount] = value;
140
return
*
this
;
141
}
142
149
VaultDeposit
150
build
(
PublicKey
const
& publicKey,
SecretKey
const
& secretKey)
151
{
152
sign
(publicKey, secretKey);
153
return
VaultDeposit
{
std::make_shared<STTx>
(std::move(
object_
))};
154
}
155
};
156
157
}
// 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< VaultDepositBuilder >::object_
STObject object_
Definition
TransactionBuilderBase.h:266
xrpl::transactions::TransactionBuilderBase< VaultDepositBuilder >::TransactionBuilderBase
TransactionBuilderBase()=default
xrpl::transactions::TransactionBuilderBase< VaultDepositBuilder >::sign
VaultDepositBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
Definition
TransactionBuilderBase.h:248
xrpl::transactions::VaultDepositBuilder
Builder for VaultDeposit transactions.
Definition
protocol_autogen/transactions/VaultDeposit.h:82
xrpl::transactions::VaultDepositBuilder::setVaultID
VaultDepositBuilder & setVaultID(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Transaction-specific field setters.
Definition
protocol_autogen/transactions/VaultDeposit.h:125
xrpl::transactions::VaultDepositBuilder::build
VaultDeposit build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the VaultDeposit wrapper.
Definition
protocol_autogen/transactions/VaultDeposit.h:150
xrpl::transactions::VaultDepositBuilder::VaultDepositBuilder
VaultDepositBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_UINT256::type::value_type > const &vaultID, 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 VaultDepositBuilder with required fields.
Definition
protocol_autogen/transactions/VaultDeposit.h:92
xrpl::transactions::VaultDepositBuilder::VaultDepositBuilder
VaultDepositBuilder(std::shared_ptr< STTx const > tx)
Construct a VaultDepositBuilder from an existing STTx object.
Definition
protocol_autogen/transactions/VaultDeposit.h:107
xrpl::transactions::VaultDepositBuilder::setAmount
VaultDepositBuilder & setAmount(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Set sfAmount (SoeRequired).
Definition
protocol_autogen/transactions/VaultDeposit.h:137
xrpl::transactions::VaultDeposit
Transaction: VaultDeposit.
Definition
protocol_autogen/transactions/VaultDeposit.h:30
xrpl::transactions::VaultDeposit::txType
static constexpr xrpl::TxType txType
Definition
protocol_autogen/transactions/VaultDeposit.h:32
xrpl::transactions::VaultDeposit::getAmount
SF_AMOUNT::type::value_type getAmount() const
Get sfAmount (SoeRequired).
Definition
protocol_autogen/transactions/VaultDeposit.h:68
xrpl::transactions::VaultDeposit::VaultDeposit
VaultDeposit(std::shared_ptr< STTx const > tx)
Construct a VaultDeposit transaction wrapper from an existing STTx object.
Definition
protocol_autogen/transactions/VaultDeposit.h:38
xrpl::transactions::VaultDeposit::getVaultID
SF_UINT256::type::value_type getVaultID() const
Get sfVaultID (SoeRequired).
Definition
protocol_autogen/transactions/VaultDeposit.h:56
std::decay_t
std::make_shared
T make_shared(T... args)
std
STL namespace.
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