Interface CheckCancel

All Superinterfaces:
Transaction
All Known Implementing Classes:
ImmutableCheckCancel

@Immutable public interface CheckCancel extends Transaction
Cancels an unredeemed Check, removing it from the ledger without sending any money. The source or the destination of the check can cancel a Check at any time using this transaction type. If the Check has expired, any address can cancel it.
  • Method Details

    • builder

      static ImmutableCheckCancel.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableCheckCancel.Builder.
    • flags

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

      Hash256 checkId()
      The ID of the Check ledger object to cancel, as a 64-character hexadecimal string.
      Returns:
      A Hash256 containing the ID of the Check ledger object in hexadecimal form.