Interface PaymentChannelFund
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutablePaymentChannelFund
Add additional XRP to an open payment channel, update the expiration time of the channel, or both.
Only the source address of the channel can use this transaction.
- See Also:
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionamount()Amount of XRP, in drops to add to the channel.builder()Construct a builder for this class.channel()The unique ID of the channel to fund.Optional<com.google.common.primitives.UnsignedLong> New Expiration time to set for the channel, in seconds since the Ripple Epoch.default TransactionFlagsflags()Set ofTransactionFlagss for thisPaymentChannelFund, which only allows thetfFullyCanonicalSigflag, which is deprecated.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
ImmutablePaymentChannelFund.Builder.
-
flags
Set ofTransactionFlagss for thisPaymentChannelFund, 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.
-
channel
Hash256 channel()The unique ID of the channel to fund.- Returns:
- A
Hash256containing the channel ID.
-
amount
XrpCurrencyAmount amount()Amount of XRP, in drops to add to the channel. This field is required, therefore it is not possible to set theexpiration()without adding value to the channel. However, you can change the expiration and add a negligible amount of XRP (like 1 drop) to the channel.- Returns:
- An
XrpCurrencyAmountrepresenting the amount of the payment channel.
-
expiration
Optional<com.google.common.primitives.UnsignedLong> expiration()New Expiration time to set for the channel, in seconds since the Ripple Epoch. This must be later than either the current time plus the SettleDelay of the channel, or the existing Expiration of the channel. After the Expiration time, any transaction that would access the channel closes the channel without taking its normal action. Any unspent XRP is returned to the source address when the channel closes. (Expiration is separate from the channel's immutable CancelAfter time.)- Returns:
- An
Optionalof typeUnsignedLong.
-