Interface DepositPreAuthObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableDepositPreAuthObject

@Immutable public interface DepositPreAuthObject extends LedgerObject
Tracks a preauthorization from one account to another. DepositPreAuth transactions create these objects.

This has no effect on processing of Transactions unless the account that provided the preauthorization requires Deposit Authorization. In that case, the account that was preauthorized can send payments and other transactions directly to the account that provided the preauthorization. Preauthorizations are uni-directional, and have no effect on payments going the opposite direction.

  • Method Details

    • builder

      Construct a builder for this class.
      Returns:
      An ImmutableDepositPreAuthObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      The type of ledger object, which will always be "DepositPreauth" in this case.
      Returns:
      Always LedgerObject.LedgerEntryType.DEPOSIT_PRE_AUTH.
    • account

      Address account()
      The account that granted the preauthorization. (The destination of the preauthorized payments.)
      Returns:
      The Address of the account.
    • authorize

      Optional<Address> authorize()
      The account that received the preauthorization. (The sender of the preauthorized payments.)
      Returns:
      The Address of the account to authorize.
    • authorizeCredentials

      List<CredentialWrapper> authorizeCredentials()
      The credential(s) that received the preauthorization.
      Returns:
      A list of CredentialWrapper.
    • flags

      @Derived default Flags flags()
      A bit-map of boolean flags. No flags are defined for DepositPreAuthObjects, so this value is always 0.
      Returns:
      Always Flags.UNSET.
    • ownerNode

      String ownerNode()
      A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.

      Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.

      Returns:
      A String containing the owner node hint.
    • previousTransactionId

      Hash256 previousTransactionId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing the previous transaction hash.
    • previousTransactionLedgerSequence

      com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()
      The index of the ledger that contains the transaction that most recently modified this object.
      Returns:
      An UnsignedInteger representing the previous transaction ledger sequence.
    • index

      Hash256 index()
      The unique ID of the DepositPreAuthObject.
      Returns:
      A Hash256 containing the ID.