# starbases
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/starbases/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

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

### StarbaseCargoAmountData

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

One unresolved cargo quantity.

#### Example

```ts
declare const amount: StarbaseCargoAmountData;
console.log(amount.cargoId, amount.amount);
```

#### Properties

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

##### amount

```ts
readonly amount: bigint;
```

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

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

##### cargoId

```ts
readonly cargoId: number;
```

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

***

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

### StarbaseCargoInventory

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

One resolved player-local Starbase CargoPod.

#### Example

```ts
declare const cargo: StarbaseCargoInventory;
console.log(cargo.items);
```

#### Properties

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

##### items

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

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

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

##### sequenceId

```ts
readonly sequenceId: number;
```

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

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

##### usedStorageUnitsRaw

```ts
readonly usedStorageUnitsRaw: bigint;
```

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

***

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

### StarbaseCargoItem

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

One resolved cargo quantity stored in a player-local Starbase CargoPod.

#### Example

```ts
declare const item: StarbaseCargoItem;
console.log(item.name, item.quantityRaw);
```

#### Extends

- [`CargoDefinitionSummary`](/reference/#cargodefinitionsummary)

#### Properties

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

##### categoryId

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

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

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`categoryId`](/reference/#cargodefinitionsummary)

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

##### id

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

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

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`id`](/reference/#cargodefinitionsummary)

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

##### mint

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

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

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`mint`](/reference/#cargodefinitionsummary)

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

##### name

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

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

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`name`](/reference/#cargodefinitionsummary)

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

##### quantityRaw

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

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

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

##### storageCost

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

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

Encoded storage cost with 8 fractional bits: 256 means one whole storage unit.
For a nonnegative bigint quantity, use `(quantity * BigInt(storageCost) + 255n) / 256n`.
Round each transfer row up before summing; Fleet capacities and pod usage are whole units.

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`storageCost`](/reference/#cargodefinitionsummary)

***

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

### StarbaseCargoPodData

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

One translated nested CargoPod before definition resolution.

#### Example

```ts
declare const cargo: StarbaseCargoPodData;
console.log(cargo.amounts);
```

#### Properties

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

##### amounts

```ts
readonly amounts: readonly StarbaseCargoAmountData[];
```

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

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

##### sequenceId

```ts
readonly sequenceId: number;
```

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

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

##### usedStorageUnitsRaw

```ts
readonly usedStorageUnitsRaw: bigint;
```

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

***

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

### StarbaseEscrowedShip

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

One resolved escrowed ship quantity.

#### Example

```ts
declare const ship: StarbaseEscrowedShip;
console.log(ship.name, ship.quantityRaw);
```

#### Extends

- [`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).`Omit`\<[`StarbaseEscrowedShipData`](/reference/starbases/#starbaseescrowedshipdata), `"shipId"`\>

#### Properties

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

##### definitionSequenceId

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`definitionSequenceId`](/reference/#shipdefinitionsummary)

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

##### id

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`id`](/reference/#shipdefinitionsummary)

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

##### mint

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`mint`](/reference/#shipdefinitionsummary)

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

##### name

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`name`](/reference/#shipdefinitionsummary)

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

##### quantityRaw

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

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

###### Inherited from

[`StarbaseEscrowedShipData`](/reference/starbases/#starbaseescrowedshipdata).[`quantityRaw`](/reference/starbases/#starbaseescrowedshipdata)

<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:99](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L99)

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`sizeClass`](/reference/#shipdefinitionsummary)

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

##### stats

```ts
readonly stats: FleetStatsData;
```

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`stats`](/reference/#shipdefinitionsummary)

***

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

### StarbaseEscrowedShipData

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

One unresolved escrowed ship quantity.

#### Example

```ts
declare const ship: StarbaseEscrowedShipData;
console.log(ship.shipId, ship.quantityRaw);
```

#### Properties

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

##### quantityRaw

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

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

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

##### shipId

```ts
readonly shipId: number;
```

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

***

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

### StarbaseFacilityRespawnData

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

One unresolved facility respawn queue.

#### Example

```ts
declare const queue: StarbaseFacilityRespawnData;
console.log(queue.definitionId);
```

#### Extends

- [`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata)

#### Properties

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

##### completesAtUnixSeconds

```ts
readonly completesAtUnixSeconds: bigint;
```

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`completesAtUnixSeconds`](/reference/starbases/#starbaserespawnqueuedata)

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

##### definitionId

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

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

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

##### quantityRaw

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

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`quantityRaw`](/reference/starbases/#starbaserespawnqueuedata)

***

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

### StarbasePlayerAccountData

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

Fully translated StarbasePlayer account data before registry joins.

#### Example

```ts
declare const data: StarbasePlayerAccountData;
console.log(data.character, data.respawning.craftingHabs);
```

#### Properties

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

##### bump

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

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

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

##### busyCrew

```ts
readonly busyCrew: number;
```

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

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

##### cargo

```ts
readonly cargo: StarbaseCargoPodData;
```

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

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

##### cargoRespawnEndsAtUnixSeconds

```ts
readonly cargoRespawnEndsAtUnixSeconds: bigint;
```

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

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

##### character

```ts
readonly character: Address;
```

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

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

##### faction

```ts
readonly faction: StarbasePlayerFaction;
```

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

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

##### playerProfile

```ts
readonly playerProfile: Address;
```

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

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

##### respawning

```ts
readonly respawning: {
  cargo: StarbaseCargoPodData;
  claimStakes: readonly StarbaseFacilityRespawnData[];
  craftingHabs: readonly StarbaseFacilityRespawnData[];
  crew: StarbaseRespawnQueueData;
  ships: readonly StarbaseShipRespawnData[];
};
```

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

###### cargo

```ts
readonly cargo: StarbaseCargoPodData;
```

###### claimStakes

```ts
readonly claimStakes: readonly StarbaseFacilityRespawnData[];
```

###### craftingHabs

```ts
readonly craftingHabs: readonly StarbaseFacilityRespawnData[];
```

###### crew

```ts
readonly crew: StarbaseRespawnQueueData;
```

###### ships

```ts
readonly ships: readonly StarbaseShipRespawnData[];
```

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

##### sequenceId

```ts
readonly sequenceId: bigint;
```

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

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

##### shipsInEscrow

```ts
readonly shipsInEscrow: readonly StarbaseEscrowedShipData[];
```

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

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

##### system

```ts
readonly system: Address;
```

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

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

##### totalCrew

```ts
readonly totalCrew: number;
```

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

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

##### version

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

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

***

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

### StarbasePlayerSnapshot

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

Immutable, translated player-local Starbase snapshot.

#### Example

```ts
declare const starbase: StarbasePlayerSnapshot;
console.log(starbase.availableCrew, starbase.cargo.items);
```

#### Extends

- `Omit`\<[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata), 
  \| `"cargo"`
  \| `"character"`
  \| `"playerProfile"`
  \| `"respawning"`
  \| `"shipsInEscrow"`
  \| `"system"`\>

#### Extended by

- [`StarbasePlayerView`](/reference/#starbaseplayerview)

#### Properties

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

##### address

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

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

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

##### availableCrew

```ts
readonly availableCrew: number;
```

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

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

##### bump

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

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`bump`](/reference/starbases/#starbaseplayeraccountdata)

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

##### busyCrew

```ts
readonly busyCrew: number;
```

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

###### 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:128](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L128)

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

##### cargoRespawnEndsAtUnixSeconds

```ts
readonly cargoRespawnEndsAtUnixSeconds: bigint;
```

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`cargoRespawnEndsAtUnixSeconds`](/reference/starbases/#starbaseplayeraccountdata)

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

##### character

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

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

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

##### faction

```ts
readonly faction: StarbasePlayerFaction;
```

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`faction`](/reference/starbases/#starbaseplayeraccountdata)

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

##### kind

```ts
readonly kind: "starbasePlayer";
```

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

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

##### playerProfile

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

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

<a id="respawning-1"></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:129](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/starbases/index.ts#L129)

###### Type Declaration

###### cargo

```ts
readonly cargo: StarbaseCargoInventory;
```

###### ships

```ts
readonly ships: readonly StarbaseShipRespawn[];
```

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

##### sequenceId

```ts
readonly sequenceId: bigint;
```

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`sequenceId`](/reference/starbases/#starbaseplayeraccountdata)

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

##### shipsInEscrow

```ts
readonly shipsInEscrow: readonly StarbaseEscrowedShip[];
```

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

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

##### system

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

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

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

##### totalCrew

```ts
readonly totalCrew: number;
```

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`totalCrew`](/reference/starbases/#starbaseplayeraccountdata)

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

##### version

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

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

###### Inherited from

[`StarbasePlayerAccountData`](/reference/starbases/#starbaseplayeraccountdata).[`version`](/reference/starbases/#starbaseplayeraccountdata)

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

***

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

### StarbaseRespawnQueueData

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

One translated respawn queue.

#### Example

```ts
declare const queue: StarbaseRespawnQueueData;
console.log(queue.quantityRaw);
```

#### Extended by

- [`StarbaseFacilityRespawnData`](/reference/starbases/#starbasefacilityrespawndata)
- [`StarbaseShipRespawnData`](/reference/starbases/#starbaseshiprespawndata)

#### Properties

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

##### completesAtUnixSeconds

```ts
readonly completesAtUnixSeconds: bigint;
```

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

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

##### quantityRaw

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

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

***

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

### StarbaseShipRespawn

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

One resolved ship respawn queue.

#### Example

```ts
declare const ship: StarbaseShipRespawn;
console.log(ship.name, ship.completesAtUnixSeconds);
```

#### Extends

- [`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).`Omit`\<[`StarbaseShipRespawnData`](/reference/starbases/#starbaseshiprespawndata), `"shipId"`\>

#### Properties

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

##### completesAtUnixSeconds

```ts
readonly completesAtUnixSeconds: bigint;
```

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`completesAtUnixSeconds`](/reference/starbases/#starbaserespawnqueuedata)

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

##### definitionSequenceId

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`definitionSequenceId`](/reference/#shipdefinitionsummary)

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

##### id

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`id`](/reference/#shipdefinitionsummary)

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

##### mint

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`mint`](/reference/#shipdefinitionsummary)

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

##### name

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

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`name`](/reference/#shipdefinitionsummary)

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

##### quantityRaw

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

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`quantityRaw`](/reference/starbases/#starbaserespawnqueuedata)

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

##### sizeClass

```ts
readonly sizeClass: 
  | "xx-small"
  | "x-small"
  | "small"
  | "medium"
  | "large"
  | "capital"
  | "commander"
  | "titan";
```

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`sizeClass`](/reference/#shipdefinitionsummary)

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

##### stats

```ts
readonly stats: FleetStatsData;
```

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

###### Inherited from

[`ShipDefinitionSummary`](/reference/#shipdefinitionsummary).[`stats`](/reference/#shipdefinitionsummary)

***

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

### StarbaseShipRespawnData

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

One unresolved ship respawn queue.

#### Example

```ts
declare const queue: StarbaseShipRespawnData;
console.log(queue.shipId);
```

#### Extends

- [`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata)

#### Properties

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

##### completesAtUnixSeconds

```ts
readonly completesAtUnixSeconds: bigint;
```

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`completesAtUnixSeconds`](/reference/starbases/#starbaserespawnqueuedata)

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

##### quantityRaw

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

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

###### Inherited from

[`StarbaseRespawnQueueData`](/reference/starbases/#starbaserespawnqueuedata).[`quantityRaw`](/reference/starbases/#starbaserespawnqueuedata)

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

##### shipId

```ts
readonly shipId: number;
```

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

***

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

### StarbaseUpgradeProcessAccountData

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

Fully translated StarbaseUpgradeProcess account data before registry joins.

#### Example

```ts
declare const data: StarbaseUpgradeProcessAccountData;
console.log(data.resourceId, data.quantityRaw);
```

#### Properties

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

##### endsAtUnixSeconds

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

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

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

##### numCrew

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

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

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

##### playerProfile

```ts
readonly playerProfile: Address;
```

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

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

##### quantityRaw

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

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

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

##### resourceId

```ts
readonly resourceId: number;
```

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

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

##### starbasePlayer

```ts
readonly starbasePlayer: Address;
```

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

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

##### starbaseSequenceId

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

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

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

##### startsAtUnixSeconds

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

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

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

##### system

```ts
readonly system: Address;
```

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

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

##### version

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

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

***

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

### StarbaseUpgradeProcessSnapshot

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

Immutable, translated Starbase upgrade-process snapshot.

#### Example

```ts
declare const upgrade: StarbaseUpgradeProcessSnapshot;
console.log(upgrade.resource.name, upgrade.endsAtUnixSeconds);
```

#### Extends

- `Omit`\<[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata), 
  \| `"playerProfile"`
  \| `"quantityRaw"`
  \| `"resourceId"`
  \| `"starbasePlayer"`
  \| `"system"`\>

#### Extended by

- [`StarbaseUpgradeProcessView`](/reference/#starbaseupgradeprocessview)

#### Properties

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

##### address

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

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

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

##### endsAtUnixSeconds

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

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

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`endsAtUnixSeconds`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### kind

```ts
readonly kind: "starbaseUpgradeProcess";
```

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

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

##### numCrew

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

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

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`numCrew`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### playerProfile

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

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

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

##### resource

```ts
readonly resource: CargoDefinitionSummary & {
  quantityRaw: bigint;
};
```

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

###### Type Declaration

###### quantityRaw

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

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

##### starbasePlayer

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

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

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

##### starbaseSequenceId

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

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

###### 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:173](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/starbase.ts#L173)

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`startsAtUnixSeconds`](/reference/starbases/#starbaseupgradeprocessaccountdata)

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

##### system

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

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

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

##### version

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

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

###### Inherited from

[`StarbaseUpgradeProcessAccountData`](/reference/starbases/#starbaseupgradeprocessaccountdata).[`version`](/reference/starbases/#starbaseupgradeprocessaccountdata)

#### Methods

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

##### toJSON()

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

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

###### Returns

`unknown`

## Type Aliases

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

### StarbaseDiscoveryOptions

```ts
type StarbaseDiscoveryOptions = Omit<DiscoveryRequest, "filters" | "strategy">;
```

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

Options supported by targeted player-local Starbase discovery.

#### Example

```ts
const options: StarbaseDiscoveryOptions = { commitment: 'confirmed' };
```

***

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

### StarbasePlayerFaction

```ts
type StarbasePlayerFaction = "unaligned" | "mud" | "oni" | "ustur";
```

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

Stable translated Starbase faction.

#### Example

```ts
const faction: StarbasePlayerFaction = 'mud';
```

## Functions

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

### getStarbasePlayer()

```ts
function getStarbasePlayer(
   context, 
   address, 
options?): Promise<StarbasePlayerSnapshot>;
```

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

Reads one required StarbasePlayer by address.

#### Parameters

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

#### Returns

`Promise`\<[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
declare const address: Address;
const starbase = await getStarbasePlayer(ctx, address);
```

***

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

### getStarbasePlayerForCharacterAtSystem()

```ts
function getStarbasePlayerForCharacterAtSystem(
   context, 
   character, 
   system, 
options?): Promise<StarbasePlayerSnapshot>;
```

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

Derives and reads StarbasePlayer for one Character at one Star System.

#### Parameters

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

#### Returns

`Promise`\<[`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
declare const character: Address;
declare const system: Address;
const starbase = await getStarbasePlayerForCharacterAtSystem(ctx, character, system);
```

***

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

### getStarbasePlayersByCharacter()

```ts
function getStarbasePlayersByCharacter(
   context, 
   character, 
options?): Promise<readonly StarbasePlayerSnapshot[]>;
```

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

Discovers player-local Starbases for one Character.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

#### Returns

`Promise`\<readonly [`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)[]\>

#### Example

```ts
declare const ctx: SageContext;
declare const character: Address;
const starbases = await getStarbasePlayersByCharacter(ctx, character);
```

***

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

### getStarbasePlayersBySystem()

```ts
function getStarbasePlayersBySystem(
   context, 
   system, 
options?): Promise<readonly StarbasePlayerSnapshot[]>;
```

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

Discovers player-local Starbases in one Star System.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `system` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

#### Returns

`Promise`\<readonly [`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)[]\>

#### Example

```ts
declare const ctx: SageContext;
declare const system: Address;
const starbases = await getStarbasePlayersBySystem(ctx, system);
```

***

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

### getStarbaseUpgradeProcess()

```ts
function getStarbaseUpgradeProcess(
   context, 
   address, 
options?): Promise<StarbaseUpgradeProcessSnapshot>;
```

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

Reads one required StarbaseUpgradeProcess by its signer-created address.

#### Parameters

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

#### Returns

`Promise`\<[`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot)\>

#### Example

```ts
declare const ctx: SageContext;
declare const address: Address;
const upgrade = await getStarbaseUpgradeProcess(ctx, address);
```

***

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

### getStarbaseUpgradeProcessesByPlayer()

```ts
function getStarbaseUpgradeProcessesByPlayer(
   context, 
   player, 
options?): Promise<readonly StarbaseUpgradeProcessSnapshot[]>;
```

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

Discovers Starbase upgrade processes stored against one StarbasePlayer.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `player` | [`Address`](/reference/#address-20) |
| `options?` | [`StarbaseDiscoveryOptions`](/reference/starbases/#starbasediscoveryoptions) |

#### Returns

`Promise`\<readonly [`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot)[]\>

#### Example

```ts
declare const ctx: SageContext;
declare const player: Address;
const upgrades = await getStarbaseUpgradeProcessesByPlayer(ctx, player);
```

***

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

### maybeGetStarbasePlayer()

```ts
function maybeGetStarbasePlayer(
   context, 
   address, 
   options?): Promise<
  | StarbasePlayerSnapshot
| undefined>;
```

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

Reads one optional StarbasePlayer by address.

#### Parameters

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

#### Returns

`Promise`\<
  \| [`StarbasePlayerSnapshot`](/reference/starbases/#starbaseplayersnapshot)
  \| `undefined`\>

#### Example

```ts
declare const ctx: SageContext;
declare const address: Address;
const starbase = await maybeGetStarbasePlayer(ctx, address);
```

***

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

### maybeGetStarbaseUpgradeProcess()

```ts
function maybeGetStarbaseUpgradeProcess(
   context, 
   address, 
   options?): Promise<
  | StarbaseUpgradeProcessSnapshot
| undefined>;
```

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

Reads one optional StarbaseUpgradeProcess by address.

#### Parameters

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

#### Returns

`Promise`\<
  \| [`StarbaseUpgradeProcessSnapshot`](/reference/starbases/#starbaseupgradeprocesssnapshot)
  \| `undefined`\>

#### Example

```ts
declare const ctx: SageContext;
declare const address: Address;
const upgrade = await maybeGetStarbaseUpgradeProcess(ctx, address);
```