Interface XChainClaim
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableXChainClaim
Object mapping for the
XChainClaim transaction.
This interface will be marked Beta until the featureXChainBridge amendment is enabled on mainnet. Its API
is subject to change.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionamount()The amount to claim on the destination chain.static ImmutableXChainClaim.Builderbuilder()Construct aXChainClaimbuilder.The destination account on the destination chain.Optional<com.google.common.primitives.UnsignedInteger> A 32-bit unsigned integer destination tag.default TransactionFlagsflags()Set ofTransactionFlagss for thisXChainClaim, which only allows thetfFullyCanonicalSigflag, which is deprecated.The bridge to use to transfer funds.The unique integer ID for the cross-chain transfer that was referenced in the correspondingXChainCommittransaction.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct aXChainClaimbuilder.- Returns:
- An
ImmutableXChainClaim.Builder.
-
flags
Set ofTransactionFlagss for thisXChainClaim, which only allows thetfFullyCanonicalSigflag, which is deprecated.- Returns:
- A set of
TransactionFlags, default isTransactionFlags.EMPTY.
-
amount
CurrencyAmount amount()The amount to claim on the destination chain. This must match the amount attested to on the attestations associated withxChainClaimId().- Returns:
- A
CurrencyAmount.
-
destination
Address destination()The destination account on the destination chain. It must exist or the transaction will fail. However, if the transaction fails in this case, the sequence number and collected signatures won't be destroyed, and the transaction can be rerun with a different destination.- Returns:
- An
Address.
-
destinationTag
Optional<com.google.common.primitives.UnsignedInteger> destinationTag()A 32-bit unsigned integer destination tag.- Returns:
- An optional
UnsignedInteger
-
xChainBridge
XChainBridge xChainBridge()The bridge to use to transfer funds.- Returns:
- An
XChainBridge.
-
xChainClaimId
XChainClaimId xChainClaimId()The unique integer ID for the cross-chain transfer that was referenced in the correspondingXChainCommittransaction.- Returns:
- An
XChainClaimId.
-