Package org.xrpl.xrpl4j.model.transactions

Interface PaymentChannelCreate

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutablePaymentChannelCreate
@Immutable public interface PaymentChannelCreate extends Transaction
Create a unidirectional channel and fund it with XRP. The address sending this transaction becomes the "source address" of the payment channel.

  • Method Details

    • builder

      static ImmutablePaymentChannelCreate.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutablePaymentChannelCreate.Builder.

    • flags

      @Default default TransactionFlags flags()
      Set of TransactionFlagss for this PaymentChannelCreate, 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.

    • amount

      XrpCurrencyAmount amount()
      Amount of XRP, in drops, to deduct from the Transaction.account()'s balance and set aside in this channel. While the channel is open, the XRP can only go to the destination() address. When the channel closes, any unclaimed XRP is returned to the Transaction.account()'s balance.
      Returns:
      An XrpCurrencyAmount representing the amount of the payment channel.

    • destination

      Address destination()
      Address to receive XRP claims against this channel. Cannot be the same as Transaction.account();
      Returns:
      The Address of the destination account.

    • settleDelay

      com.google.common.primitives.UnsignedInteger settleDelay()
      Amount of time, in seconds, the Transaction.account() must wait before closing the channel if it has unclaimed XRP.
      Returns:
      An UnsignedInteger representing the settlement delay.

    • publicKey

      String publicKey()
      The public key of the key pair the Transaction.account() will use to sign claims against this channel, in hexadecimal. This can be any secp256k1 or Ed25519 public key.
      Returns:
      A String containing the public key for the channel.

    • cancelAfter

      Optional<com.google.common.primitives.UnsignedLong> cancelAfter()
      The time, in seconds since the Ripple Epoch, when this channel expires. Any transaction that would modify the channel after this time closes the channel without otherwise affecting it. This value is immutable; the channel can be closed earlier than this time but cannot remain open after this time.
      Returns:
      An Optional of type UnsignedLong representing the cancel after time.

    • destinationTag

      Optional<com.google.common.primitives.UnsignedInteger> destinationTag()
      Arbitrary tag to further specify the destination for this payment channel, such as a hosted recipient at the destination() address.
      Returns:
      An Optional of type UnsignedInteger representing the tag of the destination account.