ordspv
    Preparing search index...

    Class CustodyHopLimitError

    The custody walk hit its hop cap with a further confirmed spend still ahead, so a caller can tell a path that is merely longer than the cap from a backend that failed. It carries the cap that fired and the hop count the walk had reached. SatStepLimitError is the same fact on the sat side; the class differs because the custody verifier has no cap and core therefore has no stake in it, so it lives in this package alone.

    The count that reaches the cap follows the backend's own outspend answers, which the reveal txid does not commit to, so the build loop records the refusal as that backend's cause and rotates, at the cost of a second walk.

    Defined here rather than beside CustodyBuildError in custodybuilder.ts for the same reason WitnessSectionUnavailableError is: the facts table below holds its constructor, and it cannot import from a module that imports this one back.

    Hierarchy

    • Error
      • CustodyHopLimitError
    Index
    cap: number

    the cap that fired

    cause?: unknown
    hops: number

    the hop count the walk had reached when it fired

    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