Interface DepositPreAuth
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableDepositPreAuth
A
DepositPreAuth transaction gives another account pre-approval to deliver payments to the sender of this
transaction. This is only useful if the sender of this transaction is using (or plans to use)
Deposit Authorization.
You can use this transaction to preauthorize certain counterparties before you enable Deposit Authorization. This may be useful to ensure a smooth transition from not requiring deposit authorization to requiring it.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionThe XRP LedgerAddressof the sender to preauthorize.TheCredentialWrapper's to preauthorize.builder()Construct a builder for this class.default TransactionFlagsflags()Set ofTransactionFlagss for thisDepositPreAuth, which only allows thetfFullyCanonicalSigflag, which is deprecated.The XRP LedgerAddressof a sender whose preauthorization should be revoked.TheCredentialWrapper's whose preauthorization should be revoked.default voidValidateauthorizeCredentials()andunauthorizeCredentials()has less than or equal to 8 credentials.default voidValidate that exactly one ofauthorize()orunauthorize()orauthorizeCredentials()orunauthorizeCredentials()is present.default voidValidateauthorizeCredentials()andunauthorizeCredentials()has unique credentials each.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableDepositPreAuth.Builder.
-
flags
Set ofTransactionFlagss for thisDepositPreAuth, which only allows thetfFullyCanonicalSigflag, 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.
-
authorize
The XRP LedgerAddressof the sender to preauthorize. -
unauthorize
The XRP LedgerAddressof a sender whose preauthorization should be revoked. -
authorizeCredentials
List<CredentialWrapper> authorizeCredentials()TheCredentialWrapper's to preauthorize.- Returns:
- A list of type
CredentialWrapperto preauthorize.
-
unauthorizeCredentials
List<CredentialWrapper> unauthorizeCredentials()TheCredentialWrapper's whose preauthorization should be revoked.- Returns:
- A list of type
CredentialWrapperto unauthorize.
-
validateExactOneFieldPresence
@Check default void validateExactOneFieldPresence()Validate that exactly one ofauthorize()orunauthorize()orauthorizeCredentials()orunauthorizeCredentials()is present. -
validateCredentialList
@Check default void validateCredentialList()ValidateauthorizeCredentials()andunauthorizeCredentials()has less than or equal to 8 credentials. -
validateForUniqueValues
@Check default void validateForUniqueValues()ValidateauthorizeCredentials()andunauthorizeCredentials()has unique credentials each.
-