# @aephia/atlas-kit
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

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

## Classes

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

### InvalidDefinitionSectionError

Defined in: [packages/sage/src/client/errors.ts:470](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L470)

The preload request contains an unsupported definition section or is not an array.

#### Example

```ts
throw new InvalidDefinitionSectionError();
```

#### Extends

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

#### Constructors

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

##### Constructor

```ts
new InvalidDefinitionSectionError(): InvalidDefinitionSectionError;
```

Defined in: [packages/sage/src/client/errors.ts:471](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L471)

###### Returns

[`InvalidDefinitionSectionError`](/reference/#invaliddefinitionsectionerror)

###### 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:70](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L70)

###### 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:71](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L71)

###### 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:69](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L69)

###### 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:72](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L72)

###### 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:73](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/errors.ts#L73)

###### 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)

## Interfaces

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

### AccountSubscriptionProvider

Defined in: [packages/sage/src/client/contracts.ts:392](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L392)

Replaceable WebSocket provider used by a `SageContext`.

The provider owns transport reconnection and emits a `reconnected` event
after each successful re-registration. The context owns validation, cache
updates, consumer notification, cancellation, and final disposal. Providers
must apply bounded exponential backoff with jitter between reconnect attempts
and must not emit `reconnected` for a failed attempt.

#### Example

```ts
const subscriptions: AccountSubscriptionProvider = {
  identity: { kind: 'websocket', name: 'zink-ptr' },
  subscribeAccount: async () => ({ unsubscribe: async () => undefined }),
};
```

#### Properties

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

##### identity

```ts
readonly identity: DataSourceIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:393](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L393)

#### Methods

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

##### subscribeAccount()

```ts
subscribeAccount(request, listener): Promise<AccountSubscriptionRegistration>;
```

Defined in: [packages/sage/src/client/contracts.ts:394](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L394)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`AccountSubscriptionRequest`](/reference/#accountsubscriptionrequest) |
| `listener` | (`event`) => `void` |

###### Returns

`Promise`\<[`AccountSubscriptionRegistration`](/reference/#accountsubscriptionregistration)\>

***

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

### AccountSubscriptionRegistration

Defined in: [packages/sage/src/client/contracts.ts:372](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L372)

Provider-owned handle for one raw WebSocket registration.

#### Example

```ts
declare const registration: AccountSubscriptionRegistration;
await registration.unsubscribe();
```

#### Methods

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

##### unsubscribe()

```ts
unsubscribe(): Promise<void>;
```

Defined in: [packages/sage/src/client/contracts.ts:373](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L373)

###### Returns

`Promise`\<`void`\>

***

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

### AccountSubscriptionRequest

Defined in: [packages/sage/src/client/contracts.ts:345](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L345)

A context-owned raw-account subscription request.

#### Example

```ts
declare const address: Address;
const request: AccountSubscriptionRequest = { address, commitment: 'confirmed' };
```

#### Extends

- [`ReadAccountOptions`](/reference/client/#readaccountoptions)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:346](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L346)

<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/develop/packages/sage/src/client/contracts.ts#L179)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`commitment`](/reference/client/#readaccountoptions)

<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/develop/packages/sage/src/client/contracts.ts#L180)

###### Inherited from

[`ReadAccountOptions`](/reference/client/#readaccountoptions).[`signal`](/reference/client/#readaccountoptions)

***

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

### AsteroidView

Defined in: [packages/sage/src/index.ts:370](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L370)

A loaded Asteroid whose stored StarSystem reference resolves through the root client.

#### Example

```ts
declare const asteroid: AsteroidView;
const system = await asteroid.system.get();
```

#### Extends

- `Omit`\<[`AsteroidSnapshot`](/reference/world/#asteroidsnapshot), `"system"`\>

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:113](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L113)

###### Inherited from

[`AsteroidSnapshot`](/reference/world/#asteroidsnapshot).[`address`](/reference/world/#asteroidsnapshot)

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

##### claimStakes

```ts
readonly claimStakes: {
  all: Promise<readonly ClaimStakeView[]>;
};
```

Defined in: [packages/sage/src/index.ts:371](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L371)

###### all()

```ts
all(options?): Promise<readonly ClaimStakeView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ClaimStakeView`](/reference/#claimstakeview)[]\>

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

##### deposit

```ts
readonly deposit: {
  get: Promise<ResourceDepositView>;
};
```

Defined in: [packages/sage/src/index.ts:376](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L376)

###### get()

```ts
get(options?): Promise<ResourceDepositView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ResourceDepositView`](/reference/#resourcedepositview)\>

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

##### details

```ts
readonly details: WorldAsteroidData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:433](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L433)

###### Inherited from

```ts
Omit.details
```

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:419](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L419)

###### Inherited from

```ts
Omit.game
```

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

##### id

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

Defined in: [packages/sage/src/internal/c4/world.ts:417](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L417)

###### Inherited from

```ts
Omit.id
```

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

##### kind

```ts
readonly kind: "asteroid";
```

Defined in: [packages/sage/src/internal/c4/world.ts:432](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L432)

###### Inherited from

```ts
Omit.kind
```

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

##### lastSyncAtUnixSeconds

```ts
readonly lastSyncAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:422](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L422)

###### Inherited from

```ts
Omit.lastSyncAtUnixSeconds
```

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:418](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L418)

###### Inherited from

```ts
Omit.name
```

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

##### system

```ts
readonly system: EntityRef<"starSystem"> & {
  get: Promise<StarSystemView>;
};
```

Defined in: [packages/sage/src/index.ts:379](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L379)

###### Type Declaration

###### get()

```ts
get(options?): Promise<StarSystemView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview)\>

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

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:421](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L421)

###### Inherited from

```ts
Omit.systemSequenceId
```

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:416](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L416)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:115](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L115)

###### Returns

`unknown`

###### Inherited from

[`AsteroidSnapshot`](/reference/world/#asteroidsnapshot).[`toJSON`](/reference/world/#asteroidsnapshot)

***

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

### CargoDefinitionSummary

Defined in: [packages/sage/src/registry/index.ts:104](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L104)

Small, stable cargo definition returned to gameplay domains.

#### Example

```ts
declare const ctx: SageContext;
const cargo: CargoDefinitionSummary = await resolveCargo(ctx, 7);
```

#### Extended by

- [`CraftingCargoItem`](/reference/crafting/#craftingcargoitem)
- [`CraftingDefinitionCargoItem`](/reference/crafting/#craftingdefinitioncargoitem)
- [`FactionMarketOfferSnapshot`](/reference/markets/#factionmarketoffersnapshot)
- [`StarbaseCargoItem`](/reference/starbases/#starbasecargoitem)
- [`CargoInventoryItem`](/reference/cargo/#cargoinventoryitem)
- [`ClaimStakeResourceRate`](/reference/claim-stakes/#claimstakeresourcerate)

#### Properties

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

##### categoryId

```ts
readonly categoryId: number;
```

Defined in: [packages/sage/src/registry/index.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L105)

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

##### id

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

Defined in: [packages/sage/src/registry/index.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L106)

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

##### mint

```ts
readonly mint: Address;
```

Defined in: [packages/sage/src/registry/index.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L107)

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/registry/index.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L108)

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

##### storageCost

```ts
readonly storageCost: number;
```

Defined in: [packages/sage/src/registry/index.ts:109](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L109)

***

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

### CharacterView

Defined in: [packages/sage/src/index.ts:168](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L168)

A loaded Character with root-only relation accessors.

#### Example

```ts
declare const sage: SageClient;
declare const profileAddress: Address;
const character: CharacterView = await sage.characters.forProfile(profileAddress);
const fleets = await character.fleets.all();
const craftingHabs = await character.craftingHabs.all();
const craftingProcesses = await character.craftingProcesses.all();
```

#### Extends

- [`CharacterSnapshot`](/reference/identity/#charactersnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/identity/index.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L122)

###### Inherited from

[`CharacterSnapshot`](/reference/identity/#charactersnapshot).[`address`](/reference/identity/#charactersnapshot)

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

##### atlas

```ts
readonly atlas: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:242](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L242)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`atlas`](/reference/identity/#characteraccountdata)

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

##### atlasRaw

```ts
readonly atlasRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:241](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L241)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`atlasRaw`](/reference/identity/#characteraccountdata)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:235](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L235)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`bump`](/reference/identity/#characteraccountdata)

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

##### checkIn

```ts
readonly checkIn: {
  lastCheckInTime: bigint;
  streak: number;
};
```

Defined in: [packages/sage/src/internal/c4/identity.ts:236](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L236)

###### lastCheckInTime

```ts
readonly lastCheckInTime: bigint;
```

###### streak

```ts
readonly streak: number;
```

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`checkIn`](/reference/identity/#characteraccountdata)

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

##### claimStakes

```ts
readonly claimStakes: {
  all: Promise<readonly ClaimStakeView[]>;
};
```

Defined in: [packages/sage/src/index.ts:179](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L179)

###### all()

```ts
all(options?): Promise<readonly ClaimStakeView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ClaimStakeView`](/reference/#claimstakeview)[]\>

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

##### counts

```ts
readonly counts: {
  claimStakes: number;
  craftingHabs: number;
  fleets: number;
};
```

Defined in: [packages/sage/src/internal/c4/identity.ts:243](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L243)

###### claimStakes

```ts
readonly claimStakes: number;
```

###### craftingHabs

```ts
readonly craftingHabs: number;
```

###### fleets

```ts
readonly fleets: number;
```

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`counts`](/reference/identity/#characteraccountdata)

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

##### craftingHabs

```ts
readonly craftingHabs: {
  all: Promise<readonly CraftingHabView[]>;
};
```

Defined in: [packages/sage/src/index.ts:187](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L187)

###### all()

```ts
all(options?): Promise<readonly CraftingHabView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingHabView`](/reference/#craftinghabview)[]\>

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

##### craftingProcesses

```ts
readonly craftingProcesses: {
  all: Promise<readonly CraftingProcessView[]>;
};
```

Defined in: [packages/sage/src/index.ts:192](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L192)

###### all()

```ts
all(options?): Promise<readonly CraftingProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingProcessView`](/reference/#craftingprocessview)[]\>

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

##### fleets

```ts
readonly fleets: {
  all: Promise<readonly FleetView[]>;
};
```

Defined in: [packages/sage/src/index.ts:184](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L184)

###### all()

```ts
all(options?): Promise<readonly FleetView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`FleetDiscoveryOptions`](/reference/fleets/#fleetdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`FleetView`](/reference/#fleetview)[]\>

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:234](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L234)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`game`](/reference/identity/#characteraccountdata)

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

##### kind

```ts
readonly kind: "character";
```

Defined in: [packages/sage/src/identity/index.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L121)

###### Inherited from

[`CharacterSnapshot`](/reference/identity/#charactersnapshot).[`kind`](/reference/identity/#charactersnapshot)

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

##### localMarketOrders

```ts
readonly localMarketOrders: {
  at: Promise<readonly LocalMarketOrderSnapshot & {
     makerState: LocalMarketMakerStateSnapshot;
  }[]>;
};
```

Defined in: [packages/sage/src/index.ts:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L169)

###### at()

```ts
at(market, options?): Promise<readonly LocalMarketOrderSnapshot & {
  makerState: LocalMarketMakerStateSnapshot;
}[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `market` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<readonly [`LocalMarketOrderSnapshot`](/reference/markets/#localmarketordersnapshot) & \{
  `makerState`: [`LocalMarketMakerStateSnapshot`](/reference/markets/#localmarketmakerstatesnapshot);
\}[]\>

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

##### modifiers

```ts
readonly modifiers: CharacterModifiersData;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:254](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L254)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`modifiers`](/reference/identity/#characteraccountdata)

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

##### pilotXpBudget

```ts
readonly pilotXpBudget: {
  available: number;
  fractionalCarry: number;
  fractionalCarryRaw: bigint;
  lastAccrualTime: bigint;
};
```

Defined in: [packages/sage/src/internal/c4/identity.ts:248](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L248)

###### available

```ts
readonly available: number;
```

###### fractionalCarry

```ts
readonly fractionalCarry: number;
```

###### fractionalCarryRaw

```ts
readonly fractionalCarryRaw: bigint;
```

###### lastAccrualTime

```ts
readonly lastAccrualTime: bigint;
```

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`pilotXpBudget`](/reference/identity/#characteraccountdata)

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

##### profile

```ts
readonly profile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/identity/index.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L123)

###### Inherited from

[`CharacterSnapshot`](/reference/identity/#charactersnapshot).[`profile`](/reference/identity/#charactersnapshot)

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

##### starbases

```ts
readonly starbases: {
  all: Promise<readonly StarbasePlayerView[]>;
  at: Promise<StarbasePlayerView>;
};
```

Defined in: [packages/sage/src/index.ts:197](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L197)

###### all()

```ts
all(options?): Promise<readonly StarbasePlayerView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbasePlayerView`](/reference/#starbaseplayerview)[]\>

###### at()

```ts
at(system, options?): Promise<StarbasePlayerView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbasePlayerView`](/reference/#starbaseplayerview)\>

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:232](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L232)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`version`](/reference/identity/#characteraccountdata)

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

##### xp

```ts
readonly xp: CharacterXpData;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:240](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L240)

###### Inherited from

[`CharacterAccountData`](/reference/identity/#characteraccountdata).[`xp`](/reference/identity/#characteraccountdata)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/identity/index.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L124)

###### Returns

`unknown`

###### Inherited from

[`CharacterSnapshot`](/reference/identity/#charactersnapshot).[`toJSON`](/reference/identity/#charactersnapshot)

***

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

### ClaimStakeView

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

A loaded Claim Stake exposed by the root convenience client.

#### Example

```ts
declare const stake: ClaimStakeView;
console.log(stake.state.kind);
```

#### Extends

- [`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:73](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L73)

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`address`](/reference/claim-stakes/#claimstakesnapshot)

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

##### body

```ts
readonly body: EntityRef<"celestialBody">;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:74](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L74)

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`body`](/reference/claim-stakes/#claimstakesnapshot)

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

##### buildingDefinitionSeqId

```ts
readonly buildingDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:157](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L157)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`buildingDefinitionSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### buildings

```ts
readonly buildings: readonly ClaimStakeBuildingData[];
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:164](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L164)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`buildings`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### claimStakeDefinitionId

```ts
readonly claimStakeDefinitionId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:155](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L155)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`claimStakeDefinitionId`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### claimStakeDefinitionSeqId

```ts
readonly claimStakeDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:156](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L156)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`claimStakeDefinitionSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### constructionProgressAtUnixSeconds

```ts
readonly constructionProgressAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L161)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`constructionProgressAtUnixSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### constructionRemainingSeconds

```ts
readonly constructionRemainingSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L160)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`constructionRemainingSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L153)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`game`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### kind

```ts
readonly kind: "claimStakeInstance";
```

Defined in: [packages/sage/src/claim-stakes/index.ts:72](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L72)

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`kind`](/reference/claim-stakes/#claimstakesnapshot)

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

##### lastRentAtUnixSeconds

```ts
readonly lastRentAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L159)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`lastRentAtUnixSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### neededCrew

```ts
readonly neededCrew: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:163](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L163)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`neededCrew`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### ownerCharacter

```ts
readonly ownerCharacter: EntityRef<"character">;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:75](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L75)

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`ownerCharacter`](/reference/claim-stakes/#claimstakesnapshot)

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

##### rentBalanceRaw

```ts
readonly rentBalanceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:162](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L162)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`rentBalanceRaw`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### resources

```ts
readonly resources: ClaimStakeResources;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:76](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L76)

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`resources`](/reference/claim-stakes/#claimstakesnapshot)

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

##### state

```ts
readonly state: ClaimStakeStateData;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:165](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L165)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`state`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### systemSeqId

```ts
readonly systemSeqId: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L158)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`systemSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L151)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`version`](/reference/claim-stakes/#claimstakeaccountdata)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:77](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L77)

###### Returns

`unknown`

###### Inherited from

[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot).[`toJSON`](/reference/claim-stakes/#claimstakesnapshot)

***

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

### CraftingHabView

Defined in: [packages/sage/src/index.ts:333](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L333)

A loaded Crafting Hab exposed by the root convenience client.

#### Example

```ts
declare const sage: SageClient;
declare const address: Address;
const hab: CraftingHabView = await sage.craftingHabs.get(address);
```

#### Extends

- [`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/crafting/index.ts:240](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L240)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`address`](/reference/crafting/#craftinghabsnapshot)

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

##### availableJobSlots

```ts
readonly availableJobSlots: number;
```

Defined in: [packages/sage/src/crafting/index.ts:246](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L246)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`availableJobSlots`](/reference/crafting/#craftinghabsnapshot)

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

##### buildingDefinitionSequenceId

```ts
readonly buildingDefinitionSequenceId: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:207](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L207)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`buildingDefinitionSequenceId`](/reference/crafting/#craftinghabsnapshot)

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

##### buildings

```ts
readonly buildings: readonly CraftingHabBuilding[];
```

Defined in: [packages/sage/src/crafting/index.ts:245](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L245)

###### Inherited from

[`CraftingHabView`](/reference/#craftinghabview).[`buildings`](/reference/#craftinghabview)

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

##### constructionProgressAtUnixSeconds

```ts
readonly constructionProgressAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:211](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L211)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`constructionProgressAtUnixSeconds`](/reference/crafting/#craftinghabsnapshot)

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

##### constructionRemainingSeconds

```ts
readonly constructionRemainingSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:210](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L210)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`constructionRemainingSeconds`](/reference/crafting/#craftinghabsnapshot)

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

##### definition

```ts
readonly definition: CraftingHabDefinitionSummary;
```

Defined in: [packages/sage/src/crafting/index.ts:244](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L244)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`definition`](/reference/crafting/#craftinghabsnapshot)

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

##### definitionId

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

Defined in: [packages/sage/src/internal/c4/crafting.ts:205](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L205)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`definitionId`](/reference/crafting/#craftinghabsnapshot)

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

##### definitionSequenceId

```ts
readonly definitionSequenceId: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:206](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L206)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`definitionSequenceId`](/reference/crafting/#craftinghabsnapshot)

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/crafting/index.ts:241](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L241)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`game`](/reference/crafting/#craftinghabsnapshot)

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

##### jobCapacity

```ts
readonly jobCapacity: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:214](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L214)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`jobCapacity`](/reference/crafting/#craftinghabsnapshot)

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

##### jobsRunning

```ts
readonly jobsRunning: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:215](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L215)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`jobsRunning`](/reference/crafting/#craftinghabsnapshot)

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

##### kind

```ts
readonly kind: "craftingHabInstance";
```

Defined in: [packages/sage/src/crafting/index.ts:239](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L239)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`kind`](/reference/crafting/#craftinghabsnapshot)

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

##### lastRentAtUnixSeconds

```ts
readonly lastRentAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:209](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L209)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`lastRentAtUnixSeconds`](/reference/crafting/#craftinghabsnapshot)

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

##### modifiers

```ts
readonly modifiers: CraftingModifierData;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:216](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L216)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`modifiers`](/reference/crafting/#craftinghabsnapshot)

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

##### neededCrew

```ts
readonly neededCrew: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:213](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L213)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`neededCrew`](/reference/crafting/#craftinghabsnapshot)

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

##### ownerProfile

```ts
readonly ownerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/crafting/index.ts:242](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L242)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`ownerProfile`](/reference/crafting/#craftinghabsnapshot)

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

##### production

```ts
readonly production: {
  inventory: CraftingCargoInventory;
  lastTickAtUnixSeconds: bigint;
  netRates: readonly CargoDefinitionSummary & {
     unitsPerSecond: number;
     unitsPerSecondRaw: bigint;
  }[];
  resourceCapacityRaw: bigint;
};
```

Defined in: [packages/sage/src/crafting/index.ts:248](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L248)

###### inventory

```ts
readonly inventory: CraftingCargoInventory;
```

###### lastTickAtUnixSeconds

```ts
readonly lastTickAtUnixSeconds: bigint;
```

###### netRates

```ts
readonly netRates: readonly CargoDefinitionSummary & {
  unitsPerSecond: number;
  unitsPerSecondRaw: bigint;
}[];
```

###### resourceCapacityRaw

```ts
readonly resourceCapacityRaw: bigint;
```

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`production`](/reference/crafting/#craftinghabsnapshot)

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

##### rentBalanceRaw

```ts
readonly rentBalanceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:212](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L212)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`rentBalanceRaw`](/reference/crafting/#craftinghabsnapshot)

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

##### state

```ts
readonly state: CraftingHabStateData;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:219](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L219)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`state`](/reference/crafting/#craftinghabsnapshot)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/crafting/index.ts:243](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L243)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`system`](/reference/crafting/#craftinghabsnapshot)

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

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:208](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L208)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`systemSequenceId`](/reference/crafting/#craftinghabsnapshot)

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

##### unlockedRecipes

```ts
readonly unlockedRecipes: readonly EntityRef<"recipe">[];
```

Defined in: [packages/sage/src/crafting/index.ts:247](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L247)

###### Inherited from

[`CraftingHabView`](/reference/#craftinghabview).[`unlockedRecipes`](/reference/#craftinghabview)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:201](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L201)

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`version`](/reference/crafting/#craftinghabsnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/crafting/index.ts:257](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L257)

###### Returns

`unknown`

###### Inherited from

[`CraftingHabSnapshot`](/reference/crafting/#craftinghabsnapshot).[`toJSON`](/reference/crafting/#craftinghabsnapshot)

***

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

### CraftingProcessView

Defined in: [packages/sage/src/index.ts:343](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L343)

A loaded Crafting Process exposed by the root convenience client.

#### Example

```ts
declare const sage: SageClient;
declare const address: Address;
const process: CraftingProcessView = await sage.craftingProcesses.get(address);
```

#### Extends

- [`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/crafting/index.ts:272](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L272)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`address`](/reference/crafting/#craftingprocesssnapshot)

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

##### craftingHab

```ts
readonly craftingHab: EntityRef<"craftingHabInstance">;
```

Defined in: [packages/sage/src/crafting/index.ts:277](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L277)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`craftingHab`](/reference/crafting/#craftingprocesssnapshot)

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

##### endsAtUnixSeconds

```ts
readonly endsAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:239](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L239)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`endsAtUnixSeconds`](/reference/crafting/#craftingprocesssnapshot)

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

##### feeEscrowAtlas

```ts
readonly feeEscrowAtlas: number;
```

Defined in: [packages/sage/src/crafting/index.ts:279](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L279)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`feeEscrowAtlas`](/reference/crafting/#craftingprocesssnapshot)

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

##### feeEscrowRaw

```ts
readonly feeEscrowRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:240](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L240)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`feeEscrowRaw`](/reference/crafting/#craftingprocesssnapshot)

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

##### inputs

```ts
readonly inputs: CraftingCargoInventory;
```

Defined in: [packages/sage/src/crafting/index.ts:278](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L278)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`inputs`](/reference/crafting/#craftingprocesssnapshot)

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

##### kind

```ts
readonly kind: "craftingProcess";
```

Defined in: [packages/sage/src/crafting/index.ts:271](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L271)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`kind`](/reference/crafting/#craftingprocesssnapshot)

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

##### numCrew

```ts
readonly numCrew: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:237](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L237)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`numCrew`](/reference/crafting/#craftingprocesssnapshot)

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

##### profile

```ts
readonly profile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/crafting/index.ts:274](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L274)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`profile`](/reference/crafting/#craftingprocesssnapshot)

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

##### quantityRaw

```ts
readonly quantityRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:236](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L236)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`quantityRaw`](/reference/crafting/#craftingprocesssnapshot)

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

##### recipe

```ts
readonly recipe: RecipeSnapshot;
```

Defined in: [packages/sage/src/crafting/index.ts:273](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L273)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`recipe`](/reference/crafting/#craftingprocesssnapshot)

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

##### starbasePlayer

```ts
readonly starbasePlayer: EntityRef<"starbasePlayer">;
```

Defined in: [packages/sage/src/crafting/index.ts:276](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L276)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`starbasePlayer`](/reference/crafting/#craftingprocesssnapshot)

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

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:234](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L234)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`starbaseSequenceId`](/reference/crafting/#craftingprocesssnapshot)

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

##### startsAtUnixSeconds

```ts
readonly startsAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:238](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L238)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`startsAtUnixSeconds`](/reference/crafting/#craftingprocesssnapshot)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/crafting/index.ts:275](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L275)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`system`](/reference/crafting/#craftingprocesssnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:229](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L229)

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`version`](/reference/crafting/#craftingprocesssnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/crafting/index.ts:280](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L280)

###### Returns

`unknown`

###### Inherited from

[`CraftingProcessSnapshot`](/reference/crafting/#craftingprocesssnapshot).[`toJSON`](/reference/crafting/#craftingprocesssnapshot)

***

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

### DefinitionLookupOptions

Defined in: [packages/sage/src/registry/index.ts:179](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L179)

Sequence information supplied by a live account that references a definition.

#### Example

```ts
const options: DefinitionLookupOptions = { expectedSequenceId: 12 };
```

#### Properties

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

##### expectedSequenceId?

```ts
readonly optional expectedSequenceId?: number;
```

Defined in: [packages/sage/src/registry/index.ts:180](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L180)

***

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

### DefinitionPreloadMeta

Defined in: [packages/sage/src/internal/read-meta.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L159)

Per-section provenance; unavailable observations are never inferred from siblings.

#### Example

```ts
import { preloadDefinitions } from '@aephia/atlas-kit';
declare const ctx: SageContext;
const meta: DefinitionPreloadMeta | undefined = readMeta(await preloadDefinitions(ctx, ['ships']));
```

#### Properties

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

##### kind

```ts
readonly kind: "definition-preload";
```

Defined in: [packages/sage/src/internal/read-meta.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L160)

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

##### sections

```ts
readonly sections: readonly {
  observation:   | {
     availability: "unavailable";
   }
     | {
     availability: "available";
     commitment: Commitment;
     slot: bigint;
   };
  section: DefinitionSection;
  sequenceId: number;
}[];
```

Defined in: [packages/sage/src/internal/read-meta.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L161)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/internal/read-meta.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L172)

###### Returns

`unknown`

***

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

### EntityRef

Defined in: [packages/sage/src/client/refs.ts:11](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/refs.ts#L11)

A lightweight cross-domain reference to an independently addressable account.

#### Example

```ts
declare const fleetAddress: Address;
const fleet: EntityRef<'fleet'> = entityRef('fleet', fleetAddress);
```

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `TType` *extends* [`EntityType`](/reference/client/#entitytype-1) | [`EntityType`](/reference/client/#entitytype-1) |

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/client/refs.ts:13](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/refs.ts#L13)

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

##### type

```ts
readonly type: TType;
```

Defined in: [packages/sage/src/client/refs.ts:12](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/refs.ts#L12)

***

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

### FactionMarketView

Defined in: [packages/sage/src/index.ts:444](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L444)

A loaded Faction Market exposed by the root convenience client.

#### Example

```ts
declare const market: FactionMarketView;
console.log(market.offers);
```

#### Extends

- [`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/markets/index.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L159)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`address`](/reference/markets/#factionmarketsnapshot)

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

##### atlasBurnBasisPoints

```ts
readonly atlasBurnBasisPoints: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:179](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L179)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`atlasBurnBasisPoints`](/reference/markets/#factionmarketsnapshot)

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

##### authoredTargetQuantityRaw

```ts
readonly authoredTargetQuantityRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:176](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L176)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`authoredTargetQuantityRaw`](/reference/markets/#factionmarketsnapshot)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:167](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L167)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`bump`](/reference/markets/#factionmarketsnapshot)

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

##### factionId

```ts
readonly factionId: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L169)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`factionId`](/reference/markets/#factionmarketsnapshot)

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

##### faucetEnabled

```ts
readonly faucetEnabled: boolean;
```

Defined in: [packages/sage/src/internal/c4/market.ts:181](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L181)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`faucetEnabled`](/reference/markets/#factionmarketsnapshot)

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/markets/index.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L160)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`game`](/reference/markets/#factionmarketsnapshot)

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

##### kind

```ts
readonly kind: "factionMarket";
```

Defined in: [packages/sage/src/markets/index.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L158)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`kind`](/reference/markets/#factionmarketsnapshot)

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

##### lastRestockedAtUnixSeconds

```ts
readonly lastRestockedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:178](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L178)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`lastRestockedAtUnixSeconds`](/reference/markets/#factionmarketsnapshot)

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

##### minimumStandingToBuy

```ts
readonly minimumStandingToBuy: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:173](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L173)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`minimumStandingToBuy`](/reference/markets/#factionmarketsnapshot)

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

##### minimumStandingToSell

```ts
readonly minimumStandingToSell: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:174](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L174)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`minimumStandingToSell`](/reference/markets/#factionmarketsnapshot)

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

##### offers

```ts
readonly offers: readonly FactionMarketOfferSnapshot[];
```

Defined in: [packages/sage/src/markets/index.ts:162](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L162)

###### Inherited from

[`FactionMarketView`](/reference/#factionmarketview).[`offers`](/reference/#factionmarketview)

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

##### priceTierBasisPoints

```ts
readonly priceTierBasisPoints: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/market.ts:175](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L175)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`priceTierBasisPoints`](/reference/markets/#factionmarketsnapshot)

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

##### restockPeriodSeconds

```ts
readonly restockPeriodSeconds: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:177](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L177)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`restockPeriodSeconds`](/reference/markets/#factionmarketsnapshot)

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

##### standingBasisPoints

```ts
readonly standingBasisPoints: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:180](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L180)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`standingBasisPoints`](/reference/markets/#factionmarketsnapshot)

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

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:171](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L171)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`starbaseSequenceId`](/reference/markets/#factionmarketsnapshot)

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

##### status

```ts
readonly status: "active" | "draft";
```

Defined in: [packages/sage/src/internal/c4/market.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L172)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`status`](/reference/markets/#factionmarketsnapshot)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/markets/index.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L161)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`system`](/reference/markets/#factionmarketsnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:166](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L166)

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`version`](/reference/markets/#factionmarketsnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/markets/index.ts:163](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L163)

###### Returns

`unknown`

###### Inherited from

[`FactionMarketSnapshot`](/reference/markets/#factionmarketsnapshot).[`toJSON`](/reference/markets/#factionmarketsnapshot)

***

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

### FleetCargoInventoryView

Defined in: [packages/sage/src/index.ts:231](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L231)

A loaded Fleet cargo inventory exposed by a root Fleet relation.

#### Example

```ts
declare const inventory: FleetCargoInventoryView;
console.log(inventory.cargoHold.items);
```

#### Extends

- [`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/cargo/index.ts:81](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/cargo/index.ts#L81)

Parent Fleet address; CargoPods are nested values and have no own address.

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`address`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### ammo

```ts
readonly ammo: CargoInventoryItem;
```

Defined in: [packages/sage/src/internal/cargo.ts:63](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L63)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`ammo`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### capacities

```ts
readonly capacities: {
  ammoUnits: CargoCapacity;
  cargoStorageUnits: CargoCapacity;
  fuelUnits: CargoCapacity;
};
```

Defined in: [packages/sage/src/internal/cargo.ts:64](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L64)

###### ammoUnits

```ts
readonly ammoUnits: CargoCapacity;
```

###### cargoStorageUnits

```ts
readonly cargoStorageUnits: CargoCapacity;
```

###### fuelUnits

```ts
readonly fuelUnits: CargoCapacity;
```

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`capacities`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### cargoHold

```ts
readonly cargoHold: CargoPodInventory;
```

Defined in: [packages/sage/src/internal/cargo.ts:59](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L59)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`cargoHold`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### components

```ts
readonly components: CargoPodInventory;
```

Defined in: [packages/sage/src/internal/cargo.ts:60](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L60)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`components`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### fleet

```ts
readonly fleet: EntityRef<"fleet">;
```

Defined in: [packages/sage/src/cargo/index.ts:82](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/cargo/index.ts#L82)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`fleet`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### fuel

```ts
readonly fuel: CargoInventoryItem;
```

Defined in: [packages/sage/src/internal/cargo.ts:62](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L62)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`fuel`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### kind

```ts
readonly kind: "fleetCargoInventory";
```

Defined in: [packages/sage/src/cargo/index.ts:79](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/cargo/index.ts#L79)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`kind`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### ownerProfile

```ts
readonly ownerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/cargo/index.ts:83](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/cargo/index.ts#L83)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`ownerProfile`](/reference/cargo/#fleetcargoinventorysnapshot)

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

##### respawningCargo

```ts
readonly respawningCargo: CargoPodInventory;
```

Defined in: [packages/sage/src/internal/cargo.ts:61](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/cargo.ts#L61)

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`respawningCargo`](/reference/cargo/#fleetcargoinventorysnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/cargo/index.ts:84](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/cargo/index.ts#L84)

###### Returns

`unknown`

###### Inherited from

[`FleetCargoInventorySnapshot`](/reference/cargo/#fleetcargoinventorysnapshot).[`toJSON`](/reference/cargo/#fleetcargoinventorysnapshot)

***

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

### FleetMiningView

Defined in: [packages/sage/src/index.ts:256](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L256)

A loaded Fleet mining state with root-only entity traversal.

#### Example

```ts
declare const mining: FleetMiningView;
const asteroid = await mining.asteroid.get();
```

#### Extends

- `Omit`\<[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot), `"asteroid"` \| `"fleet"` \| `"ownerProfile"`\>

#### Properties

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

##### asteroid

```ts
readonly asteroid: EntityRef<"celestialBody"> & {
  get: Promise<CelestialBodyView>;
};
```

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

###### Type Declaration

###### get()

```ts
get(options?): Promise<CelestialBodyView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CelestialBodyView`](/reference/#celestialbodyview)\>

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

##### fleet

```ts
readonly fleet: EntityRef<"fleet"> & {
  get: Promise<FleetView>;
};
```

Defined in: [packages/sage/src/index.ts:263](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L263)

###### Type Declaration

###### get()

```ts
get(options?): Promise<FleetView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetView`](/reference/#fleetview)\>

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

##### kind

```ts
readonly kind: "fleetMining";
```

Defined in: [packages/sage/src/mining/index.ts:119](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L119)

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`kind`](/reference/mining/#fleetminingsnapshot)

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

##### lastUpdatedAtUnixSeconds

```ts
readonly lastUpdatedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/mining/index.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L123)

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`lastUpdatedAtUnixSeconds`](/reference/mining/#fleetminingsnapshot)

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

##### miningRate

```ts
readonly miningRate: {
  raw: bigint;
  unitsPerSecond: number;
};
```

Defined in: [packages/sage/src/mining/index.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L125)

###### raw

```ts
readonly raw: bigint;
```

###### unitsPerSecond

```ts
readonly unitsPerSecond: number;
```

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`miningRate`](/reference/mining/#fleetminingsnapshot)

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

##### outputs

```ts
readonly outputs: readonly FleetMiningOutput[];
```

Defined in: [packages/sage/src/mining/index.ts:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L129)

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`outputs`](/reference/mining/#fleetminingsnapshot)

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

##### ownerProfile

```ts
readonly ownerProfile: EntityRef<"profile"> & {
  get: Promise<ProfileView>;
};
```

Defined in: [packages/sage/src/index.ts:266](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L266)

###### Type Declaration

###### get()

```ts
get(options?): Promise<ProfileView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ProfileView`](/reference/#profileview)\>

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

##### regionXpModifier

```ts
readonly regionXpModifier: WorldFixedValue;
```

Defined in: [packages/sage/src/mining/index.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L124)

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`regionXpModifier`](/reference/mining/#fleetminingsnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/mining/index.ts:130](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L130)

###### Returns

`unknown`

###### Inherited from

[`FleetMiningSnapshot`](/reference/mining/#fleetminingsnapshot).[`toJSON`](/reference/mining/#fleetminingsnapshot)

***

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

### FleetView

Defined in: [packages/sage/src/index.ts:215](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L215)

A loaded Fleet exposed by the root convenience client.

#### Example

```ts
declare const sage: SageClient;
declare const fleetAddress: Address;
const fleet: FleetView = await sage.fleets.get(fleetAddress);
console.log(fleet.name);
```

#### Extends

- [`FleetSnapshot`](/reference/fleets/#fleetsnapshot)

#### Properties

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

##### activeStimulants

```ts
readonly activeStimulants: readonly {
  chargesRemaining: number;
  deltaBps: number;
  stat: number;
}[];
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:357](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L357)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`activeStimulants`](/reference/fleets/#fleetaccountdata)

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/fleets/index.ts:92](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/fleets/index.ts#L92)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`address`](/reference/fleets/#fleetsnapshot)

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

##### ammo

```ts
readonly ammo: ResolvedCargoAmount;
```

Defined in: [packages/sage/src/internal/fleet.ts:102](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L102)

###### Inherited from

[`ResolvedFleetAccountData`](/reference/fleets/#resolvedfleetaccountdata).[`ammo`](/reference/fleets/#resolvedfleetaccountdata)

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

##### ap

```ts
readonly ap: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:343](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L343)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`ap`](/reference/fleets/#fleetaccountdata)

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

##### apReloadExpiresAt

```ts
readonly apReloadExpiresAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:348](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L348)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`apReloadExpiresAt`](/reference/fleets/#fleetaccountdata)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:326](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L326)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`bump`](/reference/fleets/#fleetaccountdata)

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

##### capacities

```ts
readonly capacities: {
  ammo: CapacitySummary;
  cargo: CapacitySummary;
  fuel: CapacitySummary;
};
```

Defined in: [packages/sage/src/internal/fleet.ts:118](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L118)

###### ammo

```ts
readonly ammo: CapacitySummary;
```

###### cargo

```ts
readonly cargo: CapacitySummary;
```

###### fuel

```ts
readonly fuel: CapacitySummary;
```

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`capacities`](/reference/fleets/#fleetsnapshot)

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

##### cargoHold

```ts
readonly cargoHold: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};
```

Defined in: [packages/sage/src/internal/fleet.ts:103](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L103)

###### items

```ts
readonly items: readonly ResolvedCargoAmount[];
```

###### seqId

```ts
readonly seqId: number;
```

###### storageCost

```ts
readonly storageCost: bigint;
```

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`cargoHold`](/reference/fleets/#fleetsnapshot)

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

##### components

```ts
readonly components: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};
```

Defined in: [packages/sage/src/internal/fleet.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L108)

###### items

```ts
readonly items: readonly ResolvedCargoAmount[];
```

###### seqId

```ts
readonly seqId: number;
```

###### storageCost

```ts
readonly storageCost: bigint;
```

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`components`](/reference/fleets/#fleetsnapshot)

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

##### crewCount

```ts
readonly crewCount: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:340](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L340)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`crewCount`](/reference/fleets/#fleetaccountdata)

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

##### faction

```ts
readonly faction: "unaligned" | "mud" | "oni" | "ustur";
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:331](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L331)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`faction`](/reference/fleets/#fleetaccountdata)

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

##### fuel

```ts
readonly fuel: ResolvedCargoAmount;
```

Defined in: [packages/sage/src/internal/fleet.ts:101](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L101)

###### Inherited from

[`ResolvedFleetAccountData`](/reference/fleets/#resolvedfleetaccountdata).[`fuel`](/reference/fleets/#resolvedfleetaccountdata)

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:327](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L327)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`game`](/reference/fleets/#fleetaccountdata)

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

##### hp

```ts
readonly hp: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:345](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L345)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`hp`](/reference/fleets/#fleetaccountdata)

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

##### inventory

```ts
readonly inventory: {
  get: Promise<FleetCargoInventoryView>;
};
```

Defined in: [packages/sage/src/index.ts:216](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L216)

###### get()

```ts
get(options?): Promise<FleetCargoInventoryView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetCargoInventoryView`](/reference/#fleetcargoinventoryview)\>

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

##### kind

```ts
readonly kind: "fleet";
```

Defined in: [packages/sage/src/fleets/index.ts:91](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/fleets/index.ts#L91)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`kind`](/reference/fleets/#fleetsnapshot)

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

##### lastCombatUpdate

```ts
readonly lastCombatUpdate: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:350](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L350)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`lastCombatUpdate`](/reference/fleets/#fleetaccountdata)

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

##### lastUpdateAt

```ts
readonly lastUpdateAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:352](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L352)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`lastUpdateAt`](/reference/fleets/#fleetaccountdata)

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

##### location

```ts
readonly location: WorldCoordinates;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:351](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L351)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`location`](/reference/fleets/#fleetaccountdata)

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

##### mining

```ts
readonly mining: {
  get: Promise<FleetMiningView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:219](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L219)

###### get()

```ts
get(options?): Promise<FleetMiningView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetMiningView`](/reference/#fleetminingview) \| `undefined`\>

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:333](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L333)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`name`](/reference/fleets/#fleetaccountdata)

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

##### npcFactionId

```ts
readonly npcFactionId: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:332](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L332)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`npcFactionId`](/reference/fleets/#fleetaccountdata)

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

##### ownerProfile

```ts
readonly ownerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/fleets/index.ts:93](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/fleets/index.ts#L93)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`ownerProfile`](/reference/fleets/#fleetsnapshot)

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

##### pendingHp

```ts
readonly pendingHp: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:346](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L346)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`pendingHp`](/reference/fleets/#fleetaccountdata)

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

##### rentedCrew

```ts
readonly rentedCrew: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:341](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L341)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`rentedCrew`](/reference/fleets/#fleetaccountdata)

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

##### respawningCargo

```ts
readonly respawningCargo: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};
```

Defined in: [packages/sage/src/internal/fleet.ts:113](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L113)

###### items

```ts
readonly items: readonly ResolvedCargoAmount[];
```

###### seqId

```ts
readonly seqId: number;
```

###### storageCost

```ts
readonly storageCost: bigint;
```

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`respawningCargo`](/reference/fleets/#fleetsnapshot)

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

##### scanCooldownExpiresAt

```ts
readonly scanCooldownExpiresAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:336](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L336)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`scanCooldownExpiresAt`](/reference/fleets/#fleetaccountdata)

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

##### shieldBreakDelayExpiresAt

```ts
readonly shieldBreakDelayExpiresAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:349](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L349)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`shieldBreakDelayExpiresAt`](/reference/fleets/#fleetaccountdata)

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

##### shipCounts

```ts
readonly shipCounts: FleetShipCountsData;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:334](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L334)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`shipCounts`](/reference/fleets/#fleetaccountdata)

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

##### shipDefinitionsSeqId

```ts
readonly shipDefinitionsSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:342](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L342)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`shipDefinitionsSeqId`](/reference/fleets/#fleetaccountdata)

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

##### ships

```ts
readonly ships: readonly ResolvedShipAmount[];
```

Defined in: [packages/sage/src/internal/fleet.ts:100](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L100)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`ships`](/reference/fleets/#fleetsnapshot)

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

##### sp

```ts
readonly sp: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:344](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L344)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`sp`](/reference/fleets/#fleetaccountdata)

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

##### stance

```ts
readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:347](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L347)

###### ammoUsage

```ts
readonly ammoUsage: "none" | "light" | "heavy";
```

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`stance`](/reference/fleets/#fleetaccountdata)

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

##### state

```ts
readonly state: ResolvedFleetState;
```

Defined in: [packages/sage/src/internal/fleet.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L123)

###### Inherited from

[`ResolvedFleetAccountData`](/reference/fleets/#resolvedfleetaccountdata).[`state`](/reference/fleets/#resolvedfleetaccountdata)

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

##### stats

```ts
readonly stats: FleetStatsData;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:337](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L337)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`stats`](/reference/fleets/#fleetaccountdata)

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

##### subProfile?

```ts
readonly optional subProfile?: Address;
```

Defined in: [packages/sage/src/internal/fleet.ts:98](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L98)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`subProfile`](/reference/fleets/#fleetsnapshot)

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

##### subProfileInvalidator?

```ts
readonly optional subProfileInvalidator?: Address;
```

Defined in: [packages/sage/src/internal/fleet.ts:99](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/fleet.ts#L99)

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`subProfileInvalidator`](/reference/fleets/#fleetsnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:325](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L325)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`version`](/reference/fleets/#fleetaccountdata)

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

##### warpCooldownExpiresAt

```ts
readonly warpCooldownExpiresAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/fleet.ts:335](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/fleet.ts#L335)

###### Inherited from

[`FleetAccountData`](/reference/fleets/#fleetaccountdata).[`warpCooldownExpiresAt`](/reference/fleets/#fleetaccountdata)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/fleets/index.ts:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/fleets/index.ts#L94)

###### Returns

`unknown`

###### Inherited from

[`FleetSnapshot`](/reference/fleets/#fleetsnapshot).[`toJSON`](/reference/fleets/#fleetsnapshot)

***

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

### LocalMarketView

Defined in: [packages/sage/src/index.ts:435](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L435)

A loaded Local Market exposed by the root convenience client.

#### Example

```ts
declare const market: LocalMarketView;
console.log(market.cargo.name);
```

#### Extends

- [`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/markets/index.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L123)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`address`](/reference/markets/#localmarketsnapshot)

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

##### asks

```ts
readonly asks: LocalMarketOrderBookSnapshot;
```

Defined in: [packages/sage/src/markets/index.ts:128](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L128)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`asks`](/reference/markets/#localmarketsnapshot)

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

##### bids

```ts
readonly bids: LocalMarketOrderBookSnapshot;
```

Defined in: [packages/sage/src/markets/index.ts:127](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L127)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`bids`](/reference/markets/#localmarketsnapshot)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:147](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L147)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`bump`](/reference/markets/#localmarketsnapshot)

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

##### cargo

```ts
readonly cargo: CargoDefinitionSummary & {
  amountRaw: bigint;
};
```

Defined in: [packages/sage/src/markets/index.ts:126](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L126)

###### Type Declaration

###### amountRaw

```ts
readonly amountRaw: bigint;
```

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`cargo`](/reference/markets/#localmarketsnapshot)

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

##### initializerProfile

```ts
readonly initializerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/markets/index.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L125)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`initializerProfile`](/reference/markets/#localmarketsnapshot)

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

##### kind

```ts
readonly kind: "localMarket";
```

Defined in: [packages/sage/src/markets/index.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L122)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`kind`](/reference/markets/#localmarketsnapshot)

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

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:146](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L146)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`starbaseSequenceId`](/reference/markets/#localmarketsnapshot)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/markets/index.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L124)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`system`](/reference/markets/#localmarketsnapshot)

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

##### vaultAtlas

```ts
readonly vaultAtlas: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L151)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`vaultAtlas`](/reference/markets/#localmarketsnapshot)

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

##### vaultRaw

```ts
readonly vaultRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/market.ts:150](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L150)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`vaultRaw`](/reference/markets/#localmarketsnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/market.ts:144](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/market.ts#L144)

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`version`](/reference/markets/#localmarketsnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/markets/index.ts:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/markets/index.ts#L129)

###### Returns

`unknown`

###### Inherited from

[`LocalMarketSnapshot`](/reference/markets/#localmarketsnapshot).[`toJSON`](/reference/markets/#localmarketsnapshot)

***

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

### PlanetView

Defined in: [packages/sage/src/index.ts:352](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L352)

A loaded Planet whose stored StarSystem reference resolves through the root client.

#### Example

```ts
declare const planet: PlanetView;
const system = await planet.system.get();
```

#### Extends

- `Omit`\<[`PlanetSnapshot`](/reference/world/#planetsnapshot), `"system"`\>

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:100](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L100)

###### Inherited from

[`PlanetSnapshot`](/reference/world/#planetsnapshot).[`address`](/reference/world/#planetsnapshot)

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

##### claimStakes

```ts
readonly claimStakes: {
  all: Promise<readonly ClaimStakeView[]>;
};
```

Defined in: [packages/sage/src/index.ts:353](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L353)

###### all()

```ts
all(options?): Promise<readonly ClaimStakeView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ClaimStakeView`](/reference/#claimstakeview)[]\>

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

##### details

```ts
readonly details: WorldPlanetData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:429](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L429)

###### Inherited from

```ts
Omit.details
```

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:419](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L419)

###### Inherited from

```ts
Omit.game
```

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

##### id

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

Defined in: [packages/sage/src/internal/c4/world.ts:417](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L417)

###### Inherited from

```ts
Omit.id
```

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

##### kind

```ts
readonly kind: "planet";
```

Defined in: [packages/sage/src/internal/c4/world.ts:428](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L428)

###### Inherited from

```ts
Omit.kind
```

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

##### lastSyncAtUnixSeconds

```ts
readonly lastSyncAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:422](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L422)

###### Inherited from

```ts
Omit.lastSyncAtUnixSeconds
```

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:418](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L418)

###### Inherited from

```ts
Omit.name
```

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

##### system

```ts
readonly system: EntityRef<"starSystem"> & {
  get: Promise<StarSystemView>;
};
```

Defined in: [packages/sage/src/index.ts:358](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L358)

###### Type Declaration

###### get()

```ts
get(options?): Promise<StarSystemView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview)\>

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

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:421](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L421)

###### Inherited from

```ts
Omit.systemSequenceId
```

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:416](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L416)

###### Inherited from

```ts
Omit.version
```

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:102](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L102)

###### Returns

`unknown`

###### Inherited from

[`PlanetSnapshot`](/reference/world/#planetsnapshot).[`toJSON`](/reference/world/#planetsnapshot)

***

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

### ProfileView

Defined in: [packages/sage/src/index.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L125)

A loaded Player Profile exposed by the root convenience client.

#### Example

```ts
declare const sage: SageClient;
declare const profileAddress: Address;
const profile: ProfileView = await sage.profiles.get(profileAddress);
```

#### Extends

- [`ProfileSnapshot`](/reference/identity/#profilesnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/identity/index.ts:103](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L103)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`address`](/reference/identity/#profilesnapshot)

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

##### authKeyCount

```ts
readonly authKeyCount: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:87](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L87)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`authKeyCount`](/reference/identity/#profilesnapshot)

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

##### createdAt

```ts
readonly createdAt: bigint;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:90](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L90)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`createdAt`](/reference/identity/#profilesnapshot)

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

##### keys

```ts
readonly keys: readonly ProfileKeyData[];
```

Defined in: [packages/sage/src/internal/c4/identity.ts:91](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L91)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`keys`](/reference/identity/#profilesnapshot)

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

##### keyThreshold

```ts
readonly keyThreshold: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:88](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L88)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`keyThreshold`](/reference/identity/#profilesnapshot)

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

##### kind

```ts
readonly kind: "profile";
```

Defined in: [packages/sage/src/identity/index.ts:102](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L102)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`kind`](/reference/identity/#profilesnapshot)

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

##### nextSeqId

```ts
readonly nextSeqId: bigint;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:89](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L89)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`nextSeqId`](/reference/identity/#profilesnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/identity.ts:86](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/identity.ts#L86)

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`version`](/reference/identity/#profilesnapshot)

#### Methods

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

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/identity/index.ts:104](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/identity/index.ts#L104)

###### Returns

`unknown`

###### Inherited from

[`ProfileSnapshot`](/reference/identity/#profilesnapshot).[`toJSON`](/reference/identity/#profilesnapshot)

***

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

### ReadMeta

Defined in: [packages/sage/src/internal/read-meta.ts:24](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L24)

Provenance attached non-enumerably to finder results.

#### Example

```ts
declare const fleets: readonly {readonly address: Address}[];
const meta: ReadMeta | undefined = readMeta(fleets);
if (meta) console.log(meta.strategy, meta.slot);
```

#### Properties

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

##### commitment

```ts
readonly commitment: Commitment;
```

Defined in: [packages/sage/src/internal/read-meta.ts:28](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L28)

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

##### filters?

```ts
readonly optional filters?: readonly ReadMetaFilter[];
```

Defined in: [packages/sage/src/internal/read-meta.ts:30](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L30)

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

##### indexer?

```ts
readonly optional indexer?: IndexerValidationMeta;
```

Defined in: [packages/sage/src/internal/read-meta.ts:31](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L31)

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

##### slot

```ts
readonly slot: bigint;
```

Defined in: [packages/sage/src/internal/read-meta.ts:27](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L27)

Earliest source slot across the result, or `0n` when it is empty.

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

##### source

```ts
readonly source: DataSourceIdentity;
```

Defined in: [packages/sage/src/internal/read-meta.ts:29](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L29)

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

##### strategy

```ts
readonly strategy: DiscoveryStrategy;
```

Defined in: [packages/sage/src/internal/read-meta.ts:25](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L25)

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

##### walletProfiles?

```ts
readonly optional walletProfiles?: WalletProfileValidationMeta;
```

Defined in: [packages/sage/src/internal/read-meta.ts:32](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L32)

#### Methods

<a id="tojson-13"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/internal/read-meta.ts:34](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L34)

Returns a JSON-safe copy with bigints as strings and filter bytes as arrays.

###### Returns

`unknown`

***

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

### ReadMetaFilter

Defined in: [packages/sage/src/internal/read-meta.ts:82](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L82)

Immutable JSON-safe filter provenance exposed by [readMeta](/reference/#readmeta-1).

#### Example

```ts
const filter: ReadMetaFilter = { offset: 0, bytes: [1, 2] };
```

#### Properties

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

##### bytes

```ts
readonly bytes: readonly number[];
```

Defined in: [packages/sage/src/internal/read-meta.ts:84](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L84)

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

##### offset

```ts
readonly offset: number;
```

Defined in: [packages/sage/src/internal/read-meta.ts:83](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L83)

***

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

### RecipeView

Defined in: [packages/sage/src/index.ts:323](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L323)

A loaded Recipe exposed by the root convenience client.

#### Example

```ts
declare const sage: SageClient;
const recipe: RecipeView = await sage.recipes.byId(7);
```

#### Extends

- [`RecipeSnapshot`](/reference/crafting/#recipesnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/crafting/index.ts:95](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L95)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`address`](/reference/crafting/#recipesnapshot)

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

##### craftingDurationSeconds

```ts
readonly craftingDurationSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:145](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L145)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`craftingDurationSeconds`](/reference/crafting/#recipesnapshot)

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

##### fee

```ts
readonly fee: {
  amountAtlas: number;
  amountRaw: bigint;
  recipient: "atlas" | "dao-atlas";
};
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:149](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L149)

###### amountAtlas

```ts
readonly amountAtlas: number;
```

###### amountRaw

```ts
readonly amountRaw: bigint;
```

###### recipient

```ts
readonly recipient: "atlas" | "dao-atlas";
```

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`fee`](/reference/crafting/#recipesnapshot)

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

##### game

```ts
readonly game: EntityRef<"game">;
```

Defined in: [packages/sage/src/crafting/index.ts:96](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L96)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`game`](/reference/crafting/#recipesnapshot)

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

##### habRequired

```ts
readonly habRequired: boolean;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L154)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`habRequired`](/reference/crafting/#recipesnapshot)

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

##### id

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

Defined in: [packages/sage/src/crafting/index.ts:97](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L97)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`id`](/reference/crafting/#recipesnapshot)

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

##### ingredients

```ts
readonly ingredients: readonly CraftingCargoItem[];
```

Defined in: [packages/sage/src/crafting/index.ts:98](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L98)

###### Inherited from

[`RecipeView`](/reference/#recipeview).[`ingredients`](/reference/#recipeview)

<a id="kind-13"></a>

##### kind

```ts
readonly kind: "recipe";
```

Defined in: [packages/sage/src/crafting/index.ts:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L94)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`kind`](/reference/crafting/#recipesnapshot)

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

##### minimumDurationSeconds

```ts
readonly minimumDurationSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:146](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L146)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`minimumDurationSeconds`](/reference/crafting/#recipesnapshot)

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

##### minimumStarbaseLevel

```ts
readonly minimumStarbaseLevel: 
  | "level-0"
  | "level-1"
  | "level-2"
  | "level-3"
  | "level-4"
  | "level-5"
  | "css";
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L158)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`minimumStarbaseLevel`](/reference/crafting/#recipesnapshot)

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

##### modifierBounds

```ts
readonly modifierBounds: {
  crewCount: CraftingModifierBoundsData;
  efficiency: CraftingModifierBoundsData;
  fee: CraftingModifierBoundsData;
  speed: CraftingModifierBoundsData;
};
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:166](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L166)

###### crewCount

```ts
readonly crewCount: CraftingModifierBoundsData;
```

###### efficiency

```ts
readonly efficiency: CraftingModifierBoundsData;
```

###### fee

```ts
readonly fee: CraftingModifierBoundsData;
```

###### speed

```ts
readonly speed: CraftingModifierBoundsData;
```

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`modifierBounds`](/reference/crafting/#recipesnapshot)

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:147](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L147)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`name`](/reference/crafting/#recipesnapshot)

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

##### outputs

```ts
readonly outputs: readonly CraftingCargoItem[];
```

Defined in: [packages/sage/src/crafting/index.ts:99](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L99)

###### Inherited from

[`RecipeView`](/reference/#recipeview).[`outputs`](/reference/#recipeview)

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

##### researchRequirementIds

```ts
readonly researchRequirementIds: readonly number[];
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:172](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L172)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`researchRequirementIds`](/reference/crafting/#recipesnapshot)

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

##### status

```ts
readonly status: "active" | "deactivated";
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:148](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L148)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`status`](/reference/crafting/#recipesnapshot)

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

##### usageCountRaw

```ts
readonly usageCountRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:155](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L155)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`usageCountRaw`](/reference/crafting/#recipesnapshot)

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

##### usageLimitRaw

```ts
readonly usageLimitRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:156](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L156)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`usageLimitRaw`](/reference/crafting/#recipesnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:142](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L142)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`version`](/reference/crafting/#recipesnapshot)

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

##### xpValueRaw

```ts
readonly xpValueRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/crafting.ts:157](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/crafting.ts#L157)

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`xpValueRaw`](/reference/crafting/#recipesnapshot)

#### Methods

<a id="tojson-14"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/crafting/index.ts:100](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/crafting/index.ts#L100)

###### Returns

`unknown`

###### Inherited from

[`RecipeSnapshot`](/reference/crafting/#recipesnapshot).[`toJSON`](/reference/crafting/#recipesnapshot)

***

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

### RegistrySnapshotStore

Defined in: [packages/sage/src/registry/index.ts:164](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L164)

Optional application storage contract for registry cold starts.

Implementations may use IndexedDB, a filesystem, or another application-owned
store. Loading remains lazy and begins only with the first definition lookup.
Ship schema version 2 persists complete configuration stats as JSON-safe data;
cargo schema version 1 remains compatible. Older ship snapshots reload lazily.
Claim Stake containers/buildings and Crafting Hab containers/buildings each
use a strict section-specific v2 schema with exact decimal bigint strings.
Malformed snapshots reload from Game; a throwing store load is a ProviderError.
XP and research are not persisted. Restored sequences do not prove freshness
and carry no observation slot or commitment. Saves are best effort.

#### Example

```ts
declare const load: RegistrySnapshotStore['load'];
declare const save: RegistrySnapshotStore['save'];
declare const rpc: SageRpc;
const store: RegistrySnapshotStore = { load, save };
const ctx = createSageContext({ cluster: 'zink-ptr', rpc, registrySnapshotStore: store });
```

#### Methods

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

##### load()

```ts
load(game, section): Promise<
  | DefinitionSectionSnapshot
| undefined>;
```

Defined in: [packages/sage/src/registry/index.ts:165](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L165)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `game` | [`Address`](/reference/#address-20) |
| `section` | \| `"ships"` \| `"cargo"` \| `"buildings"` \| `"claimStakes"` \| `"craftingHabs"` \| `"habBuildings"` |

###### Returns

`Promise`\<
  \| [`DefinitionSectionSnapshot`](/reference/#definitionsectionsnapshot)
  \| `undefined`\>

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

##### save()

```ts
save(snapshot): Promise<void>;
```

Defined in: [packages/sage/src/registry/index.ts:169](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L169)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `snapshot` | [`DefinitionSectionSnapshot`](/reference/#definitionsectionsnapshot) |

###### Returns

`Promise`\<`void`\>

***

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

### ResourceDepositView

Defined in: [packages/sage/src/index.ts:240](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L240)

A loaded Asteroid deposit with root-only StarSystem traversal.

#### Example

```ts
declare const deposit: ResourceDepositView;
const system = await deposit.system.get();
```

#### Extends

- `Omit`\<[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot), `"system"`\>

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/mining/index.ts:67](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L67)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`address`](/reference/mining/#resourcedepositsnapshot)

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

##### bodyId

```ts
readonly bodyId: number;
```

Defined in: [packages/sage/src/mining/index.ts:68](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L68)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`bodyId`](/reference/mining/#resourcedepositsnapshot)

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/mining/index.ts:70](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L70)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`game`](/reference/mining/#resourcedepositsnapshot)

<a id="kind-14"></a>

##### kind

```ts
readonly kind: "resourceDeposit";
```

Defined in: [packages/sage/src/mining/index.ts:66](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L66)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`kind`](/reference/mining/#resourcedepositsnapshot)

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

##### lastSyncedAtUnixSeconds

```ts
readonly lastSyncedAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/mining/index.ts:73](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L73)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`lastSyncedAtUnixSeconds`](/reference/mining/#resourcedepositsnapshot)

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/mining/index.ts:69](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L69)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`name`](/reference/mining/#resourcedepositsnapshot)

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

##### resources

```ts
readonly resources: readonly ResourceDepositItem[];
```

Defined in: [packages/sage/src/mining/index.ts:74](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L74)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`resources`](/reference/mining/#resourcedepositsnapshot)

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

##### system

```ts
readonly system: EntityRef<"starSystem"> & {
  get: Promise<StarSystemView>;
};
```

Defined in: [packages/sage/src/index.ts:244](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L244)

###### Type Declaration

###### get()

```ts
get(options?): Promise<StarSystemView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview)\>

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

##### systemSequenceId

```ts
readonly systemSequenceId: bigint;
```

Defined in: [packages/sage/src/mining/index.ts:72](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L72)

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`systemSequenceId`](/reference/mining/#resourcedepositsnapshot)

#### Methods

<a id="tojson-15"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/mining/index.ts:75](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/mining/index.ts#L75)

###### Returns

`unknown`

###### Inherited from

[`ResourceDepositSnapshot`](/reference/mining/#resourcedepositsnapshot).[`toJSON`](/reference/mining/#resourcedepositsnapshot)

***

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

### SageClient

Defined in: [packages/sage/src/index.ts:454](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L454)

Batteries-included root client composing the currently implemented domains.

#### Example

```ts
declare const rpc: SageRpc;
const sage: SageClient = createSageClient({ cluster: 'zink-ptr', rpc });
```

#### Properties

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

##### celestialBodies

```ts
readonly celestialBodies: {
  all: Promise<readonly CelestialBodyView[]>;
  byId: Promise<CelestialBodyView>;
  get: Promise<CelestialBodyView>;
  maybe: Promise<CelestialBodyView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:640](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L640)

###### all()

```ts
all(options?): Promise<readonly CelestialBodyView[]>;
```

Discovers loaded body views across the configured Game.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CelestialBodyDiscoveryOptions`](/reference/world/#celestialbodydiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CelestialBodyView`](/reference/#celestialbodyview)[]\>

###### Example

```ts
declare const sage: SageClient;
const bodies = await sage.celestialBodies.all();
```

###### byId()

```ts
byId(bodyId, options?): Promise<CelestialBodyView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `bodyId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CelestialBodyView`](/reference/#celestialbodyview)\>

###### get()

```ts
get(address, options?): Promise<CelestialBodyView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CelestialBodyView`](/reference/#celestialbodyview)\>

###### maybe()

```ts
maybe(address, options?): Promise<CelestialBodyView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CelestialBodyView`](/reference/#celestialbodyview) \| `undefined`\>

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

##### characters

```ts
readonly characters: {
  forProfile: Promise<CharacterView>;
};
```

Defined in: [packages/sage/src/index.ts:466](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L466)

###### forProfile()

```ts
forProfile(profileAddress, options?): Promise<CharacterView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `profileAddress` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CharacterView`](/reference/#characterview)\>

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

##### claimStakes

```ts
readonly claimStakes: {
  byBody: Promise<readonly ClaimStakeView[]>;
  byCharacter: Promise<readonly ClaimStakeView[]>;
  get: Promise<ClaimStakeView>;
  maybe: Promise<ClaimStakeView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:580](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L580)

###### byBody()

```ts
byBody(body, options?): Promise<readonly ClaimStakeView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `body` | [`Address`](/reference/#address-20) |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ClaimStakeView`](/reference/#claimstakeview)[]\>

###### byCharacter()

```ts
byCharacter(character, options?): Promise<readonly ClaimStakeView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ClaimStakeView`](/reference/#claimstakeview)[]\>

###### get()

```ts
get(address, options?): Promise<ClaimStakeView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ClaimStakeView`](/reference/#claimstakeview)\>

###### maybe()

```ts
maybe(address, options?): Promise<ClaimStakeView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ClaimStakeView`](/reference/#claimstakeview) \| `undefined`\>

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

##### context

```ts
readonly context: SageContext;
```

Defined in: [packages/sage/src/index.ts:455](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L455)

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

##### craftingHabs

```ts
readonly craftingHabs: {
  byCharacter: Promise<readonly CraftingHabView[]>;
  byProfile: Promise<readonly CraftingHabView[]>;
  byStarbasePlayer: Promise<readonly CraftingHabView[]>;
  get: Promise<CraftingHabView>;
  maybe: Promise<CraftingHabView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:491](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L491)

###### byCharacter()

```ts
byCharacter(character, options?): Promise<readonly CraftingHabView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingHabView`](/reference/#craftinghabview)[]\>

###### byProfile()

```ts
byProfile(profile, options?): Promise<readonly CraftingHabView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `profile` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingHabView`](/reference/#craftinghabview)[]\>

###### byStarbasePlayer()

```ts
byStarbasePlayer(player, options?): Promise<readonly CraftingHabView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `player` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingHabView`](/reference/#craftinghabview)[]\>

###### get()

```ts
get(address, options?): Promise<CraftingHabView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CraftingHabView`](/reference/#craftinghabview)\>

###### maybe()

```ts
maybe(address, options?): Promise<CraftingHabView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CraftingHabView`](/reference/#craftinghabview) \| `undefined`\>

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

##### craftingProcesses

```ts
readonly craftingProcesses: {
  byCharacter: Promise<readonly CraftingProcessView[]>;
  byProfile: Promise<readonly CraftingProcessView[]>;
  byStarbasePlayer: Promise<readonly CraftingProcessView[]>;
  get: Promise<CraftingProcessView>;
  maybe: Promise<CraftingProcessView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:510](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L510)

###### byCharacter()

```ts
byCharacter(character, options?): Promise<readonly CraftingProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingProcessView`](/reference/#craftingprocessview)[]\>

###### byProfile()

```ts
byProfile(profile, options?): Promise<readonly CraftingProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `profile` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingProcessView`](/reference/#craftingprocessview)[]\>

###### byStarbasePlayer()

```ts
byStarbasePlayer(player, options?): Promise<readonly CraftingProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `player` | [`Address`](/reference/#address-20) |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingProcessView`](/reference/#craftingprocessview)[]\>

###### get()

```ts
get(address, options?): Promise<CraftingProcessView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CraftingProcessView`](/reference/#craftingprocessview)\>

###### maybe()

```ts
maybe(address, options?): Promise<CraftingProcessView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`CraftingProcessView`](/reference/#craftingprocessview) \| `undefined`\>

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

##### factionMarkets

```ts
readonly factionMarkets: {
  forSystem: Promise<FactionMarketView>;
  get: Promise<FactionMarketView>;
  maybe: Promise<FactionMarketView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:546](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L546)

###### forSystem()

```ts
forSystem(
   system, 
   starbaseSequenceId, 
options?): Promise<FactionMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `starbaseSequenceId` | `bigint` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FactionMarketView`](/reference/#factionmarketview)\>

###### get()

```ts
get(address, options?): Promise<FactionMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FactionMarketView`](/reference/#factionmarketview)\>

###### maybe()

```ts
maybe(address, options?): Promise<FactionMarketView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FactionMarketView`](/reference/#factionmarketview) \| `undefined`\>

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

##### fleets

```ts
readonly fleets: {
  byOwner: Promise<readonly FleetView[]>;
  get: Promise<FleetView>;
  maybe: Promise<FleetView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:472](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L472)

###### byOwner()

```ts
byOwner(profileAddress, options?): Promise<readonly FleetView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `profileAddress` | [`Address`](/reference/#address-20) |
| `options?` | [`FleetDiscoveryOptions`](/reference/fleets/#fleetdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`FleetView`](/reference/#fleetview)[]\>

###### get()

```ts
get(address, options?): Promise<FleetView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetView`](/reference/#fleetview)\>

###### maybe()

```ts
maybe(address, options?): Promise<FleetView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetView`](/reference/#fleetview) \| `undefined`\>

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

##### localMarkets

```ts
readonly localMarkets: {
  bySystem: Promise<readonly LocalMarketView[]>;
  forCargo: Promise<LocalMarketView>;
  get: Promise<LocalMarketView>;
  maybe: Promise<LocalMarketView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:529](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L529)

###### bySystem()

```ts
bySystem(system, options?): Promise<readonly LocalMarketView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`MarketDiscoveryOptions`](/reference/markets/#marketdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`LocalMarketView`](/reference/#localmarketview)[]\>

###### forCargo()

```ts
forCargo(
   system, 
   cargoId, 
   starbaseSequenceId, 
options?): Promise<LocalMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `cargoId` | `number` |
| `starbaseSequenceId` | `bigint` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`LocalMarketView`](/reference/#localmarketview)\>

###### get()

```ts
get(address, options?): Promise<LocalMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`LocalMarketView`](/reference/#localmarketview)\>

###### maybe()

```ts
maybe(address, options?): Promise<LocalMarketView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`LocalMarketView`](/reference/#localmarketview) \| `undefined`\>

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

##### mining

```ts
readonly mining: {
  deposits: {
     get: Promise<ResourceDepositView>;
     maybe: Promise<ResourceDepositView | undefined>;
  };
  fleets: {
     byOwner: Promise<readonly FleetMiningView[]>;
     get: Promise<FleetMiningView | undefined>;
  };
};
```

Defined in: [packages/sage/src/index.ts:558](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L558)

###### deposits

```ts
readonly deposits: {
  get: Promise<ResourceDepositView>;
  maybe: Promise<ResourceDepositView | undefined>;
};
```

###### deposits.get()

```ts
get(asteroid, options?): Promise<ResourceDepositView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `asteroid` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ResourceDepositView`](/reference/#resourcedepositview)\>

###### deposits.maybe()

```ts
maybe(asteroid, options?): Promise<ResourceDepositView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `asteroid` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ResourceDepositView`](/reference/#resourcedepositview) \| `undefined`\>

###### fleets

```ts
readonly fleets: {
  byOwner: Promise<readonly FleetMiningView[]>;
  get: Promise<FleetMiningView | undefined>;
};
```

###### fleets.byOwner()

```ts
byOwner(owner, options?): Promise<readonly FleetMiningView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `owner` | [`Address`](/reference/#address-20) |
| `options?` | [`MiningDiscoveryOptions`](/reference/mining/#miningdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`FleetMiningView`](/reference/#fleetminingview)[]\>

###### fleets.get()

```ts
get(fleet, options?): Promise<FleetMiningView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `fleet` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FleetMiningView`](/reference/#fleetminingview) \| `undefined`\>

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

##### profiles

```ts
readonly profiles: {
  get: Promise<ProfileView>;
  maybe: Promise<ProfileView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:459](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L459)

###### get()

```ts
get(address, options?): Promise<ProfileView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ProfileView`](/reference/#profileview)\>

###### maybe()

```ts
maybe(address, options?): Promise<ProfileView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`ProfileView`](/reference/#profileview) \| `undefined`\>

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

##### recipes

```ts
readonly recipes: {
  byId: Promise<RecipeView>;
  get: Promise<RecipeView>;
  maybe: Promise<RecipeView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:483](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L483)

###### byId()

```ts
byId(recipeId, options?): Promise<RecipeView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recipeId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`RecipeView`](/reference/#recipeview)\>

###### get()

```ts
get(address, options?): Promise<RecipeView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`RecipeView`](/reference/#recipeview)\>

###### maybe()

```ts
maybe(address, options?): Promise<RecipeView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`RecipeView`](/reference/#recipeview) \| `undefined`\>

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

##### starbases

```ts
readonly starbases: {
  byCharacter: Promise<readonly StarbasePlayerView[]>;
  bySystem: Promise<readonly StarbasePlayerView[]>;
  forCharacterAtSystem: Promise<StarbasePlayerView>;
  get: Promise<StarbasePlayerView>;
  maybe: Promise<StarbasePlayerView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:595](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L595)

###### byCharacter()

```ts
byCharacter(character, options?): Promise<readonly StarbasePlayerView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbasePlayerView`](/reference/#starbaseplayerview)[]\>

###### bySystem()

```ts
bySystem(system, options?): Promise<readonly StarbasePlayerView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbasePlayerView`](/reference/#starbaseplayerview)[]\>

###### forCharacterAtSystem()

```ts
forCharacterAtSystem(
   character, 
   system, 
options?): Promise<StarbasePlayerView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbasePlayerView`](/reference/#starbaseplayerview)\>

###### get()

```ts
get(address, options?): Promise<StarbasePlayerView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbasePlayerView`](/reference/#starbaseplayerview)\>

###### maybe()

```ts
maybe(address, options?): Promise<StarbasePlayerView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbasePlayerView`](/reference/#starbaseplayerview) \| `undefined`\>

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

##### starbaseUpgrades

```ts
readonly starbaseUpgrades: {
  byPlayer: Promise<readonly StarbaseUpgradeProcessView[]>;
  get: Promise<StarbaseUpgradeProcessView>;
  maybe: Promise<
     | StarbaseUpgradeProcessView
    | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:615](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L615)

###### byPlayer()

```ts
byPlayer(player, options?): Promise<readonly StarbaseUpgradeProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `player` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbaseUpgradeProcessView`](/reference/#starbaseupgradeprocessview)[]\>

###### get()

```ts
get(address, options?): Promise<StarbaseUpgradeProcessView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbaseUpgradeProcessView`](/reference/#starbaseupgradeprocessview)\>

###### maybe()

```ts
maybe(address, options?): Promise<
  | StarbaseUpgradeProcessView
| undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<
  \| [`StarbaseUpgradeProcessView`](/reference/#starbaseupgradeprocessview)
  \| `undefined`\>

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

##### systems

```ts
readonly systems: {
  all: Promise<readonly StarSystemView[]>;
  byId: Promise<StarSystemView>;
  get: Promise<StarSystemView>;
  maybe: Promise<StarSystemView | undefined>;
};
```

Defined in: [packages/sage/src/index.ts:629](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L629)

###### all()

```ts
all(options?): Promise<readonly StarSystemView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`StarSystemDiscoveryOptions`](/reference/world/#starsystemdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarSystemView`](/reference/#starsystemview)[]\>

###### byId()

```ts
byId(systemId, options?): Promise<StarSystemView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `systemId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview)\>

###### get()

```ts
get(address, options?): Promise<StarSystemView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview)\>

###### maybe()

```ts
maybe(address, options?): Promise<StarSystemView | undefined>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarSystemView`](/reference/#starsystemview) \| `undefined`\>

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

##### wallets

```ts
readonly wallets: {
  get: WalletView;
};
```

Defined in: [packages/sage/src/index.ts:456](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L456)

###### get()

```ts
get(address): WalletView;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `address` | [`Address`](/reference/#address-20) |

###### Returns

[`WalletView`](/reference/#walletview)

#### Methods

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

##### dispose()

```ts
dispose(): Promise<void>;
```

Defined in: [packages/sage/src/index.ts:658](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L658)

###### Returns

`Promise`\<`void`\>

***

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

### SageContext

Defined in: [packages/sage/src/client/contracts.ts:693](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L693)

Immutable context passed as the first argument to every domain function.

Disposing the context releases its cache and in-flight read registries.

#### Example

```ts
declare const rpc: SageRpc;
const ctx: SageContext = createSageContext({ cluster: 'zink-ptr', rpc });
```

#### Properties

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

##### cluster

```ts
readonly cluster: ClusterIdentity;
```

Defined in: [packages/sage/src/client/contracts.ts:694](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L694)

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

##### data

```ts
readonly data: SageDataPort;
```

Defined in: [packages/sage/src/client/contracts.ts:696](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L696)

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

##### game?

```ts
readonly optional game?: Address;
```

Defined in: [packages/sage/src/client/contracts.ts:695](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L695)

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

##### registrySnapshotStore?

```ts
readonly optional registrySnapshotStore?: RegistrySnapshotStore;
```

Defined in: [packages/sage/src/client/contracts.ts:697](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L697)

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

##### writeRpc?

```ts
readonly optional writeRpc?: Rpc<GetBlockHeightApi & GetLatestBlockhashApi & SimulateTransactionApi & SendTransactionApi & GetSignatureStatusesApi>;
```

Defined in: [packages/sage/src/client/contracts.ts:698](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L698)

#### Methods

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

##### dispose()

```ts
dispose(): Promise<void>;
```

Defined in: [packages/sage/src/client/contracts.ts:699](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L699)

###### Returns

`Promise`\<`void`\>

***

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

### SageSubscription

Defined in: [packages/sage/src/client/contracts.ts:606](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L606)

Consumer handle for one context-owned subscription.

Unsubscription is asynchronous, idempotent, and automatically performed by
`SageContext.dispose()`. Teardown does not wait for an observer callback that
is already running, so that callback may finish after teardown resolves.

#### Example

```ts
declare const subscription: SageSubscription;
await subscription.unsubscribe();
```

#### Methods

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

##### unsubscribe()

```ts
unsubscribe(): Promise<void>;
```

Defined in: [packages/sage/src/client/contracts.ts:607](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L607)

###### Returns

`Promise`\<`void`\>

***

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

### ShipDefinitionSummary

Defined in: [packages/sage/src/registry/index.ts:79](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L79)

One immutable ship configuration from the loaded Game ships section.
Stats describe this configuration, not a Fleet's effective stats.
The sequence labels the resolved section; it does not prove chain freshness.

#### Example

```ts
declare const ctx: SageContext;
const ship: ShipDefinitionSummary = await resolveShip(ctx, 3);
const miningRate = ship.stats.cargo.miningRate;
const cargoCapacity = ship.stats.cargo.cargoCapacity;
const fuelCapacity = ship.stats.cargo.fuelCapacity;
```

#### Extended by

- [`StarbaseShipRespawn`](/reference/starbases/#starbaseshiprespawn)
- [`StarbaseEscrowedShip`](/reference/starbases/#starbaseescrowedship)

#### Properties

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

##### definitionSequenceId

```ts
readonly definitionSequenceId: number;
```

Defined in: [packages/sage/src/registry/index.ts:81](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L81)

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

##### id

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

Defined in: [packages/sage/src/registry/index.ts:82](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L82)

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

##### mint

```ts
readonly mint: Address;
```

Defined in: [packages/sage/src/registry/index.ts:83](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L83)

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/registry/index.ts:84](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L84)

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

##### sizeClass

```ts
readonly sizeClass: 
  | "xx-small"
  | "x-small"
  | "small"
  | "medium"
  | "large"
  | "capital"
  | "commander"
  | "titan";
```

Defined in: [packages/sage/src/registry/index.ts:85](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L85)

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

##### stats

```ts
readonly stats: FleetStatsData;
```

Defined in: [packages/sage/src/registry/index.ts:80](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L80)

***

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

### StarbasePlayerView

Defined in: [packages/sage/src/index.ts:289](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L289)

A loaded player-local Starbase with root-only upgrade traversal.

#### Example

```ts
declare const starbase: StarbasePlayerView;
const upgrades = await starbase.upgrades.all();
const craftingHabs = await starbase.craftingHabs.all();
const craftingProcesses = await starbase.craftingProcesses.all();
```

#### Extends

- [`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/starbases/index.ts:120](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L120)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`address`](/reference/starbases/#starbaseplayersnapshot)

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

##### availableCrew

```ts
readonly availableCrew: number;
```

Defined in: [packages/sage/src/starbases/index.ts:124](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L124)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`availableCrew`](/reference/starbases/#starbaseplayersnapshot)

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

##### bump

```ts
readonly bump: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:202](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L202)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`bump`](/reference/starbases/#starbaseplayeraccountdata)

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

##### busyCrew

```ts
readonly busyCrew: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:192](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L192)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`busyCrew`](/reference/starbases/#starbaseplayeraccountdata)

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

##### cargo

```ts
readonly cargo: StarbaseCargoInventory;
```

Defined in: [packages/sage/src/starbases/index.ts:125](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L125)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`cargo`](/reference/starbases/#starbaseplayersnapshot)

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

##### cargoRespawnEndsAtUnixSeconds

```ts
readonly cargoRespawnEndsAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:201](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L201)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`cargoRespawnEndsAtUnixSeconds`](/reference/starbases/#starbaseplayeraccountdata)

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

##### character

```ts
readonly character: EntityRef<"character">;
```

Defined in: [packages/sage/src/starbases/index.ts:123](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L123)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`character`](/reference/starbases/#starbaseplayersnapshot)

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

##### craftingHabs

```ts
readonly craftingHabs: {
  all: Promise<readonly CraftingHabView[]>;
};
```

Defined in: [packages/sage/src/index.ts:290](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L290)

###### all()

```ts
all(options?): Promise<readonly CraftingHabView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingHabView`](/reference/#craftinghabview)[]\>

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

##### craftingProcesses

```ts
readonly craftingProcesses: {
  all: Promise<readonly CraftingProcessView[]>;
};
```

Defined in: [packages/sage/src/index.ts:295](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L295)

###### all()

```ts
all(options?): Promise<readonly CraftingProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CraftingDiscoveryOptions`](/reference/crafting/#craftingdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`CraftingProcessView`](/reference/#craftingprocessview)[]\>

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

##### faction

```ts
readonly faction: StarbasePlayerFaction;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:188](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L188)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`faction`](/reference/starbases/#starbaseplayeraccountdata)

<a id="kind-15"></a>

##### kind

```ts
readonly kind: "starbasePlayer";
```

Defined in: [packages/sage/src/starbases/index.ts:119](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L119)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`kind`](/reference/starbases/#starbaseplayersnapshot)

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

##### playerProfile

```ts
readonly playerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/starbases/index.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L121)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`playerProfile`](/reference/starbases/#starbaseplayersnapshot)

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

##### respawning

```ts
readonly respawning: Omit<{
  cargo: StarbaseCargoPodData;
  claimStakes: readonly StarbaseFacilityRespawnData[];
  craftingHabs: readonly StarbaseFacilityRespawnData[];
  crew: StarbaseRespawnQueueData;
  ships: readonly StarbaseShipRespawnData[];
}, "ships" | "cargo"> & {
  cargo: StarbaseCargoInventory;
  ships: readonly StarbaseShipRespawn[];
};
```

Defined in: [packages/sage/src/starbases/index.ts:126](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L126)

###### Type Declaration

###### cargo

```ts
readonly cargo: StarbaseCargoInventory;
```

###### ships

```ts
readonly ships: readonly StarbaseShipRespawn[];
```

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`respawning`](/reference/starbases/#starbaseplayersnapshot)

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

##### sequenceId

```ts
readonly sequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:200](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L200)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`sequenceId`](/reference/starbases/#starbaseplayeraccountdata)

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

##### shipsInEscrow

```ts
readonly shipsInEscrow: readonly StarbaseEscrowedShip[];
```

Defined in: [packages/sage/src/starbases/index.ts:133](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L133)

###### Inherited from

[`StarbasePlayerView`](/reference/#starbaseplayerview).[`shipsInEscrow`](/reference/#starbaseplayerview)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/starbases/index.ts:122](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L122)

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`system`](/reference/starbases/#starbaseplayersnapshot)

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

##### totalCrew

```ts
readonly totalCrew: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:191](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L191)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`totalCrew`](/reference/starbases/#starbaseplayeraccountdata)

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

##### upgrades

```ts
readonly upgrades: {
  all: Promise<readonly StarbaseUpgradeProcessView[]>;
};
```

Defined in: [packages/sage/src/index.ts:300](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L300)

###### all()

```ts
all(options?): Promise<readonly StarbaseUpgradeProcessView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbaseUpgradeProcessView`](/reference/#starbaseupgradeprocessview)[]\>

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:186](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L186)

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`version`](/reference/starbases/#starbaseplayeraccountdata)

#### Methods

<a id="tojson-16"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/starbases/index.ts:134](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L134)

###### Returns

`unknown`

###### Inherited from

[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot).[`toJSON`](/reference/starbases/#starbaseplayersnapshot)

***

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

### StarbaseUpgradeProcessView

Defined in: [packages/sage/src/index.ts:314](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L314)

A loaded Starbase upgrade process exposed by the root client.

#### Example

```ts
declare const upgrade: StarbaseUpgradeProcessView;
console.log(upgrade.resource.name);
```

#### Extends

- [`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/starbases/index.ts:149](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L149)

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`address`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### endsAtUnixSeconds

```ts
readonly endsAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:224](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L224)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`endsAtUnixSeconds`](/reference/starbases/#starbaseupgradeprocessaccountdata)

<a id="kind-16"></a>

##### kind

```ts
readonly kind: "starbaseUpgradeProcess";
```

Defined in: [packages/sage/src/starbases/index.ts:148](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L148)

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`kind`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### numCrew

```ts
readonly numCrew: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:222](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L222)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`numCrew`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### playerProfile

```ts
readonly playerProfile: EntityRef<"profile">;
```

Defined in: [packages/sage/src/starbases/index.ts:150](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L150)

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`playerProfile`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### resource

```ts
readonly resource: CargoDefinitionSummary & {
  quantityRaw: bigint;
};
```

Defined in: [packages/sage/src/starbases/index.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L153)

###### Type Declaration

###### quantityRaw

```ts
readonly quantityRaw: bigint;
```

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`resource`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### starbasePlayer

```ts
readonly starbasePlayer: EntityRef<"starbasePlayer">;
```

Defined in: [packages/sage/src/starbases/index.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L151)

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`starbasePlayer`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### starbaseSequenceId

```ts
readonly starbaseSequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:219](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L219)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`starbaseSequenceId`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### startsAtUnixSeconds

```ts
readonly startsAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:223](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L223)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`startsAtUnixSeconds`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### system

```ts
readonly system: EntityRef<"starSystem">;
```

Defined in: [packages/sage/src/starbases/index.ts:152](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L152)

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`system`](/reference/starbases/#starbaseupgradeprocesssnapshot)

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

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/starbase.ts:215](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L215)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`version`](/reference/starbases/#starbaseupgradeprocessaccountdata)

#### Methods

<a id="tojson-17"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/starbases/index.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L154)

###### Returns

`unknown`

###### Inherited from

[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot).[`toJSON`](/reference/starbases/#starbaseupgradeprocesssnapshot)

***

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

### StarSystemView

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

A loaded StarSystem with explicit body projection relation accessors.

#### Example

```ts
declare const system: StarSystemView;
const planets = await system.planets.all();
```

#### Extends

- [`StarSystemSnapshot`](/reference/world/#starsystemsnapshot)

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/world/index.ts:82](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L82)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`address`](/reference/world/#starsystemsnapshot)

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

##### asteroids

```ts
readonly asteroids: {
  all: Promise<readonly AsteroidView[]>;
};
```

Defined in: [packages/sage/src/index.ts:414](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L414)

###### all()

```ts
all(options?): Promise<readonly AsteroidView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<readonly [`AsteroidView`](/reference/#asteroidview)[]\>

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

##### celestialBodies

```ts
readonly celestialBodies: {
  all: Promise<readonly CelestialBodyView[]>;
};
```

Defined in: [packages/sage/src/index.ts:408](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L408)

###### all()

```ts
all(options?): Promise<readonly CelestialBodyView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<readonly [`CelestialBodyView`](/reference/#celestialbodyview)[]\>

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

##### celestialBodyAddresses

```ts
readonly celestialBodyAddresses: readonly Address[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:317](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L317)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`celestialBodyAddresses`](/reference/world/#starsystemsnapshot)

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

##### connections

```ts
readonly connections: readonly WorldConnectionData[];
```

Defined in: [packages/sage/src/internal/c4/world.ts:316](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L316)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`connections`](/reference/world/#starsystemsnapshot)

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

##### coordinates

```ts
readonly coordinates: WorldCoordinates;
```

Defined in: [packages/sage/src/internal/c4/world.ts:314](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L314)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`coordinates`](/reference/world/#starsystemsnapshot)

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

##### factionMarket

```ts
readonly factionMarket: {
  get: Promise<FactionMarketView>;
};
```

Defined in: [packages/sage/src/index.ts:405](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L405)

###### get()

```ts
get(options?): Promise<FactionMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`FactionMarketView`](/reference/#factionmarketview)\>

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

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/world.ts:310](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L310)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`game`](/reference/world/#starsystemsnapshot)

<a id="kind-17"></a>

##### kind

```ts
readonly kind: "starSystem";
```

Defined in: [packages/sage/src/world/index.ts:81](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L81)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`kind`](/reference/world/#starsystemsnapshot)

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

##### localMarkets

```ts
readonly localMarkets: {
  all: Promise<readonly LocalMarketView[]>;
  forCargo: Promise<LocalMarketView>;
};
```

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

###### all()

```ts
all(options?): Promise<readonly LocalMarketView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`MarketDiscoveryOptions`](/reference/markets/#marketdiscoveryoptions) |

###### Returns

`Promise`\<readonly [`LocalMarketView`](/reference/#localmarketview)[]\>

###### forCargo()

```ts
forCargo(cargoId, options?): Promise<LocalMarketView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `cargoId` | `number` |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`LocalMarketView`](/reference/#localmarketview)\>

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

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/internal/c4/world.ts:312](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L312)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`name`](/reference/world/#starsystemsnapshot)

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

##### planets

```ts
readonly planets: {
  all: Promise<readonly PlanetView[]>;
};
```

Defined in: [packages/sage/src/index.ts:411](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L411)

###### all()

```ts
all(options?): Promise<readonly PlanetView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<readonly [`PlanetView`](/reference/#planetview)[]\>

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

##### playerStarbases

```ts
readonly playerStarbases: {
  all: Promise<readonly StarbasePlayerView[]>;
  forCharacter: Promise<StarbasePlayerView>;
};
```

Defined in: [packages/sage/src/index.ts:417](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L417)

###### all()

```ts
all(options?): Promise<readonly StarbasePlayerView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

###### Returns

`Promise`\<readonly [`StarbasePlayerView`](/reference/#starbaseplayerview)[]\>

###### forCharacter()

```ts
forCharacter(character, options?): Promise<StarbasePlayerView>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

###### Returns

`Promise`\<[`StarbasePlayerView`](/reference/#starbaseplayerview)\>

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

##### regionId?

```ts
readonly optional regionId?: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:313](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L313)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`regionId`](/reference/world/#starsystemsnapshot)

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

##### sequenceId

```ts
readonly sequenceId: bigint;
```

Defined in: [packages/sage/src/internal/c4/world.ts:315](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L315)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`sequenceId`](/reference/world/#starsystemsnapshot)

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

##### starbase?

```ts
readonly optional starbase?: WorldStarbaseData;
```

Defined in: [packages/sage/src/internal/c4/world.ts:318](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L318)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`starbase`](/reference/world/#starsystemsnapshot)

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

##### systemId

```ts
readonly systemId: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:311](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L311)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`systemId`](/reference/world/#starsystemsnapshot)

<a id="version-13"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/world.ts:309](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/world.ts#L309)

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`version`](/reference/world/#starsystemsnapshot)

#### Methods

<a id="tojson-18"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/world/index.ts:83](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/world/index.ts#L83)

###### Returns

`unknown`

###### Inherited from

[`StarSystemSnapshot`](/reference/world/#starsystemsnapshot).[`toJSON`](/reference/world/#starsystemsnapshot)

***

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

### SubscriptionObserver

Defined in: [packages/sage/src/client/contracts.ts:544](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L544)

Observer for validated snapshots and recoverable subscription errors.

Malformed account events call `onError` without replacing the last valid
cache entry or ending the subscription.

#### Example

```ts
const observer: SubscriptionObserver<{ name: string }> = {
  onSnapshot: snapshot => console.log(snapshot.data.name),
  onError: error => console.error(error),
};
```

#### Type Parameters

| Type Parameter |
| ------ |
| `TSnapshot` |

#### Properties

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

##### onDiagnostic?

```ts
readonly optional onDiagnostic?: (event) => void;
```

Defined in: [packages/sage/src/client/contracts.ts:550](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L550)

Observes bounded-delivery coalescing without treating it as an error.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | [`SubscriptionDiagnosticEvent`](/reference/#subscriptiondiagnosticevent) |

###### Returns

`void`

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

##### onError

```ts
readonly onError: (error) => void | Promise<void>;
```

Defined in: [packages/sage/src/client/contracts.ts:548](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L548)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | [`SageSdkError`](/reference/client/#sagesdkerror) |

###### Returns

`void` \| `Promise`\<`void`\>

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

##### onSnapshot

```ts
readonly onSnapshot: (snapshot) => void | Promise<void>;
```

Defined in: [packages/sage/src/client/contracts.ts:545](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L545)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `snapshot` | [`SnapshotEnvelope`](/reference/client/#snapshotenvelope)\<`TSnapshot`\> |

###### Returns

`void` \| `Promise`\<`void`\>

***

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

### WalletView

Defined in: [packages/sage/src/index.ts:140](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L140)

A wallet actor with explicit Profile and Character discovery relations.

Wallet views contain no signing capability and perform no I/O until a
relation is requested with either a provider or known-address strategy.

#### Example

```ts
declare const sage: SageClient;
declare const walletAddress: Address;
const wallet: WalletView = sage.wallets.get(walletAddress);
const profiles = await wallet.profiles.all({ strategy: 'provider' });
```

#### Properties

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

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/index.ts:142](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L142)

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

##### characters

```ts
readonly characters: {
  all: Promise<readonly CharacterView[]>;
};
```

Defined in: [packages/sage/src/index.ts:148](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L148)

###### all()

```ts
all(options): Promise<readonly CharacterView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`WalletProfileDiscoveryOptions`](/reference/identity/#walletprofilediscoveryoptions) |

###### Returns

`Promise`\<readonly [`CharacterView`](/reference/#characterview)[]\>

<a id="kind-18"></a>

##### kind

```ts
readonly kind: "wallet";
```

Defined in: [packages/sage/src/index.ts:141](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L141)

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

##### profiles

```ts
readonly profiles: {
  all: Promise<readonly ProfileView[]>;
};
```

Defined in: [packages/sage/src/index.ts:143](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L143)

###### all()

```ts
all(options): Promise<readonly ProfileView[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`WalletProfileDiscoveryOptions`](/reference/identity/#walletprofilediscoveryoptions) |

###### Returns

`Promise`\<readonly [`ProfileView`](/reference/#profileview)[]\>

#### Methods

<a id="tojson-19"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/index.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L153)

###### Returns

`unknown`

## Type Aliases

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

### AccountSubscriptionEvent

```ts
type AccountSubscriptionEvent = 
  | {
  account: RawAccount;
  kind: "account";
}
  | {
  kind: "reconnected";
};
```

Defined in: [packages/sage/src/client/contracts.ts:360](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L360)

A raw account update or a transport reconnection boundary.

Providers emit `reconnected` before post-reconnect account events so the
context can close the missed-update gap through its direct provider.

#### Example

```ts
declare const account: RawAccount;
const event: AccountSubscriptionEvent = { kind: 'account', account };
```

***

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

### Address

```ts
type Address = KitAddress;
```

Defined in: [packages/sage/src/client/contracts.ts:24](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L24)

A z.ink/Solana account address represented by `@solana/kit`.

#### Example

```ts
declare const profileAddress: Address;
```

***

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

### CelestialBodyView

```ts
type CelestialBodyView = 
  | PlanetView
  | AsteroidView;
```

Defined in: [packages/sage/src/index.ts:391](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L391)

A loaded CelestialBody root view projected as a Planet or Asteroid.

#### Example

```ts
declare const body: CelestialBodyView;
console.log(body.kind);
```

***

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

### DefinitionSection

```ts
type DefinitionSection = 
  | "ships"
  | "cargo"
  | "buildings"
  | "claimStakes"
  | "craftingHabs"
  | "habBuildings"
  | "xp"
  | "research";
```

Defined in: [packages/sage/src/registry/index.ts:56](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L56)

Definition sections implemented by the first registry slice.

#### Example

```ts
const section: DefinitionSection = 'ships';
```

***

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

### DefinitionSectionSnapshot

```ts
type DefinitionSectionSnapshot = 
  | { [S in PersistedDefinitionSection]: DefinitionSectionWire<S> }[PersistedDefinitionSection]
  | {
  definitions: readonly Omit<ShipDefinitionSummary, "definitionSequenceId" | "stats"> & {
     stats: ShipStatsJson;
  }[];
  game: Address;
  schemaVersion: 2;
  section: "ships";
  sequenceId: number;
}
  | {
  definitions: readonly CargoDefinitionSummary[];
  game: Address;
  schemaVersion: 1;
  section: "cargo";
  sequenceId: number;
};
```

Defined in: [packages/sage/src/registry/index.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L121)

Serializable cold-start snapshot for one Game definitions section.

#### Example

```ts
declare const store: RegistrySnapshotStore;
declare const snapshot: DefinitionSectionSnapshot;
await store.save(snapshot);
```

***

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

### PreloadedDefinitions

```ts
type PreloadedDefinitions = readonly DefinitionSection[] & {
  [PRELOADED_DEFINITIONS]: true;
};
```

Defined in: [packages/sage/src/internal/read-meta.ts:147](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L147)

The immutable section names satisfied by one preload call.

#### Type Declaration

##### \[PRELOADED\_DEFINITIONS\]

```ts
readonly [PRELOADED_DEFINITIONS]: true;
```

#### Example

```ts
import { preloadDefinitions } from '@aephia/atlas-kit';
declare const ctx: SageContext;
const sections: PreloadedDefinitions = await preloadDefinitions(ctx, ['cargo']);
```

***

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

### SageContextOptions

```ts
type SageContextOptions = 
  | SharedContextOptions & ContextTransport & {
  cluster: KnownCluster;
}
  | SharedContextOptions & ContextTransport & {
  cluster: CustomClusterIdentity;
  game: Address;
};
```

Defined in: [packages/sage/src/client/contracts.ts:743](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L743)

Configuration accepted by the synchronous context and client factories.

Custom clusters require an explicit canonical Game address.

#### Example

```ts
declare const rpc: SageRpc;
const options: SageContextOptions = { cluster: 'zink-ptr', rpc };
```

***

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

### SubscriptionDiagnosticEvent

```ts
type SubscriptionDiagnosticEvent = 
  | {
  accountType: EntityType;
  address: Address;
  coalescedCount: number;
  kind: "subscription-snapshot-coalesced";
}
  | {
  accountType: EntityType;
  address: Address;
  coalescedCount: number;
  errorCode: SageSdkError["code"];
  kind: "subscription-error-coalesced";
};
```

Defined in: [packages/sage/src/client/contracts.ts:570](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L570)

A bounded-delivery diagnostic emitted by one account subscription.

`coalescedCount` is cumulative for the currently pending observer delivery.
Coalescing is expected under burst traffic and is never reported to
`SubscriptionObserver.onError`.

#### Example

```ts
declare const address: Address;
const event: SubscriptionDiagnosticEvent = {
  kind: 'subscription-snapshot-coalesced',
  accountType: 'fleet',
  address,
  coalescedCount: 2,
};
```

***

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

### SubscriptionOptions

```ts
type SubscriptionOptions = ReadAccountOptions;
```

Defined in: [packages/sage/src/client/contracts.ts:592](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/client/contracts.ts#L592)

Options for one context-owned subscription.

#### Example

```ts
const options: SubscriptionOptions = { commitment: 'confirmed' };
```

## Functions

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

### createSageClient()

```ts
function createSageClient(options): SageClient;
```

Defined in: [packages/sage/src/index.ts:1113](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/index.ts#L1113)

Creates the root client synchronously without performing network I/O.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | [`SageContextOptions`](/reference/#sagecontextoptions) |

#### Returns

[`SageClient`](/reference/#sageclient)

#### Example

```ts
declare const rpc: SageRpc;
const sage = createSageClient({ cluster: 'zink-ptr', rpc });
```

***

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

### listCargoDefinitions()

```ts
function listCargoDefinitions(context): Promise<readonly CargoDefinitionSummary[]>;
```

Defined in: [packages/sage/src/registry/index.ts:1253](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L1253)

Lists all cargo definitions from the context's retained Game section.

The readonly array and its definitions are shared with by-id lookups for one
section generation. A refresh replaces the array and id map together; old
arrays remain immutable snapshots. Results have no guaranteed sorting order.
Loading is lazy and may use a compatible cargo schema-v1 stored snapshot.
The retained generation does not prove latest-chain freshness.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |

#### Returns

`Promise`\<readonly [`CargoDefinitionSummary`](/reference/#cargodefinitionsummary)[]\>

#### Example

```ts
declare const ctx: SageContext;
const definitions = await listCargoDefinitions(ctx);
for (const cargo of definitions) console.log(cargo.id, cargo.name);
```

***

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

### listShipConfigurations()

```ts
function listShipConfigurations(context): Promise<readonly ShipDefinitionSummary[]>;
```

Defined in: [packages/sage/src/registry/index.ts:1068](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L1068)

Lists every ship configuration in the context's loaded Game definitions section.

Entries and the readonly array are retained for the section generation. Each
entry is the same immutable object returned by `resolveShip`; loading either
route serves the other without another Game read. A section refresh replaces
the array and its entries together. Existing returned arrays remain immutable
snapshots of their prior generation.

`definitionSequenceId` identifies the loaded section, not proven-current chain
state. This enumerates existing configurations without grouping by model or
filling unallocated ids. The result has no guaranteed sorting order.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |

#### Returns

`Promise`\<readonly [`ShipDefinitionSummary`](/reference/#shipdefinitionsummary)[]\>

#### Example

```ts
declare const ctx: SageContext;
const configurations = await listShipConfigurations(ctx);
for (const ship of configurations) {
  console.log(ship.id, ship.name, ship.stats.cargo.cargoCapacity);
}
```

***

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

### listShipConfigurationsByMint()

```ts
function listShipConfigurationsByMint(context, mint): Promise<readonly ShipDefinitionSummary[]>;
```

Defined in: [packages/sage/src/registry/index.ts:1098](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L1098)

Lists current ship configurations associated with a mint in this context's Game.

Groups by each configuration's on-chain `mint`, never display names, id ranges,
or historical `mintToId` entries. Use a mint from the selected deployment;
this does not map production mints to PTR or provide make/model labels or a
default configuration. See `docs/research/ship-model-identity.md` (#395/#397).

The frozen result shares objects with `resolveShip` and `listShipConfigurations`.
A lazy index is retained with the ships section and replaced on section refresh;
building it adds no RPC calls or metadata fetches. Unknown mints return a retained
frozen empty array. Results have no guaranteed order or configuration count.
`definitionSequenceId` denotes the loaded generation, not proven-current state.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `mint` | [`Address`](/reference/#address-20) |

#### Returns

`Promise`\<readonly [`ShipDefinitionSummary`](/reference/#shipdefinitionsummary)[]\>

#### Example

```ts
declare const ctx: SageContext;
declare const shipMint: Address;
const configurations = await listShipConfigurationsByMint(ctx, shipMint);
for (const ship of configurations) {
  console.log(ship.id, ship.stats.cargo.cargoCapacity);
}
```

***

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

### preloadDefinitions()

```ts
function preloadDefinitions(
   context, 
   sections, 
options?): Promise<PreloadedDefinitions>;
```

Defined in: [packages/sage/src/registry/index.ts:922](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L922)

Warm selected definition catalogs, retaining each section's own observation.
Already usable sections are reused; this is not a freshness refresh.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `sections` | readonly [`DefinitionSection`](/reference/#definitionsection)[] |
| `options` | \{ `signal?`: `AbortSignal`; \} |
| `options.signal?` | `AbortSignal` |

#### Returns

`Promise`\<[`PreloadedDefinitions`](/reference/#preloadeddefinitions)\>

#### Example

```ts
declare const ctx: SageContext;
const loaded = await preloadDefinitions(ctx, ['ships', 'claimStakes']);
const provenance = readMeta(loaded);
```

***

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

### readMeta()

```ts
function readMeta<T>(result): 
  | unknown extends T ? 
  | ReadMeta
  | DefinitionPreloadMeta : T extends PreloadedDefinitions ? DefinitionPreloadMeta : PreloadedDefinitions extends T ? 
  | ReadMeta
  | DefinitionPreloadMeta : ReadMeta
  | undefined;
```

Defined in: [packages/sage/src/internal/read-meta.ts:99](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/read-meta.ts#L99)

Returns finder provenance without wrapping the finder result.

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* `object` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `result` | `T` |

#### Returns

  \| `unknown` *extends* `T` ? 
  \| [`ReadMeta`](/reference/#readmeta)
  \| [`DefinitionPreloadMeta`](/reference/#definitionpreloadmeta) : `T` *extends* [`PreloadedDefinitions`](/reference/#preloadeddefinitions) ? [`DefinitionPreloadMeta`](/reference/#definitionpreloadmeta) : [`PreloadedDefinitions`](/reference/#preloadeddefinitions) *extends* `T` ? 
  \| [`ReadMeta`](/reference/#readmeta)
  \| [`DefinitionPreloadMeta`](/reference/#definitionpreloadmeta) : [`ReadMeta`](/reference/#readmeta)
  \| `undefined`

#### Example

```ts
declare const ctx: SageContext;
declare const profileAddress: Address;
const fleets = await getFleetsByOwner(ctx, profileAddress);
const meta = readMeta(fleets);
```

***

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

### resolveCargo()

```ts
function resolveCargo(
   context, 
   cargoId, 
options?): Promise<CargoDefinitionSummary>;
```

Defined in: [packages/sage/src/registry/index.ts:1126](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L1126)

Resolves one cargo id to an immutable SDK-owned definition summary.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `cargoId` | `number` |
| `options` | [`DefinitionLookupOptions`](/reference/#definitionlookupoptions) |

#### Returns

`Promise`\<[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary)\>

#### Example

```ts
declare const ctx: SageContext;
declare const cargoId: number;
declare const expectedSequenceId: number;
const cargo = await resolveCargo(ctx, cargoId, { expectedSequenceId });
```

***

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

### resolveShip()

```ts
function resolveShip(
   context, 
   shipId, 
options?): Promise<ShipDefinitionSummary>;
```

Defined in: [packages/sage/src/registry/index.ts:1039](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L1039)

Resolves one ship id to an immutable SDK-owned definition summary.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `shipId` | `number` |
| `options` | [`DefinitionLookupOptions`](/reference/#definitionlookupoptions) |

#### Returns

`Promise`\<[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary)\>

#### Example

```ts
declare const ctx: SageContext;
declare const fleet: { readonly shipId: number; readonly shipDefinitionsSeqId: number };
const ship = await resolveShip(ctx, fleet.shipId, { expectedSequenceId: fleet.shipDefinitionsSeqId });
```