claim-stakes

Interfaces

ClaimStakeAccountData

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

Fully translated ClaimStakeInstance account data before registry joins.

Example

declare const stake: ClaimStakeAccountData;
console.log(stake.ownerProfile, stake.body);

Properties

body

readonly body: Address;

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

buildingDefinitionSeqId

readonly buildingDefinitionSeqId: number;

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

buildings

readonly buildings: readonly ClaimStakeBuildingData[];

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

claimStakeDefinitionId

readonly claimStakeDefinitionId: number;

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

claimStakeDefinitionSeqId

readonly claimStakeDefinitionSeqId: number;

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

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

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

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

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

game

readonly game: Address;

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

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

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

neededCrew

readonly neededCrew: number;

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

Crew the stake committed, on a version-1 instance. A version-0 instance stores an unverified nominal value instead, and cannot be finalized or deconstructed.

ownerProfile

readonly ownerProfile: Address;

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

production

readonly production: {
  cargoPod: ClaimStakeCargoPodData;
  lastTickAtUnixSeconds: bigint;
  netResources: readonly ClaimStakeResourceRateData[];
  resourceCapacityRaw: bigint;
};

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

cargoPod

readonly cargoPod: ClaimStakeCargoPodData;

lastTickAtUnixSeconds

readonly lastTickAtUnixSeconds: bigint;

netResources

readonly netResources: readonly ClaimStakeResourceRateData[];

resourceCapacityRaw

readonly resourceCapacityRaw: bigint;

rentBalanceRaw

readonly rentBalanceRaw: bigint;

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

state

readonly state: ClaimStakeStateData;

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

systemSeqId

readonly systemSeqId: bigint;

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

version

readonly version: number;

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

---

ClaimStakeBuildingData

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

One translated building quantity on a Claim Stake.

Example

declare const building: ClaimStakeBuildingData;
console.log(building.buildingId, building.quantity);

Properties

buildingId

readonly buildingId: number;

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

quantity

readonly quantity: number;

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

---

ClaimStakeCargoAmountData

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

One unresolved resource quantity in the nested production CargoPod.

Example

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

Properties

amount

readonly amount: bigint;

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

cargoId

readonly cargoId: number;

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

---

ClaimStakeCargoPodData

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

The translated nested production CargoPod.

Example

declare const pod: ClaimStakeCargoPodData;
console.log(pod.storageCost, pod.amounts);

Properties

amounts

readonly amounts: readonly ClaimStakeCargoAmountData[];

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

seqId

readonly seqId: number;

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

storageCost

readonly storageCost: bigint;

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

---

ClaimStakeResourceRate

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

One registry-resolved Claim Stake net production or consumption rate.

Example

declare const rate: ClaimStakeResourceRate;
console.log(rate.name, rate.ratePerSecond);

Extends

• CargoDefinitionSummary

Properties

categoryId

readonly categoryId: number;

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

Inherited from

CargoDefinitionSummary.categoryId

id

readonly id: number;

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

Inherited from

CargoDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

CargoDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

CargoDefinitionSummary.name

ratePerSecond

readonly ratePerSecond: number;

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

ratePerSecondRaw

readonly ratePerSecondRaw: bigint;

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

storageCost

readonly storageCost: number;

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

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

Inherited from

CargoDefinitionSummary.storageCost

---

ClaimStakeResourceRateData

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

One unresolved net resource production rate.

Example

declare const resource: ClaimStakeResourceRateData;
console.log(resource.ratePerSecond);

Properties

cargoId

readonly cargoId: number;

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

ratePerSecond

readonly ratePerSecond: number;

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

ratePerSecondRaw

readonly ratePerSecondRaw: bigint;

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

---

ClaimStakeResources

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

Registry-resolved Claim Stake resource state.

Example

declare const resources: ClaimStakeResources;
console.log(resources.capacity.remainingRaw);

Properties

capacity

readonly capacity: CargoCapacity;

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

inventory

readonly inventory: CargoPodInventory;

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

lastTickAtUnixSeconds

readonly lastTickAtUnixSeconds: bigint;

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

netProduction

readonly netProduction: readonly ClaimStakeResourceRate[];

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

---

ClaimStakeSnapshot

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

Immutable, translated Claim Stake snapshot.

Example

declare const stake: ClaimStakeSnapshot;
console.log(stake.state.kind, stake.resources.capacity.remainingRaw);

Extends

• Omit<ClaimStakeAccountData, "body" | "ownerProfile" | "production">

Extended by

• ClaimStakeView

Properties

address

readonly address: Address;

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

body

readonly body: EntityRef<"celestialBody">;

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

buildingDefinitionSeqId

readonly buildingDefinitionSeqId: number;

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

Inherited from

ClaimStakeAccountData.buildingDefinitionSeqId

buildings

readonly buildings: readonly ClaimStakeBuildingData[];

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

Inherited from

ClaimStakeAccountData.buildings

claimStakeDefinitionId

readonly claimStakeDefinitionId: number;

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

Inherited from

ClaimStakeAccountData.claimStakeDefinitionId

claimStakeDefinitionSeqId

readonly claimStakeDefinitionSeqId: number;

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

Inherited from

ClaimStakeAccountData.claimStakeDefinitionSeqId

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

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

Inherited from

ClaimStakeAccountData.constructionProgressAtUnixSeconds

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

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

Inherited from

ClaimStakeAccountData.constructionRemainingSeconds

game

readonly game: Address;

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

Inherited from

ClaimStakeAccountData.game

kind

readonly kind: "claimStakeInstance";

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

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

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

Inherited from

ClaimStakeAccountData.lastRentAtUnixSeconds

neededCrew

readonly neededCrew: number;

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

Crew the stake committed, on a version-1 instance. A version-0 instance stores an unverified nominal value instead, and cannot be finalized or deconstructed.

Inherited from

ClaimStakeAccountData.neededCrew

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

rentBalanceRaw

readonly rentBalanceRaw: bigint;

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

Inherited from

ClaimStakeAccountData.rentBalanceRaw

resources

readonly resources: ClaimStakeResources;

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

state

readonly state: ClaimStakeStateData;

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

Inherited from

ClaimStakeAccountData.state

systemSeqId

readonly systemSeqId: bigint;

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

Inherited from

ClaimStakeAccountData.systemSeqId

version

readonly version: number;

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

Inherited from

ClaimStakeAccountData.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

ClaimStakeBuildingDefinition

type ClaimStakeBuildingDefinition = GameClaimStakeBuildingDefinitionData;

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

Immutable Building definition for Claim Stakes, not placed production state. Construction duration is exact signed seconds; crewSlots and power preserve signed on-chain integers. XP is U16F16. Production rates are I54F10 and extraction rates U54F10 (raw / 1024); no time denominator or gameplay formula is inferred. Raw capacity/quantities and fixed-point raw values remain bigint. JSON converts bigint to decimal strings. Hab-only fields are not included.

Example

declare const definition: ClaimStakeBuildingDefinition;
console.log(definition.power, definition.netResourceProduction);

---

ClaimStakeDefinition

type ClaimStakeDefinition = GameClaimStakeDefinitionData;

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

Immutable Claim Stake container definition, distinct from a placed instance. Both multipliers are dimensionless U8F56 values: raw / 2^56 gives value. Exact raw bigint supports arithmetic; JSON serializes raw as decimal strings.

Example

declare const definition: ClaimStakeDefinition;
console.log(definition.rentMultiplier.raw, definition.placementFeeMultiplier.value);

---

ClaimStakeDiscoveryOptions

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

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

Options supported by targeted Claim Stake discovery.

Example

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

---

ClaimStakeStateData

type ClaimStakeStateData =
  | {
  kind: "active";
}
  | {
  buildings: readonly ClaimStakeBuildingData[];
  kind: "design";
  sequenceId: number;
}
  | {
  deactivatedAtUnixSeconds: bigint;
  kind: "deactivated";
};

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

Stable translated Claim Stake lifecycle state.

Example

declare const state: ClaimStakeStateData;
console.log(state.kind);

Functions

getAllClaimStakes()

function getAllClaimStakes(context, options?): Promise<readonly ClaimStakeSnapshot[]>;

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

Discovers all extant Claim Stake instances for the context Game. Includes active, design and deactivated states without traversing bodies or Characters. Uses the configured indexer or targeted RPC discovery, subject to context limits; excessive results reject rather than truncate. Provider freshness and per-account slots do not establish an atomic Game snapshot. Stored body references may be unresolved. Inspect provenance with readMeta.

Parameters

Parameter	Type
context	SageContext
options?	ClaimStakeDiscoveryOptions

Returns

Promise<readonly ClaimStakeSnapshot[]>

Example

declare const ctx: SageContext;
const stakes = await getAllClaimStakes(ctx);
for (const stake of stakes) console.log(stake.address, stake.state.kind);

---

getClaimStake()

function getClaimStake(
   context,
   address,
options?): Promise<ClaimStakeSnapshot>;

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

Reads a required Claim Stake by its signer-created account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<ClaimStakeSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const stake = await getClaimStake(ctx, address);

---

getClaimStakeBuildingDefinition()

function getClaimStakeBuildingDefinition(context, id): Promise<GameClaimStakeBuildingDefinitionData>;

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

Loads one Claim Stake Building definition by its Game Building table id.

Parameters

Parameter	Type
context	SageContext
id	number

Returns

Promise<GameClaimStakeBuildingDefinitionData>

Example

declare const ctx: SageContext;
const building = await getClaimStakeBuildingDefinition(ctx, 2175);
console.log(building.constructionDurationSeconds);

---

getClaimStakeDefinition()

function getClaimStakeDefinition(context, id): Promise<GameClaimStakeDefinitionData>;

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

Loads one Claim Stake container definition by its Game table id. Loads the container catalog lazily; this does not fetch a placed instance.

Parameters

Parameter	Type
context	SageContext
id	number

Returns

Promise<GameClaimStakeDefinitionData>

Example

declare const ctx: SageContext;
const definition = await getClaimStakeDefinition(ctx, 7);
console.log(definition.slots);

---

getClaimStakesByBody()

function getClaimStakesByBody(
   context,
   body,
options?): Promise<readonly ClaimStakeSnapshot[]>;

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

Discovers Claim Stakes placed on a Celestial Body using stable targeted filters.

Parameters

Parameter	Type
context	SageContext
body	Address
options?	ClaimStakeDiscoveryOptions

Returns

Promise<readonly ClaimStakeSnapshot[]>

Example

declare const ctx: SageContext;
declare const body: Address;
const stakes = await getClaimStakesByBody(ctx, body);

---

getClaimStakesByProfile()

function getClaimStakesByProfile(
   context,
   profile,
options?): Promise<readonly ClaimStakeSnapshot[]>;

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

Discovers Claim Stakes owned by a Profile using stable targeted filters. The chain records a Claim Stake’s owner as the Profile, not its Character.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	ClaimStakeDiscoveryOptions

Returns

Promise<readonly ClaimStakeSnapshot[]>

Example

declare const ctx: SageContext;
declare const profile: Address;
const stakes = await getClaimStakesByProfile(ctx, profile);

---

listClaimStakeBuildingDefinitions()

function listClaimStakeBuildingDefinitions(context): Promise<readonly GameClaimStakeBuildingDefinitionData[]>;

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

Lists immutable canonical Claim Stake Building definitions in table order. Shares objects with by-id catalog lookups, not with fresh planner observations.

Parameters

Parameter	Type
context	SageContext

Returns

Promise<readonly GameClaimStakeBuildingDefinitionData[]>

Example

declare const ctx: SageContext;
const buildings = await listClaimStakeBuildingDefinitions(ctx);
console.log(buildings.map(building => building.name));

---

listClaimStakeDefinitions()

function listClaimStakeDefinitions(context): Promise<readonly GameClaimStakeDefinitionData[]>;

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

Lists the loaded Claim Stake container catalog as immutable canonical objects. The array is retained per section generation and shares by-id lookup objects.

Parameters

Parameter	Type
context	SageContext

Returns

Promise<readonly GameClaimStakeDefinitionData[]>

Example

declare const ctx: SageContext;
const definitions = await listClaimStakeDefinitions(ctx);
console.log(definitions.map(definition => definition.name));

---

maybeGetClaimStake()

function maybeGetClaimStake(
   context,
   address,
   options?): Promise<
  | ClaimStakeSnapshot
| undefined>;

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

Reads an optional Claim Stake by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | ClaimStakeSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const stake = await maybeGetClaimStake(ctx, address);