Documentation: 0.5.0 (source: v0.5.0).
# client

Markdown source of https://docs-v0-5-0.atlas-kit-docs.pages.dev/reference/client/ — see https://docs-v0-5-0.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Classes

<a id="accountdecodeerror"></a>

### AccountDecodeError

Defined in: [packages/sage/src/client/errors.ts:190](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L190)

Error thrown when validated account data cannot produce a trustworthy SDK snapshot.

#### Examples

```ts
declare const fleetAddress: Address;
declare const cause: unknown;
throw new AccountDecodeError('fleet', fleetAddress, cause);
```

```ts
declare const characterAddress: Address;
declare const cause: unknown;
throw new AccountDecodeError(
  'character',
  characterAddress,
  cause,
  'The Character references a different Profile. Verify the Profile address and retry.',
);
```

#### Param

**message**

Optional cause-and-remedy guidance for validated data that
decoded successfully but contradicts the requested gameplay relationship.

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor"></a>

##### Constructor

```ts
new AccountDecodeError(
   accountType, 
   address, 
   cause, 
   message?): AccountDecodeError;
```

Defined in: [packages/sage/src/client/errors.ts:191](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L191)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accountType` | [`EntityType`](/reference/client/#entitytype-1) |
| `address` | [`Address`](/reference/#address-19) |
| `cause` | `unknown` |
| `message` | `string` |

###### Returns

[`AccountDecodeError`](/reference/client/#accountdecodeerror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="accountnotfounderror"></a>

### AccountNotFoundError

Defined in: [packages/sage/src/client/errors.ts:113](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L113)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-1"></a>

##### Constructor

```ts
new AccountNotFoundError(accountType, address): AccountNotFoundError;
```

Defined in: [packages/sage/src/client/errors.ts:114](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L114)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accountType` | [`EntityType`](/reference/client/#entitytype-1) |
| `address` | [`Address`](/reference/#address-19) |

###### Returns

[`AccountNotFoundError`](/reference/client/#accountnotfounderror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-1"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-1"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-1"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-1"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-1"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-1"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-1"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-1"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-1"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-1"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-1"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-1"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="contextdisposederror"></a>

### ContextDisposedError

Defined in: [packages/sage/src/client/errors.ts:96](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L96)

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

#### Example

```ts
throw new ContextDisposedError();
```

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-2"></a>

##### Constructor

```ts
new ContextDisposedError(): ContextDisposedError;
```

Defined in: [packages/sage/src/client/errors.ts:97](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L97)

###### Returns

[`ContextDisposedError`](/reference/client/#contextdisposederror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-2"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-2"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-2"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-2"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-2"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-2"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-2"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-2"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-2"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-2"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-2"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-2"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="invalidaccountownererror"></a>

### InvalidAccountOwnerError

Defined in: [packages/sage/src/client/errors.ts:133](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L133)

Error thrown when an account belongs to a different program.

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-3"></a>

##### Constructor

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

Defined in: [packages/sage/src/client/errors.ts:134](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L134)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accountType` | [`EntityType`](/reference/client/#entitytype-1) |
| `address` | [`Address`](/reference/#address-19) |
| `expectedOwner` | [`Address`](/reference/#address-19) |
| `actualOwner` | [`Address`](/reference/#address-19) |

###### Returns

[`InvalidAccountOwnerError`](/reference/client/#invalidaccountownererror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-3"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-3"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-3"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-3"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-3"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-3"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-3"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-3"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-3"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-3"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-3"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-3"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="invalidderivationinputerror"></a>

### InvalidDerivationInputError

Defined in: [packages/sage/src/client/errors.ts:334](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L334)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-4"></a>

##### Constructor

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

Defined in: [packages/sage/src/client/errors.ts:338](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L338)

###### Parameters

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

###### Returns

[`InvalidDerivationInputError`](/reference/client/#invalidderivationinputerror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-4"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-4"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-4"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-4"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="field"></a>

##### field

```ts
readonly field: string;
```

Defined in: [packages/sage/src/client/errors.ts:335](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L335)

<a id="message-4"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-4"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-4"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-4"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-4"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="value"></a>

##### value

```ts
readonly value: number | bigint;
```

Defined in: [packages/sage/src/client/errors.ts:336](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L336)

<a id="stacktracelimit-4"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-4"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-4"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="invaliddiscriminatorerror"></a>

### InvalidDiscriminatorError

Defined in: [packages/sage/src/client/errors.ts:156](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L156)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-5"></a>

##### Constructor

```ts
new InvalidDiscriminatorError(accountType, address): InvalidDiscriminatorError;
```

Defined in: [packages/sage/src/client/errors.ts:157](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L157)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `accountType` | [`EntityType`](/reference/client/#entitytype-1) |
| `address` | [`Address`](/reference/#address-19) |

###### Returns

[`InvalidDiscriminatorError`](/reference/client/#invaliddiscriminatorerror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-5"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-5"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-5"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-5"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-5"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-5"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-5"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-5"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-5"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-5"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-5"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-5"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="invalidentityiderror"></a>

### InvalidEntityIdError

Defined in: [packages/sage/src/client/errors.ts:277](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L277)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-6"></a>

##### Constructor

```ts
new InvalidEntityIdError(entityType, id): InvalidEntityIdError;
```

Defined in: [packages/sage/src/client/errors.ts:288](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L288)

###### Parameters

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

###### Returns

[`InvalidEntityIdError`](/reference/client/#invalidentityiderror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-6"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-6"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-6"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-6"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="entitytype"></a>

##### entityType

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

Defined in: [packages/sage/src/client/errors.ts:278](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L278)

<a id="id"></a>

##### id

```ts
readonly id: number;
```

Defined in: [packages/sage/src/client/errors.ts:286](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L286)

<a id="message-6"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-6"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-6"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-6"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-6"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-6"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-6"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-6"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="missinggamecontexterror"></a>

### MissingGameContextError

Defined in: [packages/sage/src/client/errors.ts:260](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L260)

Error thrown when an operation needs a canonical Game address.

#### Example

```ts
throw new MissingGameContextError();
```

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-7"></a>

##### Constructor

```ts
new MissingGameContextError(): MissingGameContextError;
```

Defined in: [packages/sage/src/client/errors.ts:261](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L261)

###### Returns

[`MissingGameContextError`](/reference/client/#missinggamecontexterror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-7"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-7"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-7"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-7"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-7"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-7"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-7"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-7"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-7"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-7"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-7"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-7"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="providererror"></a>

### ProviderError

Defined in: [packages/sage/src/client/errors.ts:208](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L208)

Error thrown when the configured provider cannot satisfy a read.

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-8"></a>

##### Constructor

```ts
new ProviderError(message, details?): ProviderError;
```

Defined in: [packages/sage/src/client/errors.ts:209](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L209)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `message` | `string` |
| `details` | [`SageSdkErrorDetails`](/reference/client/#sagesdkerrordetails) |

###### Returns

[`ProviderError`](/reference/client/#providererror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-8"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-8"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-8"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-8"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-8"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-8"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-8"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-8"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-8"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-8"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-8"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-8"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="registryoutofsyncerror"></a>

### RegistryOutOfSyncError

Defined in: [packages/sage/src/client/errors.ts:397](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L397)

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

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-9"></a>

##### Constructor

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

Defined in: [packages/sage/src/client/errors.ts:406](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L406)

###### Parameters

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

###### Returns

[`RegistryOutOfSyncError`](/reference/client/#registryoutofsyncerror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-9"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="actualsequenceid"></a>

##### actualSequenceId

```ts
readonly actualSequenceId: number;
```

Defined in: [packages/sage/src/client/errors.ts:401](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L401)

<a id="address-9"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-9"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-9"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="definitionid"></a>

##### definitionId

```ts
readonly definitionId: number;
```

Defined in: [packages/sage/src/client/errors.ts:402](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L402)

<a id="definitionmissingafterrefresh"></a>

##### definitionMissingAfterRefresh

```ts
readonly definitionMissingAfterRefresh: boolean;
```

Defined in: [packages/sage/src/client/errors.ts:404](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L404)

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

<a id="expectedsequenceid"></a>

##### expectedSequenceId

```ts
readonly expectedSequenceId: number | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:400](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L400)

<a id="message-9"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-9"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-9"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="section"></a>

##### section

```ts
readonly section: "ships" | "cargo" | "craftingHabs" | "habBuildings" | "xp" | "research";
```

Defined in: [packages/sage/src/client/errors.ts:398](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L398)

<a id="stack-9"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-9"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-9"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-9"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-9"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="relationshipnotdiscoverableerror"></a>

### RelationshipNotDiscoverableError

Defined in: [packages/sage/src/client/errors.ts:247](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L247)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-10"></a>

##### Constructor

```ts
new RelationshipNotDiscoverableError(message, details?): RelationshipNotDiscoverableError;
```

Defined in: [packages/sage/src/client/errors.ts:248](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L248)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `message` | `string` |
| `details` | [`SageSdkErrorDetails`](/reference/client/#sagesdkerrordetails) |

###### Returns

[`RelationshipNotDiscoverableError`](/reference/client/#relationshipnotdiscoverableerror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-10"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="address-10"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-10"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-10"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="message-10"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-10"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-10"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="stack-10"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-10"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-10"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-10"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-10"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="resourcelimitexceedederror"></a>

### ResourceLimitExceededError

Defined in: [packages/sage/src/client/errors.ts:221](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L221)

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

#### Example

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

#### Extends

- [`SageSdkError`](/reference/client/#sagesdkerror)

#### Constructors

<a id="constructor-11"></a>

##### Constructor

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

Defined in: [packages/sage/src/client/errors.ts:227](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L227)

###### Parameters

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

###### Returns

[`ResourceLimitExceededError`](/reference/client/#resourcelimitexceedederror)

###### Overrides

[`SageSdkError`](/reference/client/#sagesdkerror).[`constructor`](/reference/client/#sagesdkerror)

#### Properties

<a id="accounttype-11"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`accountType`](/reference/client/#sagesdkerror)

<a id="actual"></a>

##### actual

```ts
readonly actual: number;
```

Defined in: [packages/sage/src/client/errors.ts:224](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L224)

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

<a id="address-11"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`address`](/reference/client/#sagesdkerror)

<a id="cause-11"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`cause`](/reference/client/#sagesdkerror)

<a id="code-11"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`code`](/reference/client/#sagesdkerror)

<a id="limit"></a>

##### limit

```ts
readonly limit: number;
```

Defined in: [packages/sage/src/client/errors.ts:225](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L225)

<a id="message-11"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`message`](/reference/client/#sagesdkerror)

<a id="name-11"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`name`](/reference/client/#sagesdkerror)

<a id="provider-11"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`provider`](/reference/client/#sagesdkerror)

<a id="resource"></a>

##### resource

```ts
readonly resource: string;
```

Defined in: [packages/sage/src/client/errors.ts:222](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L222)

<a id="stack-11"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`stack`](/reference/client/#sagesdkerror)

<a id="strategy-11"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`strategy`](/reference/client/#sagesdkerror)

<a id="stacktracelimit-11"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

[`SageSdkError`](/reference/client/#sagesdkerror).[`stackTraceLimit`](/reference/client/#sagesdkerror)

#### Methods

<a id="capturestacktrace-11"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

[`SageSdkError`](/reference/client/#sagesdkerror).[`captureStackTrace`](/reference/client/#sagesdkerror)

<a id="preparestacktrace-11"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

[`SageSdkError`](/reference/client/#sagesdkerror).[`prepareStackTrace`](/reference/client/#sagesdkerror)

***

<a id="sagesdkerror"></a>

### SageSdkError

Defined in: [packages/sage/src/client/errors.ts:67](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L67)

Base error for all SDK failures.

Messages identify the gameplay cause and a corrective next step.

#### Example

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

#### Extends

- `Error`

#### Extended by

- [`AccountDecodeError`](/reference/client/#accountdecodeerror)
- [`AccountNotFoundError`](/reference/client/#accountnotfounderror)
- [`ContextDisposedError`](/reference/client/#contextdisposederror)
- [`InvalidAccountOwnerError`](/reference/client/#invalidaccountownererror)
- [`InvalidDiscriminatorError`](/reference/client/#invaliddiscriminatorerror)
- [`InvalidDerivationInputError`](/reference/client/#invalidderivationinputerror)
- [`InvalidEntityIdError`](/reference/client/#invalidentityiderror)
- [`MissingGameContextError`](/reference/client/#missinggamecontexterror)
- [`ProviderError`](/reference/client/#providererror)
- [`ResourceLimitExceededError`](/reference/client/#resourcelimitexceedederror)
- [`RelationshipNotDiscoverableError`](/reference/client/#relationshipnotdiscoverableerror)
- [`RegistryOutOfSyncError`](/reference/client/#registryoutofsyncerror)

#### Constructors

<a id="constructor-12"></a>

##### Constructor

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

Defined in: [packages/sage/src/client/errors.ts:74](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L74)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `code` | [`SageSdkErrorCode`](/reference/client/#sagesdkerrorcode-1) |
| `message` | `string` |
| `details` | [`SageSdkErrorDetails`](/reference/client/#sagesdkerrordetails) |

###### Returns

[`SageSdkError`](/reference/client/#sagesdkerror)

###### Overrides

```ts
Error.constructor
```

#### Properties

<a id="accounttype-12"></a>

##### accountType

```ts
readonly accountType: EntityType | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L69)

<a id="address-12"></a>

##### address

```ts
readonly address: Address | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L70)

<a id="cause-12"></a>

##### cause?

```ts
optional cause?: unknown;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26

###### Inherited from

```ts
Error.cause
```

<a id="code-12"></a>

##### code

```ts
readonly code: SageSdkErrorCode;
```

Defined in: [packages/sage/src/client/errors.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L68)

<a id="message-12"></a>

##### message

```ts
message: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077

###### Inherited from

```ts
Error.message
```

<a id="name-12"></a>

##### name

```ts
name: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

###### Inherited from

```ts
Error.name
```

<a id="provider-12"></a>

##### provider

```ts
readonly provider: 
  | DataSourceIdentity
  | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L71)

<a id="stack-12"></a>

##### stack?

```ts
optional stack?: string;
```

Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078

###### Inherited from

```ts
Error.stack
```

<a id="strategy-12"></a>

##### strategy

```ts
readonly strategy: DiscoveryStrategy | undefined;
```

Defined in: [packages/sage/src/client/errors.ts:72](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L72)

<a id="stacktracelimit-12"></a>

##### stackTraceLimit

```ts
static stackTraceLimit: number;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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

```ts
Error.stackTraceLimit
```

#### Methods

<a id="capturestacktrace-12"></a>

##### captureStackTrace()

```ts
static captureStackTrace(targetObject, constructorOpt?): void;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/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.

```js
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:

```js
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

```ts
Error.captureStackTrace
```

<a id="preparestacktrace-12"></a>

##### prepareStackTrace()

```ts
static prepareStackTrace(err, stackTraces): any;
```

Defined in: node\_modules/.pnpm/@types+node@24.10.1/node\_modules/@types/node/globals.d.ts:56

###### Parameters

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

###### Returns

`any`

###### See

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

###### Inherited from

```ts
Error.prepareStackTrace
```

## Interfaces

<a id="accountdefinition"></a>

### AccountDefinition

Defined in: [packages/sage/src/client/contracts.ts:431](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L431)

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

```ts
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

<a id="discriminator"></a>

##### discriminator

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

Defined in: [packages/sage/src/client/contracts.ts:434](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L434)

<a id="minimumdatalength"></a>

##### minimumDataLength?

```ts
readonly optional minimumDataLength?: number;
```

Defined in: [packages/sage/src/client/contracts.ts:436](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L436)

Optional positive safe-integer byte minimum enforced before decoding.

<a id="programaddress"></a>

##### programAddress

```ts
readonly programAddress: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:433](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L433)

<a id="type"></a>

##### type

```ts
readonly type: EntityType;
```

Defined in: [packages/sage/src/client/contracts.ts:432](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L432)

#### Methods

<a id="decode"></a>

##### decode()

```ts
decode(account): Readonly<TSnapshot>;
```

Defined in: [packages/sage/src/client/contracts.ts:437](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L437)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `account` | [`RawAccount`](/reference/client/#rawaccount) |

###### Returns

`Readonly`\<`TSnapshot`\>

***

<a id="accountprovider"></a>

### AccountProvider

Defined in: [packages/sage/src/client/contracts.ts:315](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L315)

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

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

#### Properties

<a id="identity"></a>

##### identity

```ts
readonly identity: DataSourceIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:316](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L316)

#### Methods

<a id="discoveraccounts"></a>

##### discoverAccounts()

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

Defined in: [packages/sage/src/client/contracts.ts:332](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L332)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`ProgramAccountRequest`](/reference/client/#programaccountrequest) |

###### Returns

`Promise`\<readonly [`RawAccount`](/reference/client/#rawaccount)[]\>

<a id="readaccount"></a>

##### readAccount()

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

Defined in: [packages/sage/src/client/contracts.ts:317](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L317)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadAccountOptions`](/reference/client/#readaccountoptions) |

###### Returns

`Promise`\<[`RawAccount`](/reference/client/#rawaccount) \| `undefined`\>

<a id="readaccounts"></a>

##### readAccounts()?

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

Defined in: [packages/sage/src/client/contracts.ts:328](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L328)

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`](/reference/#address-19)[] |
| `options?` | [`ReadAccountOptions`](/reference/client/#readaccountoptions) |

###### Returns

`Promise`\<readonly ([`RawAccount`](/reference/client/#rawaccount) \| `undefined`)[]\>

***

<a id="cachekey"></a>

### CacheKey

Defined in: [packages/sage/src/client/contracts.ts:763](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L763)

Address-keyed cache identity scoped to one context.

#### Example

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

#### Properties

<a id="accounttype-13"></a>

##### accountType

```ts
readonly accountType: EntityType;
```

Defined in: [packages/sage/src/client/contracts.ts:766](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L766)

<a id="address-13"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:767](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L767)

<a id="cluster"></a>

##### cluster

```ts
readonly cluster: ClusterIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:764](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L764)

<a id="programaddress-1"></a>

##### programAddress

```ts
readonly programAddress: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:765](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L765)

***

<a id="cacherecord"></a>

### CacheRecord

Defined in: [packages/sage/src/client/contracts.ts:781](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L781)

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

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

#### Type Parameters

| Type Parameter |
| ------ |
| `TSnapshot` |

#### Properties

<a id="invalidated"></a>

##### invalidated

```ts
readonly invalidated: boolean;
```

Defined in: [packages/sage/src/client/contracts.ts:784](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L784)

<a id="key"></a>

##### key

```ts
readonly key: CacheKey;
```

Defined in: [packages/sage/src/client/contracts.ts:782](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L782)

<a id="snapshot"></a>

##### snapshot

```ts
readonly snapshot: SnapshotEnvelope<TSnapshot>;
```

Defined in: [packages/sage/src/client/contracts.ts:783](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L783)

***

<a id="customclusteridentity"></a>

### CustomClusterIdentity

Defined in: [packages/sage/src/client/contracts.ts:128](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L128)

An application-defined cluster identity.

#### Example

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

#### Properties

<a id="name-13"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/client/contracts.ts:129](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L129)

***

<a id="datasourceidentity"></a>

### DataSourceIdentity

Defined in: [packages/sage/src/client/contracts.ts:148](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L148)

The source that supplied a raw account or translated snapshot.

#### Example

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

#### Properties

<a id="kind"></a>

##### kind

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

Defined in: [packages/sage/src/client/contracts.ts:149](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L149)

<a id="name-14"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/client/contracts.ts:150](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L150)

***

<a id="diagnosticevent"></a>

### DiagnosticEvent

Defined in: [packages/sage/src/client/contracts.ts:797](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L797)

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

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

#### Properties

<a id="accounttype-14"></a>

##### accountType?

```ts
readonly optional accountType?: EntityType;
```

Defined in: [packages/sage/src/client/contracts.ts:802](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L802)

<a id="address-14"></a>

##### address?

```ts
readonly optional address?: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:801](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L801)

<a id="cluster-1"></a>

##### cluster

```ts
readonly cluster: ClusterIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:800](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L800)

<a id="kind-1"></a>

##### kind

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

Defined in: [packages/sage/src/client/contracts.ts:798](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L798)

***

<a id="discoveryrequest"></a>

### DiscoveryRequest

Defined in: [packages/sage/src/client/contracts.ts:518](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L518)

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

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

#### Extends

- [`ReadAccountOptions`](/reference/client/#readaccountoptions)

#### Properties

<a id="commitment"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`commitment`](/reference/client/#readaccountoptions)

<a id="filters"></a>

##### filters

```ts
readonly filters: readonly ProgramAccountFilter[];
```

Defined in: [packages/sage/src/client/contracts.ts:528](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L528)

<a id="policy"></a>

##### policy?

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

Defined in: [packages/sage/src/client/contracts.ts:520](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L520)

Controls whether validated discoveries populate the account cache.

<a id="signal"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`signal`](/reference/client/#readaccountoptions)

<a id="strategy-13"></a>

##### strategy

```ts
readonly strategy: AccountDiscoveryStrategy;
```

Defined in: [packages/sage/src/client/contracts.ts:527](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L527)

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.

***

<a id="indexerdiscoveryrequest"></a>

### IndexerDiscoveryRequest

Defined in: [packages/sage/src/client/contracts.ts:224](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L224)

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

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

#### Extends

- [`ProgramAccountRequest`](/reference/client/#programaccountrequest)

#### Properties

<a id="accounttype-15"></a>

##### accountType

```ts
readonly accountType: EntityType;
```

Defined in: [packages/sage/src/client/contracts.ts:225](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L225)

<a id="commitment-1"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ProgramAccountRequest`](/reference/client/#programaccountrequest).[`commitment`](/reference/client/#programaccountrequest)

<a id="filters-1"></a>

##### filters

```ts
readonly filters: readonly ProgramAccountFilter[];
```

Defined in: [packages/sage/src/client/contracts.ts:205](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L205)

###### Inherited from

[`ProgramAccountRequest`](/reference/client/#programaccountrequest).[`filters`](/reference/client/#programaccountrequest)

<a id="programaddress-2"></a>

##### programAddress

```ts
readonly programAddress: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:204](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L204)

###### Inherited from

[`ProgramAccountRequest`](/reference/client/#programaccountrequest).[`programAddress`](/reference/client/#programaccountrequest)

<a id="signal-1"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ProgramAccountRequest`](/reference/client/#programaccountrequest).[`signal`](/reference/client/#programaccountrequest)

***

<a id="indexerprovider"></a>

### IndexerProvider

Defined in: [packages/sage/src/client/contracts.ts:247](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L247)

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

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

#### Properties

<a id="identity-1"></a>

##### identity

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

Defined in: [packages/sage/src/client/contracts.ts:248](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L248)

###### Type Declaration

###### kind

```ts
readonly kind: "indexer";
```

#### Methods

<a id="discoveraddresses"></a>

##### discoverAddresses()

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

Defined in: [packages/sage/src/client/contracts.ts:249](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L249)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`IndexerDiscoveryRequest`](/reference/client/#indexerdiscoveryrequest) |

###### Returns

`Promise`\<readonly [`Address`](/reference/#address-19)[]\>

***

<a id="indexervalidationmeta"></a>

### IndexerValidationMeta

Defined in: [packages/sage/src/internal/read-meta.ts:48](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L48)

Conservative validation summary for address hints returned by an indexer.

#### Example

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

#### Properties

<a id="candidatecount"></a>

##### candidateCount

```ts
readonly candidateCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:49](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L49)

<a id="duplicatecount"></a>

##### duplicateCount

```ts
readonly duplicateCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:50](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L50)

<a id="missingcount"></a>

##### missingCount

```ts
readonly missingCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:51](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L51)

<a id="validatedcount"></a>

##### validatedCount

```ts
readonly validatedCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:52](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L52)

***

<a id="programaccountfilter"></a>

### ProgramAccountFilter

Defined in: [packages/sage/src/client/contracts.ts:190](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L190)

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

#### Example

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

#### Properties

<a id="bytes"></a>

##### bytes

```ts
readonly bytes: Uint8Array;
```

Defined in: [packages/sage/src/client/contracts.ts:192](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L192)

<a id="offset"></a>

##### offset

```ts
readonly offset: number;
```

Defined in: [packages/sage/src/client/contracts.ts:191](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L191)

***

<a id="programaccountrequest"></a>

### ProgramAccountRequest

Defined in: [packages/sage/src/client/contracts.ts:203](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L203)

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

#### Example

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

#### Extends

- [`ReadAccountOptions`](/reference/client/#readaccountoptions)

#### Extended by

- [`IndexerDiscoveryRequest`](/reference/client/#indexerdiscoveryrequest)

#### Properties

<a id="commitment-2"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`commitment`](/reference/client/#readaccountoptions)

<a id="filters-2"></a>

##### filters

```ts
readonly filters: readonly ProgramAccountFilter[];
```

Defined in: [packages/sage/src/client/contracts.ts:205](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L205)

<a id="programaddress-3"></a>

##### programAddress

```ts
readonly programAddress: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:204](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L204)

<a id="signal-2"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`signal`](/reference/client/#readaccountoptions)

***

<a id="rawaccount"></a>

### RawAccount

Defined in: [packages/sage/src/client/contracts.ts:161](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L161)

Raw, untrusted account bytes returned by a provider.

#### Example

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

#### Properties

<a id="address-15"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:162](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L162)

<a id="commitment-3"></a>

##### commitment

```ts
readonly commitment: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:168](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L168)

<a id="data"></a>

##### data

```ts
readonly data: Uint8Array;
```

Defined in: [packages/sage/src/client/contracts.ts:165](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L165)

<a id="executable"></a>

##### executable

```ts
readonly executable: boolean;
```

Defined in: [packages/sage/src/client/contracts.ts:166](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L166)

<a id="lamports"></a>

##### lamports

```ts
readonly lamports: bigint;
```

Defined in: [packages/sage/src/client/contracts.ts:164](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L164)

<a id="owner"></a>

##### owner

```ts
readonly owner: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:163](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L163)

<a id="slot"></a>

##### slot

```ts
readonly slot: bigint;
```

Defined in: [packages/sage/src/client/contracts.ts:167](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L167)

***

<a id="readaccountoptions"></a>

### ReadAccountOptions

Defined in: [packages/sage/src/client/contracts.ts:178](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L178)

Options shared by direct and batched raw-account reads.

#### Example

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

#### Extended by

- [`AccountSubscriptionRequest`](/reference/#accountsubscriptionrequest)
- [`DiscoveryRequest`](/reference/client/#discoveryrequest)
- [`ProgramAccountRequest`](/reference/client/#programaccountrequest)
- [`ReadOptions`](/reference/client/#readoptions)
- [`WalletProfileDiscoveryRequest`](/reference/client/#walletprofilediscoveryrequest)

#### Properties

<a id="commitment-4"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

<a id="signal-3"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

***

<a id="readoptions"></a>

### ReadOptions

Defined in: [packages/sage/src/client/contracts.ts:469](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L469)

Cache-first read controls for account and finder operations.

#### Example

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

#### Extends

- [`ReadAccountOptions`](/reference/client/#readaccountoptions)

#### Extended by

- [`MarketDiscoveryOptions`](/reference/markets/#marketdiscoveryoptions)

#### Properties

<a id="commitment-5"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`commitment`](/reference/client/#readaccountoptions)

<a id="maxagems"></a>

##### maxAgeMs?

```ts
readonly optional maxAgeMs?: number;
```

Defined in: [packages/sage/src/client/contracts.ts:481](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L481)

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.

<a id="policy-1"></a>

##### policy?

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

Defined in: [packages/sage/src/client/contracts.ts:482](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L482)

<a id="refresh"></a>

##### refresh?

```ts
readonly optional refresh?: boolean;
```

Defined in: [packages/sage/src/client/contracts.ts:475](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L475)

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.

<a id="signal-4"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`signal`](/reference/client/#readaccountoptions)

***

<a id="sagedataport"></a>

### SageDataPort

Defined in: [packages/sage/src/client/contracts.ts:632](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L632)

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

```ts
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

<a id="discover"></a>

##### discover()

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

Defined in: [packages/sage/src/client/contracts.ts:659](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L659)

###### Type Parameters

| Type Parameter |
| ------ |
| `TSnapshot` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `definition` | [`AccountDefinition`](/reference/client/#accountdefinition)\<`TSnapshot`\> |
| `request` | [`DiscoveryRequest`](/reference/client/#discoveryrequest) |

###### Returns

`Promise`\<readonly [`SnapshotEnvelope`](/reference/client/#snapshotenvelope)\<`TSnapshot`\>[]\>

<a id="invalidate"></a>

##### invalidate()

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

Defined in: [packages/sage/src/client/contracts.ts:639](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L639)

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`](/reference/client/#accountdefinition)\<`TSnapshot`\> |
| `address` | [`Address`](/reference/#address-19) |

###### Returns

`void`

<a id="read"></a>

##### read()

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

Defined in: [packages/sage/src/client/contracts.ts:643](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L643)

###### Type Parameters

| Type Parameter |
| ------ |
| `TSnapshot` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `definition` | [`AccountDefinition`](/reference/client/#accountdefinition)\<`TSnapshot`\> |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`SnapshotEnvelope`](/reference/client/#snapshotenvelope)\<`TSnapshot`\>\>

<a id="readmany"></a>

##### readMany()

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

Defined in: [packages/sage/src/client/contracts.ts:654](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L654)

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`](/reference/client/#accountdefinition)\<`TSnapshot`\> |
| `addresses` | readonly [`Address`](/reference/#address-19)[] |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<readonly (
  \| [`SnapshotEnvelope`](/reference/client/#snapshotenvelope)\<`TSnapshot`\>
  \| `undefined`)[]\>

<a id="readraw"></a>

##### readRaw()

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

Defined in: [packages/sage/src/client/contracts.ts:677](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L677)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-19) |
| `options?` | [`ReadAccountOptions`](/reference/client/#readaccountoptions) |

###### Returns

`Promise`\<[`RawAccount`](/reference/client/#rawaccount) \| `undefined`\>

<a id="subscribe"></a>

##### subscribe()

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

Defined in: [packages/sage/src/client/contracts.ts:671](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L671)

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`](/reference/client/#accountdefinition)\<`TSnapshot`\> |
| `address` | [`Address`](/reference/#address-19) |
| `observer` | [`SubscriptionObserver`](/reference/#subscriptionobserver)\<`TSnapshot`\> |
| `options?` | [`ReadAccountOptions`](/reference/client/#readaccountoptions) |

###### Returns

`Promise`\<[`SageSubscription`](/reference/#sagesubscription)\>

***

<a id="sagesdkerrordetails"></a>

### SageSdkErrorDetails

Defined in: [packages/sage/src/client/errors.ts:47](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L47)

Safe contextual fields carried by SDK errors.

#### Example

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

#### Properties

<a id="accounttype-16"></a>

##### accountType?

```ts
readonly optional accountType?: EntityType;
```

Defined in: [packages/sage/src/client/errors.ts:48](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L48)

<a id="address-16"></a>

##### address?

```ts
readonly optional address?: Address;
```

Defined in: [packages/sage/src/client/errors.ts:49](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L49)

<a id="cause-13"></a>

##### cause?

```ts
readonly optional cause?: unknown;
```

Defined in: [packages/sage/src/client/errors.ts:50](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L50)

<a id="provider-13"></a>

##### provider?

```ts
readonly optional provider?: DataSourceIdentity;
```

Defined in: [packages/sage/src/client/errors.ts:51](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L51)

<a id="strategy-14"></a>

##### strategy?

```ts
readonly optional strategy?: DiscoveryStrategy;
```

Defined in: [packages/sage/src/client/errors.ts:52](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L52)

***

<a id="snapshotenvelope"></a>

### SnapshotEnvelope

Defined in: [packages/sage/src/client/contracts.ts:449](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L449)

A fully described immutable account snapshot plus its read provenance.

#### Example

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

#### Type Parameters

| Type Parameter |
| ------ |
| `TSnapshot` |

#### Properties

<a id="accounttype-17"></a>

##### accountType

```ts
readonly accountType: EntityType;
```

Defined in: [packages/sage/src/client/contracts.ts:453](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L453)

<a id="address-17"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:451](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L451)

<a id="commitment-6"></a>

##### commitment

```ts
readonly commitment: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:455](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L455)

<a id="data-1"></a>

##### data

```ts
readonly data: Readonly<TSnapshot>;
```

Defined in: [packages/sage/src/client/contracts.ts:450](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L450)

<a id="fetchedat"></a>

##### fetchedAt

```ts
readonly fetchedAt: number;
```

Defined in: [packages/sage/src/client/contracts.ts:456](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L456)

<a id="programaddress-4"></a>

##### programAddress

```ts
readonly programAddress: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:452](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L452)

<a id="slot-1"></a>

##### slot

```ts
readonly slot: bigint;
```

Defined in: [packages/sage/src/client/contracts.ts:454](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L454)

<a id="source"></a>

##### source

```ts
readonly source: DataSourceIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:457](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L457)

#### Methods

<a id="tojson"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/client/contracts.ts:459](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L459)

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

###### Returns

`unknown`

***

<a id="walletprofilediscoveryprovider"></a>

### WalletProfileDiscoveryProvider

Defined in: [packages/sage/src/client/contracts.ts:292](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L292)

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

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

#### Properties

<a id="identity-2"></a>

##### identity

```ts
readonly identity: DataSourceIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:293](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L293)

#### Methods

<a id="discoverprofileaddresses"></a>

##### discoverProfileAddresses()

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

Defined in: [packages/sage/src/client/contracts.ts:294](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L294)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`WalletProfileDiscoveryRequest`](/reference/client/#walletprofilediscoveryrequest) |

###### Returns

`Promise`\<readonly [`Address`](/reference/#address-19)[]\>

***

<a id="walletprofilediscoveryrequest"></a>

### WalletProfileDiscoveryRequest

Defined in: [packages/sage/src/client/contracts.ts:266](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L266)

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

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

#### Extends

- [`ReadAccountOptions`](/reference/client/#readaccountoptions)

#### Properties

<a id="commitment-7"></a>

##### commitment?

```ts
readonly optional commitment?: Commitment;
```

Defined in: [packages/sage/src/client/contracts.ts:179](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`commitment`](/reference/client/#readaccountoptions)

<a id="signal-5"></a>

##### signal?

```ts
readonly optional signal?: AbortSignal;
```

Defined in: [packages/sage/src/client/contracts.ts:180](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`signal`](/reference/client/#readaccountoptions)

<a id="wallet"></a>

##### wallet

```ts
readonly wallet: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:267](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L267)

***

<a id="walletprofilevalidationmeta"></a>

### WalletProfileValidationMeta

Defined in: [packages/sage/src/internal/read-meta.ts:67](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L67)

Validation summary for wallet-to-Profile address hints.

#### Example

```ts
const summary: WalletProfileValidationMeta = {
  candidateCount: 3,
  duplicateCount: 1,
  missingCount: 1,
  validatedCount: 1,
};
```

#### Properties

<a id="candidatecount-1"></a>

##### candidateCount

```ts
readonly candidateCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:68](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L68)

<a id="duplicatecount-1"></a>

##### duplicateCount

```ts
readonly duplicateCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:69](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L69)

<a id="missingcount-1"></a>

##### missingCount

```ts
readonly missingCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:70](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L70)

<a id="validatedcount-1"></a>

##### validatedCount

```ts
readonly validatedCount: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:71](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/internal/read-meta.ts#L71)

## Type Aliases

<a id="accountdiscoverystrategy"></a>

### AccountDiscoveryStrategy

```ts
type AccountDiscoveryStrategy = 
  | "direct"
  | "derived"
  | "indexer"
  | "targeted-program-accounts"
  | "broad-scan";
```

Defined in: [packages/sage/src/client/contracts.ts:492](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L492)

Strategies supported by generic account discovery requests.

#### Example

```ts
const strategy: AccountDiscoveryStrategy = 'targeted-program-accounts';
```

***

<a id="clusteridentity"></a>

### ClusterIdentity

```ts
type ClusterIdentity = 
  | KnownCluster
  | CustomClusterIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:139](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L139)

Identity used to isolate context-owned caches and providers.

#### Example

```ts
const cluster: ClusterIdentity = { name: 'local-fixture' };
```

***

<a id="commitment-8"></a>

### Commitment

```ts
type Commitment = KitCommitment;
```

Defined in: [packages/sage/src/client/contracts.ts:33](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L33)

A z.ink/Solana RPC commitment level.

#### Example

```ts
const commitment: Commitment = 'confirmed';
```

***

<a id="discoverystrategy"></a>

### DiscoveryStrategy

```ts
type DiscoveryStrategy = 
  | AccountDiscoveryStrategy
  | "known-addresses"
  | "wallet-profile-provider";
```

Defined in: [packages/sage/src/client/contracts.ts:502](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L502)

Every strategy name exposed through public read metadata and errors.

#### Example

```ts
const strategy: DiscoveryStrategy = 'wallet-profile-provider';
```

***

<a id="entitytype-1"></a>

### EntityType

```ts
type EntityType = 
  | "game"
  | "profile"
  | "profileFaction"
  | "character"
  | "fleet"
  | "fleetCrewBinding"
  | "starSystem"
  | "celestialBody"
  | "starbasePlayer"
  | "starbaseUpgradeProcess"
  | "cargoPod"
  | "claimStakeInstance"
  | "recipe"
  | "craftingHabInstance"
  | "craftingProcess"
  | "market"
  | "marketOrder"
  | "scanPattern"
  | "loot"
  | "outlawFlag"
  | "atlasRewardRegistry"
  | "atlasRewardConfig"
  | "atlasRewardTreasury"
  | "faction"
  | "factionConfig"
  | "factionEconomicsConfig"
  | "factionRelationTracker"
  | "factionStanding"
  | "factionTreasury"
  | "factionOwnership"
  | "kingSystemTracker"
  | "regionTracker"
  | "loyaltyEpoch"
  | "loyaltyContribution"
  | "loyaltyAtlasBank";
```

Defined in: [packages/sage/src/client/contracts.ts:75](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L75)

Stable account and gameplay entity identifiers used by cache keys and references.

#### Example

```ts
const type: EntityType = 'fleet';
```

***

<a id="knowncluster"></a>

### KnownCluster

```ts
type KnownCluster = "zink-ptr";
```

Defined in: [packages/sage/src/client/contracts.ts:119](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L119)

A known deployment preset supported by the installed SDK version.

#### Example

```ts
const cluster: KnownCluster = 'zink-ptr';
```

***

<a id="sagerpc"></a>

### SageRpc

```ts
type SageRpc = Rpc<GetAccountInfoApi & GetMultipleAccountsApi & GetProgramAccountsApi>;
```

Defined in: [packages/sage/src/client/contracts.ts:43](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L43)

The minimal Kit RPC surface used by the read-only z.ink provider.

#### Example

```ts
declare const rpc: SageRpc;
const ctx = createSageContext({ cluster: 'zink-ptr', rpc });
```

***

<a id="sagesdkerrorcode-1"></a>

### SageSdkErrorCode

```ts
type SageSdkErrorCode = 
  | "ACCOUNT_NOT_FOUND"
  | "INVALID_ACCOUNT_OWNER"
  | "INVALID_DISCRIMINATOR"
  | "INVALID_ENTITY_ID"
  | "INVALID_DERIVATION_INPUT"
  | "ACCOUNT_DECODE_FAILED"
  | "RELATIONSHIP_NOT_DISCOVERABLE"
  | "MISSING_GAME_CONTEXT"
  | "REGISTRY_OUT_OF_SYNC"
  | "STALE_BINDING_VERSION"
  | "PROVIDER_ERROR"
  | "RESOURCE_LIMIT_EXCEEDED"
  | "CONTEXT_DISPOSED"
  | "INVALID_ACTION_INPUT"
  | "INCOMPATIBLE_PLAN_COMPOSITION"
  | "MISSING_WRITE_TRANSPORT"
  | "TRANSACTION_TOO_LARGE"
  | "TRANSACTION_EXPIRED"
  | "ACTION_PRECONDITION_FAILED"
  | "SIMULATION_FAILED"
  | "TRANSACTION_SUBMISSION_FAILED"
  | "TRANSACTION_OUTCOME_UNKNOWN";
```

Defined in: [packages/sage/src/client/errors.ts:15](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/errors.ts#L15)

Stable error codes for read behavior and approved write boundaries.

#### Example

```ts
const code: SageSdkErrorCode = 'ACCOUNT_NOT_FOUND';
```

***

<a id="sagewriterpc"></a>

### SageWriteRpc

```ts
type SageWriteRpc = Rpc<GetBlockHeightApi & GetLatestBlockhashApi & SimulateTransactionApi & SendTransactionApi & GetSignatureStatusesApi>;
```

Defined in: [packages/sage/src/client/contracts.ts:60](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/contracts.ts#L60)

The minimal Kit RPC surface used for explicit write-side operations.

Context creation only retains this transport; it never invokes it. Assembly
uses it for blockhash lifetime, signer-free simulation, submission, and
confirmation during explicit Plan operations.

#### Example

```ts
declare const rpc: SageRpc;
declare const writeRpc: SageWriteRpc;
const ctx = createSageContext({ cluster: 'zink-ptr', rpc, writeRpc });
```

## Functions

<a id="createsagecontext"></a>

### createSageContext()

```ts
function createSageContext(options): SageContext;
```

Defined in: [packages/sage/src/client/context.ts:2079](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/context.ts#L2079)

Creates an isolated context synchronously without performing network I/O.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`SageContextOptions`](/reference/#sagecontextoptions) |

#### Returns

[`SageContext`](/reference/#sagecontext)

#### Example

```ts
declare const rpc: SageRpc;
const ctx = createSageContext({ cluster: 'zink-ptr', rpc });
```

***

<a id="entityref"></a>

### entityRef()

```ts
function entityRef<TType>(type, address): EntityRef<TType>;
```

Defined in: [packages/sage/src/client/refs.ts:24](https://github.com/Aephia/atlas-kit/blob/v0.5.0/packages/sage/src/client/refs.ts#L24)

Creates a plain typed reference without resolving or reading the account.

#### Type Parameters

| Type Parameter |
| ------ |
| `TType` *extends* [`EntityType`](/reference/client/#entitytype-1) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `TType` |
| `address` | [`Address`](/reference/#address-19) |

#### Returns

[`EntityRef`](/reference/#entityref)\<`TType`\>

#### Example

```ts
declare const fleetAddress: Address;
const fleet = entityRef('fleet', fleetAddress);
```

## References

<a id="accountsubscriptionevent"></a>

### AccountSubscriptionEvent

Re-exports [AccountSubscriptionEvent](/reference/#accountsubscriptionevent)

***

<a id="accountsubscriptionprovider"></a>

### AccountSubscriptionProvider

Re-exports [AccountSubscriptionProvider](/reference/#accountsubscriptionprovider)

***

<a id="accountsubscriptionregistration"></a>

### AccountSubscriptionRegistration

Re-exports [AccountSubscriptionRegistration](/reference/#accountsubscriptionregistration)

***

<a id="accountsubscriptionrequest"></a>

### AccountSubscriptionRequest

Re-exports [AccountSubscriptionRequest](/reference/#accountsubscriptionrequest)

***

<a id="address-18"></a>

### Address

Re-exports [Address](/reference/#address-19)

***

<a id="cargodefinitionsummary"></a>

### CargoDefinitionSummary

Re-exports [CargoDefinitionSummary](/reference/#cargodefinitionsummary)

***

<a id="definitionlookupoptions"></a>

### DefinitionLookupOptions

Re-exports [DefinitionLookupOptions](/reference/#definitionlookupoptions)

***

<a id="definitionsection"></a>

### DefinitionSection

Re-exports [DefinitionSection](/reference/#definitionsection)

***

<a id="definitionsectionsnapshot"></a>

### DefinitionSectionSnapshot

Re-exports [DefinitionSectionSnapshot](/reference/#definitionsectionsnapshot)

***

<a id="entityref-3"></a>

### EntityRef

Re-exports [EntityRef](/reference/#entityref)

***

<a id="readmeta"></a>

### readMeta

Re-exports [readMeta](/reference/#readmeta-1)

***

<a id="readmeta-1"></a>

### ReadMeta

Re-exports [ReadMeta](/reference/#readmeta)

***

<a id="readmetafilter"></a>

### ReadMetaFilter

Re-exports [ReadMetaFilter](/reference/#readmetafilter)

***

<a id="registrysnapshotstore"></a>

### RegistrySnapshotStore

Re-exports [RegistrySnapshotStore](/reference/#registrysnapshotstore)

***

<a id="sagecontext"></a>

### SageContext

Re-exports [SageContext](/reference/#sagecontext)

***

<a id="sagecontextoptions"></a>

### SageContextOptions

Re-exports [SageContextOptions](/reference/#sagecontextoptions)

***

<a id="sagesubscription"></a>

### SageSubscription

Re-exports [SageSubscription](/reference/#sagesubscription)

***

<a id="shipdefinitionsummary"></a>

### ShipDefinitionSummary

Re-exports [ShipDefinitionSummary](/reference/#shipdefinitionsummary)

***

<a id="subscriptiondiagnosticevent"></a>

### SubscriptionDiagnosticEvent

Re-exports [SubscriptionDiagnosticEvent](/reference/#subscriptiondiagnosticevent)

***

<a id="subscriptionobserver"></a>

### SubscriptionObserver

Re-exports [SubscriptionObserver](/reference/#subscriptionobserver)

***

<a id="subscriptionoptions"></a>

### SubscriptionOptions

Re-exports [SubscriptionOptions](/reference/#subscriptionoptions)