xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
include
xrpl
protocol_autogen
transactions
protocol_autogen/transactions/EscrowCancel.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
EscrowCancelBuilder
;
17
29
class
EscrowCancel
:
public
TransactionBase
30
{
31
public
:
32
static
constexpr
xrpl::TxType
txType
= ttESCROW_CANCEL;
33
38
explicit
EscrowCancel
(
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 EscrowCancel"
);
45
}
46
}
47
48
// Transaction-specific field getters
49
54
[[nodiscard]]
55
SF_ACCOUNT::type::value_type
56
getOwner
()
const
57
{
58
return
this->
tx_
->at(sfOwner);
59
}
60
65
[[nodiscard]]
66
SF_UINT32::type::value_type
67
getOfferSequence
()
const
68
{
69
return
this->
tx_
->at(sfOfferSequence);
70
}
71
};
72
80
class
EscrowCancelBuilder
:
public
TransactionBuilderBase
<EscrowCancelBuilder>
81
{
82
public
:
91
EscrowCancelBuilder
(SF_ACCOUNT::type::value_type account,
92
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& owner,
std::decay_t<typename SF_UINT32::type::value_type>
const
& offerSequence,
std::optional<SF_UINT32::type::value_type>
sequence = std::nullopt,
93
std::optional<SF_AMOUNT::type::value_type>
fee = std::nullopt
94
)
95
:
TransactionBuilderBase
<
EscrowCancelBuilder
>(ttESCROW_CANCEL, account, sequence, fee)
96
{
97
setOwner
(owner);
98
setOfferSequence
(offerSequence);
99
}
100
106
EscrowCancelBuilder
(
std::shared_ptr<STTx const>
tx)
107
{
108
if
(tx->getTxnType() != ttESCROW_CANCEL)
109
{
110
throw
std::runtime_error
(
"Invalid transaction type for EscrowCancelBuilder"
);
111
}
112
object_
= *tx;
113
}
114
118
123
EscrowCancelBuilder
&
124
setOwner
(
std::decay_t<typename SF_ACCOUNT::type::value_type>
const
& value)
125
{
126
object_
[sfOwner] = value;
127
return
*
this
;
128
}
129
134
EscrowCancelBuilder
&
135
setOfferSequence
(
std::decay_t<typename SF_UINT32::type::value_type>
const
& value)
136
{
137
object_
[sfOfferSequence] = value;
138
return
*
this
;
139
}
140
147
EscrowCancel
148
build
(
PublicKey
const
& publicKey,
SecretKey
const
& secretKey)
149
{
150
sign
(publicKey, secretKey);
151
return
EscrowCancel
{
std::make_shared<STTx>
(std::move(
object_
))};
152
}
153
};
154
155
}
// namespace xrpl::transactions
xrpl::PublicKey
A public key.
Definition
PublicKey.h:53
xrpl::SecretKey
A secret key.
Definition
SecretKey.h:24
xrpl::transactions::EscrowCancelBuilder
Builder for EscrowCancel transactions.
Definition
protocol_autogen/transactions/EscrowCancel.h:81
xrpl::transactions::EscrowCancelBuilder::build
EscrowCancel build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the EscrowCancel wrapper.
Definition
protocol_autogen/transactions/EscrowCancel.h:148
xrpl::transactions::EscrowCancelBuilder::setOfferSequence
EscrowCancelBuilder & setOfferSequence(std::decay_t< typename SF_UINT32::type::value_type > const &value)
Set sfOfferSequence (SoeRequired).
Definition
protocol_autogen/transactions/EscrowCancel.h:135
xrpl::transactions::EscrowCancelBuilder::EscrowCancelBuilder
EscrowCancelBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_ACCOUNT::type::value_type > const &owner, std::decay_t< typename SF_UINT32::type::value_type > const &offerSequence, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
Construct a new EscrowCancelBuilder with required fields.
Definition
protocol_autogen/transactions/EscrowCancel.h:91
xrpl::transactions::EscrowCancelBuilder::EscrowCancelBuilder
EscrowCancelBuilder(std::shared_ptr< STTx const > tx)
Construct a EscrowCancelBuilder from an existing STTx object.
Definition
protocol_autogen/transactions/EscrowCancel.h:106
xrpl::transactions::EscrowCancelBuilder::setOwner
EscrowCancelBuilder & setOwner(std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
Transaction-specific field setters.
Definition
protocol_autogen/transactions/EscrowCancel.h:124
xrpl::transactions::EscrowCancel
Transaction: EscrowCancel.
Definition
protocol_autogen/transactions/EscrowCancel.h:30
xrpl::transactions::EscrowCancel::EscrowCancel
EscrowCancel(std::shared_ptr< STTx const > tx)
Construct a EscrowCancel transaction wrapper from an existing STTx object.
Definition
protocol_autogen/transactions/EscrowCancel.h:38
xrpl::transactions::EscrowCancel::getOfferSequence
SF_UINT32::type::value_type getOfferSequence() const
Get sfOfferSequence (SoeRequired).
Definition
protocol_autogen/transactions/EscrowCancel.h:67
xrpl::transactions::EscrowCancel::txType
static constexpr xrpl::TxType txType
Definition
protocol_autogen/transactions/EscrowCancel.h:32
xrpl::transactions::EscrowCancel::getOwner
SF_ACCOUNT::type::value_type getOwner() const
Get sfOwner (SoeRequired).
Definition
protocol_autogen/transactions/EscrowCancel.h:56
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< EscrowCancelBuilder >::object_
STObject object_
Definition
TransactionBuilderBase.h:266
xrpl::transactions::TransactionBuilderBase< EscrowCancelBuilder >::TransactionBuilderBase
TransactionBuilderBase()=default
xrpl::transactions::TransactionBuilderBase< EscrowCancelBuilder >::sign
EscrowCancelBuilder & 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::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