Package org.xrpl.xrpl4j.model.transactions

Interface EscrowFinish

All Superinterfaces:

Transaction

All Known Implementing Classes:

ImmutableEscrowFinish

@Immutable
public interface EscrowFinish
extends Transaction

Deliver XRP from a held payment to the recipient.

Field Summary

Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction

RIPPLE_EPOCH, typeMap

Method Summary

Modifier and Type	Method	Description
static ImmutableEscrowFinish.Builder	builder()
default void	check()	Validate fields.
static XrpCurrencyAmount	computeFee(XrpCurrencyAmount currentLedgerFeeDrops, com.ripple.cryptoconditions.Fulfillment fulfillment)	Compute the fee for the supplied fulfillment.
Optional<com.ripple.cryptoconditions.Condition>	condition()	Hex value matching the previously-supplied PREIMAGE-SHA-256 crypto-condition of the held payment.
default Flags.TransactionFlags	flags()	Set of Flags.TransactionFlagss for this EscrowFinish, which only allows tfFullyCanonicalSig flag.
Optional<com.ripple.cryptoconditions.Fulfillment<?>>	fulfillment()	Hex value of the PREIMAGE-SHA-256 crypto-condition fulfillment matching the held payment's condition.
com.google.common.primitives.UnsignedInteger	offerSequence()	The Transaction.sequence() of the transaction that created the escrow to cancel.
Address	owner()	Address of the source account that funded the escrow payment.

Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction

account, accountTransactionId, closeDate, closeDateHuman, fee, hash, lastLedgerSequence, ledgerIndex, memos, sequence, signers, signingPublicKey, sourceTag, transactionSignature, transactionType

Method Detail

builder

static ImmutableEscrowFinish.Builder builder()

computeFee

static XrpCurrencyAmount computeFee(XrpCurrencyAmount currentLedgerFeeDrops,
                                    com.ripple.cryptoconditions.Fulfillment fulfillment)

Compute the fee for the supplied fulfillment. The minimum transaction cost to submit an EscrowFinish transaction increases if it contains a fulfillment. If the transaction contains a fulfillment, the transaction cost is 330 drops of XRP plus another 10 drops for every 16 bytes in size of the preimage.

Parameters:

currentLedgerFeeDrops - The number of drops that the ledger demands at present.

fulfillment - The Fulfillment that is being presented to the ledger for computation purposes.

Returns:

An XrpCurrencyAmount representing the computed fee.

See Also:

"https://xrpl.org/escrowfinish.html"

flags

@Derived
default Flags.TransactionFlags flags()

Set of Flags.TransactionFlagss for this EscrowFinish, which only allows tfFullyCanonicalSig flag.

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 Flags.TransactionFlags with tfFullyCanonicalSig set.

owner

Address owner()

Address of the source account that funded the escrow payment.

Returns:

The Address of the source account.

offerSequence

com.google.common.primitives.UnsignedInteger offerSequence()

The Transaction.sequence() of the transaction that created the escrow to cancel.

Returns:

An UnsignedInteger representing the sequence number.

condition

Optional<com.ripple.cryptoconditions.Condition> condition()

Hex value matching the previously-supplied PREIMAGE-SHA-256 crypto-condition of the held payment.

Returns:

An Optional of type Condition containing the escrow condition.

fulfillment

Optional<com.ripple.cryptoconditions.Fulfillment<?>> fulfillment()

Hex value of the PREIMAGE-SHA-256 crypto-condition fulfillment matching the held payment's condition.

Returns:

An Optional of type Fulfillment containing the fulfillment for the escrow's condition.

check

@Check
default void check()

Validate fields.