Package org.xrpl.xrpl4j.model.ledger
Interface XChainOwnedCreateAccountClaimIdObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableXChainOwnedCreateAccountClaimIdObject
The
XChainOwnedCreateAccountClaimID ledger object is used to collect attestations for creating an account via
a cross-chain transfer.
It is created when an XChainAddAccountCreateAttestation transaction adds a signature attesting to a XChainAccountCreateCommit transaction and the XChainAccountCreateCount is greater than or equal to the current XChainAccountClaimCount on the Bridge ledger object.
The ledger object is destroyed when all the attestations have been received and the funds have transferred to the new account.
This interface will be marked Beta until the featureXChainBridge amendment is enabled on mainnet. Its API
is subject to change.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The account that owns this object.builder()Construct aXChainOwnedCreateAccountClaimIdObjectbuilder.default Flagsflags()A bit-map of boolean flags.index()The unique ID of theXChainOwnedCreateAccountClaimIdObject.default LedgerObject.LedgerEntryTypeThe type of ledger object, which will always be "XChainOwnedCreateAccountClaimIdObject" in this case.A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.The identifying hash of the transaction that most recently modified this object.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.An integer that determines the order that accounts created through cross-chain transfers must be performed.The door accounts and assets of the bridge this object correlates to.Attestations collected from the witness servers.
-
Method Details
-
builder
Construct aXChainOwnedCreateAccountClaimIdObjectbuilder. -
ledgerEntryType
The type of ledger object, which will always be "XChainOwnedCreateAccountClaimIdObject" in this case.- Returns:
- Always returns
LedgerObject.LedgerEntryType.XCHAIN_OWNED_CREATE_ACCOUNT_CLAIM_ID.
-
flags
A bit-map of boolean flags. No flags are defined forXChainOwnedCreateAccountClaimIdObject, so this value is always 0.- Returns:
- Always
Flags.UNSET.
-
account
Address account()The account that owns this object.- Returns:
- An
Address.
-
xChainBridge
XChainBridge xChainBridge()The door accounts and assets of the bridge this object correlates to.- Returns:
- An
XChainBridge.
-
xChainCreateAccountAttestations
List<XChainCreateAccountAttestation> xChainCreateAccountAttestations()Attestations collected from the witness servers. This includes the parameters needed to recreate the message that was signed, including the amount, destination, signature reward amount, and reward account for that signature. With the exception of the reward account, all signatures must sign the message created with common parameters.- Returns:
- A
ListofXChainCreateAccountAttestations.
-
xChainAccountCreateCount
XChainCount xChainAccountCreateCount()An integer that determines the order that accounts created through cross-chain transfers must be performed. Smaller numbers must execute before larger numbers.- Returns:
- An
XChainCount.
-
ownerNode
String ownerNode()A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
- Returns:
- A
Stringcontaining the owner node hint.
-
previousTransactionId
Hash256 previousTransactionId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Returns:
- An
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
index
Hash256 index()The unique ID of theXChainOwnedCreateAccountClaimIdObject.- Returns:
- A
Hash256containing the ID.
-