Builder for Payment transactions. More...

#include <Payment.h>

Inheritance diagram for xrpl::transactions::PaymentBuilder:

Collaboration diagram for xrpl::transactions::PaymentBuilder:

[legend]

Public Member Functions
	PaymentBuilder (SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_ACCOUNT::type::value_type > const &destination, 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 PaymentBuilder with required fields.

	PaymentBuilder (std::shared_ptr< STTx const > tx)
	Construct a PaymentBuilder from an existing STTx object.

PaymentBuilder &	setDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Transaction-specific field setters.

PaymentBuilder &	setAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfAmount (soeREQUIRED)

PaymentBuilder &	setSendMax (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfSendMax (soeOPTIONAL)

PaymentBuilder &	setPaths (STPathSet const &value)
	Set sfPaths (soeDEFAULT)

PaymentBuilder &	setInvoiceID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfInvoiceID (soeOPTIONAL)

PaymentBuilder &	setDestinationTag (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfDestinationTag (soeOPTIONAL)

PaymentBuilder &	setDeliverMin (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfDeliverMin (soeOPTIONAL)

PaymentBuilder &	setCredentialIDs (std::decay_t< typename SF_VECTOR256::type::value_type > const &value)
	Set sfCredentialIDs (soeOPTIONAL)

PaymentBuilder &	setDomainID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfDomainID (soeOPTIONAL)

Payment	build (PublicKey const &publicKey, SecretKey const &secretKey)
	Build and return the Payment wrapper.

PaymentBuilder &	setAccount (AccountID const &value)
	Set the account that is sending the transaction.

PaymentBuilder &	setFee (STAmount const &value)
	Set the transaction fee.

PaymentBuilder &	setSequence (std::uint32_t const &value)
	Set the sequence number.

PaymentBuilder &	setTicketSequence (std::uint32_t const &value)
	Set the ticket sequence to use for this transaction.

PaymentBuilder &	setFlags (std::uint32_t const &value)
	Set transaction flags.

PaymentBuilder &	setSourceTag (std::uint32_t const &value)
	Set the source tag.

PaymentBuilder &	setLastLedgerSequence (std::uint32_t const &value)
	Set the last ledger sequence.

PaymentBuilder &	setAccountTxnID (uint256 const &value)
	Set the account transaction ID.

PaymentBuilder &	setPreviousTxnID (uint256 const &value)
	Set the previous transaction ID.

PaymentBuilder &	setOperationLimit (std::uint32_t const &value)
	Set the operation limit.

PaymentBuilder &	setMemos (STArray const &value)
	Set the memos array.

PaymentBuilder &	setSigners (STArray const &value)
	Set the signers array for multi-signing.

PaymentBuilder &	setNetworkID (std::uint32_t const &value)
	Set the network ID.

PaymentBuilder &	setDelegate (AccountID const &value)
	Set the delegate account for delegated transactions.

STObject const &	getSTObject () const
	Get the underlying STObject.

Protected Member Functions
PaymentBuilder &	sign (PublicKey const &publicKey, SecretKey const &secretKey)
	Sign the transaction with the given keys.

Protected Attributes
STObject	object_

Detailed Description

Builder for Payment 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 263 of file protocol_autogen/transactions/Payment.h.

Constructor & Destructor Documentation

◆ PaymentBuilder() [1/2]

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

Parameters

account	The account initiating the transaction.
destination	The sfDestination field value.
amount	The sfAmount field value.
sequence	Optional sequence number for the transaction.
fee	Optional fee for the transaction.

Definition at line 274 of file protocol_autogen/transactions/Payment.h.

◆ PaymentBuilder() [2/2]

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

Construct a PaymentBuilder from an existing STTx object.

Parameters

tx	The existing transaction to copy from.

Exceptions

std::runtime_error if the transaction type doesn't match.

Definition at line 289 of file protocol_autogen/transactions/Payment.h.

Member Function Documentation

◆ setDestination()

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

Transaction-specific field setters.

Set sfDestination (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 305 of file protocol_autogen/transactions/Payment.h.

◆ setAmount()

PaymentBuilder & xrpl::transactions::PaymentBuilder::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 317 of file protocol_autogen/transactions/Payment.h.

◆ setSendMax()

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

Set sfSendMax (soeOPTIONAL)

Note: This field supports MPT (Multi-Purpose Token) amounts.

Returns: Reference to this builder for method chaining.

Definition at line 329 of file protocol_autogen/transactions/Payment.h.

◆ setPaths()

PaymentBuilder & xrpl::transactions::PaymentBuilder::setPaths ( STPathSet const & value )

Set sfPaths (soeDEFAULT)

Returns: Reference to this builder for method chaining.

Definition at line 340 of file protocol_autogen/transactions/Payment.h.

◆ setInvoiceID()

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

Set sfInvoiceID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 351 of file protocol_autogen/transactions/Payment.h.

◆ setDestinationTag()

PaymentBuilder & xrpl::transactions::PaymentBuilder::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 362 of file protocol_autogen/transactions/Payment.h.

◆ setDeliverMin()

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

Set sfDeliverMin (soeOPTIONAL)

Note: This field supports MPT (Multi-Purpose Token) amounts.

Returns: Reference to this builder for method chaining.

Definition at line 374 of file protocol_autogen/transactions/Payment.h.

◆ setCredentialIDs()

PaymentBuilder & xrpl::transactions::PaymentBuilder::setCredentialIDs ( std::decay_t< typename SF_VECTOR256::type::value_type > const & value )

Set sfCredentialIDs (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 385 of file protocol_autogen/transactions/Payment.h.

◆ setDomainID()

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

Set sfDomainID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 396 of file protocol_autogen/transactions/Payment.h.

◆ build()

Payment xrpl::transactions::PaymentBuilder::build	(	PublicKey const &	publicKey,
		SecretKey const &	secretKey
	)

Build and return the Payment wrapper.

Parameters

publicKey	The public key for signing.
secretKey	The secret key for signing.

Returns: The constructed transaction wrapper.

Definition at line 409 of file protocol_autogen/transactions/Payment.h.

◆ setAccount()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setAccount ( AccountID const & value )

inherited

Set the account that is sending the transaction.

Parameters

value Account address (typically as a string)

Returns: Reference to the derived builder for method chaining.

Definition at line 62 of file TransactionBuilderBase.h.

◆ setFee()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setFee ( STAmount const & value )

inherited

Set the transaction fee.

Parameters

value Fee 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()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setSequence ( std::uint32_t const & value )

inherited

Set the sequence number.

Parameters

value Sequence number

Returns: Reference to the derived builder for method chaining.

Definition at line 86 of file TransactionBuilderBase.h.

◆ setTicketSequence()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setTicketSequence ( std::uint32_t const & value )

inherited

Set the ticket sequence to use for this transaction.

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

Parameters

value Ticket sequence number

Returns: Reference to the derived builder for method chaining.

Definition at line 99 of file TransactionBuilderBase.h.

◆ setFlags()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setFlags ( std::uint32_t const & value )

inherited

Set transaction flags.

Parameters

value Flags value

Returns: Reference to the derived builder for method chaining.

Definition at line 112 of file TransactionBuilderBase.h.

◆ setSourceTag()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setSourceTag ( std::uint32_t const & value )

inherited

Set the source tag.

Parameters

value Source tag

Returns: Reference to the derived builder for method chaining.

Definition at line 124 of file TransactionBuilderBase.h.

◆ setLastLedgerSequence()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setLastLedgerSequence ( std::uint32_t const & value )

inherited

Set the last ledger sequence.

Parameters

value Last ledger sequence number

Returns: Reference to the derived builder for method chaining.

Definition at line 136 of file TransactionBuilderBase.h.

◆ setAccountTxnID()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setAccountTxnID ( uint256 const & value )

inherited

Set the account transaction ID.

Parameters

value Account 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()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setPreviousTxnID ( uint256 const & value )

inherited

Set the previous transaction ID.

Used for emulate027 compatibility.

Parameters

value Previous transaction ID

Returns: Reference to the derived builder for method chaining.

Definition at line 161 of file TransactionBuilderBase.h.

◆ setOperationLimit()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setOperationLimit ( std::uint32_t const & value )

inherited

Set the operation limit.

Parameters

value Operation limit

Returns: Reference to the derived builder for method chaining.

Definition at line 173 of file TransactionBuilderBase.h.

◆ setMemos()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setMemos ( STArray const & value )

inherited

Set the memos array.

Parameters

value Array of memo objects

Returns: Reference to the derived builder for method chaining.

Definition at line 185 of file TransactionBuilderBase.h.

◆ setSigners()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setSigners ( STArray const & value )

inherited

Set the signers array for multi-signing.

Parameters

value Array of signer objects

Returns: Reference to the derived builder for method chaining.

Definition at line 197 of file TransactionBuilderBase.h.

◆ setNetworkID()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setNetworkID ( std::uint32_t const & value )

inherited

Set the network ID.

Parameters

value Network ID

Returns: Reference to the derived builder for method chaining.

Definition at line 209 of file TransactionBuilderBase.h.

◆ setDelegate()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::setDelegate ( AccountID const & value )

inherited

Set the delegate account for delegated transactions.

Parameters

value Delegate account ID

Returns: Reference to the derived builder for method chaining.

Definition at line 221 of file TransactionBuilderBase.h.

◆ getSTObject()

STObject const & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::getSTObject ( ) const

inherited

Get the underlying STObject.

Returns: The STObject

Definition at line 232 of file TransactionBuilderBase.h.

◆ sign()

PaymentBuilder & xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::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

publicKey	The public key for signing
secretKey	The 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_

STObject xrpl::transactions::TransactionBuilderBase< PaymentBuilder >::object_

protectedinherited

Definition at line 266 of file TransactionBuilderBase.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PaymentBuilder() [1/2]

◆ PaymentBuilder() [2/2]

Member Function Documentation

◆ setDestination()

◆ setAmount()

◆ setSendMax()

◆ setPaths()

◆ setInvoiceID()

◆ setDestinationTag()

◆ setDeliverMin()

◆ setCredentialIDs()

◆ setDomainID()

◆ build()

◆ setAccount()

◆ setFee()

◆ setSequence()

◆ setTicketSequence()

◆ setFlags()

◆ setSourceTag()

◆ setLastLedgerSequence()

◆ setAccountTxnID()

◆ setPreviousTxnID()

◆ setOperationLimit()

◆ setMemos()

◆ setSigners()

◆ setNetworkID()

◆ setDelegate()

◆ getSTObject()

◆ sign()

Member Data Documentation

◆ object_