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

Builder for XChainAddClaimAttestation transactions. More...

#include <XChainAddClaimAttestation.h>

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

Public Member Functions

 XChainAddClaimAttestationBuilder (SF_ACCOUNT::type::value_type account, std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &xChainBridge, std::decay_t< typename SF_ACCOUNT::type::value_type > const &attestationSignerAccount, std::decay_t< typename SF_VL::type::value_type > const &publicKey, std::decay_t< typename SF_VL::type::value_type > const &signature, std::decay_t< typename SF_ACCOUNT::type::value_type > const &otherChainSource, std::decay_t< typename SF_AMOUNT::type::value_type > const &amount, std::decay_t< typename SF_ACCOUNT::type::value_type > const &attestationRewardAccount, std::decay_t< typename SF_UINT8::type::value_type > const &wasLockingChainSend, std::decay_t< typename SF_UINT64::type::value_type > const &xChainClaimID, std::optional< SF_UINT32::type::value_type > sequence=std::nullopt, std::optional< SF_AMOUNT::type::value_type > fee=std::nullopt)
 Construct a new XChainAddClaimAttestationBuilder with required fields.
 
 XChainAddClaimAttestationBuilder (std::shared_ptr< STTx const > tx)
 Construct a XChainAddClaimAttestationBuilder from an existing STTx object.
 
XChainAddClaimAttestationBuildersetXChainBridge (std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &value)
 Transaction-specific field setters.
 
XChainAddClaimAttestationBuildersetAttestationSignerAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfAttestationSignerAccount (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetPublicKey (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfPublicKey (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetSignature (std::decay_t< typename SF_VL::type::value_type > const &value)
 Set sfSignature (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetOtherChainSource (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfOtherChainSource (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetAmount (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
 Set sfAmount (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetAttestationRewardAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfAttestationRewardAccount (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetWasLockingChainSend (std::decay_t< typename SF_UINT8::type::value_type > const &value)
 Set sfWasLockingChainSend (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetXChainClaimID (std::decay_t< typename SF_UINT64::type::value_type > const &value)
 Set sfXChainClaimID (soeREQUIRED)
 
XChainAddClaimAttestationBuildersetDestination (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
 Set sfDestination (soeOPTIONAL)
 
XChainAddClaimAttestation build (PublicKey const &publicKey, SecretKey const &secretKey)
 Build and return the XChainAddClaimAttestation wrapper.
 
XChainAddClaimAttestationBuildersetAccount (AccountID const &value)
 Set the account that is sending the transaction.
 
XChainAddClaimAttestationBuildersetFee (STAmount const &value)
 Set the transaction fee.
 
XChainAddClaimAttestationBuildersetSequence (std::uint32_t const &value)
 Set the sequence number.
 
XChainAddClaimAttestationBuildersetTicketSequence (std::uint32_t const &value)
 Set the ticket sequence to use for this transaction.
 
XChainAddClaimAttestationBuildersetFlags (std::uint32_t const &value)
 Set transaction flags.
 
XChainAddClaimAttestationBuildersetSourceTag (std::uint32_t const &value)
 Set the source tag.
 
XChainAddClaimAttestationBuildersetLastLedgerSequence (std::uint32_t const &value)
 Set the last ledger sequence.
 
XChainAddClaimAttestationBuildersetAccountTxnID (uint256 const &value)
 Set the account transaction ID.
 
XChainAddClaimAttestationBuildersetPreviousTxnID (uint256 const &value)
 Set the previous transaction ID.
 
XChainAddClaimAttestationBuildersetOperationLimit (std::uint32_t const &value)
 Set the operation limit.
 
XChainAddClaimAttestationBuildersetMemos (STArray const &value)
 Set the memos array.
 
XChainAddClaimAttestationBuildersetSigners (STArray const &value)
 Set the signers array for multi-signing.
 
XChainAddClaimAttestationBuildersetNetworkID (std::uint32_t const &value)
 Set the network ID.
 
XChainAddClaimAttestationBuildersetDelegate (AccountID const &value)
 Set the delegate account for delegated transactions.
 
STObject const & getSTObject () const
 Get the underlying STObject.
 

Protected Member Functions

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

Protected Attributes

STObject object_
 

Detailed Description

Builder for XChainAddClaimAttestation 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 183 of file XChainAddClaimAttestation.h.

Constructor & Destructor Documentation

◆ XChainAddClaimAttestationBuilder() [1/2]

xrpl::transactions::XChainAddClaimAttestationBuilder::XChainAddClaimAttestationBuilder ( SF_ACCOUNT::type::value_type  account,
std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &  xChainBridge,
std::decay_t< typename SF_ACCOUNT::type::value_type > const &  attestationSignerAccount,
std::decay_t< typename SF_VL::type::value_type > const &  publicKey,
std::decay_t< typename SF_VL::type::value_type > const &  signature,
std::decay_t< typename SF_ACCOUNT::type::value_type > const &  otherChainSource,
std::decay_t< typename SF_AMOUNT::type::value_type > const &  amount,
std::decay_t< typename SF_ACCOUNT::type::value_type > const &  attestationRewardAccount,
std::decay_t< typename SF_UINT8::type::value_type > const &  wasLockingChainSend,
std::decay_t< typename SF_UINT64::type::value_type > const &  xChainClaimID,
std::optional< SF_UINT32::type::value_type >  sequence = std::nullopt,
std::optional< SF_AMOUNT::type::value_type >  fee = std::nullopt 
)

Construct a new XChainAddClaimAttestationBuilder with required fields.

Parameters
accountThe account initiating the transaction.
xChainBridgeThe sfXChainBridge field value.
attestationSignerAccountThe sfAttestationSignerAccount field value.
publicKeyThe sfPublicKey field value.
signatureThe sfSignature field value.
otherChainSourceThe sfOtherChainSource field value.
amountThe sfAmount field value.
attestationRewardAccountThe sfAttestationRewardAccount field value.
wasLockingChainSendThe sfWasLockingChainSend field value.
xChainClaimIDThe sfXChainClaimID field value.
sequenceOptional sequence number for the transaction.
feeOptional fee for the transaction.

Definition at line 201 of file XChainAddClaimAttestation.h.

◆ XChainAddClaimAttestationBuilder() [2/2]

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

Construct a XChainAddClaimAttestationBuilder 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 223 of file XChainAddClaimAttestation.h.

Member Function Documentation

◆ setXChainBridge()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::setXChainBridge ( std::decay_t< typename SF_XCHAIN_BRIDGE::type::value_type > const &  value)

Transaction-specific field setters.

Set sfXChainBridge (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 239 of file XChainAddClaimAttestation.h.

◆ setAttestationSignerAccount()

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

Set sfAttestationSignerAccount (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 250 of file XChainAddClaimAttestation.h.

◆ setPublicKey()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::setPublicKey ( std::decay_t< typename SF_VL::type::value_type > const &  value)

Set sfPublicKey (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 261 of file XChainAddClaimAttestation.h.

◆ setSignature()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::setSignature ( std::decay_t< typename SF_VL::type::value_type > const &  value)

Set sfSignature (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 272 of file XChainAddClaimAttestation.h.

◆ setOtherChainSource()

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

Set sfOtherChainSource (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 283 of file XChainAddClaimAttestation.h.

◆ setAmount()

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

Set sfAmount (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 294 of file XChainAddClaimAttestation.h.

◆ setAttestationRewardAccount()

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

Set sfAttestationRewardAccount (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 305 of file XChainAddClaimAttestation.h.

◆ setWasLockingChainSend()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::setWasLockingChainSend ( std::decay_t< typename SF_UINT8::type::value_type > const &  value)

Set sfWasLockingChainSend (soeREQUIRED)

Returns
Reference to this builder for method chaining.

Definition at line 316 of file XChainAddClaimAttestation.h.

◆ setXChainClaimID()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::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 327 of file XChainAddClaimAttestation.h.

◆ setDestination()

XChainAddClaimAttestationBuilder & xrpl::transactions::XChainAddClaimAttestationBuilder::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 338 of file XChainAddClaimAttestation.h.

◆ build()

XChainAddClaimAttestation xrpl::transactions::XChainAddClaimAttestationBuilder::build ( PublicKey const &  publicKey,
SecretKey const &  secretKey 
)

Build and return the XChainAddClaimAttestation wrapper.

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

Definition at line 351 of file XChainAddClaimAttestation.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()

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