RelayerServiceError

client

Defined in: src/client/implementation/relayer-forwarder.ts:101

Error thrown when the relayer service returns an error response.

Remarks

This error is thrown when the relayer endpoint returns an error object in the response instead of a transaction signature.

Extends

• TransactionForwarderError

Constructors

Constructor

new RelayerServiceError(message, relayerError, cause?): RelayerServiceError

Defined in: src/client/implementation/relayer-forwarder.ts:119

Creates a new instance of RelayerServiceError.

Parameters

message

string

Human-readable error message describing what went wrong

relayerError

unknown

The error object returned by the relayer service

cause?

TransactionForwarderError

Optional underlying error that caused this error

Returns

RelayerServiceError

Overrides

TransactionForwarderError.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

TransactionForwarderError.cause

code

readonly code: "RELAYER_FORWARDER_SERVICE_ERROR" = 'RELAYER_FORWARDER_SERVICE_ERROR'

Defined in: src/client/implementation/relayer-forwarder.ts:105

Unique identifier code for this error type.

Overrides

TransactionForwarderError.code

message

message: string

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

Inherited from

TransactionForwarderError.message

name

name: string

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

Inherited from

TransactionForwarderError.name

relayerError

readonly relayerError: unknown

Defined in: src/client/implementation/relayer-forwarder.ts:110

The error object returned by the relayer service.

stack?

optional stack: string

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

Inherited from

TransactionForwarderError.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

TransactionForwarderError.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

TransactionForwarderError.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

TransactionForwarderError.prepareStackTrace