xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol_autogen
transactions
protocol_autogen/transactions/SponsorshipTransfer.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
SponsorshipTransferBuilder
;
17
29
class
SponsorshipTransfer
:
public
TransactionBase
30
{
31
public
:
32
static
constexpr
xrpl::TxType
txType
= ttSPONSORSHIP_TRANSFER;
33
38
explicit
SponsorshipTransfer
(
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 SponsorshipTransfer"
);
45
}
46
}
47
48
// Transaction-specific field getters
49
54
[[nodiscard]]
55
protocol_autogen::Optional<SF_UINT256::type::value_type>
56
getObjectID
()
const
57
{
58
if
(
hasObjectID
())
59
{
60
return
this->
tx_
->at(sfObjectID);
61
}
62
return
std::nullopt;
63
}
64
69
[[nodiscard]]
70
bool
71
hasObjectID
()
const
72
{
73
return
this->
tx_
->isFieldPresent(sfObjectID);
74
}
75
80
[[nodiscard]]
81
protocol_autogen::Optional<SF_ACCOUNT::type::value_type>
82
getSponsee
()
const
83
{
84
if
(
hasSponsee
())
85
{
86
return
this->
tx_
->at(sfSponsee);
87
}
88
return
std::nullopt;
89
}
90
95
[[nodiscard]]
96
bool
97
hasSponsee
()
const
98
{
99
return
this->
tx_
->isFieldPresent(sfSponsee);
100
}
101
};
102
110
class
SponsorshipTransferBuilder
:
public
TransactionBuilderBase
<SponsorshipTransferBuilder>
111
{
112
public
:
119
SponsorshipTransferBuilder
(SF_ACCOUNT::type::value_type account,
120
std::optional<SF_UINT32::type::value_type>
sequence = std::nullopt,
121
std::optional<SF_AMOUNT::type::value_type>
fee = std::nullopt
122
)
123
:
TransactionBuilderBase
<
SponsorshipTransferBuilder
>(ttSPONSORSHIP_TRANSFER, account, sequence, fee)
124
{
125
}
126
132
SponsorshipTransferBuilder
(
std::shared_ptr<STTx const>
tx)
133
{
134
if
(tx->getTxnType() != ttSPONSORSHIP_TRANSFER)
135
{
136
throw
std::runtime_error
(
"Invalid transaction type for SponsorshipTransferBuilder"
);
137
}
138
object_
= *tx;
139
}
140
144
149
SponsorshipTransferBuilder
&
150
setObjectID
(
std::decay_t<typename SF_UINT256::type::value_type>
const
& value)
151
{
152
object_
[sfObjectID] = value;
153
return
*
this
;
154
}
155
160
SponsorshipTransferBuilder
&
161
setSponsee
(
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& value)
162
{
163
object_
[sfSponsee] = value;
164
return
*
this
;
165
}
166
173
SponsorshipTransfer
174
build
(
PublicKey
const
& publicKey,
SecretKey
const
& secretKey)
175
{
176
sign
(publicKey, secretKey);
177
return
SponsorshipTransfer
{
std::make_shared<STTx>
(std::move(
object_
))};
178
}
179
};
180
181
}
// namespace xrpl::transactions
xrpl::PublicKey
A public key.
Definition
PublicKey.h:53
xrpl::SecretKey
A secret key.
Definition
SecretKey.h:24
xrpl::transactions::SponsorshipTransferBuilder
Builder for SponsorshipTransfer transactions.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:111
xrpl::transactions::SponsorshipTransferBuilder::build
SponsorshipTransfer build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the SponsorshipTransfer wrapper.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:174
xrpl::transactions::SponsorshipTransferBuilder::SponsorshipTransferBuilder
SponsorshipTransferBuilder(std::shared_ptr< STTx const > tx)
Construct a SponsorshipTransferBuilder from an existing STTx object.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:132
xrpl::transactions::SponsorshipTransferBuilder::setSponsee
SponsorshipTransferBuilder & setSponsee(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Set sfSponsee (SoeOptional).
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:161
xrpl::transactions::SponsorshipTransferBuilder::SponsorshipTransferBuilder
SponsorshipTransferBuilder(SF_ACCOUNT::type::value_type account, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
Construct a new SponsorshipTransferBuilder with required fields.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:119
xrpl::transactions::SponsorshipTransferBuilder::setObjectID
SponsorshipTransferBuilder & setObjectID(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Transaction-specific field setters.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:150
xrpl::transactions::SponsorshipTransfer
Transaction: SponsorshipTransfer.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:30
xrpl::transactions::SponsorshipTransfer::hasSponsee
bool hasSponsee() const
Check if sfSponsee is present.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:97
xrpl::transactions::SponsorshipTransfer::hasObjectID
bool hasObjectID() const
Check if sfObjectID is present.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:71
xrpl::transactions::SponsorshipTransfer::txType
static constexpr xrpl::TxType txType
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:32
xrpl::transactions::SponsorshipTransfer::getObjectID
protocol_autogen::Optional< SF_UINT256::type::value_type > getObjectID() const
Get sfObjectID (SoeOptional).
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:56
xrpl::transactions::SponsorshipTransfer::SponsorshipTransfer
SponsorshipTransfer(std::shared_ptr< STTx const > tx)
Construct a SponsorshipTransfer transaction wrapper from an existing STTx object.
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:38
xrpl::transactions::SponsorshipTransfer::getSponsee
protocol_autogen::Optional< SF_ACCOUNT::type::value_type > getSponsee() const
Get sfSponsee (SoeOptional).
Definition
protocol_autogen/transactions/SponsorshipTransfer.h:82
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< SponsorshipTransferBuilder >::object_
STObject object_
Definition
TransactionBuilderBase.h:266
xrpl::transactions::TransactionBuilderBase< SponsorshipTransferBuilder >::TransactionBuilderBase
TransactionBuilderBase()=default
xrpl::transactions::TransactionBuilderBase< SponsorshipTransferBuilder >::sign
SponsorshipTransferBuilder & 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