Interface PaymentChannelFund

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutablePaymentChannelFund

@Immutable public interface PaymentChannelFund extends Transaction
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:
  • "https://xrpl.org/paymentchannelfund.html"
  • Method Details

    • builder

      Construct a builder for this class.
      Returns:
      An ImmutablePaymentChannelFund.Builder.
    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this PaymentChannelFund, which only allows the tfFullyCanonicalSig flag, 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 Hash256 containing the channel ID.
    • amount

      Amount of XRP, in drops to add to the channel. This field is required, therefore it is not possible to set the expiration() 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 XrpCurrencyAmount representing 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 Optional of type UnsignedLong.