ordspv
    Preparing search index...

    Class SatStepLimitError

    A genealogy is deeper than the step cap that was allowed for it. The cap is what bounds the work an untrusted document can demand, so hitting it is a refusal to read and not a judgement about the document. A bundle refused this way may be perfectly honest and merely have a deep ancestry, which is a different fact from being forged (plain Error) or leaving v1's sat domain (CustodyUnsupportedError). The caller raises the cap to read it.

    The class lives here because both the builder's walk and the verifier's read refuse on the same ground, and a caller that discriminates on the class has to see one class from both. @ordspv/fetch re-exports it for the builder.

    Hierarchy

    • Error
      • SatStepLimitError
    Index
    cause?: unknown
    message: string
    name: string
    stack?: string
    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.

    • 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