Package org.xrpl.xrpl4j.model.transactions

Interface XChainCommit

All Superinterfaces:

Transaction

All Known Implementing Classes:

ImmutableXChainCommit

@Beta
@Immutable
public interface XChainCommit
extends Transaction

Object mapping for the XChainCommit 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 Type	Method	Description
CurrencyAmount	amount()	The asset to commit, and the quantity.
static ImmutableXChainCommit.Builder	builder()	Construct a XChainCommit builder.
default TransactionFlags	flags()	Set of TransactionFlagss for this XChainCommit, which only allows the tfFullyCanonicalSig flag, which is deprecated.
Optional<Address>	otherChainDestination()	The destination account on the destination chain.
XChainBridge	xChainBridge()	The bridge to use to transfer funds.
XChainClaimId	xChainClaimId()	The unique integer ID for a cross-chain transfer.

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

static ImmutableXChainCommit.Builder builder()

Construct a XChainCommit builder.

Returns:

An ImmutableXChainCommit.Builder.

flags

@Default
default TransactionFlags flags()

Set of TransactionFlagss for this XChainCommit, which only allows the tfFullyCanonicalSig flag, which is deprecated.

Returns:

A set of TransactionFlags, default is TransactionFlags.EMPTY.

amount

CurrencyAmount amount()

The asset to commit, and the quantity. This must match the door account's LockingChainIssue (if on the locking chain) or the door account's IssuingChainIssue (if on the issuing chain).

Returns:

A CurrencyAmount.

otherChainDestination

Optional<Address> otherChainDestination()

The destination account on the destination chain. If this is not specified, the account that submitted the XChainCreateClaimId transaction on the destination chain will need to submit a XChainClaim transaction to claim the funds.

Returns:

An optionally-present Address.

xChainBridge

XChainBridge xChainBridge()

The bridge to use to transfer funds.

Returns:

An XChainBridge.

xChainClaimId

XChainClaimId xChainClaimId()

The unique integer ID for a cross-chain transfer. This must be acquired on the destination chain (via a XChainCreateClaimId transaction) and checked from a validated ledger before submitting this transaction. If an incorrect sequence number is specified, the funds will be lost.

Returns:

An XChainClaimId.