Skip to content

ContractError.md

Latest commit

 

History

History
223 lines (126 loc) · 4.46 KB

ContractError.md

File metadata and controls

223 lines (126 loc) · 4.46 KB
Raw

@grainlify/contracts-sdk

@grainlify/contracts-sdk / ContractError

Class: ContractError

Defined in: src/errors.ts:15

Contract-specific errors that map to Soroban contract error codes

Extends

Constructors

Constructor

new ContractError(message, code, contractErrorCode?): ContractError

Defined in: src/errors.ts:16

Parameters

message

string

code

string

contractErrorCode?

number

Returns

ContractError

Overrides

SDKError.constructor

Properties

code

readonly code: string

Defined in: src/errors.ts:5

Inherited from

SDKError.code

contractErrorCode?

readonly optional contractErrorCode?: number

Defined in: src/errors.ts:16

message

message: string

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

Inherited from

SDKError.message

name

name: string

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

Inherited from

SDKError.name

stack?

optional stack?: string

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

Inherited from

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

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

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

SDKError.prepareStackTrace