Record Class TransactionSimulationResult

java.lang.Object
java.lang.Record
org.hyperledger.besu.plugin.data.TransactionSimulationResult
Record Components:
transaction - the simulated transaction
result - the processing result of the simulation
public record TransactionSimulationResult(org.hyperledger.besu.datatypes.Transaction transaction, org.hyperledger.besu.plugin.data.TransactionProcessingResult result) extends Record
The result of simulating a transaction: the transaction that was run and the outcome of processing it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransactionSimulationResult(org.hyperledger.besu.datatypes.Transaction transaction, org.hyperledger.besu.plugin.data.TransactionProcessingResult result)
    Creates an instance of a TransactionSimulationResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    getGasEstimate()
    Estimated gas used by the transaction
    Optional<String>
    getInvalidReason()
    Return the optional invalid reason
    Optional<org.apache.tuweni.bytes.Bytes>
    getRevertReason()
    Return the optional revert reason
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isInvalid()
    Was the transaction invalid?
    boolean
    isSuccessful()
    Was the simulation successful?
    org.hyperledger.besu.plugin.data.TransactionProcessingResult
    result()
    Returns the value of the result record component.
    final String
    toString()
    Returns a string representation of this record class.
    org.hyperledger.besu.datatypes.Transaction
    transaction()
    Returns the value of the transaction record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TransactionSimulationResult

      public TransactionSimulationResult(org.hyperledger.besu.datatypes.Transaction transaction, org.hyperledger.besu.plugin.data.TransactionProcessingResult result)
      Creates an instance of a TransactionSimulationResult record class.
      Parameters:
      transaction - the value for the transaction record component
      result - the value for the result record component

  • Method Details

    • isSuccessful

      public boolean isSuccessful()
      Was the simulation successful?
      Returns:
      true if the transaction was processed successfully

    • isInvalid

      public boolean isInvalid()
      Was the transaction invalid?
      Returns:
      true if the transaction failed validation and was not executed

    • getRevertReason

      public Optional<org.apache.tuweni.bytes.Bytes> getRevertReason()
      Return the optional revert reason
      Returns:
      the optional revert reason

    • getInvalidReason

      public Optional<String> getInvalidReason()
      Return the optional invalid reason
      Returns:
      the optional invalid reason

    • getGasEstimate

      public long getGasEstimate()
      Estimated gas used by the transaction
      Returns:
      estimated gas used

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • transaction

      public org.hyperledger.besu.datatypes.Transaction transaction()
      Returns the value of the transaction record component.
      Returns:
      the value of the transaction record component

    • result

      public org.hyperledger.besu.plugin.data.TransactionProcessingResult result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component