starbases

Interfaces

StarbaseCargoAmountData

Defined in: packages/sage/src/internal/c4/starbase.ts:98

One unresolved cargo quantity.

Example

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

Properties

amount

readonly amount: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:100

cargoId

readonly cargoId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:99

---

StarbaseCargoInventory

Defined in: packages/sage/src/starbases/index.ts:80

One resolved player-local Starbase CargoPod.

Example

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

Properties

items

readonly items: readonly StarbaseCargoItem[];

Defined in: packages/sage/src/starbases/index.ts:83

sequenceId

readonly sequenceId: number;

Defined in: packages/sage/src/starbases/index.ts:81

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

Defined in: packages/sage/src/starbases/index.ts:82

---

StarbaseCargoItem

Defined in: packages/sage/src/starbases/index.ts:69

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

Example

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

Extends

• CargoDefinitionSummary

Properties

categoryId

readonly categoryId: number;

Defined in: packages/sage/src/registry/index.ts:119

Inherited from

CargoDefinitionSummary.categoryId

id

readonly id: number;

Defined in: packages/sage/src/registry/index.ts:120

Inherited from

CargoDefinitionSummary.id

mint

readonly mint: Address;

Defined in: packages/sage/src/registry/index.ts:121

Inherited from

CargoDefinitionSummary.mint

name

readonly name: string;

Defined in: packages/sage/src/registry/index.ts:122

Inherited from

CargoDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/starbases/index.ts:70

storageCost

readonly storageCost: number;

Defined in: packages/sage/src/registry/index.ts:127

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

---

StarbaseCargoPodData

Defined in: packages/sage/src/internal/c4/starbase.ts:110

One translated nested CargoPod before definition resolution.

Example

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

Properties

amounts

readonly amounts: readonly StarbaseCargoAmountData[];

Defined in: packages/sage/src/internal/c4/starbase.ts:113

sequenceId

readonly sequenceId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:111

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:112

---

StarbaseEscrowedShip

Defined in: packages/sage/src/starbases/index.ts:103

One resolved escrowed ship quantity.

Example

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

Extends

• ShipDefinitionSummary.Omit<StarbaseEscrowedShipData, "shipId">

Properties

definitionSequenceId

readonly definitionSequenceId: number;

Defined in: packages/sage/src/registry/index.ts:95

Inherited from

ShipDefinitionSummary.definitionSequenceId

id

readonly id: number;

Defined in: packages/sage/src/registry/index.ts:96

Inherited from

ShipDefinitionSummary.id

mint

readonly mint: Address;

Defined in: packages/sage/src/registry/index.ts:97

Inherited from

ShipDefinitionSummary.mint

name

readonly name: string;

Defined in: packages/sage/src/registry/index.ts:98

Inherited from

ShipDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:125

Inherited from

StarbaseEscrowedShipData.quantityRaw

sizeClass

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

Defined in: packages/sage/src/registry/index.ts:99

Inherited from

ShipDefinitionSummary.sizeClass

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/registry/index.ts:94

Inherited from

ShipDefinitionSummary.stats

---

StarbaseEscrowedShipData

Defined in: packages/sage/src/internal/c4/starbase.ts:123

One unresolved escrowed ship quantity.

Example

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

Properties

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:125

shipId

readonly shipId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:124

---

StarbaseFacilityRespawnData

Defined in: packages/sage/src/internal/c4/starbase.ts:87

One unresolved facility respawn queue.

Example

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

Extends

• StarbaseRespawnQueueData

Properties

completesAtUnixSeconds

readonly completesAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:66

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

definitionId

readonly definitionId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:88

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:65

Inherited from

StarbaseRespawnQueueData.quantityRaw

---

StarbasePlayerAccountData

Defined in: packages/sage/src/internal/c4/starbase.ts:135

Fully translated StarbasePlayer account data before registry joins.

Example

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

Properties

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:152

busyCrew

readonly busyCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:142

cargo

readonly cargo: StarbaseCargoPodData;

Defined in: packages/sage/src/internal/c4/starbase.ts:154

cargoRespawnEndsAtUnixSeconds

readonly cargoRespawnEndsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:151

character

readonly character: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:140

faction

readonly faction: StarbasePlayerFaction;

Defined in: packages/sage/src/internal/c4/starbase.ts:138

playerProfile

readonly playerProfile: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:137

respawning

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

cargo

readonly cargo: StarbaseCargoPodData;

claimStakes

readonly claimStakes: readonly StarbaseFacilityRespawnData[];

craftingHabs

readonly craftingHabs: readonly StarbaseFacilityRespawnData[];

crew

readonly crew: StarbaseRespawnQueueData;

ships

readonly ships: readonly StarbaseShipRespawnData[];

sequenceId

readonly sequenceId: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:150

shipsInEscrow

readonly shipsInEscrow: readonly StarbaseEscrowedShipData[];

Defined in: packages/sage/src/internal/c4/starbase.ts:153

system

readonly system: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:139

totalCrew

readonly totalCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:141

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:136

---

StarbasePlayerSnapshot

Defined in: packages/sage/src/starbases/index.ts:113

Immutable, translated player-local Starbase snapshot.

Example

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

Extends

• Omit<StarbasePlayerAccountData, | "cargo" | "character" | "playerProfile" | "respawning" | "shipsInEscrow" | "system">

Extended by

• StarbasePlayerView

Properties

address

readonly address: Address;

Defined in: packages/sage/src/starbases/index.ts:123

availableCrew

readonly availableCrew: number;

Defined in: packages/sage/src/starbases/index.ts:127

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:152

Inherited from

StarbasePlayerAccountData.bump

busyCrew

readonly busyCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:142

Inherited from

StarbasePlayerAccountData.busyCrew

cargo

readonly cargo: StarbaseCargoInventory;

Defined in: packages/sage/src/starbases/index.ts:128

cargoRespawnEndsAtUnixSeconds

readonly cargoRespawnEndsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:151

Inherited from

StarbasePlayerAccountData.cargoRespawnEndsAtUnixSeconds

character

readonly character: EntityRef<"character">;

Defined in: packages/sage/src/starbases/index.ts:126

faction

readonly faction: StarbasePlayerFaction;

Defined in: packages/sage/src/internal/c4/starbase.ts:138

Inherited from

StarbasePlayerAccountData.faction

kind

readonly kind: "starbasePlayer";

Defined in: packages/sage/src/starbases/index.ts:122

playerProfile

readonly playerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/starbases/index.ts:124

respawning

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

Type Declaration

cargo

readonly cargo: StarbaseCargoInventory;

ships

readonly ships: readonly StarbaseShipRespawn[];

sequenceId

readonly sequenceId: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:150

Inherited from

StarbasePlayerAccountData.sequenceId

shipsInEscrow

readonly shipsInEscrow: readonly StarbaseEscrowedShip[];

Defined in: packages/sage/src/starbases/index.ts:136

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/starbases/index.ts:125

totalCrew

readonly totalCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:141

Inherited from

StarbasePlayerAccountData.totalCrew

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:136

Inherited from

StarbasePlayerAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/starbases/index.ts:137

Returns

unknown

---

StarbaseRespawnQueueData

Defined in: packages/sage/src/internal/c4/starbase.ts:64

One translated respawn queue.

Example

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

Extended by

• StarbaseFacilityRespawnData
• StarbaseShipRespawnData

Properties

completesAtUnixSeconds

readonly completesAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:66

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:65

---

StarbaseShipRespawn

Defined in: packages/sage/src/starbases/index.ts:93

One resolved ship respawn queue.

Example

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

Extends

• ShipDefinitionSummary.Omit<StarbaseShipRespawnData, "shipId">

Properties

completesAtUnixSeconds

readonly completesAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:66

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

definitionSequenceId

readonly definitionSequenceId: number;

Defined in: packages/sage/src/registry/index.ts:95

Inherited from

ShipDefinitionSummary.definitionSequenceId

id

readonly id: number;

Defined in: packages/sage/src/registry/index.ts:96

Inherited from

ShipDefinitionSummary.id

mint

readonly mint: Address;

Defined in: packages/sage/src/registry/index.ts:97

Inherited from

ShipDefinitionSummary.mint

name

readonly name: string;

Defined in: packages/sage/src/registry/index.ts:98

Inherited from

ShipDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:65

Inherited from

StarbaseRespawnQueueData.quantityRaw

sizeClass

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

Defined in: packages/sage/src/registry/index.ts:99

Inherited from

ShipDefinitionSummary.sizeClass

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/registry/index.ts:94

Inherited from

ShipDefinitionSummary.stats

---

StarbaseShipRespawnData

Defined in: packages/sage/src/internal/c4/starbase.ts:76

One unresolved ship respawn queue.

Example

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

Extends

• StarbaseRespawnQueueData

Properties

completesAtUnixSeconds

readonly completesAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:66

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:65

Inherited from

StarbaseRespawnQueueData.quantityRaw

shipId

readonly shipId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:77

---

StarbaseUpgradeProcessAccountData

Defined in: packages/sage/src/internal/c4/starbase.ts:164

Fully translated StarbaseUpgradeProcess account data before registry joins.

Example

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

Properties

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:174

numCrew

readonly numCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:172

playerProfile

readonly playerProfile: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:166

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:171

resourceId

readonly resourceId: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:170

starbasePlayer

readonly starbasePlayer: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:168

starbaseSequenceId

readonly starbaseSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:169

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:173

system

readonly system: Address;

Defined in: packages/sage/src/internal/c4/starbase.ts:167

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:165

---

StarbaseUpgradeProcessSnapshot

Defined in: packages/sage/src/starbases/index.ts:147

Immutable, translated Starbase upgrade-process snapshot.

Example

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

Extends

• Omit<StarbaseUpgradeProcessAccountData, | "playerProfile" | "quantityRaw" | "resourceId" | "starbasePlayer" | "system">

Extended by

• StarbaseUpgradeProcessView

Properties

address

readonly address: Address;

Defined in: packages/sage/src/starbases/index.ts:152

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:174

Inherited from

StarbaseUpgradeProcessAccountData.endsAtUnixSeconds

kind

readonly kind: "starbaseUpgradeProcess";

Defined in: packages/sage/src/starbases/index.ts:151

numCrew

readonly numCrew: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:172

Inherited from

StarbaseUpgradeProcessAccountData.numCrew

playerProfile

readonly playerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/starbases/index.ts:153

resource

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

Defined in: packages/sage/src/starbases/index.ts:156

Type Declaration

quantityRaw

readonly quantityRaw: bigint;

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

Defined in: packages/sage/src/starbases/index.ts:154

starbaseSequenceId

readonly starbaseSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:169

Inherited from

StarbaseUpgradeProcessAccountData.starbaseSequenceId

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/starbase.ts:173

Inherited from

StarbaseUpgradeProcessAccountData.startsAtUnixSeconds

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/starbases/index.ts:155

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/starbase.ts:165

Inherited from

StarbaseUpgradeProcessAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/starbases/index.ts:157

Returns

unknown

Type Aliases

StarbaseDiscoveryOptions

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

Defined in: packages/sage/src/starbases/index.ts:57

Options supported by targeted player-local Starbase discovery.

Example

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

---

StarbasePlayerFaction

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

Defined in: packages/sage/src/internal/c4/starbase.ts:55

Stable translated Starbase faction.

Example

const faction: StarbasePlayerFaction = 'mud';

Functions

getStarbasePlayer()

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

Defined in: packages/sage/src/starbases/index.ts:320

Reads one required StarbasePlayer by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<StarbasePlayerSnapshot>

Example

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

---

getStarbasePlayerForCharacterAtSystem()

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

Defined in: packages/sage/src/starbases/index.ts:365

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

Parameters

Parameter	Type
context	SageContext
character	Address
system	Address
options?	ReadOptions

Returns

Promise<StarbasePlayerSnapshot>

Example

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

---

getStarbasePlayersByCharacter()

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

Defined in: packages/sage/src/starbases/index.ts:400

Discovers player-local Starbases for one Character.

Parameters

Parameter	Type
context	SageContext
character	Address
options?	StarbaseDiscoveryOptions

Returns

Promise<readonly StarbasePlayerSnapshot[]>

Example

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

---

getStarbasePlayersBySystem()

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

Defined in: packages/sage/src/starbases/index.ts:420

Discovers player-local Starbases in one Star System.

Parameters

Parameter	Type
context	SageContext
system	Address
options?	StarbaseDiscoveryOptions

Returns

Promise<readonly StarbasePlayerSnapshot[]>

Example

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

---

getStarbaseUpgradeProcess()

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

Defined in: packages/sage/src/starbases/index.ts:440

Reads one required StarbaseUpgradeProcess by its signer-created address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<StarbaseUpgradeProcessSnapshot>

Example

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

---

getStarbaseUpgradeProcessesByPlayer()

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

Defined in: packages/sage/src/starbases/index.ts:488

Discovers Starbase upgrade processes stored against one StarbasePlayer.

Parameters

Parameter	Type
context	SageContext
player	Address
options?	StarbaseDiscoveryOptions

Returns

Promise<readonly StarbaseUpgradeProcessSnapshot[]>

Example

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

---

maybeGetStarbasePlayer()

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

Defined in: packages/sage/src/starbases/index.ts:340

Reads one optional StarbasePlayer by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | StarbasePlayerSnapshot | undefined>

Example

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

---

maybeGetStarbaseUpgradeProcess()

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

Defined in: packages/sage/src/starbases/index.ts:464

Reads one optional StarbaseUpgradeProcess by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | StarbaseUpgradeProcessSnapshot | undefined>

Example

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