supra-ts-sdk - v2.0.0
    Preparing search index...

    Class SupraSimulationFailedError

    SupraSimulationFailedError is thrown when a simulation returns a status other than Success. The simulated transaction would not succeed against the state the node simulated it on:

    • Fail: it would be executed and fail (for example a Move abort or Out of gas).
    • PendingAfterExecution: it failed validation with a status that can change with the chain's state, for example SENDING_ACCOUNT_DOES_NOT_EXIST or SEQUENCE_NUMBER_TOO_NEW. gas_used is 0.
    • Invalid: it would be discarded.

    The node answers a simulation with HTTP 200 whatever its status, so this error derives from SupraError, not from SupraAPIError. The simulated transaction is available as transaction. A simulation refused for a gas unit price below the node's minimum throws SupraGasUnitPriceBelowMinimumError instead.

    Hierarchy (View Summary)

    Index
    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Returns {
          name: string;
          message: string;
          status: TransactionStatus;
          vm_status: string | undefined;
          major_status: string | undefined;
          sub_status: number | undefined;
      }

    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    The status of the simulated transaction.

    vm_status: string | undefined

    The vm_status of the simulated transaction's Move output, or undefined when it has no Move output.

    major_status: string | undefined

    The name of the Move VM status that vm_status reports (for example SENDING_ACCOUNT_DOES_NOT_EXIST).

    sub_status: number | undefined

    The sub status of the Move VM status: the abort code of an ABORTED status.

    transaction: TransactionResponse

    The simulated transaction as the node returned it, with its output.

    cause?: unknown
    name: string
    message: string
    stack?: string