@hashgraph/sdk
    Preparing search index...

    Class ReceiptStatusError

    Represents an error that occurs when a transaction receipt indicates a failure on the Hedera network. The ReceiptStatusError class extends the base StatusError class and provides additional context specific to receipt-related failures, such as the transaction ID, status, and any associated messages.

    This error is typically thrown when a transaction has been processed, but the receipt indicates that it did not complete successfully. It allows developers to handle such errors effectively in their applications by providing detailed information about the failure.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    status: Status
    transactionId: TransactionId
    transactionReceipt: TransactionReceipt
    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.

    Methods

    • 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