rippled
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
xrpl::transactions::LoanBrokerCoverWithdrawBuilder Class Reference

Builder for LoanBrokerCoverWithdraw transactions. More...

#include <LoanBrokerCoverWithdraw.h>

Inheritance diagram for xrpl::transactions::LoanBrokerCoverWithdrawBuilder:
Inheritance graph
[legend]
Collaboration diagram for xrpl::transactions::LoanBrokerCoverWithdrawBuilder:
Collaboration graph
[legend]

Public Member Functions

 LoanBrokerCoverWithdrawBuilder (SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_UINT256::type::value_type > const &loanBrokerID, 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 LoanBrokerCoverWithdrawBuilder with required fields.
 
 LoanBrokerCoverWithdrawBuilder (std::shared_ptr< STTx const > tx)
 Construct a LoanBrokerCoverWithdrawBuilder from an existing STTx object.
 
LoanBrokerCoverWithdrawBuildersetLoanBrokerID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
 Transaction-specific field setters.
 
LoanBrokerCoverWithdrawBuildersetAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
 Set sfAmount (soeREQUIRED)
 
LoanBrokerCoverWithdrawBuildersetDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfDestination (soeOPTIONAL)
 
LoanBrokerCoverWithdrawBuildersetDestinationTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfDestinationTag (soeOPTIONAL)
 
LoanBrokerCoverWithdraw build (PublicKey const &publicKey, SecretKey const &secretKey)
 Build and return the LoanBrokerCoverWithdraw wrapper.
 
LoanBrokerCoverWithdrawBuildersetAccount (AccountID const &value)
 Set the account that is sending the transaction.
 
LoanBrokerCoverWithdrawBuildersetFee (STAmount const &value)
 Set the transaction fee.
 
LoanBrokerCoverWithdrawBuildersetSequence (std::uint32_t const &value)
 Set the sequence number.
 
LoanBrokerCoverWithdrawBuildersetTicketSequence (std::uint32_t const &value)
 Set the ticket sequence to use for this transaction.
 
LoanBrokerCoverWithdrawBuildersetFlags (std::uint32_t const &value)
 Set transaction flags.
 
LoanBrokerCoverWithdrawBuildersetSourceTag (std::uint32_t const &value)
 Set the source tag.
 
LoanBrokerCoverWithdrawBuildersetLastLedgerSequence (std::uint32_t const &value)
 Set the last ledger sequence.
 
LoanBrokerCoverWithdrawBuildersetAccountTxnID (uint256 const &value)
 Set the account transaction ID.
 
LoanBrokerCoverWithdrawBuildersetPreviousTxnID (uint256 const &value)
 Set the previous transaction ID.
 
LoanBrokerCoverWithdrawBuildersetOperationLimit (std::uint32_t const &value)
 Set the operation limit.
 
LoanBrokerCoverWithdrawBuildersetMemos (STArray const &value)
 Set the memos array.
 
LoanBrokerCoverWithdrawBuildersetSigners (STArray const &value)
 Set the signers array for multi-signing.
 
LoanBrokerCoverWithdrawBuildersetNetworkID (std::uint32_t const &value)
 Set the network ID.
 
LoanBrokerCoverWithdrawBuildersetDelegate (AccountID const &value)
 Set the delegate account for delegated transactions.
 
STObject const & getSTObject () const
 Get the underlying STObject.
 

Protected Member Functions

LoanBrokerCoverWithdrawBuildersign (PublicKey const &publicKey, SecretKey const &secretKey)
 Sign the transaction with the given keys.
 

Protected Attributes

STObject object_
 

Detailed Description

Builder for LoanBrokerCoverWithdraw transactions.

Provides a fluent interface for constructing transactions with method chaining. Uses Json::Value internally for flexible transaction construction. Inherits common field setters from TransactionBuilderBase.

Definition at line 133 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

Constructor & Destructor Documentation

◆ LoanBrokerCoverWithdrawBuilder() [1/2]

xrpl::transactions::LoanBrokerCoverWithdrawBuilder::LoanBrokerCoverWithdrawBuilder ( SF_ACCOUNT::type::value_type  account,
std::decay_t< typename SF_UINT256::type::value_type > const &  loanBrokerID,
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 LoanBrokerCoverWithdrawBuilder with required fields.

Parameters
accountThe account initiating the transaction.
loanBrokerIDThe sfLoanBrokerID field value.
amountThe sfAmount field value.
sequenceOptional sequence number for the transaction.
feeOptional fee for the transaction.

Definition at line 144 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ LoanBrokerCoverWithdrawBuilder() [2/2]

xrpl::transactions::LoanBrokerCoverWithdrawBuilder::LoanBrokerCoverWithdrawBuilder ( std::shared_ptr< STTx const >  tx)

Construct a LoanBrokerCoverWithdrawBuilder from an existing STTx object.

Parameters
txThe existing transaction to copy from.
Exceptions
std::runtime_errorif the transaction type doesn't match.

Definition at line 159 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

Member Function Documentation

◆ setLoanBrokerID()

LoanBrokerCoverWithdrawBuilder & xrpl::transactions::LoanBrokerCoverWithdrawBuilder::setLoanBrokerID ( std::decay_t< typename SF_UINT256::type::value_type > const &  value)

Transaction-specific field setters.

Set sfLoanBrokerID (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 175 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ setAmount()

LoanBrokerCoverWithdrawBuilder & xrpl::transactions::LoanBrokerCoverWithdrawBuilder::setAmount ( std::decay_t< typename SF_AMOUNT::type::value_type > const &  value)

Set sfAmount (soeREQUIRED)

Note
This field supports MPT (Multi-Purpose Token) amounts.
Returns
Reference to this builder for method chaining.

Definition at line 187 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ setDestination()

LoanBrokerCoverWithdrawBuilder & xrpl::transactions::LoanBrokerCoverWithdrawBuilder::setDestination ( std::decay_t< typename SF_ACCOUNT::type::value_type > const &  value)

Set sfDestination (soeOPTIONAL)

Returns
Reference to this builder for method chaining.

Definition at line 198 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ setDestinationTag()

LoanBrokerCoverWithdrawBuilder & xrpl::transactions::LoanBrokerCoverWithdrawBuilder::setDestinationTag ( std::decay_t< typename SF_UINT32::type::value_type > const &  value)

Set sfDestinationTag (soeOPTIONAL)

Returns
Reference to this builder for method chaining.

Definition at line 209 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ build()

LoanBrokerCoverWithdraw xrpl::transactions::LoanBrokerCoverWithdrawBuilder::build ( PublicKey const &  publicKey,
SecretKey const &  secretKey 
)

Build and return the LoanBrokerCoverWithdraw wrapper.

Parameters
publicKeyThe public key for signing.
secretKeyThe secret key for signing.
Returns
The constructed transaction wrapper.

Definition at line 222 of file protocol_autogen/transactions/LoanBrokerCoverWithdraw.h.

◆ setAccount()

Set the account that is sending the transaction.

Parameters
valueAccount address (typically as a string)
Returns
Reference to the derived builder for method chaining.

Definition at line 62 of file TransactionBuilderBase.h.

◆ setFee()

Set the transaction fee.

Parameters
valueFee in drops (typically as a string or number)
Returns
Reference to the derived builder for method chaining.

Definition at line 74 of file TransactionBuilderBase.h.

◆ setSequence()

Set the sequence number.

Parameters
valueSequence number
Returns
Reference to the derived builder for method chaining.

Definition at line 86 of file TransactionBuilderBase.h.

◆ setTicketSequence()

Set the ticket sequence to use for this transaction.

When using a ticket, the regular sequence number is set to 0.

Parameters
valueTicket sequence number
Returns
Reference to the derived builder for method chaining.

Definition at line 99 of file TransactionBuilderBase.h.

◆ setFlags()

Set transaction flags.

Parameters
valueFlags value
Returns
Reference to the derived builder for method chaining.

Definition at line 112 of file TransactionBuilderBase.h.

◆ setSourceTag()

Set the source tag.

Parameters
valueSource tag
Returns
Reference to the derived builder for method chaining.

Definition at line 124 of file TransactionBuilderBase.h.

◆ setLastLedgerSequence()

Set the last ledger sequence.

Parameters
valueLast ledger sequence number
Returns
Reference to the derived builder for method chaining.

Definition at line 136 of file TransactionBuilderBase.h.

◆ setAccountTxnID()

Set the account transaction ID.

Parameters
valueAccount transaction ID (typically as a hex string)
Returns
Reference to the derived builder for method chaining.

Definition at line 148 of file TransactionBuilderBase.h.

◆ setPreviousTxnID()

Set the previous transaction ID.

Used for emulate027 compatibility.

Parameters
valuePrevious transaction ID
Returns
Reference to the derived builder for method chaining.

Definition at line 161 of file TransactionBuilderBase.h.

◆ setOperationLimit()

Set the operation limit.

Parameters
valueOperation limit
Returns
Reference to the derived builder for method chaining.

Definition at line 173 of file TransactionBuilderBase.h.

◆ setMemos()

Set the memos array.

Parameters
valueArray of memo objects
Returns
Reference to the derived builder for method chaining.

Definition at line 185 of file TransactionBuilderBase.h.

◆ setSigners()

Set the signers array for multi-signing.

Parameters
valueArray of signer objects
Returns
Reference to the derived builder for method chaining.

Definition at line 197 of file TransactionBuilderBase.h.

◆ setNetworkID()

Set the network ID.

Parameters
valueNetwork ID
Returns
Reference to the derived builder for method chaining.

Definition at line 209 of file TransactionBuilderBase.h.

◆ setDelegate()

Set the delegate account for delegated transactions.

Parameters
valueDelegate account ID
Returns
Reference to the derived builder for method chaining.

Definition at line 221 of file TransactionBuilderBase.h.

◆ getSTObject()

Get the underlying STObject.

Returns
The STObject

Definition at line 232 of file TransactionBuilderBase.h.

◆ sign()

LoanBrokerCoverWithdrawBuilder & xrpl::transactions::TransactionBuilderBase< LoanBrokerCoverWithdrawBuilder >::sign ( PublicKey const &  publicKey,
SecretKey const &  secretKey 
)
protectedinherited

Sign the transaction with the given keys.

This sets the SigningPubKey field and computes the TxnSignature.

Parameters
publicKeyThe public key for signing
secretKeyThe secret key for signing
Returns
Reference to the derived builder for method chaining.

Definition at line 248 of file TransactionBuilderBase.h.

Member Data Documentation

◆ object_

Definition at line 266 of file TransactionBuilderBase.h.