rippled
Loading...
Searching...
No Matches
protocol_autogen/transactions/PaymentChannelFund.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
14namespace xrpl::transactions {
15
16class PaymentChannelFundBuilder;
17
30{
31public:
32 static constexpr xrpl::TxType txType = ttPAYCHAN_FUND;
33
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 PaymentChannelFund");
45 }
46 }
47
48 // Transaction-specific field getters
49
54 [[nodiscard]]
55 SF_UINT256::type::value_type
56 getChannel() const
57 {
58 return this->tx_->at(sfChannel);
59 }
60
65 [[nodiscard]]
66 SF_AMOUNT::type::value_type
67 getAmount() const
68 {
69 return this->tx_->at(sfAmount);
70 }
71
76 [[nodiscard]]
79 {
80 if (hasExpiration())
81 {
82 return this->tx_->at(sfExpiration);
83 }
84 return std::nullopt;
85 }
86
91 [[nodiscard]]
92 bool
94 {
95 return this->tx_->isFieldPresent(sfExpiration);
96 }
97};
98
106class PaymentChannelFundBuilder : public TransactionBuilderBase<PaymentChannelFundBuilder>
107{
108public:
126
133 {
134 if (tx->getTxnType() != ttPAYCHAN_FUND)
135 {
136 throw std::runtime_error("Invalid transaction type for PaymentChannelFundBuilder");
137 }
138 object_ = *tx;
139 }
140
149 {
150 object_[sfChannel] = value;
151 return *this;
152 }
153
160 {
161 object_[sfAmount] = value;
162 return *this;
163 }
164
171 {
172 object_[sfExpiration] = value;
173 return *this;
174 }
175
183 build(PublicKey const& publicKey, SecretKey const& secretKey)
184 {
185 sign(publicKey, secretKey);
187 }
188};
189
190} // namespace xrpl::transactions
A public key.
Definition PublicKey.h:42
A secret key.
Definition SecretKey.h:18
PaymentChannelFundBuilder(std::shared_ptr< STTx const > tx)
Construct a PaymentChannelFundBuilder from an existing STTx object.
PaymentChannelFund build(PublicKey const &publicKey, SecretKey const &secretKey)
Build and return the PaymentChannelFund wrapper.
PaymentChannelFundBuilder & setExpiration(std::decay_t< typename SF_UINT32::type::value_type > const &value)
Set sfExpiration (soeOPTIONAL)
PaymentChannelFundBuilder & setChannel(std::decay_t< typename SF_UINT256::type::value_type > const &value)
Transaction-specific field setters.
PaymentChannelFundBuilder(SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_UINT256::type::value_type > const &channel, 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 PaymentChannelFundBuilder with required fields.
PaymentChannelFundBuilder & setAmount(std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
Set sfAmount (soeREQUIRED)
PaymentChannelFund(std::shared_ptr< STTx const > tx)
Construct a PaymentChannelFund transaction wrapper from an existing STTx object.
protocol_autogen::Optional< SF_UINT32::type::value_type > getExpiration() const
Get sfExpiration (soeOPTIONAL)
SF_UINT256::type::value_type getChannel() const
Get sfChannel (soeREQUIRED)
SF_AMOUNT::type::value_type getAmount() const
Get sfAmount (soeREQUIRED)
Base class for all transaction wrapper types.
std::shared_ptr< STTx const > tx_
The underlying transaction object being wrapped.
Base class for all transaction builders.
PaymentChannelFundBuilder & sign(PublicKey const &publicKey, SecretKey const &secretKey)
Sign the transaction with the given keys.
T is_same_v
STL namespace.
TxType
Transaction type identifiers.
Definition TxFormats.h:39