claim-stakes

Interfaces

ClaimStakeAccountData

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

Fully translated ClaimStakeInstance account data before registry joins.

Example

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

Properties

body

readonly body: Address;

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

buildingDefinitionSeqId

readonly buildingDefinitionSeqId: number;

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

buildings

readonly buildings: readonly ClaimStakeBuildingData[];

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

claimStakeDefinitionId

readonly claimStakeDefinitionId: number;

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

claimStakeDefinitionSeqId

readonly claimStakeDefinitionSeqId: number;

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

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

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

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

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

game

readonly game: Address;

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

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

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

neededCrew

readonly neededCrew: number;

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

ownerCharacter

readonly ownerCharacter: Address;

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

production

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

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

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

state

readonly state: ClaimStakeStateData;

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

systemSeqId

readonly systemSeqId: bigint;

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

version

readonly version: number;

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

---

ClaimStakeBuildingData

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

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

quantity

readonly quantity: number;

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

---

ClaimStakeCargoAmountData

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

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

cargoId

readonly cargoId: number;

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

---

ClaimStakeCargoPodData

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

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

seqId

readonly seqId: number;

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

storageCost

readonly storageCost: bigint;

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

---

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

Inherited from

CargoDefinitionSummary.categoryId

id

readonly id: number;

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

Inherited from

CargoDefinitionSummary.id

mint

readonly mint: Address;

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

Inherited from

CargoDefinitionSummary.mint

name

readonly name: string;

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

Inherited from

CargoDefinitionSummary.name

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

Inherited from

CargoDefinitionSummary.storageCost

---

ClaimStakeResourceRateData

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

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

ratePerSecond

readonly ratePerSecond: number;

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

ratePerSecondRaw

readonly ratePerSecondRaw: bigint;

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

---

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

Immutable, translated Claim Stake snapshot.

Example

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

Extends

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

Extended by

• ClaimStakeView

Properties

address

readonly address: Address;

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

body

readonly body: EntityRef<"celestialBody">;

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

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

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

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

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

Type Aliases

ClaimStakeDiscoveryOptions

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

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

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

Stable translated Claim Stake lifecycle state.

Example

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

Functions

getClaimStake()

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

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

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

---

getClaimStakesByBody()

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

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

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

---

getClaimStakesByCharacter()

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

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

Discovers Claim Stakes owned by a Character using stable targeted filters.

Parameters

Parameter	Type
context	SageContext
character	Address
options?	ClaimStakeDiscoveryOptions

Returns

Promise<readonly ClaimStakeSnapshot[]>

Example

declare const ctx: SageContext;
declare const character: Address;
const stakes = await getClaimStakesByCharacter(ctx, character);

---

maybeGetClaimStake()

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

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

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