TransactionForwarderError

client

Defined in: src/client/interface/transaction-forwarder.ts:16

Abstract base class for all transaction forwarder-related errors.

Remarks

This class provides a foundation for all transaction forwarder errors, ensuring consistent error handling and type safety across forwarder implementations. All transaction forwarder errors in implementations should extend this class and provide a unique error code.

The error code serves as an identifier for programmatic error handling and allows implementations to define specific error types with associated codes for different failure scenarios.

Extends

• Error

Extended by

• TransactionForwardingError
• BatchTransactionForwardingError
• InvalidDelayArrayError
• RelayerTransactionForwardingError
• RelayerBatchTransactionForwardingError
• RelayerInvalidDelayArrayError
• RelayerServiceError

Constructors

Constructor

new TransactionForwarderError(message, cause?): TransactionForwarderError

Defined in: src/client/interface/transaction-forwarder.ts:32

Creates a new instance of TransactionForwarderError.

Parameters

message

string

Human-readable error message describing what went wrong

cause?

TransactionForwarderError

Optional underlying error that caused this error

Returns

TransactionForwarderError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

code

abstract readonly code: string

Defined in: src/client/interface/transaction-forwarder.ts:24

Unique identifier code for this error type.

Remarks

This code is used to identify the specific error type programmatically. Each error subclass in implementations should define a unique code.

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

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.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:52

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

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace