Interface EscrowCancel
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableEscrowCancel
Return escrowed XRP, IOU tokens, or MPT tokens to the sender.
With the TokenEscrow amendment enabled, this transaction can cancel escrows containing:
- XRP (as before)
- IOU tokens (trustline-based tokens)
- MPT tokens (Multi-Purpose Tokens)
Note: Unlike EscrowFinish, freeze/lock conditions do NOT prevent cancellation.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Construct a builder for this class.default TransactionFlagsflags()Set ofTransactionFlagss for thisEscrowCancel, which only allows thetfFullyCanonicalSigflag, which is deprecated.com.google.common.primitives.UnsignedIntegerTheTransaction.sequence()of the transaction that created the escrow to cancel.owner()Addressof the source account that funded the escrow payment.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 a builder for this class.- Returns:
- An
ImmutableEscrowCancel.Builder.
-
flags
Set ofTransactionFlagss for thisEscrowCancel, which only allows thetfFullyCanonicalSigflag, which is deprecated.The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.
- Returns:
- Always
TransactionFlags.EMPTY.
-
owner
Address owner()Addressof the source account that funded the escrow payment.- Returns:
- The
Addressof the escrow owner.
-
offerSequence
com.google.common.primitives.UnsignedInteger offerSequence()TheTransaction.sequence()of the transaction that created the escrow to cancel.- Returns:
- An
UnsignedIntegerrepresenting the sequence of theEscrowCreatetransaction that created the escrow.
-