Interface CheckCreate
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableCheckCreate
Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination.
The sender of this transaction is the sender of the Check.
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionstatic ImmutableCheckCreate.Builderbuilder()Construct a builder for this class.The uniqueAddressof the account that can cash the Check.Optional<com.google.common.primitives.UnsignedInteger> Arbitrary tag that identifies the reason for the Check, or a hosted recipient to pay.Optional<com.google.common.primitives.UnsignedInteger> Time after which the Check is no longer valid, in seconds since the Ripple Epoch.default TransactionFlagsflags()Set ofTransactionFlagss for thisCheckCreate, which only allows thetfFullyCanonicalSigflag, which is deprecated.Arbitrary 256-bit hash representing a specific reason or identifier for this Check.sendMax()Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies.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
ImmutableCheckCreate.Builder.
-
flags
Set ofTransactionFlagss for thisCheckCreate, 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.
-
destination
Address destination()The uniqueAddressof the account that can cash the Check.- Returns:
- The unique
Addressof the account that can cash the Check.
-
destinationTag
Optional<com.google.common.primitives.UnsignedInteger> destinationTag()Arbitrary tag that identifies the reason for the Check, or a hosted recipient to pay.- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the tag of the destination account.
-
sendMax
CurrencyAmount sendMax()Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies. The Check can only credit the destination with the same currency (from the same issuer, for non-XRP currencies). For non-XRP amounts, the nested field names MUST be lower-case.- Returns:
- A
CurrencyAmountcontaining the maximum amount this check is allowed to send.
-
expiration
Optional<com.google.common.primitives.UnsignedInteger> expiration()Time after which the Check is no longer valid, in seconds since the Ripple Epoch.- Returns:
- An
Optionalof typeUnsignedIntegerdenoting the expiration time.
-
invoiceId
Arbitrary 256-bit hash representing a specific reason or identifier for this Check.
-