index

Interfaces

AccountSubscriptionProvider

Defined in: packages/sage/src/client/contracts.ts:366

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

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

Properties

identity

readonly identity: DataSourceIdentity;

Defined in: packages/sage/src/client/contracts.ts:367

Methods

subscribeAccount()

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

Defined in: packages/sage/src/client/contracts.ts:368

Parameters

Parameter	Type
`request`	`AccountSubscriptionRequest`
`listener`	(`event`) => `void`

Returns

Promise<AccountSubscriptionRegistration>

AccountSubscriptionRegistration

Defined in: packages/sage/src/client/contracts.ts:346

Provider-owned handle for one raw WebSocket registration.

Example

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

Methods

unsubscribe()

unsubscribe(): Promise<void>;

Defined in: packages/sage/src/client/contracts.ts:347

Returns

Promise<void>

AccountSubscriptionRequest

Defined in: packages/sage/src/client/contracts.ts:319

A context-owned raw-account subscription request.

Example

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

Extends

ReadAccountOptions

Properties

address

readonly address: Address;

Defined in: packages/sage/src/client/contracts.ts:320

commitment?

readonly optional commitment?: Commitment;

Defined in: packages/sage/src/client/contracts.ts:153

Inherited from

ReadAccountOptions.commitment

signal?

readonly optional signal?: AbortSignal;

Defined in: packages/sage/src/client/contracts.ts:154

Inherited from

ReadAccountOptions.signal

AsteroidView

Defined in: packages/sage/src/index.ts:368

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

Example

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

Extends

Omit<AsteroidSnapshot, "system">

Properties

address

readonly address: Address;

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

Inherited from

AsteroidSnapshot.address

claimStakes

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

Defined in: packages/sage/src/index.ts:369

all()

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

Parameters

Parameter	Type
`options?`	`ClaimStakeDiscoveryOptions`

Returns

Promise<readonly ClaimStakeView[]>

deposit

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

Defined in: packages/sage/src/index.ts:374

get()

get(options?): Promise<ResourceDepositView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<ResourceDepositView>

details

readonly details: WorldAsteroidData;

Defined in: packages/sage/src/internal/c4/world.ts:407

Inherited from

Omit.details

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/world.ts:393

Inherited from

Omit.game

id

readonly id: number;

Defined in: packages/sage/src/internal/c4/world.ts:391

Inherited from

Omit.id

kind

readonly kind: "asteroid";

Defined in: packages/sage/src/internal/c4/world.ts:406

Inherited from

Omit.kind

lastSyncAtUnixSeconds

readonly lastSyncAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/world.ts:396

Inherited from

Omit.lastSyncAtUnixSeconds

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/world.ts:392

Inherited from

Omit.name

system

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

Defined in: packages/sage/src/index.ts:377

Type Declaration

get()

get(options?): Promise<StarSystemView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<StarSystemView>

systemSequenceId

readonly systemSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/world.ts:395

Inherited from

Omit.systemSequenceId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/world.ts:390

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/world/index.ts:102

Returns

unknown

Inherited from

AsteroidSnapshot.toJSON

CargoDefinitionSummary

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

Small, stable cargo definition returned to gameplay domains.

Example

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

Extended by

Properties

categoryId

readonly categoryId: number;

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

id

readonly id: number;

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

mint

readonly mint: Address;

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

name

readonly name: string;

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

storageCost

readonly storageCost: number;

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

CharacterView

Defined in: packages/sage/src/index.ts:166

A loaded Character with root-only relation accessors.

Example

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

Properties

address

readonly address: Address;

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

Inherited from

CharacterSnapshot.address

atlas

readonly atlas: number;

Defined in: packages/sage/src/internal/c4/identity.ts:242

Inherited from

CharacterAccountData.atlas

atlasRaw

readonly atlasRaw: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:241

Inherited from

CharacterAccountData.atlasRaw

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/identity.ts:235

Inherited from

CharacterAccountData.bump

checkIn

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

Defined in: packages/sage/src/internal/c4/identity.ts:236

lastCheckInTime

readonly lastCheckInTime: bigint;

streak

readonly streak: number;

Inherited from

CharacterAccountData.checkIn

claimStakes

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

Defined in: packages/sage/src/index.ts:177

all()

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

Parameters

Parameter	Type
`options?`	`ClaimStakeDiscoveryOptions`

Returns

Promise<readonly ClaimStakeView[]>

counts

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

Defined in: packages/sage/src/internal/c4/identity.ts:243

claimStakes

readonly claimStakes: number;

craftingHabs

readonly craftingHabs: number;

fleets

readonly fleets: number;

Inherited from

CharacterAccountData.counts

craftingHabs

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

Defined in: packages/sage/src/index.ts:185

all()

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

Parameters

Parameter	Type
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingHabView[]>

craftingProcesses

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

Defined in: packages/sage/src/index.ts:190

all()

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

Parameters

Parameter	Type
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingProcessView[]>

fleets

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

Defined in: packages/sage/src/index.ts:182

all()

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

Parameters

Parameter	Type
`options?`	`FleetDiscoveryOptions`

Returns

Promise<readonly FleetView[]>

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/identity.ts:234

Inherited from

CharacterAccountData.game

kind

readonly kind: "character";

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

Inherited from

CharacterSnapshot.kind

localMarketOrders

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

Defined in: packages/sage/src/index.ts:167

at()

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

Parameters

Parameter	Type
`market`	`Address`
`options?`	`ReadOptions`

Returns

Promise<readonly LocalMarketOrderSnapshot & { makerState: LocalMarketMakerStateSnapshot; }[]>

modifiers

readonly modifiers: CharacterModifiersData;

Defined in: packages/sage/src/internal/c4/identity.ts:254

Inherited from

CharacterAccountData.modifiers

pilotXpBudget

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

Defined in: packages/sage/src/internal/c4/identity.ts:248

available

readonly available: number;

fractionalCarry

readonly fractionalCarry: number;

fractionalCarryRaw

readonly fractionalCarryRaw: bigint;

lastAccrualTime

readonly lastAccrualTime: bigint;

Inherited from

CharacterAccountData.pilotXpBudget

profile

readonly profile: EntityRef<"profile">;

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

Inherited from

CharacterSnapshot.profile

starbases

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

Defined in: packages/sage/src/index.ts:195

all()

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

Parameters

Parameter	Type
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbasePlayerView[]>

at()

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

Parameters

Parameter	Type
`system`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbasePlayerView>

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:232

Inherited from

CharacterAccountData.version

xp

readonly xp: CharacterXpData;

Defined in: packages/sage/src/internal/c4/identity.ts:240

Inherited from

CharacterAccountData.xp

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Inherited from

CharacterSnapshot.toJSON

ClaimStakeView

Defined in: packages/sage/src/index.ts:276

A loaded Claim Stake exposed by the root convenience client.

Example

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

Extends

ClaimStakeSnapshot

Properties

address

readonly address: Address;

Defined in: packages/sage/src/claim-stakes/index.ts:63

Inherited from

ClaimStakeSnapshot.address

body

readonly body: EntityRef<"celestialBody">;

Defined in: packages/sage/src/claim-stakes/index.ts:64

Inherited from

ClaimStakeSnapshot.body

buildingDefinitionSeqId

readonly buildingDefinitionSeqId: number;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:157

Inherited from

ClaimStakeAccountData.buildingDefinitionSeqId

buildings

readonly buildings: readonly ClaimStakeBuildingData[];

Defined in: packages/sage/src/internal/c4/claim-stake.ts:164

Inherited from

ClaimStakeAccountData.buildings

claimStakeDefinitionId

readonly claimStakeDefinitionId: number;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:155

Inherited from

ClaimStakeAccountData.claimStakeDefinitionId

claimStakeDefinitionSeqId

readonly claimStakeDefinitionSeqId: number;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:156

Inherited from

ClaimStakeAccountData.claimStakeDefinitionSeqId

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:161

Inherited from

ClaimStakeAccountData.constructionProgressAtUnixSeconds

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:160

Inherited from

ClaimStakeAccountData.constructionRemainingSeconds

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:153

Inherited from

ClaimStakeAccountData.game

kind

readonly kind: "claimStakeInstance";

Defined in: packages/sage/src/claim-stakes/index.ts:62

Inherited from

ClaimStakeSnapshot.kind

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:159

Inherited from

ClaimStakeAccountData.lastRentAtUnixSeconds

neededCrew

readonly neededCrew: number;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:163

Inherited from

ClaimStakeAccountData.neededCrew

ownerCharacter

readonly ownerCharacter: EntityRef<"character">;

Defined in: packages/sage/src/claim-stakes/index.ts:65

Inherited from

ClaimStakeSnapshot.ownerCharacter

rentBalanceRaw

readonly rentBalanceRaw: bigint;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:162

Inherited from

ClaimStakeAccountData.rentBalanceRaw

resources

readonly resources: ClaimStakeResources;

Defined in: packages/sage/src/claim-stakes/index.ts:66

Inherited from

ClaimStakeSnapshot.resources

state

readonly state: ClaimStakeStateData;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:165

Inherited from

ClaimStakeAccountData.state

systemSeqId

readonly systemSeqId: bigint;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:158

Inherited from

ClaimStakeAccountData.systemSeqId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/claim-stake.ts:151

Inherited from

ClaimStakeAccountData.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/claim-stakes/index.ts:67

Returns

unknown

Inherited from

ClaimStakeSnapshot.toJSON

CraftingHabView

Defined in: packages/sage/src/index.ts:331

A loaded Crafting Hab exposed by the root convenience client.

Example

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

Extends

CraftingHabSnapshot

Properties

address

readonly address: Address;

Defined in: packages/sage/src/crafting/index.ts:183

Inherited from

CraftingHabSnapshot.address

availableJobSlots

readonly availableJobSlots: number;

Defined in: packages/sage/src/crafting/index.ts:189

Inherited from

CraftingHabSnapshot.availableJobSlots

buildingDefinitionSequenceId

readonly buildingDefinitionSequenceId: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:207

Inherited from

CraftingHabSnapshot.buildingDefinitionSequenceId

buildings

readonly buildings: readonly CraftingHabBuilding[];

Defined in: packages/sage/src/crafting/index.ts:188

Inherited from

CraftingHabView.buildings

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:211

Inherited from

CraftingHabSnapshot.constructionProgressAtUnixSeconds

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:210

Inherited from

CraftingHabSnapshot.constructionRemainingSeconds

definition

readonly definition: CraftingHabDefinitionSummary;

Defined in: packages/sage/src/crafting/index.ts:187

Inherited from

CraftingHabSnapshot.definition

definitionId

readonly definitionId: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:205

Inherited from

CraftingHabSnapshot.definitionId

definitionSequenceId

readonly definitionSequenceId: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:206

Inherited from

CraftingHabSnapshot.definitionSequenceId

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/crafting/index.ts:184

Inherited from

CraftingHabSnapshot.game

jobCapacity

readonly jobCapacity: number;

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

Inherited from

CraftingHabSnapshot.jobCapacity

jobsRunning

readonly jobsRunning: number;

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

Inherited from

CraftingHabSnapshot.jobsRunning

kind

readonly kind: "craftingHabInstance";

Defined in: packages/sage/src/crafting/index.ts:182

Inherited from

CraftingHabSnapshot.kind

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:209

Inherited from

CraftingHabSnapshot.lastRentAtUnixSeconds

modifiers

readonly modifiers: CraftingModifierData;

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

Inherited from

CraftingHabSnapshot.modifiers

neededCrew

readonly neededCrew: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:213

Inherited from

CraftingHabSnapshot.neededCrew

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/crafting/index.ts:185

Inherited from

CraftingHabSnapshot.ownerProfile

production

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

Defined in: packages/sage/src/crafting/index.ts:191

inventory

readonly inventory: CraftingCargoInventory;

lastTickAtUnixSeconds

readonly lastTickAtUnixSeconds: bigint;

netRates

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

resourceCapacityRaw

readonly resourceCapacityRaw: bigint;

Inherited from

CraftingHabSnapshot.production

rentBalanceRaw

readonly rentBalanceRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:212

Inherited from

CraftingHabSnapshot.rentBalanceRaw

state

readonly state: CraftingHabStateData;

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

Inherited from

CraftingHabSnapshot.state

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/crafting/index.ts:186

Inherited from

CraftingHabSnapshot.system

systemSequenceId

readonly systemSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:208

Inherited from

CraftingHabSnapshot.systemSequenceId

unlockedRecipes

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

Defined in: packages/sage/src/crafting/index.ts:190

Inherited from

CraftingHabView.unlockedRecipes

version

readonly version: number;

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

Inherited from

CraftingHabSnapshot.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/crafting/index.ts:200

Returns

unknown

Inherited from

CraftingHabSnapshot.toJSON

CraftingProcessView

Defined in: packages/sage/src/index.ts:341

A loaded Crafting Process exposed by the root convenience client.

Example

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

Extends

CraftingProcessSnapshot

Properties

address

readonly address: Address;

Defined in: packages/sage/src/crafting/index.ts:215

Inherited from

CraftingProcessSnapshot.address

craftingHab

readonly craftingHab: EntityRef<"craftingHabInstance">;

Defined in: packages/sage/src/crafting/index.ts:220

Inherited from

CraftingProcessSnapshot.craftingHab

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:239

Inherited from

CraftingProcessSnapshot.endsAtUnixSeconds

feeEscrowAtlas

readonly feeEscrowAtlas: number;

Defined in: packages/sage/src/crafting/index.ts:222

Inherited from

CraftingProcessSnapshot.feeEscrowAtlas

feeEscrowRaw

readonly feeEscrowRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:240

Inherited from

CraftingProcessSnapshot.feeEscrowRaw

inputs

readonly inputs: CraftingCargoInventory;

Defined in: packages/sage/src/crafting/index.ts:221

Inherited from

CraftingProcessSnapshot.inputs

kind

readonly kind: "craftingProcess";

Defined in: packages/sage/src/crafting/index.ts:214

Inherited from

CraftingProcessSnapshot.kind

numCrew

readonly numCrew: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:237

Inherited from

CraftingProcessSnapshot.numCrew

profile

readonly profile: EntityRef<"profile">;

Defined in: packages/sage/src/crafting/index.ts:217

Inherited from

CraftingProcessSnapshot.profile

quantityRaw

readonly quantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:236

Inherited from

CraftingProcessSnapshot.quantityRaw

recipe

readonly recipe: RecipeSnapshot;

Defined in: packages/sage/src/crafting/index.ts:216

Inherited from

CraftingProcessSnapshot.recipe

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

Defined in: packages/sage/src/crafting/index.ts:219

Inherited from

CraftingProcessSnapshot.starbasePlayer

starbaseSequenceId

readonly starbaseSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:234

Inherited from

CraftingProcessSnapshot.starbaseSequenceId

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:238

Inherited from

CraftingProcessSnapshot.startsAtUnixSeconds

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/crafting/index.ts:218

Inherited from

CraftingProcessSnapshot.system

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/crafting.ts:229

Inherited from

CraftingProcessSnapshot.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/crafting/index.ts:223

Returns

unknown

Inherited from

CraftingProcessSnapshot.toJSON

DefinitionLookupOptions

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

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

Example

const options: DefinitionLookupOptions = { expectedSequenceId: 12 };

Properties

expectedSequenceId?

readonly optional expectedSequenceId?: number;

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

EntityRef

Defined in: packages/sage/src/client/refs.ts:11

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

Example

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

Type Parameters

Type Parameter	Default type
`TType` extends `EntityType`	`EntityType`

Properties

address

readonly address: Address;

Defined in: packages/sage/src/client/refs.ts:13

type

readonly type: TType;

Defined in: packages/sage/src/client/refs.ts:12

FactionMarketView

Defined in: packages/sage/src/index.ts:442

A loaded Faction Market exposed by the root convenience client.

Example

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

Extends

FactionMarketSnapshot

Properties

address

readonly address: Address;

Defined in: packages/sage/src/markets/index.ts:159

Inherited from

FactionMarketSnapshot.address

atlasBurnBasisPoints

readonly atlasBurnBasisPoints: number;

Defined in: packages/sage/src/internal/c4/market.ts:179

Inherited from

FactionMarketSnapshot.atlasBurnBasisPoints

authoredTargetQuantityRaw

readonly authoredTargetQuantityRaw: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:176

Inherited from

FactionMarketSnapshot.authoredTargetQuantityRaw

bump

readonly bump: number;

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

Inherited from

FactionMarketSnapshot.bump

factionId

readonly factionId: number;

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

Inherited from

FactionMarketSnapshot.factionId

faucetEnabled

readonly faucetEnabled: boolean;

Defined in: packages/sage/src/internal/c4/market.ts:181

Inherited from

FactionMarketSnapshot.faucetEnabled

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/markets/index.ts:160

Inherited from

FactionMarketSnapshot.game

kind

readonly kind: "factionMarket";

Defined in: packages/sage/src/markets/index.ts:158

Inherited from

FactionMarketSnapshot.kind

lastRestockedAtUnixSeconds

readonly lastRestockedAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:178

Inherited from

FactionMarketSnapshot.lastRestockedAtUnixSeconds

minimumStandingToBuy

readonly minimumStandingToBuy: number;

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

Inherited from

FactionMarketSnapshot.minimumStandingToBuy

minimumStandingToSell

readonly minimumStandingToSell: number;

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

Inherited from

FactionMarketSnapshot.minimumStandingToSell

offers

readonly offers: readonly FactionMarketOfferSnapshot[];

Defined in: packages/sage/src/markets/index.ts:162

Inherited from

FactionMarketView.offers

priceTierBasisPoints

readonly priceTierBasisPoints: readonly number[];

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

Inherited from

FactionMarketSnapshot.priceTierBasisPoints

restockPeriodSeconds

readonly restockPeriodSeconds: number;

Defined in: packages/sage/src/internal/c4/market.ts:177

Inherited from

FactionMarketSnapshot.restockPeriodSeconds

standingBasisPoints

readonly standingBasisPoints: number;

Defined in: packages/sage/src/internal/c4/market.ts:180

Inherited from

FactionMarketSnapshot.standingBasisPoints

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

Inherited from

FactionMarketSnapshot.starbaseSequenceId

status

readonly status: "active" | "draft";

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

Inherited from

FactionMarketSnapshot.status

system

readonly system: EntityRef<"starSystem">;

Defined in: packages/sage/src/markets/index.ts:161

Inherited from

FactionMarketSnapshot.system

version

readonly version: number;

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

Inherited from

FactionMarketSnapshot.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/markets/index.ts:163

Returns

unknown

Inherited from

FactionMarketSnapshot.toJSON

FleetCargoInventoryView

Defined in: packages/sage/src/index.ts:229

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

Example

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

Extends

FleetCargoInventorySnapshot

Properties

address

readonly address: Address;

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

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

Inherited from

FleetCargoInventorySnapshot.address

ammo

readonly ammo: CargoInventoryItem;

Defined in: packages/sage/src/internal/cargo.ts:63

Inherited from

FleetCargoInventorySnapshot.ammo

capacities

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

Defined in: packages/sage/src/internal/cargo.ts:64

ammoUnits

readonly ammoUnits: CargoCapacity;

cargoStorageUnits

readonly cargoStorageUnits: CargoCapacity;

fuelUnits

readonly fuelUnits: CargoCapacity;

Inherited from

FleetCargoInventorySnapshot.capacities

cargoHold

readonly cargoHold: CargoPodInventory;

Defined in: packages/sage/src/internal/cargo.ts:59

Inherited from

FleetCargoInventorySnapshot.cargoHold

components

readonly components: CargoPodInventory;

Defined in: packages/sage/src/internal/cargo.ts:60

Inherited from

FleetCargoInventorySnapshot.components

fleet

readonly fleet: EntityRef<"fleet">;

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

Inherited from

FleetCargoInventorySnapshot.fleet

fuel

readonly fuel: CargoInventoryItem;

Defined in: packages/sage/src/internal/cargo.ts:62

Inherited from

FleetCargoInventorySnapshot.fuel

kind

readonly kind: "fleetCargoInventory";

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

Inherited from

FleetCargoInventorySnapshot.kind

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

Inherited from

FleetCargoInventorySnapshot.ownerProfile

respawningCargo

readonly respawningCargo: CargoPodInventory;

Defined in: packages/sage/src/internal/cargo.ts:61

Inherited from

FleetCargoInventorySnapshot.respawningCargo

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Inherited from

FleetCargoInventorySnapshot.toJSON

FleetMiningView

Defined in: packages/sage/src/index.ts:254

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

Example

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

Extends

Omit<FleetMiningSnapshot, "asteroid" | "fleet" | "ownerProfile">

Properties

asteroid

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

Defined in: packages/sage/src/index.ts:258

Type Declaration

get()

get(options?): Promise<CelestialBodyView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<CelestialBodyView>

fleet

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

Defined in: packages/sage/src/index.ts:261

Type Declaration

get()

get(options?): Promise<FleetView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<FleetView>

kind

readonly kind: "fleetMining";

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

Inherited from

FleetMiningSnapshot.kind

lastUpdatedAtUnixSeconds

readonly lastUpdatedAtUnixSeconds: bigint;

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

Inherited from

FleetMiningSnapshot.lastUpdatedAtUnixSeconds

miningRate

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

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

raw

readonly raw: bigint;

unitsPerSecond

readonly unitsPerSecond: number;

Inherited from

FleetMiningSnapshot.miningRate

outputs

readonly outputs: readonly FleetMiningOutput[];

Defined in: packages/sage/src/mining/index.ts:129

Inherited from

FleetMiningSnapshot.outputs

ownerProfile

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

Defined in: packages/sage/src/index.ts:264

Type Declaration

get()

get(options?): Promise<ProfileView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<ProfileView>

regionXpModifier

readonly regionXpModifier: WorldFixedValue;

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

Inherited from

FleetMiningSnapshot.regionXpModifier

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/mining/index.ts:130

Returns

unknown

Inherited from

FleetMiningSnapshot.toJSON

FleetView

Defined in: packages/sage/src/index.ts:213

A loaded Fleet exposed by the root convenience client.

Example

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

Extends

FleetSnapshot

Properties

activeStimulants

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

Defined in: packages/sage/src/internal/c4/fleet.ts:369

Inherited from

FleetAccountData.activeStimulants

address

readonly address: Address;

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

Inherited from

FleetSnapshot.address

ammo

readonly ammo: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:102

Inherited from

ResolvedFleetAccountData.ammo

ap

readonly ap: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:355

Inherited from

FleetAccountData.ap

apReloadExpiresAt

readonly apReloadExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:360

Inherited from

FleetAccountData.apReloadExpiresAt

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:338

Inherited from

FleetAccountData.bump

capacities

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

Defined in: packages/sage/src/internal/fleet.ts:118

ammo

readonly ammo: CapacitySummary;

cargo

readonly cargo: CapacitySummary;

fuel

readonly fuel: CapacitySummary;

Inherited from

FleetSnapshot.capacities

cargoHold

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

Defined in: packages/sage/src/internal/fleet.ts:103

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

FleetSnapshot.cargoHold

components

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

Defined in: packages/sage/src/internal/fleet.ts:108

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

FleetSnapshot.components

crewCount

readonly crewCount: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:352

Inherited from

FleetAccountData.crewCount

faction

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

Defined in: packages/sage/src/internal/c4/fleet.ts:343

Inherited from

FleetAccountData.faction

fuel

readonly fuel: ResolvedCargoAmount;

Defined in: packages/sage/src/internal/fleet.ts:101

Inherited from

ResolvedFleetAccountData.fuel

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/fleet.ts:339

Inherited from

FleetAccountData.game

hp

readonly hp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:357

Inherited from

FleetAccountData.hp

inventory

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

Defined in: packages/sage/src/index.ts:214

get()

get(options?): Promise<FleetCargoInventoryView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<FleetCargoInventoryView>

kind

readonly kind: "fleet";

Defined in: packages/sage/src/fleets/index.ts:89

Inherited from

FleetSnapshot.kind

lastCombatUpdate

readonly lastCombatUpdate: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:362

Inherited from

FleetAccountData.lastCombatUpdate

lastUpdateAt

readonly lastUpdateAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:364

Inherited from

FleetAccountData.lastUpdateAt

location

readonly location: SectorCoordinates;

Defined in: packages/sage/src/internal/c4/fleet.ts:363

Inherited from

FleetAccountData.location

mining

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

Defined in: packages/sage/src/index.ts:217

get()

get(options?): Promise<FleetMiningView | undefined>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<FleetMiningView | undefined>

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/fleet.ts:345

Inherited from

FleetAccountData.name

npcFactionId

readonly npcFactionId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:344

Inherited from

FleetAccountData.npcFactionId

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

Defined in: packages/sage/src/fleets/index.ts:91

Inherited from

FleetSnapshot.ownerProfile

pendingHp

readonly pendingHp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:358

Inherited from

FleetAccountData.pendingHp

rentedCrew

readonly rentedCrew: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:353

Inherited from

FleetAccountData.rentedCrew

respawningCargo

readonly respawningCargo: {
  items: readonly ResolvedCargoAmount[];
  seqId: number;
  storageCost: bigint;
};

Defined in: packages/sage/src/internal/fleet.ts:113

items

readonly items: readonly ResolvedCargoAmount[];

seqId

readonly seqId: number;

storageCost

readonly storageCost: bigint;

Inherited from

FleetSnapshot.respawningCargo

scanCooldownExpiresAt

readonly scanCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:348

Inherited from

FleetAccountData.scanCooldownExpiresAt

shieldBreakDelayExpiresAt

readonly shieldBreakDelayExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:361

Inherited from

FleetAccountData.shieldBreakDelayExpiresAt

shipCounts

readonly shipCounts: FleetShipCountsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:346

Inherited from

FleetAccountData.shipCounts

shipDefinitionsSeqId

readonly shipDefinitionsSeqId: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:354

Inherited from

FleetAccountData.shipDefinitionsSeqId

ships

readonly ships: readonly ResolvedShipAmount[];

Defined in: packages/sage/src/internal/fleet.ts:100

Inherited from

FleetSnapshot.ships

sp

readonly sp: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:356

Inherited from

FleetAccountData.sp

stance

readonly stance: {
  ammoUsage: "none" | "light" | "heavy";
};

Defined in: packages/sage/src/internal/c4/fleet.ts:359

ammoUsage

readonly ammoUsage: "none" | "light" | "heavy";

Inherited from

FleetAccountData.stance

state

readonly state: ResolvedFleetState;

Defined in: packages/sage/src/internal/fleet.ts:123

Inherited from

ResolvedFleetAccountData.state

stats

readonly stats: FleetStatsData;

Defined in: packages/sage/src/internal/c4/fleet.ts:349

Inherited from

FleetAccountData.stats

subProfile?

readonly optional subProfile?: Address;

Defined in: packages/sage/src/internal/fleet.ts:98

Inherited from

FleetSnapshot.subProfile

subProfileInvalidator?

readonly optional subProfileInvalidator?: Address;

Defined in: packages/sage/src/internal/fleet.ts:99

Inherited from

FleetSnapshot.subProfileInvalidator

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/fleet.ts:337

Inherited from

FleetAccountData.version

warpCooldownExpiresAt

readonly warpCooldownExpiresAt: bigint;

Defined in: packages/sage/src/internal/c4/fleet.ts:347

Inherited from

FleetAccountData.warpCooldownExpiresAt

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/fleets/index.ts:92

Returns

unknown

Inherited from

FleetSnapshot.toJSON

LocalMarketView

Defined in: packages/sage/src/index.ts:433

A loaded Local Market exposed by the root convenience client.

Example

declare const market: LocalMarketView;
console.log(market.cargo.name);

Extends

LocalMarketSnapshot

Properties

address

readonly address: Address;

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

Inherited from

LocalMarketSnapshot.address

asks

readonly asks: LocalMarketOrderBookSnapshot;

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

Inherited from

LocalMarketSnapshot.asks

bids

readonly bids: LocalMarketOrderBookSnapshot;

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

Inherited from

LocalMarketSnapshot.bids

bump

readonly bump: number;

Defined in: packages/sage/src/internal/c4/market.ts:147

Inherited from

LocalMarketSnapshot.bump

cargo

readonly cargo: CargoDefinitionSummary & {
  amountRaw: bigint;
};

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

Type Declaration

amountRaw

readonly amountRaw: bigint;

Inherited from

LocalMarketSnapshot.cargo

initializerProfile

readonly initializerProfile: EntityRef<"profile">;

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

Inherited from

LocalMarketSnapshot.initializerProfile

kind

readonly kind: "localMarket";

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

Inherited from

LocalMarketSnapshot.kind

starbaseSequenceId

readonly starbaseSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/market.ts:146

Inherited from

LocalMarketSnapshot.starbaseSequenceId

system

readonly system: EntityRef<"starSystem">;

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

Inherited from

LocalMarketSnapshot.system

vaultAtlas

readonly vaultAtlas: number;

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

Inherited from

LocalMarketSnapshot.vaultAtlas

vaultRaw

readonly vaultRaw: bigint;

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

Inherited from

LocalMarketSnapshot.vaultRaw

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/market.ts:144

Inherited from

LocalMarketSnapshot.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/markets/index.ts:129

Returns

unknown

Inherited from

LocalMarketSnapshot.toJSON

PlanetView

Defined in: packages/sage/src/index.ts:350

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

Example

declare const planet: PlanetView;
const system = await planet.system.get();

Extends

Omit<PlanetSnapshot, "system">

Properties

address

readonly address: Address;

Defined in: packages/sage/src/world/index.ts:87

Inherited from

PlanetSnapshot.address

claimStakes

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

Defined in: packages/sage/src/index.ts:351

all()

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

Parameters

Parameter	Type
`options?`	`ClaimStakeDiscoveryOptions`

Returns

Promise<readonly ClaimStakeView[]>

details

readonly details: WorldPlanetData;

Defined in: packages/sage/src/internal/c4/world.ts:403

Inherited from

Omit.details

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/world.ts:393

Inherited from

Omit.game

id

readonly id: number;

Defined in: packages/sage/src/internal/c4/world.ts:391

Inherited from

Omit.id

kind

readonly kind: "planet";

Defined in: packages/sage/src/internal/c4/world.ts:402

Inherited from

Omit.kind

lastSyncAtUnixSeconds

readonly lastSyncAtUnixSeconds: bigint;

Defined in: packages/sage/src/internal/c4/world.ts:396

Inherited from

Omit.lastSyncAtUnixSeconds

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/world.ts:392

Inherited from

Omit.name

system

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

Defined in: packages/sage/src/index.ts:356

Type Declaration

get()

get(options?): Promise<StarSystemView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<StarSystemView>

systemSequenceId

readonly systemSequenceId: bigint;

Defined in: packages/sage/src/internal/c4/world.ts:395

Inherited from

Omit.systemSequenceId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/world.ts:390

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/world/index.ts:89

Returns

unknown

Inherited from

PlanetSnapshot.toJSON

ProfileView

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

A loaded Player Profile exposed by the root convenience client.

Example

declare const sage: SageClient;
declare const profileAddress: Address;
const profile: ProfileView = await sage.profiles.get(profileAddress);

Extends

ProfileSnapshot

Properties

address

readonly address: Address;

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

Inherited from

ProfileSnapshot.address

authKeyCount

readonly authKeyCount: number;

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

Inherited from

ProfileSnapshot.authKeyCount

createdAt

readonly createdAt: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:90

Inherited from

ProfileSnapshot.createdAt

keys

readonly keys: readonly ProfileKeyData[];

Defined in: packages/sage/src/internal/c4/identity.ts:91

Inherited from

ProfileSnapshot.keys

keyThreshold

readonly keyThreshold: number;

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

Inherited from

ProfileSnapshot.keyThreshold

kind

readonly kind: "profile";

Defined in: packages/sage/src/identity/index.ts:102

Inherited from

ProfileSnapshot.kind

nextSeqId

readonly nextSeqId: bigint;

Defined in: packages/sage/src/internal/c4/identity.ts:89

Inherited from

ProfileSnapshot.nextSeqId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/identity.ts:86

Inherited from

ProfileSnapshot.version

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/identity/index.ts:104

Returns

unknown

Inherited from

ProfileSnapshot.toJSON

ReadMeta

Defined in: packages/sage/src/internal/read-meta.ts:23

Provenance attached non-enumerably to finder results.

Example

declare const fleets: object;
const meta: ReadMeta | undefined = readMeta(fleets);
if (meta) console.log(meta.strategy, meta.slot);

Properties

commitment

readonly commitment: Commitment;

Defined in: packages/sage/src/internal/read-meta.ts:27

filters?

readonly optional filters?: readonly ReadMetaFilter[];

Defined in: packages/sage/src/internal/read-meta.ts:29

indexer?

readonly optional indexer?: IndexerValidationMeta;

Defined in: packages/sage/src/internal/read-meta.ts:30

slot

readonly slot: bigint;

Defined in: packages/sage/src/internal/read-meta.ts:26

Earliest source slot across the result, or 0n when it is empty.

source

readonly source: DataSourceIdentity;

Defined in: packages/sage/src/internal/read-meta.ts:28

strategy

readonly strategy: DiscoveryStrategy;

Defined in: packages/sage/src/internal/read-meta.ts:24

walletProfiles?

readonly optional walletProfiles?: WalletProfileValidationMeta;

Defined in: packages/sage/src/internal/read-meta.ts:31

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/internal/read-meta.ts:33

Returns a JSON-safe copy with bigints as strings and filter bytes as arrays.

Returns

unknown

ReadMetaFilter

Defined in: packages/sage/src/internal/read-meta.ts:81

Immutable JSON-safe filter provenance exposed by readMeta.

Example

const filter: ReadMetaFilter = { offset: 0, bytes: [1, 2] };

Properties

bytes

readonly bytes: readonly number[];

Defined in: packages/sage/src/internal/read-meta.ts:83

offset

readonly offset: number;

Defined in: packages/sage/src/internal/read-meta.ts:82

RecipeView

Defined in: packages/sage/src/index.ts:321

A loaded Recipe exposed by the root convenience client.

Example

declare const sage: SageClient;
const recipe: RecipeView = await sage.recipes.byId(7);

Extends

RecipeSnapshot

Properties

address

readonly address: Address;

Defined in: packages/sage/src/crafting/index.ts:87

Inherited from

RecipeSnapshot.address

craftingDurationSeconds

readonly craftingDurationSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:145

Inherited from

RecipeSnapshot.craftingDurationSeconds

fee

readonly fee: {
  amountAtlas: number;
  amountRaw: bigint;
  recipient: "atlas" | "dao-atlas";
};

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

amountAtlas

readonly amountAtlas: number;

amountRaw

readonly amountRaw: bigint;

recipient

readonly recipient: "atlas" | "dao-atlas";

Inherited from

RecipeSnapshot.fee

game

readonly game: EntityRef<"game">;

Defined in: packages/sage/src/crafting/index.ts:88

Inherited from

RecipeSnapshot.game

habRequired

readonly habRequired: boolean;

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

Inherited from

RecipeSnapshot.habRequired

id

readonly id: number;

Defined in: packages/sage/src/crafting/index.ts:89

Inherited from

RecipeSnapshot.id

ingredients

readonly ingredients: readonly CraftingCargoItem[];

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

Inherited from

RecipeView.ingredients

kind

readonly kind: "recipe";

Defined in: packages/sage/src/crafting/index.ts:86

Inherited from

RecipeSnapshot.kind

minimumDurationSeconds

readonly minimumDurationSeconds: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:146

Inherited from

RecipeSnapshot.minimumDurationSeconds

minimumStarbaseLevel

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

Inherited from

RecipeSnapshot.minimumStarbaseLevel

modifierBounds

readonly modifierBounds: {
  crewCount: CraftingModifierBoundsData;
  efficiency: CraftingModifierBoundsData;
  fee: CraftingModifierBoundsData;
  speed: CraftingModifierBoundsData;
};

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

crewCount

readonly crewCount: CraftingModifierBoundsData;

efficiency

readonly efficiency: CraftingModifierBoundsData;

fee

readonly fee: CraftingModifierBoundsData;

speed

readonly speed: CraftingModifierBoundsData;

Inherited from

RecipeSnapshot.modifierBounds

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/crafting.ts:147

Inherited from

RecipeSnapshot.name

outputs

readonly outputs: readonly CraftingCargoItem[];

Defined in: packages/sage/src/crafting/index.ts:91

Inherited from

RecipeView.outputs

researchRequirementIds

readonly researchRequirementIds: readonly number[];

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

Inherited from

RecipeSnapshot.researchRequirementIds

status

readonly status: "active" | "deactivated";

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

Inherited from

RecipeSnapshot.status

usageCountRaw

readonly usageCountRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:155

Inherited from

RecipeSnapshot.usageCountRaw

usageLimitRaw

readonly usageLimitRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:156

Inherited from

RecipeSnapshot.usageLimitRaw

version

readonly version: number;

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

Inherited from

RecipeSnapshot.version

xpValueRaw

readonly xpValueRaw: bigint;

Defined in: packages/sage/src/internal/c4/crafting.ts:157

Inherited from

RecipeSnapshot.xpValueRaw

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/crafting/index.ts:92

Returns

unknown

Inherited from

RecipeSnapshot.toJSON

RegistrySnapshotStore

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

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. Schema version 1 persists only the bigint-free ship and cargo sections. Crafting Hab and Hab building sections continue to load lazily from Game because their exact bigint fields do not yet have a versioned JSON encoding.

Example

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

load()

load(game, section): Promise<
  | DefinitionSectionSnapshot
| undefined>;

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

Parameters

Parameter	Type
`game`	`Address`
`section`	`"ships"` \| `"cargo"`

Returns

Promise< | DefinitionSectionSnapshot | undefined>

save()

save(snapshot): Promise<void>;

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

Parameters

Parameter	Type
`snapshot`	`DefinitionSectionSnapshot`

Returns

Promise<void>

ResourceDepositView

Defined in: packages/sage/src/index.ts:238

A loaded Asteroid deposit with root-only StarSystem traversal.

Example

declare const deposit: ResourceDepositView;
const system = await deposit.system.get();

Extends

Omit<ResourceDepositSnapshot, "system">

Properties

address

readonly address: Address;

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

Inherited from

ResourceDepositSnapshot.address

bodyId

readonly bodyId: number;

Defined in: packages/sage/src/mining/index.ts:68

Inherited from

ResourceDepositSnapshot.bodyId

game

readonly game: Address;

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

Inherited from

ResourceDepositSnapshot.game

kind

readonly kind: "resourceDeposit";

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

Inherited from

ResourceDepositSnapshot.kind

lastSyncedAtUnixSeconds

readonly lastSyncedAtUnixSeconds: bigint;

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

Inherited from

ResourceDepositSnapshot.lastSyncedAtUnixSeconds

name

readonly name: string;

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

Inherited from

ResourceDepositSnapshot.name

resources

readonly resources: readonly ResourceDepositItem[];

Defined in: packages/sage/src/mining/index.ts:74

Inherited from

ResourceDepositSnapshot.resources

system

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

Defined in: packages/sage/src/index.ts:242

Type Declaration

get()

get(options?): Promise<StarSystemView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<StarSystemView>

systemSequenceId

readonly systemSequenceId: bigint;

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

Inherited from

ResourceDepositSnapshot.systemSequenceId

Methods

toJSON()

toJSON(): unknown;

Defined in: packages/sage/src/mining/index.ts:75

Returns

unknown

Inherited from

ResourceDepositSnapshot.toJSON

SageClient

Defined in: packages/sage/src/index.ts:452

Batteries-included root client composing the currently implemented domains.

Example

declare const rpc: SageRpc;
const sage: SageClient = createSageClient({ cluster: 'zink-ptr', rpc });

Properties

celestialBodies

readonly celestialBodies: {
  byId: Promise<CelestialBodyView>;
  get: Promise<CelestialBodyView>;
  maybe: Promise<CelestialBodyView | undefined>;
};

Defined in: packages/sage/src/index.ts:638

byId()

byId(bodyId, options?): Promise<CelestialBodyView>;

Parameters

Parameter	Type
`bodyId`	`number`
`options?`	`ReadOptions`

Returns

Promise<CelestialBodyView>

get()

get(address, options?): Promise<CelestialBodyView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CelestialBodyView>

maybe()

maybe(address, options?): Promise<CelestialBodyView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CelestialBodyView | undefined>

characters

readonly characters: {
  forProfile: Promise<CharacterView>;
};

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

forProfile()

forProfile(profileAddress, options?): Promise<CharacterView>;

Parameters

Parameter	Type
`profileAddress`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CharacterView>

claimStakes

readonly claimStakes: {
  byBody: Promise<readonly ClaimStakeView[]>;
  byCharacter: Promise<readonly ClaimStakeView[]>;
  get: Promise<ClaimStakeView>;
  maybe: Promise<ClaimStakeView | undefined>;
};

Defined in: packages/sage/src/index.ts:578

byBody()

byBody(body, options?): Promise<readonly ClaimStakeView[]>;

Parameters

Parameter	Type
`body`	`Address`
`options?`	`ClaimStakeDiscoveryOptions`

Returns

Promise<readonly ClaimStakeView[]>

byCharacter()

byCharacter(character, options?): Promise<readonly ClaimStakeView[]>;

Parameters

Parameter	Type
`character`	`Address`
`options?`	`ClaimStakeDiscoveryOptions`

Returns

Promise<readonly ClaimStakeView[]>

get()

get(address, options?): Promise<ClaimStakeView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ClaimStakeView>

maybe()

maybe(address, options?): Promise<ClaimStakeView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ClaimStakeView | undefined>

context

readonly context: SageContext;

Defined in: packages/sage/src/index.ts:453

craftingHabs

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

byCharacter()

byCharacter(character, options?): Promise<readonly CraftingHabView[]>;

Parameters

Parameter	Type
`character`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingHabView[]>

byProfile()

byProfile(profile, options?): Promise<readonly CraftingHabView[]>;

Parameters

Parameter	Type
`profile`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingHabView[]>

byStarbasePlayer()

byStarbasePlayer(player, options?): Promise<readonly CraftingHabView[]>;

Parameters

Parameter	Type
`player`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingHabView[]>

get()

get(address, options?): Promise<CraftingHabView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CraftingHabView>

maybe()

maybe(address, options?): Promise<CraftingHabView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CraftingHabView | undefined>

craftingProcesses

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

byCharacter()

byCharacter(character, options?): Promise<readonly CraftingProcessView[]>;

Parameters

Parameter	Type
`character`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingProcessView[]>

byProfile()

byProfile(profile, options?): Promise<readonly CraftingProcessView[]>;

Parameters

Parameter	Type
`profile`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingProcessView[]>

byStarbasePlayer()

byStarbasePlayer(player, options?): Promise<readonly CraftingProcessView[]>;

Parameters

Parameter	Type
`player`	`Address`
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingProcessView[]>

get()

get(address, options?): Promise<CraftingProcessView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CraftingProcessView>

maybe()

maybe(address, options?): Promise<CraftingProcessView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<CraftingProcessView | undefined>

factionMarkets

readonly factionMarkets: {
  forSystem: Promise<FactionMarketView>;
  get: Promise<FactionMarketView>;
  maybe: Promise<FactionMarketView | undefined>;
};

Defined in: packages/sage/src/index.ts:544

forSystem()

forSystem(
   system,
   starbaseSequenceId,
options?): Promise<FactionMarketView>;

Parameters

Parameter	Type
`system`	`Address`
`starbaseSequenceId`	`bigint`
`options?`	`ReadOptions`

Returns

Promise<FactionMarketView>

get()

get(address, options?): Promise<FactionMarketView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FactionMarketView>

maybe()

maybe(address, options?): Promise<FactionMarketView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FactionMarketView | undefined>

fleets

readonly fleets: {
  byOwner: Promise<readonly FleetView[]>;
  get: Promise<FleetView>;
  maybe: Promise<FleetView | undefined>;
};

Defined in: packages/sage/src/index.ts:470

byOwner()

byOwner(profileAddress, options?): Promise<readonly FleetView[]>;

Parameters

Parameter	Type
`profileAddress`	`Address`
`options?`	`FleetDiscoveryOptions`

Returns

Promise<readonly FleetView[]>

get()

get(address, options?): Promise<FleetView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FleetView>

maybe()

maybe(address, options?): Promise<FleetView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FleetView | undefined>

localMarkets

readonly localMarkets: {
  bySystem: Promise<readonly LocalMarketView[]>;
  forCargo: Promise<LocalMarketView>;
  get: Promise<LocalMarketView>;
  maybe: Promise<LocalMarketView | undefined>;
};

Defined in: packages/sage/src/index.ts:527

bySystem()

bySystem(system, options?): Promise<readonly LocalMarketView[]>;

Parameters

Parameter	Type
`system`	`Address`
`options?`	`MarketDiscoveryOptions`

Returns

Promise<readonly LocalMarketView[]>

forCargo()

forCargo(
   system,
   cargoId,
   starbaseSequenceId,
options?): Promise<LocalMarketView>;

Parameters

Parameter	Type
`system`	`Address`
`cargoId`	`number`
`starbaseSequenceId`	`bigint`
`options?`	`ReadOptions`

Returns

Promise<LocalMarketView>

get()

get(address, options?): Promise<LocalMarketView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<LocalMarketView>

maybe()

maybe(address, options?): Promise<LocalMarketView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<LocalMarketView | undefined>

mining

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

deposits

readonly deposits: {
  get: Promise<ResourceDepositView>;
  maybe: Promise<ResourceDepositView | undefined>;
};

deposits.get()

get(asteroid, options?): Promise<ResourceDepositView>;

Parameters

Parameter	Type
`asteroid`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ResourceDepositView>

deposits.maybe()

maybe(asteroid, options?): Promise<ResourceDepositView | undefined>;

Parameters

Parameter	Type
`asteroid`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ResourceDepositView | undefined>

fleets

readonly fleets: {
  byOwner: Promise<readonly FleetMiningView[]>;
  get: Promise<FleetMiningView | undefined>;
};

fleets.byOwner()

byOwner(owner, options?): Promise<readonly FleetMiningView[]>;

Parameters

Parameter	Type
`owner`	`Address`
`options?`	`MiningDiscoveryOptions`

Returns

Promise<readonly FleetMiningView[]>

fleets.get()

get(fleet, options?): Promise<FleetMiningView | undefined>;

Parameters

Parameter	Type
`fleet`	`Address`
`options?`	`ReadOptions`

Returns

Promise<FleetMiningView | undefined>

profiles

readonly profiles: {
  get: Promise<ProfileView>;
  maybe: Promise<ProfileView | undefined>;
};

Defined in: packages/sage/src/index.ts:457

get()

get(address, options?): Promise<ProfileView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ProfileView>

maybe()

maybe(address, options?): Promise<ProfileView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<ProfileView | undefined>

recipes

readonly recipes: {
  byId: Promise<RecipeView>;
  get: Promise<RecipeView>;
  maybe: Promise<RecipeView | undefined>;
};

Defined in: packages/sage/src/index.ts:481

byId()

byId(recipeId, options?): Promise<RecipeView>;

Parameters

Parameter	Type
`recipeId`	`number`
`options?`	`ReadOptions`

Returns

Promise<RecipeView>

get()

get(address, options?): Promise<RecipeView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<RecipeView>

maybe()

maybe(address, options?): Promise<RecipeView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<RecipeView | undefined>

starbases

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

byCharacter()

byCharacter(character, options?): Promise<readonly StarbasePlayerView[]>;

Parameters

Parameter	Type
`character`	`Address`
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbasePlayerView[]>

bySystem()

bySystem(system, options?): Promise<readonly StarbasePlayerView[]>;

Parameters

Parameter	Type
`system`	`Address`
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbasePlayerView[]>

forCharacterAtSystem()

forCharacterAtSystem(
   character,
   system,
options?): Promise<StarbasePlayerView>;

Parameters

Parameter	Type
`character`	`Address`
`system`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbasePlayerView>

get()

get(address, options?): Promise<StarbasePlayerView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbasePlayerView>

maybe()

maybe(address, options?): Promise<StarbasePlayerView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbasePlayerView | undefined>

starbaseUpgrades

readonly starbaseUpgrades: {
  byPlayer: Promise<readonly StarbaseUpgradeProcessView[]>;
  get: Promise<StarbaseUpgradeProcessView>;
  maybe: Promise<
     | StarbaseUpgradeProcessView
    | undefined>;
};

Defined in: packages/sage/src/index.ts:613

byPlayer()

byPlayer(player, options?): Promise<readonly StarbaseUpgradeProcessView[]>;

Parameters

Parameter	Type
`player`	`Address`
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbaseUpgradeProcessView[]>

get()

get(address, options?): Promise<StarbaseUpgradeProcessView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbaseUpgradeProcessView>

maybe()

maybe(address, options?): Promise<
  | StarbaseUpgradeProcessView
| undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise< | StarbaseUpgradeProcessView | undefined>

systems

readonly systems: {
  all: Promise<readonly StarSystemView[]>;
  byId: Promise<StarSystemView>;
  get: Promise<StarSystemView>;
  maybe: Promise<StarSystemView | undefined>;
};

Defined in: packages/sage/src/index.ts:627

all()

all(options?): Promise<readonly StarSystemView[]>;

Parameters

Parameter	Type
`options?`	`StarSystemDiscoveryOptions`

Returns

Promise<readonly StarSystemView[]>

byId()

byId(systemId, options?): Promise<StarSystemView>;

Parameters

Parameter	Type
`systemId`	`number`
`options?`	`ReadOptions`

Returns

Promise<StarSystemView>

get()

get(address, options?): Promise<StarSystemView>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarSystemView>

maybe()

maybe(address, options?): Promise<StarSystemView | undefined>;

Parameters

Parameter	Type
`address`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarSystemView | undefined>

wallets

readonly wallets: {
  get: WalletView;
};

Defined in: packages/sage/src/index.ts:454

get()

get(address): WalletView;

Parameters

Parameter	Type
`address`	`Address`

Returns

WalletView

Methods

dispose()

dispose(): Promise<void>;

Defined in: packages/sage/src/index.ts:646

Returns

Promise<void>

SageContext

Defined in: packages/sage/src/client/contracts.ts:667

Immutable context passed as the first argument to every domain function.

Disposing the context releases its cache and in-flight read registries.

Example

declare const rpc: SageRpc;
const ctx: SageContext = createSageContext({ cluster: 'zink-ptr', rpc });

Properties

cluster

readonly cluster: ClusterIdentity;

Defined in: packages/sage/src/client/contracts.ts:668

data

readonly data: SageDataPort;

Defined in: packages/sage/src/client/contracts.ts:670

game?

readonly optional game?: Address;

Defined in: packages/sage/src/client/contracts.ts:669

registrySnapshotStore?

readonly optional registrySnapshotStore?: RegistrySnapshotStore;

Defined in: packages/sage/src/client/contracts.ts:671

Methods

dispose()

dispose(): Promise<void>;

Defined in: packages/sage/src/client/contracts.ts:672

Returns

Promise<void>

SageSubscription

Defined in: packages/sage/src/client/contracts.ts:580

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

declare const subscription: SageSubscription;
await subscription.unsubscribe();

Methods

unsubscribe()

unsubscribe(): Promise<void>;

Defined in: packages/sage/src/client/contracts.ts:581

Returns

Promise<void>

ShipDefinitionSummary

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

Small, stable ship definition returned to gameplay domains.

Example

declare const ctx: SageContext;
const ship: ShipDefinitionSummary = await resolveShip(ctx, 3);

Extended by

Properties

id

readonly id: number;

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

mint

readonly mint: Address;

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

name

readonly name: string;

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

sizeClass

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

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

StarbasePlayerView

Defined in: packages/sage/src/index.ts:287

A loaded player-local Starbase with root-only upgrade traversal.

Example

declare const starbase: StarbasePlayerView;
const upgrades = await starbase.upgrades.all();
const craftingHabs = await starbase.craftingHabs.all();
const craftingProcesses = await starbase.craftingProcesses.all();

Extends

StarbasePlayerSnapshot

Properties

address

readonly address: Address;

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

Inherited from

StarbasePlayerSnapshot.address

availableCrew

readonly availableCrew: number;

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

Inherited from

StarbasePlayerSnapshot.availableCrew

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

Inherited from

StarbasePlayerSnapshot.cargo

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

Inherited from

StarbasePlayerSnapshot.character

craftingHabs

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

Defined in: packages/sage/src/index.ts:288

all()

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

Parameters

Parameter	Type
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingHabView[]>

craftingProcesses

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

Defined in: packages/sage/src/index.ts:293

all()

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

Parameters

Parameter	Type
`options?`	`CraftingDiscoveryOptions`

Returns

Promise<readonly CraftingProcessView[]>

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

Inherited from

StarbasePlayerSnapshot.kind

playerProfile

readonly playerProfile: EntityRef<"profile">;

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

Inherited from

StarbasePlayerSnapshot.playerProfile

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[];

Inherited from

StarbasePlayerSnapshot.respawning

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

Inherited from

StarbasePlayerView.shipsInEscrow

system

readonly system: EntityRef<"starSystem">;

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

Inherited from

StarbasePlayerSnapshot.system

totalCrew

readonly totalCrew: number;

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

Inherited from

StarbasePlayerAccountData.totalCrew

upgrades

readonly upgrades: {
  all: Promise<readonly StarbaseUpgradeProcessView[]>;
};

Defined in: packages/sage/src/index.ts:298

all()

all(options?): Promise<readonly StarbaseUpgradeProcessView[]>;

Parameters

Parameter	Type
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbaseUpgradeProcessView[]>

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

Inherited from

StarbasePlayerSnapshot.toJSON

StarbaseUpgradeProcessView

Defined in: packages/sage/src/index.ts:312

A loaded Starbase upgrade process exposed by the root client.

Example

declare const upgrade: StarbaseUpgradeProcessView;
console.log(upgrade.resource.name);

Extends

StarbaseUpgradeProcessSnapshot

Properties

address

readonly address: Address;

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

Inherited from

StarbaseUpgradeProcessSnapshot.address

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

Inherited from

StarbaseUpgradeProcessSnapshot.kind

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

Inherited from

StarbaseUpgradeProcessSnapshot.playerProfile

resource

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

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

Type Declaration

quantityRaw

readonly quantityRaw: bigint;

Inherited from

StarbaseUpgradeProcessSnapshot.resource

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

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

Inherited from

StarbaseUpgradeProcessSnapshot.starbasePlayer

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

Inherited from

StarbaseUpgradeProcessSnapshot.system

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

Inherited from

StarbaseUpgradeProcessSnapshot.toJSON

StarSystemView

Defined in: packages/sage/src/index.ts:398

A loaded StarSystem with explicit body projection relation accessors.

Example

declare const system: StarSystemView;
const planets = await system.planets.all();

Extends

StarSystemSnapshot

Properties

address

readonly address: Address;

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

Inherited from

StarSystemSnapshot.address

asteroids

readonly asteroids: {
  all: Promise<readonly AsteroidView[]>;
};

Defined in: packages/sage/src/index.ts:412

all()

all(options?): Promise<readonly AsteroidView[]>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<readonly AsteroidView[]>

celestialBodies

readonly celestialBodies: {
  all: Promise<readonly CelestialBodyView[]>;
};

Defined in: packages/sage/src/index.ts:406

all()

all(options?): Promise<readonly CelestialBodyView[]>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<readonly CelestialBodyView[]>

celestialBodyAddresses

readonly celestialBodyAddresses: readonly Address[];

Defined in: packages/sage/src/internal/c4/world.ts:317

Inherited from

StarSystemSnapshot.celestialBodyAddresses

connections

readonly connections: readonly WorldConnectionData[];

Defined in: packages/sage/src/internal/c4/world.ts:316

Inherited from

StarSystemSnapshot.connections

coordinates

readonly coordinates: WorldCoordinates;

Defined in: packages/sage/src/internal/c4/world.ts:314

Inherited from

StarSystemSnapshot.coordinates

factionMarket

readonly factionMarket: {
  get: Promise<FactionMarketView>;
};

Defined in: packages/sage/src/index.ts:403

get()

get(options?): Promise<FactionMarketView>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<FactionMarketView>

game

readonly game: Address;

Defined in: packages/sage/src/internal/c4/world.ts:310

Inherited from

StarSystemSnapshot.game

kind

readonly kind: "starSystem";

Defined in: packages/sage/src/world/index.ts:68

Inherited from

StarSystemSnapshot.kind

localMarkets

readonly localMarkets: {
  all: Promise<readonly LocalMarketView[]>;
  forCargo: Promise<LocalMarketView>;
};

Defined in: packages/sage/src/index.ts:399

all()

all(options?): Promise<readonly LocalMarketView[]>;

Parameters

Parameter	Type
`options?`	`MarketDiscoveryOptions`

Returns

Promise<readonly LocalMarketView[]>

forCargo()

forCargo(cargoId, options?): Promise<LocalMarketView>;

Parameters

Parameter	Type
`cargoId`	`number`
`options?`	`ReadOptions`

Returns

Promise<LocalMarketView>

name

readonly name: string;

Defined in: packages/sage/src/internal/c4/world.ts:312

Inherited from

StarSystemSnapshot.name

planets

readonly planets: {
  all: Promise<readonly PlanetView[]>;
};

Defined in: packages/sage/src/index.ts:409

all()

all(options?): Promise<readonly PlanetView[]>;

Parameters

Parameter	Type
`options?`	`ReadOptions`

Returns

Promise<readonly PlanetView[]>

playerStarbases

readonly playerStarbases: {
  all: Promise<readonly StarbasePlayerView[]>;
  forCharacter: Promise<StarbasePlayerView>;
};

Defined in: packages/sage/src/index.ts:415

all()

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

Parameters

Parameter	Type
`options?`	`StarbaseDiscoveryOptions`

Returns

Promise<readonly StarbasePlayerView[]>

forCharacter()

forCharacter(character, options?): Promise<StarbasePlayerView>;

Parameters

Parameter	Type
`character`	`Address`
`options?`	`ReadOptions`

Returns

Promise<StarbasePlayerView>

regionId?

readonly optional regionId?: number;

Defined in: packages/sage/src/internal/c4/world.ts:313

Inherited from

StarSystemSnapshot.regionId

sequenceId

readonly sequenceId: bigint;

Defined in: packages/sage/src/internal/c4/world.ts:315

Inherited from

StarSystemSnapshot.sequenceId

starbase?

readonly optional starbase?: WorldStarbaseData;

Defined in: packages/sage/src/internal/c4/world.ts:318

Inherited from

StarSystemSnapshot.starbase

systemId

readonly systemId: number;

Defined in: packages/sage/src/internal/c4/world.ts:311

Inherited from

StarSystemSnapshot.systemId

version

readonly version: number;

Defined in: packages/sage/src/internal/c4/world.ts:309

Inherited from

StarSystemSnapshot.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Inherited from

StarSystemSnapshot.toJSON

SubscriptionObserver

Defined in: packages/sage/src/client/contracts.ts:518

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

const observer: SubscriptionObserver<{ name: string }> = {
  onSnapshot: snapshot => console.log(snapshot.data.name),
  onError: error => console.error(error),
};

Type Parameters

Type Parameter
`TSnapshot`

Properties

onDiagnostic?

readonly optional onDiagnostic?: (event) => void;

Defined in: packages/sage/src/client/contracts.ts:524

Observes bounded-delivery coalescing without treating it as an error.

Parameters

Parameter	Type
`event`	`SubscriptionDiagnosticEvent`

Returns

void

onError

readonly onError: (error) => void | Promise<void>;

Defined in: packages/sage/src/client/contracts.ts:522

Parameters

Parameter	Type
`error`	`SageSdkError`

Returns

void | Promise<void>

onSnapshot

readonly onSnapshot: (snapshot) => void | Promise<void>;

Defined in: packages/sage/src/client/contracts.ts:519

Parameters

Parameter	Type
`snapshot`	`SnapshotEnvelope`<`TSnapshot`>

Returns

void | Promise<void>

WalletView

Defined in: packages/sage/src/index.ts:138

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

declare const sage: SageClient;
declare const walletAddress: Address;
const wallet: WalletView = sage.wallets.get(walletAddress);
const profiles = await wallet.profiles.all({ strategy: 'provider' });

Properties

address

readonly address: Address;

Defined in: packages/sage/src/index.ts:140

characters

readonly characters: {
  all: Promise<readonly CharacterView[]>;
};

Defined in: packages/sage/src/index.ts:146

all()

all(options): Promise<readonly CharacterView[]>;

Parameters

Parameter	Type
`options`	`WalletProfileDiscoveryOptions`

Returns

Promise<readonly CharacterView[]>

kind

readonly kind: "wallet";

Defined in: packages/sage/src/index.ts:139

profiles

readonly profiles: {
  all: Promise<readonly ProfileView[]>;
};

Defined in: packages/sage/src/index.ts:141

all()

all(options): Promise<readonly ProfileView[]>;

Parameters

Parameter	Type
`options`	`WalletProfileDiscoveryOptions`

Returns

Promise<readonly ProfileView[]>

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

AccountSubscriptionEvent

type AccountSubscriptionEvent =
  | {
  account: RawAccount;
  kind: "account";
}
  | {
  kind: "reconnected";
};

Defined in: packages/sage/src/client/contracts.ts:334

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

declare const account: RawAccount;
const event: AccountSubscriptionEvent = { kind: 'account', account };

Address

type Address = KitAddress;

Defined in: packages/sage/src/client/contracts.ts:19

A z.ink/Solana account address represented by @solana/kit.

Example

declare const profileAddress: Address;

CelestialBodyView

type CelestialBodyView =
  | PlanetView
  | AsteroidView;

Defined in: packages/sage/src/index.ts:389

A loaded CelestialBody root view projected as a Planet or Asteroid.

Example

declare const body: CelestialBodyView;
console.log(body.kind);

DefinitionSection

type DefinitionSection = "ships" | "cargo" | "craftingHabs" | "habBuildings" | "xp" | "research";

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

Definition sections implemented by the first registry slice.

Example

const section: DefinitionSection = 'ships';

DefinitionSectionSnapshot

type DefinitionSectionSnapshot =
  | {
  definitions: readonly ShipDefinitionSummary[];
  game: Address;
  schemaVersion: 1;
  section: "ships";
  sequenceId: number;
}
  | {
  definitions: readonly CargoDefinitionSummary[];
  game: Address;
  schemaVersion: 1;
  section: "cargo";
  sequenceId: number;
};

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

Serializable cold-start snapshot for one Game definitions section.

Example

declare const store: RegistrySnapshotStore;
declare const snapshot: DefinitionSectionSnapshot;
await store.save(snapshot);

SageContextOptions

type SageContextOptions =
  | SharedContextOptions & ContextTransport & {
  cluster: KnownCluster;
}
  | SharedContextOptions & ContextTransport & {
  cluster: CustomClusterIdentity;
  game: Address;
};

Defined in: packages/sage/src/client/contracts.ts:715

Configuration accepted by the synchronous context and client factories.

Custom clusters require an explicit canonical Game address.

Example

declare const rpc: SageRpc;
const options: SageContextOptions = { cluster: 'zink-ptr', rpc };

SubscriptionDiagnosticEvent

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

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

declare const address: Address;
const event: SubscriptionDiagnosticEvent = {
  kind: 'subscription-snapshot-coalesced',
  accountType: 'fleet',
  address,
  coalescedCount: 2,
};

SubscriptionOptions

type SubscriptionOptions = ReadAccountOptions;

Defined in: packages/sage/src/client/contracts.ts:566

Options for one context-owned subscription.

Example

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

Functions

createSageClient()

function createSageClient(options): SageClient;

Defined in: packages/sage/src/index.ts:1101

Creates the root client synchronously without performing network I/O.

Parameters

Parameter	Type
`options`	`SageContextOptions`

Returns

SageClient

Example

declare const rpc: SageRpc;
const sage = createSageClient({ cluster: 'zink-ptr', rpc });

readMeta()

function readMeta(result): ReadMeta | undefined;

Defined in: packages/sage/src/internal/read-meta.ts:98

Returns finder provenance without wrapping the finder result.

Parameters

Parameter	Type
`result`	`object`

Returns

ReadMeta | undefined

Example

declare const ctx: SageContext;
declare const profileAddress: Address;
const fleets = await getFleetsByOwner(ctx, profileAddress);
const meta = readMeta(fleets);

resolveCargo()

function resolveCargo(
   context,
   cargoId,
options?): Promise<CargoDefinitionSummary>;

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

Resolves one cargo id to an immutable SDK-owned definition summary.

Parameters

Parameter	Type
`context`	`SageContext`
`cargoId`	`number`
`options`	`DefinitionLookupOptions`

Returns

Promise<CargoDefinitionSummary>

Example

declare const ctx: SageContext;
declare const cargoId: number;
declare const expectedSequenceId: number;
const cargo = await resolveCargo(ctx, cargoId, { expectedSequenceId });

resolveShip()

function resolveShip(
   context,
   shipId,
options?): Promise<ShipDefinitionSummary>;

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

Resolves one ship id to an immutable SDK-owned definition summary.

Parameters

Parameter	Type
`context`	`SageContext`
`shipId`	`number`
`options`	`DefinitionLookupOptions`

Returns

Promise<ShipDefinitionSummary>

Example

declare const ctx: SageContext;
declare const fleet: { readonly shipId: number; readonly shipDefinitionsSeqId: number };
const ship = await resolveShip(ctx, fleet.shipId, { expectedSequenceId: fleet.shipDefinitionsSeqId });