xrpl::ledger_entries::BridgeBuilder Class Reference

Builder for Bridge ledger entries. More...

#include <Bridge.h>

Inheritance diagram for xrpl::ledger_entries::BridgeBuilder:

Collaboration diagram for xrpl::ledger_entries::BridgeBuilder:

Public Member Functions
	BridgeBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_AMOUNT::type::value_type > const &signatureReward, std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &xChainBridge, std::decay_t< typename SF_UINT64::type::value_type > const &xChainClaimID, std::decay_t< typename SF_UINT64::type::value_type > const &xChainAccountCreateCount, std::decay_t< typename SF_UINT64::type::value_type > const &xChainAccountClaimCount, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, 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 BridgeBuilder with required fields.
	BridgeBuilder (std::shared_ptr< SLE const > sle)
	Construct a BridgeBuilder from an existing SLE object.
BridgeBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
BridgeBuilder &	setSignatureReward (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfSignatureReward (soeREQUIRED)
BridgeBuilder &	setMinAccountCreateAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfMinAccountCreateAmount (soeOPTIONAL)
BridgeBuilder &	setXChainBridge (std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &value)
	Set sfXChainBridge (soeREQUIRED)
BridgeBuilder &	setXChainClaimID (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfXChainClaimID (soeREQUIRED)
BridgeBuilder &	setXChainAccountCreateCount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfXChainAccountCreateCount (soeREQUIRED)
BridgeBuilder &	setXChainAccountClaimCount (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfXChainAccountClaimCount (soeREQUIRED)
BridgeBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
BridgeBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
BridgeBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
Bridge	build (uint256 const &index)
	Build and return the completed Bridge wrapper.
bool	validate () const
	Validate the ledger entry.
BridgeBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
BridgeBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Bridge 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 179 of file Bridge.h.

Constructor & Destructor Documentation

BridgeBuilder() [1/2]

xrpl::ledger_entries::BridgeBuilder::BridgeBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	signatureReward,
		std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &	xChainBridge,
		std::decay_t< typename SF_UINT64::type::value_type > const &	xChainClaimID,
		std::decay_t< typename SF_UINT64::type::value_type > const &	xChainAccountCreateCount,
		std::decay_t< typename SF_UINT64::type::value_type > const &	xChainAccountClaimCount,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		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 BridgeBuilder with required fields.

Parameters

account	The sfAccount field value.
signatureReward	The sfSignatureReward field value.
xChainBridge	The sfXChainBridge field value.
xChainClaimID	The sfXChainClaimID field value.
xChainAccountCreateCount	The sfXChainAccountCreateCount field value.
xChainAccountClaimCount	The sfXChainAccountClaimCount field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 194 of file Bridge.h.

BridgeBuilder() [2/2]

xrpl::ledger_entries::BridgeBuilder::BridgeBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a BridgeBuilder 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 213 of file Bridge.h.

Member Function Documentation

setAccount()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::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 229 of file Bridge.h.

setSignatureReward()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setSignatureReward

(

std::decay_t< typename SF_AMOUNT::type::value_type > const &

value

)

Set sfSignatureReward (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 240 of file Bridge.h.

setMinAccountCreateAmount()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setMinAccountCreateAmount

(

std::decay_t< typename SF_AMOUNT::type::value_type > const &

value

)

Set sfMinAccountCreateAmount (soeOPTIONAL)

Returns

Reference to this builder for method chaining.

Definition at line 251 of file Bridge.h.

setXChainBridge()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setXChainBridge

(

std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &

value

)

Set sfXChainBridge (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 262 of file Bridge.h.

setXChainClaimID()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setXChainClaimID

(

std::decay_t< typename SF_UINT64::type::value_type > const &

value

)

Set sfXChainClaimID (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 273 of file Bridge.h.

setXChainAccountCreateCount()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setXChainAccountCreateCount

(

std::decay_t< typename SF_UINT64::type::value_type > const &

value

)

Set sfXChainAccountCreateCount (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 284 of file Bridge.h.

setXChainAccountClaimCount()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setXChainAccountClaimCount

(

std::decay_t< typename SF_UINT64::type::value_type > const &

value

)

Set sfXChainAccountClaimCount (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 295 of file Bridge.h.

setOwnerNode()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::setOwnerNode

(

std::decay_t< typename SF_UINT64::type::value_type > const &

value

)

Set sfOwnerNode (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 306 of file Bridge.h.

setPreviousTxnID()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::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 317 of file Bridge.h.

setPreviousTxnLgrSeq()

BridgeBuilder & xrpl::ledger_entries::BridgeBuilder::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 328 of file Bridge.h.

build()

Bridge xrpl::ledger_entries::BridgeBuilder::build

(

uint256 const &

index

)

Build and return the completed Bridge wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 340 of file Bridge.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

BridgeBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< BridgeBuilder >::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()

BridgeBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< BridgeBuilder >::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< BridgeBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.