Interface SubmitResult<TxnType extends Transaction>
-
- Type Parameters:
TxnType
- The type ofTransaction
that was submitted.
- All Superinterfaces:
XrplResult
- All Known Implementing Classes:
ImmutableSubmitResult
@Immutable public interface SubmitResult<TxnType extends Transaction> extends XrplResult
The result of a "submit" rippled API call.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
accepted()
The valuetrue
indicates that the transaction was applied, queued, broadcast, or kept for later.com.google.common.primitives.UnsignedInteger
accountSequenceAvailable()
The next Sequence number available for the sending account after all pending and queued transactions.com.google.common.primitives.UnsignedInteger
accountSequenceNext()
The next Sequence number for the sending account after all transactions that have been provisionally applied, but not transactions in the queue.boolean
applied()
The valuetrue
indicates that this transaction was applied to the open ledger.boolean
broadcast()
true
indicates this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network.static <T extends Transaction>
ImmutableSubmitResult.Builder<T>builder()
Construct a builder for this class.default Optional<String>
engineResult()
Deprecated.useresult()
instead.default Optional<String>
engineResultMessage()
Deprecated.UseresultMessage()
instead.boolean
kept()
The valuetrue
indicates that the transaction was kept to be retried later.XrpCurrencyAmount
openLedgerCost()
The current open ledger cost before processing this transaction.boolean
queued()
The valuetrue
indicates the transaction was put in the Transaction Queue, which means it is likely to be included in a future ledger version.String
result()
Text result code indicating the preliminary result of the transaction, for example "tesSUCCESS".String
resultMessage()
Human-readable explanation of the transaction's preliminary result.String
transactionBlob()
The complete transaction in hexString
format.TransactionResult<TxnType>
transactionResult()
The completeTransaction
that was submitted, as aTransactionResult
.LedgerIndex
validatedLedgerIndex()
The ledger index of the newest validated ledger at the time of submission.-
Methods inherited from interface org.xrpl.xrpl4j.model.client.XrplResult
status
-
-
-
-
Method Detail
-
builder
static <T extends Transaction> ImmutableSubmitResult.Builder<T> builder()
Construct a builder for this class.- Type Parameters:
T
- The actual type ofTransaction
that was submitted.- Returns:
- An
ImmutableSubmitResult.Builder
-
engineResult
@Deprecated @Auxiliary default Optional<String> engineResult()
Deprecated.useresult()
instead.Text result code indicating the preliminary result of the transaction, for example "tesSUCCESS".- Returns:
- An optionally-present
String
containing the result of the submission.
-
result
String result()
Text result code indicating the preliminary result of the transaction, for example "tesSUCCESS".- Returns:
String
containing the result of the submission.
-
engineResultMessage
@Deprecated @Auxiliary default Optional<String> engineResultMessage()
Deprecated.UseresultMessage()
instead.Human-readable explanation of the transaction's preliminary result.- Returns:
- An optionally-present
String
containing the result message of the submission.
-
resultMessage
String resultMessage()
Human-readable explanation of the transaction's preliminary result.- Returns:
- A
String
containing the result message of the submission.
-
transactionBlob
String transactionBlob()
The complete transaction in hexString
format.- Returns:
- A hexadecimal encoded
String
containing the binary encoded transaction that was submitted.
-
transactionResult
TransactionResult<TxnType> transactionResult()
The completeTransaction
that was submitted, as aTransactionResult
.- Returns:
- A
TransactionResult
.
-
accepted
boolean accepted()
The valuetrue
indicates that the transaction was applied, queued, broadcast, or kept for later. The valuefalse
indicates that none of those happened, so the transaction cannot possibly succeed as long as you do not submit it again and have not already submitted it another time.- Returns:
true
if the transaction was applied, queued, broadcast, or kept for later, otherwisefalse
.
-
accountSequenceAvailable
com.google.common.primitives.UnsignedInteger accountSequenceAvailable()
The next Sequence number available for the sending account after all pending and queued transactions.- Returns:
- An
UnsignedInteger
representing the sequence number.
-
accountSequenceNext
com.google.common.primitives.UnsignedInteger accountSequenceNext()
The next Sequence number for the sending account after all transactions that have been provisionally applied, but not transactions in the queue.- Returns:
- An
UnsignedInteger
representing the sequence number.
-
applied
boolean applied()
The valuetrue
indicates that this transaction was applied to the open ledger. In this case, the transaction is likely, but not guaranteed, to be validated in the next ledger version.- Returns:
true
if this transaction was applied to the open ledger, otherwisefalse
.
-
broadcast
boolean broadcast()
true
indicates this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network.false
indicates the transaction was not broadcast to any other servers.- Returns:
true
if this transaction was broadcast to peer servers in the peer-to-peer XRP Ledger network, otherwisefalse
.
-
kept
boolean kept()
The valuetrue
indicates that the transaction was kept to be retried later.- Returns:
true
if the transaction was kept to be retried later,false
if not.
-
queued
boolean queued()
The valuetrue
indicates the transaction was put in the Transaction Queue, which means it is likely to be included in a future ledger version.- Returns:
true
if the transaction was put in the Transaction Queue, otherwisefalse
.
-
openLedgerCost
XrpCurrencyAmount openLedgerCost()
The current open ledger cost before processing this transaction. Transactions with a lower cost are likely to be queued.- Returns:
- An
XrpCurrencyAmount
representing the current open ledger cost.
-
validatedLedgerIndex
LedgerIndex validatedLedgerIndex()
The ledger index of the newest validated ledger at the time of submission. This provides a lower bound on the ledger versions that the transaction can appear in as a result of this request.- Returns:
- A
LedgerIndex
indicating the ledger index of the newest validated ledger.
-
-