Package org.xrpl.xrpl4j.model.ledger
Interface DepositPreAuthObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableDepositPreAuthObject
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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The account that granted the preauthorization.The account that received the preauthorization.The credential(s) that received the preauthorization.builder()Construct a builder for this class.default Flagsflags()A bit-map of boolean flags.index()The unique ID of theDepositPreAuthObject.default LedgerObject.LedgerEntryTypeThe type of ledger object, which will always be "DepositPreauth" in this case.A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.The identifying hash of the transaction that most recently modified this object.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableDepositPreAuthObject.Builder.
-
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
Addressof the account.
-
authorize
The account that received the preauthorization. (The sender of the preauthorized payments.)- Returns:
- The
Addressof the account to authorize.
-
authorizeCredentials
List<CredentialWrapper> authorizeCredentials()The credential(s) that received the preauthorization.- Returns:
- A list of
CredentialWrapper.
-
flags
A bit-map of boolean flags. No flags are defined forDepositPreAuthObjects, 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
Stringcontaining the owner node hint.
-
previousTransactionId
Hash256 previousTransactionId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing 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
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
index
Hash256 index()The unique ID of theDepositPreAuthObject.- Returns:
- A
Hash256containing the ID.
-