Builder for AccountRoot ledger entries. More...

#include <AccountRoot.h>

Inheritance diagram for xrpl::ledger_entries::AccountRootBuilder:

Collaboration diagram for xrpl::ledger_entries::AccountRootBuilder:

[legend]

Public Member Functions
	AccountRootBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_UINT32::type::value_type > const &sequence, std::decay_t< typename SF_AMOUNT::type::value_type > const &balance, std::decay_t< typename SF_UINT32::type::value_type > const &ownerCount, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
	Construct a new AccountRootBuilder with required fields.

	AccountRootBuilder (std::shared_ptr< SLE const > sle)
	Construct a AccountRootBuilder from an existing SLE object.

AccountRootBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.

AccountRootBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeREQUIRED)

AccountRootBuilder &	setBalance (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfBalance (soeREQUIRED)

AccountRootBuilder &	setOwnerCount (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfOwnerCount (soeREQUIRED)

AccountRootBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)

AccountRootBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)

AccountRootBuilder &	setAccountTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfAccountTxnID (soeOPTIONAL)

AccountRootBuilder &	setRegularKey (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfRegularKey (soeOPTIONAL)

AccountRootBuilder &	setEmailHash (std::decay_t< typename SF_UINT128::type::value_type > const &value)
	Set sfEmailHash (soeOPTIONAL)

AccountRootBuilder &	setWalletLocator (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfWalletLocator (soeOPTIONAL)

AccountRootBuilder &	setWalletSize (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfWalletSize (soeOPTIONAL)

AccountRootBuilder &	setMessageKey (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfMessageKey (soeOPTIONAL)

AccountRootBuilder &	setTransferRate (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfTransferRate (soeOPTIONAL)

AccountRootBuilder &	setDomain (std::decay_t< typename SF_VL::type::value_type > const &value)
	Set sfDomain (soeOPTIONAL)

AccountRootBuilder &	setTickSize (std::decay_t< typename SF_UINT8::type::value_type > const &value)
	Set sfTickSize (soeOPTIONAL)

AccountRootBuilder &	setTicketCount (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfTicketCount (soeOPTIONAL)

AccountRootBuilder &	setNFTokenMinter (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Set sfNFTokenMinter (soeOPTIONAL)

AccountRootBuilder &	setMintedNFTokens (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfMintedNFTokens (soeDEFAULT)

AccountRootBuilder &	setBurnedNFTokens (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfBurnedNFTokens (soeDEFAULT)

AccountRootBuilder &	setFirstNFTokenSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfFirstNFTokenSequence (soeOPTIONAL)

AccountRootBuilder &	setAMMID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfAMMID (soeOPTIONAL)

AccountRootBuilder &	setVaultID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfVaultID (soeOPTIONAL)

AccountRootBuilder &	setLoanBrokerID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfLoanBrokerID (soeOPTIONAL)

AccountRoot	build (uint256 const &index)
	Build and return the completed AccountRoot wrapper.

bool	validate () const
	Validate the ledger entry.

AccountRootBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.

AccountRootBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for AccountRoot ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses Json::Value internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 530 of file AccountRoot.h.

Constructor & Destructor Documentation

◆ AccountRootBuilder() [1/2]

xrpl::ledger_entries::AccountRootBuilder::AccountRootBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_UINT32::type::value_type > const &	sequence,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	balance,
		std::decay_t< typename SF_UINT32::type::value_type > const &	ownerCount,
		std::decay_t< typename SF_UINT256::type::value_type > const &	previousTxnID,
		std::decay_t< typename SF_UINT32::type::value_type > const &	previousTxnLgrSeq
	)

Construct a new AccountRootBuilder with required fields.

Parameters

account	The sfAccount field value.
sequence	The sfSequence field value.
balance	The sfBalance field value.
ownerCount	The sfOwnerCount field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 542 of file AccountRoot.h.

◆ AccountRootBuilder() [2/2]

xrpl::ledger_entries::AccountRootBuilder::AccountRootBuilder ( std::shared_ptr< SLE const > sle )

Construct a AccountRootBuilder from an existing SLE object.

Parameters

sle	The existing ledger entry to copy from.

Exceptions

std::runtime_error if the ledger entry type doesn't match.

Definition at line 558 of file AccountRoot.h.

Member Function Documentation

◆ setAccount()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setAccount ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Ledger entry-specific field setters.

Set sfAccount (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 574 of file AccountRoot.h.

◆ setSequence()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setSequence ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfSequence (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 585 of file AccountRoot.h.

◆ setBalance()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setBalance ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfBalance (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 596 of file AccountRoot.h.

◆ setOwnerCount()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setOwnerCount ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfOwnerCount (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 607 of file AccountRoot.h.

◆ setPreviousTxnID()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setPreviousTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfPreviousTxnID (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 618 of file AccountRoot.h.

◆ setPreviousTxnLgrSeq()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setPreviousTxnLgrSeq ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfPreviousTxnLgrSeq (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 629 of file AccountRoot.h.

◆ setAccountTxnID()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setAccountTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfAccountTxnID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 640 of file AccountRoot.h.

◆ setRegularKey()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setRegularKey ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Set sfRegularKey (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 651 of file AccountRoot.h.

◆ setEmailHash()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setEmailHash ( std::decay_t< typename SF_UINT128::type::value_type > const & value )

Set sfEmailHash (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 662 of file AccountRoot.h.

◆ setWalletLocator()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setWalletLocator ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfWalletLocator (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 673 of file AccountRoot.h.

◆ setWalletSize()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setWalletSize ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfWalletSize (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 684 of file AccountRoot.h.

◆ setMessageKey()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setMessageKey ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfMessageKey (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 695 of file AccountRoot.h.

◆ setTransferRate()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setTransferRate ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfTransferRate (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 706 of file AccountRoot.h.

◆ setDomain()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setDomain ( std::decay_t< typename SF_VL::type::value_type > const & value )

Set sfDomain (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 717 of file AccountRoot.h.

◆ setTickSize()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setTickSize ( std::decay_t< typename SF_UINT8::type::value_type > const & value )

Set sfTickSize (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 728 of file AccountRoot.h.

◆ setTicketCount()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setTicketCount ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfTicketCount (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 739 of file AccountRoot.h.

◆ setNFTokenMinter()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setNFTokenMinter ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Set sfNFTokenMinter (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 750 of file AccountRoot.h.

◆ setMintedNFTokens()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setMintedNFTokens ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfMintedNFTokens (soeDEFAULT)

Returns: Reference to this builder for method chaining.

Definition at line 761 of file AccountRoot.h.

◆ setBurnedNFTokens()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setBurnedNFTokens ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfBurnedNFTokens (soeDEFAULT)

Returns: Reference to this builder for method chaining.

Definition at line 772 of file AccountRoot.h.

◆ setFirstNFTokenSequence()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setFirstNFTokenSequence ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfFirstNFTokenSequence (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 783 of file AccountRoot.h.

◆ setAMMID()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setAMMID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfAMMID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 794 of file AccountRoot.h.

◆ setVaultID()

AccountRootBuilder & xrpl::ledger_entries::AccountRootBuilder::setVaultID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfVaultID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 805 of file AccountRoot.h.

◆ setLoanBrokerID()

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

Set sfLoanBrokerID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 816 of file AccountRoot.h.

◆ build()

AccountRoot xrpl::ledger_entries::AccountRootBuilder::build ( uint256 const & index )

Build and return the completed AccountRoot wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 828 of file AccountRoot.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< AccountRootBuilder >::validate ( ) const

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

AccountRootBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< AccountRootBuilder >::setLedgerIndex ( uint256 const & value )

inherited

Set the ledger index.

Parameters

value Ledger index

Returns: Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

AccountRootBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< AccountRootBuilder >::setFlags ( uint32_t value )

inherited

Set the flags.

Parameters

value Flags value

Returns: Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_

STObject xrpl::ledger_entries::LedgerEntryBuilderBase< AccountRootBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AccountRootBuilder() [1/2]

◆ AccountRootBuilder() [2/2]

Member Function Documentation

◆ setAccount()

◆ setSequence()

◆ setBalance()

◆ setOwnerCount()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setAccountTxnID()

◆ setRegularKey()

◆ setEmailHash()

◆ setWalletLocator()

◆ setWalletSize()

◆ setMessageKey()

◆ setTransferRate()

◆ setDomain()

◆ setTickSize()

◆ setTicketCount()

◆ setNFTokenMinter()

◆ setMintedNFTokens()

◆ setBurnedNFTokens()

◆ setFirstNFTokenSequence()

◆ setAMMID()

◆ setVaultID()

◆ setLoanBrokerID()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_