starbases

Interfaces

StarbaseCargoAmountData

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

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:150

cargoId

readonly cargoId: number;

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

---

StarbaseCargoInventory

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

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:80

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

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

---

StarbaseCargoItem

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

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:69

Inherited from

CargoDefinitionSummary.categoryId

id

readonly id: number;

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

Inherited from

CargoDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

CargoDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

CargoDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

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

storageCost

readonly storageCost: number;

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

Inherited from

CargoDefinitionSummary.storageCost

---

StarbaseCargoPodData

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

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:163

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

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

---

StarbaseEscrowedShip

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

One resolved escrowed ship quantity.

Example

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

Extends

• ShipDefinitionSummary.Omit<StarbaseEscrowedShipData, "shipId">

Properties

id

readonly id: number;

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

Inherited from

ShipDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

ShipDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

ShipDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

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

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:49

Inherited from

ShipDefinitionSummary.sizeClass

---

StarbaseEscrowedShipData

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

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:175

shipId

readonly shipId: number;

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

---

StarbaseFacilityRespawnData

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

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:116

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

definitionId

readonly definitionId: number;

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

quantityRaw

readonly quantityRaw: bigint;

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

Inherited from

StarbaseRespawnQueueData.quantityRaw

---

StarbasePlayerAccountData

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

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:202

busyCrew

readonly busyCrew: number;

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

cargo

readonly cargo: StarbaseCargoPodData;

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

cargoRespawnEndsAtUnixSeconds

readonly cargoRespawnEndsAtUnixSeconds: bigint;

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

character

readonly character: Address;

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

faction

readonly faction: StarbasePlayerFaction;

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

playerProfile

readonly playerProfile: Address;

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

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:193

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:200

shipsInEscrow

readonly shipsInEscrow: readonly StarbaseEscrowedShipData[];

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

system

readonly system: Address;

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

totalCrew

readonly totalCrew: number;

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

version

readonly version: number;

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

---

StarbasePlayerSnapshot

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

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:120

availableCrew

readonly availableCrew: number;

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

bump

readonly bump: number;

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

Inherited from

StarbasePlayerAccountData.bump

busyCrew

readonly busyCrew: number;

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

Inherited from

StarbasePlayerAccountData.busyCrew

cargo

readonly cargo: StarbaseCargoInventory;

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

cargoRespawnEndsAtUnixSeconds

readonly cargoRespawnEndsAtUnixSeconds: bigint;

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

Inherited from

StarbasePlayerAccountData.cargoRespawnEndsAtUnixSeconds

character

readonly character: EntityRef<"character">;

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

faction

readonly faction: StarbasePlayerFaction;

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

Inherited from

StarbasePlayerAccountData.faction

kind

readonly kind: "starbasePlayer";

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

playerProfile

readonly playerProfile: EntityRef<"profile">;

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

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:126

Type Declaration

cargo

readonly cargo: StarbaseCargoInventory;

ships

readonly ships: readonly StarbaseShipRespawn[];

sequenceId

readonly sequenceId: bigint;

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

Inherited from

StarbasePlayerAccountData.sequenceId

shipsInEscrow

readonly shipsInEscrow: readonly StarbaseEscrowedShip[];

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

system

readonly system: EntityRef<"starSystem">;

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

totalCrew

readonly totalCrew: number;

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

Inherited from

StarbasePlayerAccountData.totalCrew

version

readonly version: number;

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

Inherited from

StarbasePlayerAccountData.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

StarbaseRespawnQueueData

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

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:116

quantityRaw

readonly quantityRaw: bigint;

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

---

StarbaseShipRespawn

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

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:116

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

id

readonly id: number;

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

Inherited from

ShipDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

ShipDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

ShipDefinitionSummary.name

quantityRaw

readonly quantityRaw: bigint;

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

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:49

Inherited from

ShipDefinitionSummary.sizeClass

---

StarbaseShipRespawnData

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

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:116

Inherited from

StarbaseRespawnQueueData.completesAtUnixSeconds

quantityRaw

readonly quantityRaw: bigint;

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

Inherited from

StarbaseRespawnQueueData.quantityRaw

shipId

readonly shipId: number;

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

---

StarbaseUpgradeProcessAccountData

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

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:224

numCrew

readonly numCrew: number;

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

playerProfile

readonly playerProfile: Address;

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

quantityRaw

readonly quantityRaw: bigint;

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

resourceId

readonly resourceId: number;

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

starbasePlayer

readonly starbasePlayer: Address;

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

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

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

system

readonly system: Address;

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

version

readonly version: number;

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

---

StarbaseUpgradeProcessSnapshot

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

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:149

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

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

Inherited from

StarbaseUpgradeProcessAccountData.endsAtUnixSeconds

kind

readonly kind: "starbaseUpgradeProcess";

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

numCrew

readonly numCrew: number;

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

Inherited from

StarbaseUpgradeProcessAccountData.numCrew

playerProfile

readonly playerProfile: EntityRef<"profile">;

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

resource

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

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

Type Declaration

quantityRaw

readonly quantityRaw: bigint;

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

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

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

Inherited from

StarbaseUpgradeProcessAccountData.starbaseSequenceId

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

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

Inherited from

StarbaseUpgradeProcessAccountData.startsAtUnixSeconds

system

readonly system: EntityRef<"starSystem">;

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

version

readonly version: number;

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

Inherited from

StarbaseUpgradeProcessAccountData.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

StarbaseDiscoveryOptions

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

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

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:105

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:328

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:373

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:408

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:428

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:448

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:496

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:348

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:472

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