client

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

Error thrown when a required account does not exist at the requested address.

Example

declare const fleetAddress: Address;
throw new AccountNotFoundError('fleet', fleetAddress);

Extends

SageSdkError

Constructors

Constructor

new AccountNotFoundError(accountType, address): AccountNotFoundError;

Defined in: packages/sage/src/client/errors.ts:115

Parameters

Parameter	Type
`accountType`	`EntityType`
`address`	`Address`

Returns

AccountNotFoundError

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

ContextDisposedError

Defined in: packages/sage/src/client/errors.ts:97

Error thrown when a read API is invoked after its context is disposed.

Example

throw new ContextDisposedError();

Extends

SageSdkError

Constructors

Constructor

new ContextDisposedError(): ContextDisposedError;

Defined in: packages/sage/src/client/errors.ts:98

Returns

ContextDisposedError

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

InvalidAccountOwnerError

InvalidAccountOwnerError

Defined in: packages/sage/src/client/errors.ts:134

Error thrown when an account belongs to a different program.

Example

declare const fleetAddress: Address;
declare const sageProgram: Address;
declare const actualOwner: Address;
throw new InvalidAccountOwnerError('fleet', fleetAddress, sageProgram, actualOwner);

Extends

SageSdkError

Constructors

Constructor

new InvalidAccountOwnerError(
   accountType,
   address,
   expectedOwner,
   actualOwner): InvalidAccountOwnerError;

Defined in: packages/sage/src/client/errors.ts:135

Parameters

Parameter	Type
`accountType`	`EntityType`
`address`	`Address`
`expectedOwner`	`Address`
`actualOwner`	`Address`

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

InvalidDerivationInputError

InvalidDerivationInputError

Defined in: packages/sage/src/client/errors.ts:335

Error thrown when a pure gameplay derivation input cannot be encoded or used safely.

Example

throw new InvalidDerivationInputError('Fleet mining units per second', -1);

Extends

SageSdkError

Constructors

Constructor

new InvalidDerivationInputError(
   field,
   value,
   remedy?): InvalidDerivationInputError;

Defined in: packages/sage/src/client/errors.ts:339

Parameters

Parameter	Type	Default value
`field`	`string`	`undefined`
`value`	`string` \| `number` \| `bigint`	`undefined`
`remedy`	`string`	`'Supply a finite, nonnegative number before deriving the gameplay value.'`

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

field

readonly field: string;

Defined in: packages/sage/src/client/errors.ts:336

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

value

readonly value: string | number | bigint;

Defined in: packages/sage/src/client/errors.ts:337

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

InvalidDiscriminatorError

InvalidDiscriminatorError

Defined in: packages/sage/src/client/errors.ts:157

Error thrown when account bytes do not start with the expected discriminator.

Example

declare const fleetAddress: Address;
throw new InvalidDiscriminatorError('fleet', fleetAddress);

Extends

SageSdkError

Constructors

Constructor

new InvalidDiscriminatorError(accountType, address): InvalidDiscriminatorError;

Defined in: packages/sage/src/client/errors.ts:158

Parameters

Parameter	Type
`accountType`	`EntityType`
`address`	`Address`

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

InvalidEntityIdError

Defined in: packages/sage/src/client/errors.ts:278

Error thrown when a generated account id cannot fit its unsigned 16-bit PDA seed.

Example

throw new InvalidEntityIdError('recipe', 65_536);

Extends

SageSdkError

Constructors

Constructor

new InvalidEntityIdError(entityType, id): InvalidEntityIdError;

Defined in: packages/sage/src/client/errors.ts:289

Parameters

Parameter	Type
`entityType`	\| `"starSystem"` \| `"celestialBody"` \| `"recipe"` \| `"market"` \| `"scanPattern"` \| `"faction"` \| `"region"`
`id`	`number`

Returns

InvalidEntityIdError

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

entityType

readonly entityType:
  | "starSystem"
  | "celestialBody"
  | "recipe"
  | "market"
  | "scanPattern"
  | "faction"
  | "region";

Defined in: packages/sage/src/client/errors.ts:279

id

readonly id: number;

Defined in: packages/sage/src/client/errors.ts:287

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

MissingGameContextError

MissingGameContextError

Defined in: packages/sage/src/client/errors.ts:261

Error thrown when an operation needs a canonical Game address.

Example

throw new MissingGameContextError();

Extends

SageSdkError

Constructors

Constructor

new MissingGameContextError(): MissingGameContextError;

Defined in: packages/sage/src/client/errors.ts:262

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

ProviderError

Defined in: packages/sage/src/client/errors.ts:209

Error thrown when the configured provider cannot satisfy a read.

Example

throw new ProviderError('The z.ink provider is unavailable. Check its endpoint and retry.');

Extends

SageSdkError

Constructors

Constructor

new ProviderError(message, details?): ProviderError;

Defined in: packages/sage/src/client/errors.ts:210

Parameters

Parameter	Type
`message`	`string`
`details`	`SageSdkErrorDetails`

Returns

ProviderError

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

RegistryOutOfSyncError

Defined in: packages/sage/src/client/errors.ts:430

Error thrown when live state and one cached definitions section disagree.

A cached section behind live state is marked for refresh on its next lookup. After an authoritative read confirms that mismatch, further refresh attempts for the section are coalesced for one second. Sequence-sensitive sections reject callers behind the loaded section. Ship lookups may reuse newer stable identity summaries; an id removed from the newer ship rows throws without scheduling an impossible historical refresh.

Example

throw new RegistryOutOfSyncError('ships', 12, 11, 3);

Extends

SageSdkError

Constructors

Constructor

new RegistryOutOfSyncError(
   section,
   expectedSequenceId,
   actualSequenceId,
   definitionId,
   definitionMissingAfterRefresh?): RegistryOutOfSyncError;

Defined in: packages/sage/src/client/errors.ts:446

Parameters

Parameter	Type	Default value
`section`	\| `"ships"` \| `"cargo"` \| `"buildings"` \| `"claimStakes"` \| `"craftingHabs"` \| `"habBuildings"` \| `"xp"` \| `"research"`	`undefined`
`expectedSequenceId`	`number` \| `undefined`	`undefined`
`actualSequenceId`	`number`	`undefined`
`definitionId`	`number`	`undefined`
`definitionMissingAfterRefresh`	`boolean`	`false`

Returns

RegistryOutOfSyncError

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

actualSequenceId

readonly actualSequenceId: number;

Defined in: packages/sage/src/client/errors.ts:441

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

definitionId

readonly definitionId: number;

Defined in: packages/sage/src/client/errors.ts:442

definitionMissingAfterRefresh

readonly definitionMissingAfterRefresh: boolean;

Defined in: packages/sage/src/client/errors.ts:444

Whether a fresh Game read already confirmed the definition is absent.

expectedSequenceId

readonly expectedSequenceId: number | undefined;

Defined in: packages/sage/src/client/errors.ts:440

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

section

readonly section:
  | "ships"
  | "cargo"
  | "buildings"
  | "claimStakes"
  | "craftingHabs"
  | "habBuildings"
  | "xp"
  | "research";

Defined in: packages/sage/src/client/errors.ts:431

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

RelationshipNotDiscoverableError

RelationshipNotDiscoverableError

Defined in: packages/sage/src/client/errors.ts:248

Error thrown when a requested relationship has no configured discovery capability.

Example

throw new RelationshipNotDiscoverableError(
  'Wallet-to-Profile discovery is unavailable. Configure a provider.',
);

Extends

SageSdkError

Constructors

Constructor

new RelationshipNotDiscoverableError(message, details?): RelationshipNotDiscoverableError;

Defined in: packages/sage/src/client/errors.ts:249

Parameters

Parameter	Type
`message`	`string`
`details`	`SageSdkErrorDetails`

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

ResourceLimitExceededError

ResourceLimitExceededError

Defined in: packages/sage/src/client/errors.ts:222

Error thrown before an untrusted collection or payload can exceed a context limit.

Example

throw new ResourceLimitExceededError('discovery results', 1001, 1000);

Extends

SageSdkError

Constructors

Constructor

new ResourceLimitExceededError(
   resource,
   actual,
   limit): ResourceLimitExceededError;

Defined in: packages/sage/src/client/errors.ts:228

Parameters

Parameter	Type
`resource`	`string`
`actual`	`number`
`limit`	`number`

Returns

Overrides

Properties

accountType

readonly accountType: EntityType | undefined;

Inherited from

actual

readonly actual: number;

Defined in: packages/sage/src/client/errors.ts:225

The observed quantity, or a conservative decoded-byte upper bound when an encoded payload is rejected before decoding.

address

readonly address: Address | undefined;

Inherited from

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

code

readonly code: SageSdkErrorCode;

Inherited from

limit

readonly limit: number;

Defined in: packages/sage/src/client/errors.ts:226

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

Inherited from

resource

readonly resource: string;

Defined in: packages/sage/src/client/errors.ts:223

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

strategy

readonly strategy: DiscoveryStrategy | undefined;

Inherited from

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

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

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

SageSdkError

Defined in: packages/sage/src/client/errors.ts:68

Base error for all SDK failures.

Messages identify the gameplay cause and a corrective next step.

Example

throw new SageSdkError(
  'ACCOUNT_NOT_FOUND',
  'The Fleet account was not found. Verify the Fleet address and cluster.',
);

Extends

Error

Extended by

Constructors

Constructor

new SageSdkError(
   code,
   message,
   details?): SageSdkError;

Defined in: packages/sage/src/client/errors.ts:75

Parameters

Parameter	Type
`code`	`SageSdkErrorCode`
`message`	`string`
`details`	`SageSdkErrorDetails`

Returns

SageSdkError

Overrides

Error.constructor

Properties

accountType

readonly accountType: EntityType | undefined;

address

readonly address: Address | undefined;

cause?

optional cause?: unknown;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

code

readonly code: SageSdkErrorCode;

message

message: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

provider

readonly provider:
  | DataSourceIdentity
  | undefined;

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

strategy

readonly strategy: DiscoveryStrategy | undefined;

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

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@[email protected]/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/.pnpm/@[email protected]/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

Parameter	Type
`targetObject`	`object`
`constructorOpt?`	`Function`

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
`err`	`Error`
`stackTraces`	`CallSite`[]

Returns

any

See

Inherited from

Error.prepareStackTrace

Interfaces

AccountDefinition

Defined in: packages/sage/src/client/contracts.ts:446

Adapter-owned definition for validating and decoding one account type.

Decoded snapshots may contain primitives, arrays, and plain objects. Account definitions must normalize mutation-capable built-ins such as typed arrays, Date, Map, and Set to immutable domain values before returning them. The returned value must be an acyclic JSON-safe tree without undefined, symbol-keyed properties, accessors, or functions. Acyclic repeated object references are allowed and retain their identity in the frozen runtime tree. Each decoder receives an isolated copy of the untrusted provider account, so decoder mutation cannot affect another concurrent decoder or raw read. Decoders return plain data without methods. Public domain layers attach their required toJSON() method after reading through this port; returning a method from decode violates the immutable plain-data contract. A context reuses decoded cache entries only for the same definition object; distinct definitions cannot consume or overwrite each other’s typed data. Keep definitions as stable module-level singletons. Reconstructing an equivalent definition for each call deliberately creates independent cache slots and prevents cache reuse.

Example

declare const programAddress: Address;
const definition: AccountDefinition<{ name: string }> = {
  type: 'fleet',
  programAddress,
  discriminator: new Uint8Array([1]),
  minimumDataLength: 128,
  decode: () => ({ name: 'Ravager' }),
};

Type Parameters

Type Parameter
`TSnapshot`

Properties

discriminator

readonly discriminator: readonly number[] | Uint8Array<ArrayBufferLike>;

Defined in: packages/sage/src/client/contracts.ts:449

minimumDataLength?

readonly optional minimumDataLength?: number;

Defined in: packages/sage/src/client/contracts.ts:451

Optional positive safe-integer byte minimum enforced before decoding.

programAddress

readonly programAddress: Address;

Defined in: packages/sage/src/client/contracts.ts:448

type

readonly type: EntityType;

Defined in: packages/sage/src/client/contracts.ts:447

Methods

decode()

decode(account): Readonly<TSnapshot>;

Defined in: packages/sage/src/client/contracts.ts:452

Parameters

Parameter	Type
`account`	`RawAccount`

Returns

Readonly<TSnapshot>

AccountProvider

Defined in: packages/sage/src/client/contracts.ts:330

Provider contract for raw z.ink account access.

Provider results remain untrusted until an account definition validates and decodes them. Provider implementations must sanitize transport-specific causes before wrapping them in a typed SageSdkError; unknown exceptions are normalized by the data plane without retaining their raw cause.

Example

const provider: AccountProvider = {
  identity: { kind: 'fixture', name: 'unit-test' },
  readAccount: async () => undefined,
  discoverAccounts: async () => [],
};

Properties

identity

readonly identity: DataSourceIdentity;

Defined in: packages/sage/src/client/contracts.ts:331

Methods

discoverAccounts()

discoverAccounts(request): Promise<readonly RawAccount[]>;

Defined in: packages/sage/src/client/contracts.ts:347

Parameters

Parameter	Type
`request`	`ProgramAccountRequest`

Returns

Promise<readonly RawAccount[]>

readAccount()

readAccount(address, options?): Promise<RawAccount | undefined>;

Defined in: packages/sage/src/client/contracts.ts:332

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadAccountOptions`

Returns

Promise<RawAccount | undefined>

readAccounts()?

optional readAccounts(addresses, options?): Promise<readonly (RawAccount | undefined)[]>;

Defined in: packages/sage/src/client/contracts.ts:343

Optional provider batching capability.

Implementations preserve input order. Callers can fall back to ordered readAccount calls when a provider does not expose this transport method. Large reads can span multiple source slots because every RPC chunk records its own response context.

Parameters

Parameter	Type
`addresses`	readonly `Address`[]
`options?`	`ReadAccountOptions`

Returns

Promise<readonly (RawAccount | undefined)[]>

CacheKey

Defined in: packages/sage/src/client/contracts.ts:778

Address-keyed cache identity scoped to one context.

Example

declare const programAddress: Address;
declare const address: Address;
const key: CacheKey = { cluster: 'zink-ptr', programAddress, accountType: 'fleet', address };

Properties

accountType

readonly accountType: EntityType;

Defined in: packages/sage/src/client/contracts.ts:781

address

readonly address: Address;

Defined in: packages/sage/src/client/contracts.ts:782

cluster

readonly cluster: ClusterIdentity;

Defined in: packages/sage/src/client/contracts.ts:779

programAddress

readonly programAddress: Address;

Defined in: packages/sage/src/client/contracts.ts:780

CacheRecord

Defined in: packages/sage/src/client/contracts.ts:796

Compatibility prototype; not the runtime cache representation.

The shipped context owns its cache internally and does not expose cache records for inspection or mutation.

Example

declare const record: CacheRecord<unknown>;
const snapshot = record.invalidated ? undefined : record.snapshot;

Type Parameters

Type Parameter
`TSnapshot`

Properties

invalidated

readonly invalidated: boolean;

Defined in: packages/sage/src/client/contracts.ts:799

key

readonly key: CacheKey;

Defined in: packages/sage/src/client/contracts.ts:797

snapshot

readonly snapshot: SnapshotEnvelope<TSnapshot>;

Defined in: packages/sage/src/client/contracts.ts:798

CustomClusterIdentity

Defined in: packages/sage/src/client/contracts.ts:143

An application-defined cluster identity.

Example

const cluster: CustomClusterIdentity = { name: 'local-fixture' };

Properties

name

readonly name: string;

Defined in: packages/sage/src/client/contracts.ts:144

DataSourceIdentity

Defined in: packages/sage/src/client/contracts.ts:163

The source that supplied a raw account or translated snapshot.

Example

const source: DataSourceIdentity = { kind: 'fixture', name: 'unit-test' };

Properties

kind

readonly kind: "indexer" | "rpc" | "websocket" | "fixture" | "application";

Defined in: packages/sage/src/client/contracts.ts:164

name

readonly name: string;

Defined in: packages/sage/src/client/contracts.ts:165

DiagnosticEvent

Defined in: packages/sage/src/client/contracts.ts:812

Compatibility prototype; no context-wide diagnostic emitter ships.

Shipped diagnostics are limited to finder provenance through readMeta() and subscription delivery events through SubscriptionObserver.onDiagnostic.

Example

const event: DiagnosticEvent = { kind: 'cache-hit', cluster: 'zink-ptr' };

Properties

accountType?

readonly optional accountType?: EntityType;

Defined in: packages/sage/src/client/contracts.ts:817

address?

readonly optional address?: Address;

Defined in: packages/sage/src/client/contracts.ts:816

cluster

readonly cluster: ClusterIdentity;

Defined in: packages/sage/src/client/contracts.ts:815

kind

readonly kind:
  | "cache-hit"
  | "cache-miss"
  | "provider-read"
  | "validation"
  | "discovery";

Defined in: packages/sage/src/client/contracts.ts:813

DiscoveryRequest

Defined in: packages/sage/src/client/contracts.ts:533

A discovery request supplied to the shared data port.

Discovery always consults the provider, so direct-read freshness controls such as refresh and maxAgeMs are intentionally unavailable.

Example

const request: DiscoveryRequest = {
  strategy: 'targeted-program-accounts',
  filters: [],
};

Extends

ReadAccountOptions

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

Inherited from

filters

readonly filters: readonly ProgramAccountFilter[];

Defined in: packages/sage/src/client/contracts.ts:543

policy?

readonly optional policy?: "cache-first" | "no-store";

Defined in: packages/sage/src/client/contracts.ts:535

Controls whether validated discoveries populate the account cache.

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

Inherited from

ProgramAccountRequest.commitment

strategy

readonly strategy: AccountDiscoveryStrategy;

Defined in: packages/sage/src/client/contracts.ts:542

Selects the discovery behavior when no indexer takes precedence.

When an indexer is configured, targeted-program-accounts, broad-scan, and indexer are advisory and use the indexer. Use direct or derived to bypass the indexer for a request.

IndexerDiscoveryRequest

Defined in: packages/sage/src/client/contracts.ts:239

Address-only discovery request accepted by a replaceable indexer.

Indexers return candidate addresses, never decoded domain state. The context validates every candidate through its direct account provider before a finder can expose it.

Example

declare const programAddress: Address;
const request: IndexerDiscoveryRequest = {
  accountType: 'fleet',
  programAddress,
  filters: [],
};

Extends

ProgramAccountRequest

Properties

accountType

readonly accountType: EntityType;

Defined in: packages/sage/src/client/contracts.ts:240

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

Inherited from

filters

readonly filters: readonly ProgramAccountFilter[];

Defined in: packages/sage/src/client/contracts.ts:220

Inherited from

ProgramAccountRequest.filters

programAddress

readonly programAddress: Address;

Defined in: packages/sage/src/client/contracts.ts:219

Inherited from

ProgramAccountRequest.programAddress

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

Inherited from

ProgramAccountRequest.signal

IndexerProvider

Defined in: packages/sage/src/client/contracts.ts:262

Optional address-only provider for reverse and high-cardinality discovery.

Implementations must treat signal as cancellation, preserve candidate order, and sanitize transport failures before throwing a SageSdkError. Duplicate addresses are allowed; the context deduplicates them before direct validation. A configured provider must support every account type and stable filter request that its context may issue. An empty result means the request is supported and has no candidates; it does not trigger RPC fallback. Use a separate context or the direct/derived strategies when indexer coverage is intentionally partial.

Example

const indexer: IndexerProvider = {
  identity: { kind: 'indexer', name: 'application-indexer' },
  discoverAddresses: async () => [],
};

Properties

identity

readonly identity: DataSourceIdentity & {
  kind: "indexer";
};

Defined in: packages/sage/src/client/contracts.ts:263

Type Declaration

kind

readonly kind: "indexer";

Methods

discoverAddresses()

discoverAddresses(request): Promise<readonly Address[]>;

Defined in: packages/sage/src/client/contracts.ts:264

Parameters

Parameter	Type
`request`	`IndexerDiscoveryRequest`

Returns

Promise<readonly Address[]>

IndexerValidationMeta

Defined in: packages/sage/src/internal/read-meta.ts:49

Conservative validation summary for address hints returned by an indexer.

Example

const summary: IndexerValidationMeta = {
  candidateCount: 3,
  duplicateCount: 1,
  missingCount: 1,
  validatedCount: 1,
};

Properties

candidateCount

readonly candidateCount: number;

Defined in: packages/sage/src/internal/read-meta.ts:50

duplicateCount

readonly duplicateCount: number;

Defined in: packages/sage/src/internal/read-meta.ts:51

missingCount

readonly missingCount: number;

Defined in: packages/sage/src/internal/read-meta.ts:52

validatedCount

readonly validatedCount: number;

Defined in: packages/sage/src/internal/read-meta.ts:53

ProgramAccountFilter

Defined in: packages/sage/src/client/contracts.ts:205

A verified byte comparison used for targeted program-account discovery.

Example

const filter: ProgramAccountFilter = { offset: 0, bytes: new Uint8Array([1]) };

Properties

bytes

readonly bytes: Uint8Array;

Defined in: packages/sage/src/client/contracts.ts:207

offset

readonly offset: number;

Defined in: packages/sage/src/client/contracts.ts:206

ProgramAccountRequest

Defined in: packages/sage/src/client/contracts.ts:218

A targeted program-account request using only adapter-verified offsets.

Example

declare const programAddress: Address;
const request: ProgramAccountRequest = { programAddress, filters: [] };

Extends

ReadAccountOptions

Extended by

IndexerDiscoveryRequest

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

Inherited from

filters

readonly filters: readonly ProgramAccountFilter[];

Defined in: packages/sage/src/client/contracts.ts:220

programAddress

readonly programAddress: Address;

Defined in: packages/sage/src/client/contracts.ts:219

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

Inherited from

RawAccount

Defined in: packages/sage/src/client/contracts.ts:176

Raw, untrusted account bytes returned by a provider.

Example

declare const rawAccount: RawAccount;
const bytes = rawAccount.data;

Properties

address

readonly address: Address;

Defined in: packages/sage/src/client/contracts.ts:177

commitment

readonly commitment: Commitment;

Defined in: packages/sage/src/client/contracts.ts:183

data

readonly data: Uint8Array;

Defined in: packages/sage/src/client/contracts.ts:180

executable

readonly executable: boolean;

Defined in: packages/sage/src/client/contracts.ts:181

lamports

readonly lamports: bigint;

Defined in: packages/sage/src/client/contracts.ts:179

owner

readonly owner: Address;

Defined in: packages/sage/src/client/contracts.ts:178

slot

readonly slot: bigint;

Defined in: packages/sage/src/client/contracts.ts:182

ReadAccountOptions

Defined in: packages/sage/src/client/contracts.ts:193

Options shared by direct and batched raw-account reads.

Example

const options: ReadAccountOptions = { commitment: 'confirmed' };

Extended by

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

ReadOptions

Defined in: packages/sage/src/client/contracts.ts:484

Cache-first read controls for account and finder operations.

Example

const options: ReadOptions = { refresh: true, commitment: 'confirmed' };

Extends

ReadAccountOptions

Extended by

MarketDiscoveryOptions

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

Inherited from

maxAgeMs?

readonly optional maxAgeMs?: number;

Defined in: packages/sage/src/client/contracts.ts:496

Maximum age of a completed cache entry in milliseconds.

Overrides the context’s defaultMaxAgeMs. Use 0 to always revalidate or Infinity to reuse completed cache entries until explicit invalidation.

policy?

readonly optional policy?: "cache-first" | "no-store";

Defined in: packages/sage/src/client/contracts.ts:497

refresh?

readonly optional refresh?: boolean;

Defined in: packages/sage/src/client/contracts.ts:490

Bypasses a completed cache entry.

A refresh may share a compatible provider request that is already in flight, because that request has not yet produced cached state.

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

Inherited from

RpcSubscriptionProviderOptions

Defined in: packages/sage/src/client/rpc-subscription-provider.ts:21

Options for the injected Kit WebSocket account adapter. No connection is opened by the factory.

Example

import type { AccountNotificationsApi, RpcSubscriptions } from '@solana/kit';
declare const rpcSubscriptions: RpcSubscriptions<AccountNotificationsApi>;
const options: RpcSubscriptionProviderOptions = { rpcSubscriptions };

Properties

backoff?

readonly optional backoff?: {
  initialMs?: number;
  maxMs?: number;
};

Defined in: packages/sage/src/client/rpc-subscription-provider.ts:25

initialMs?

readonly optional initialMs?: number;

maxMs?

readonly optional maxMs?: number;

identity?

readonly optional identity?: DataSourceIdentity;

Defined in: packages/sage/src/client/rpc-subscription-provider.ts:24

Non-secret provenance label; never supply an endpoint or credentials.

rpcSubscriptions

readonly rpcSubscriptions: RpcSubscriptions<AccountNotificationsApi>;

Defined in: packages/sage/src/client/rpc-subscription-provider.ts:22

SageDataPort

Defined in: packages/sage/src/client/contracts.ts:647

Public read and discovery boundary shared by built-in domains and extensions.

Cache entries are partitioned by stable account-definition object identity and may retain one view per commitment. They remain in memory until replaced, explicitly removed with invalidate(), or released when the owning context is disposed. The context rejects new cache keys above maxCacheEntries; callers can use no-store for intentional reads beyond that bound. Reconstructing definitions per call can therefore exhaust the configured capacity. Invalidation retains lightweight per-key generation barriers until context disposal so older in-flight reads and discoveries cannot repopulate a removed entry.

Example

declare const ctx: SageContext;
declare const definition: AccountDefinition<unknown>;
declare const address: Address;
const data: SageDataPort = ctx.data;
const envelope = await data.read(definition, address);
data.invalidate(definition, address);

Methods

discover()

discover<TSnapshot>(definition, request): Promise<readonly SnapshotEnvelope<TSnapshot>[]>;

Defined in: packages/sage/src/client/contracts.ts:674

Type Parameters

Type Parameter
`TSnapshot`

Parameters

Parameter	Type
`definition`	`AccountDefinition`<`TSnapshot`>
`request`	`DiscoveryRequest`

Returns

Promise<readonly SnapshotEnvelope<TSnapshot>[]>

invalidate()

invalidate<TSnapshot>(definition, address): void;

Defined in: packages/sage/src/client/contracts.ts:654

Removes the exact cached account generation.

Operations that started before invalidation may still resolve to their original callers, but cannot repopulate this cache entry or satisfy reads that start after invalidation.

Type Parameters

Type Parameter
`TSnapshot`

Parameters

Parameter	Type
`definition`	`AccountDefinition`<`TSnapshot`>
`address`	`Address`

Returns

void

read()

read<TSnapshot>(
   definition,
   address,
options?): Promise<SnapshotEnvelope<TSnapshot>>;

Defined in: packages/sage/src/client/contracts.ts:658

Type Parameters

Type Parameter
`TSnapshot`

Parameters

Parameter	Type
`definition`	`AccountDefinition`<`TSnapshot`>
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<SnapshotEnvelope<TSnapshot>>

readMany()

readMany<TSnapshot>(
   definition,
   addresses,
   options?): Promise<readonly (
  | SnapshotEnvelope<TSnapshot>
| undefined)[]>;

Defined in: packages/sage/src/client/contracts.ts:669

Reads addresses in input order.

Context reads remain individually deduplicated. Uncached unique addresses use provider batching when available; direct-only providers use a bounded fallback worker pool.

Type Parameters

Type Parameter
`TSnapshot`

Parameters

Parameter	Type
`definition`	`AccountDefinition`<`TSnapshot`>
`addresses`	readonly `Address`[]
`options?`	`ReadOptions`

Returns

Promise<readonly ( | SnapshotEnvelope<TSnapshot> | undefined)[]>

readRaw()

readRaw(address, options?): Promise<RawAccount | undefined>;

Defined in: packages/sage/src/client/contracts.ts:692

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadAccountOptions`

Returns

Promise<RawAccount | undefined>

subscribe<TSnapshot>(
   definition,
   address,
   observer,
options?): Promise<SageSubscription>;

Defined in: packages/sage/src/client/contracts.ts:686

Subscribes to one typed account and emits the selected cache view.

Registration establishes the WebSocket listener first, then performs one direct read to close the registration race and emit current state. Valid stream updates use the same validation and cache path as direct reads. A failed initial read is reported through onError; it does not reject the subscription handle or end the registered stream.

Type Parameters

Type Parameter
`TSnapshot`

Parameters

Parameter	Type
`definition`	`AccountDefinition`<`TSnapshot`>
`address`	`Address`
`observer`	`SubscriptionObserver`<`TSnapshot`>
`options?`	`ReadAccountOptions`

Returns

Promise<SageSubscription>

SageSdkErrorDetails

Defined in: packages/sage/src/client/errors.ts:48

Safe contextual fields carried by SDK errors.

Example

declare const address: Address;
const details: SageSdkErrorDetails = { accountType: 'fleet', address };

Properties

accountType?

readonly optional accountType?: EntityType;

Defined in: packages/sage/src/client/errors.ts:49

address?

readonly optional address?: Address;

Defined in: packages/sage/src/client/errors.ts:50

cause?

readonly optional cause?: unknown;

Defined in: packages/sage/src/client/errors.ts:51

provider?

readonly optional provider?: DataSourceIdentity;

Defined in: packages/sage/src/client/errors.ts:52

strategy?

readonly optional strategy?: DiscoveryStrategy;

Defined in: packages/sage/src/client/errors.ts:53

SnapshotEnvelope

Defined in: packages/sage/src/client/contracts.ts:464

A fully described immutable account snapshot plus its read provenance.

Example

declare const envelope: SnapshotEnvelope<unknown>;
const slot = envelope.slot;
const snapshot = envelope.data;

Type Parameters

Type Parameter
`TSnapshot`

Properties

accountType

readonly accountType: EntityType;

Defined in: packages/sage/src/client/contracts.ts:468

address

readonly address: Address;

Defined in: packages/sage/src/client/contracts.ts:466

commitment

readonly commitment: Commitment;

Defined in: packages/sage/src/client/contracts.ts:470

data

readonly data: Readonly<TSnapshot>;

Defined in: packages/sage/src/client/contracts.ts:465

fetchedAt

readonly fetchedAt: number;

Defined in: packages/sage/src/client/contracts.ts:471

programAddress

readonly programAddress: Address;

Defined in: packages/sage/src/client/contracts.ts:467

slot

readonly slot: bigint;

Defined in: packages/sage/src/client/contracts.ts:469

source

readonly source: DataSourceIdentity;

Defined in: packages/sage/src/client/contracts.ts:472

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/client/contracts.ts:474

Returns a JSON-safe copy with every bigint represented as a decimal string.

Returns

unknown

WalletProfileDiscoveryProvider

Defined in: packages/sage/src/client/contracts.ts:307

Replaceable address-only provider for wallet-to-Profile discovery.

Implementations may use an application index, service, or recorded mapping, but their output is never authoritative. They return Profile addresses only; the SDK validates account ownership, discriminator, shape, and the stored wallet-key relationship through its direct account provider. Duplicate and stale addresses are permitted and reported through finder metadata. Concurrent requests for the same wallet and commitment are single-flighted per context; cancelling one caller does not cancel the shared provider call. Shared operations are in-flight only: a settled failure is removed so a later request can retry the provider. Implementations must sanitize transport-specific causes before throwing a typed SageSdkError; unknown exceptions are normalized without their cause.

Example

const walletProfiles: WalletProfileDiscoveryProvider = {
  identity: { kind: 'indexer', name: 'application-wallet-index' },
  discoverProfileAddresses: async () => [],
};

Properties

identity

readonly identity: DataSourceIdentity;

Defined in: packages/sage/src/client/contracts.ts:308

Methods

discoverProfileAddresses()

discoverProfileAddresses(request): Promise<readonly Address[]>;

Defined in: packages/sage/src/client/contracts.ts:309

Parameters

Parameter	Type
`request`	`WalletProfileDiscoveryRequest`

Returns

Promise<readonly Address[]>

WalletProfileDiscoveryRequest

Defined in: packages/sage/src/client/contracts.ts:281

Address-only request accepted by a wallet-to-Profile discovery provider.

The provider returns hints only. The identity domain directly reads every candidate Profile and verifies that its decoded key list contains the requested wallet before exposing it.

Example

declare const wallet: Address;
const request: WalletProfileDiscoveryRequest = { wallet };

Extends

ReadAccountOptions

Properties

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:194

Inherited from

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:195

Inherited from