# claim-stakes
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

Markdown source of https://develop.atlas-kit-docs.pages.dev/reference/claim-stakes/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

<a id="claimstakeaccountdata"></a>

### ClaimStakeAccountData

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:150](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L150)

Fully translated ClaimStakeInstance account data before registry joins.

#### Example

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

#### Properties

<a id="body"></a>

##### body

```ts
readonly body: Address;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L154)

<a id="buildingdefinitionseqid"></a>

##### buildingDefinitionSeqId

```ts
readonly buildingDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:157](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L157)

<a id="buildings"></a>

##### buildings

```ts
readonly buildings: readonly ClaimStakeBuildingData[];
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:164](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L164)

<a id="claimstakedefinitionid"></a>

##### claimStakeDefinitionId

```ts
readonly claimStakeDefinitionId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:155](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L155)

<a id="claimstakedefinitionseqid"></a>

##### claimStakeDefinitionSeqId

```ts
readonly claimStakeDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:156](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L156)

<a id="constructionprogressatunixseconds"></a>

##### constructionProgressAtUnixSeconds

```ts
readonly constructionProgressAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L161)

<a id="constructionremainingseconds"></a>

##### constructionRemainingSeconds

```ts
readonly constructionRemainingSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L160)

<a id="game"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L153)

<a id="lastrentatunixseconds"></a>

##### lastRentAtUnixSeconds

```ts
readonly lastRentAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L159)

<a id="neededcrew"></a>

##### neededCrew

```ts
readonly neededCrew: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:163](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L163)

<a id="ownercharacter"></a>

##### ownerCharacter

```ts
readonly ownerCharacter: Address;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:152](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L152)

<a id="production"></a>

##### production

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

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:166](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L166)

###### cargoPod

```ts
readonly cargoPod: ClaimStakeCargoPodData;
```

###### lastTickAtUnixSeconds

```ts
readonly lastTickAtUnixSeconds: bigint;
```

###### netResources

```ts
readonly netResources: readonly ClaimStakeResourceRateData[];
```

###### resourceCapacityRaw

```ts
readonly resourceCapacityRaw: bigint;
```

<a id="rentbalanceraw"></a>

##### rentBalanceRaw

```ts
readonly rentBalanceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:162](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L162)

<a id="state"></a>

##### state

```ts
readonly state: ClaimStakeStateData;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:165](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L165)

<a id="systemseqid"></a>

##### systemSeqId

```ts
readonly systemSeqId: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L158)

<a id="version"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L151)

***

<a id="claimstakebuildingdata"></a>

### ClaimStakeBuildingData

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:81](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L81)

One translated building quantity on a Claim Stake.

#### Example

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

#### Properties

<a id="buildingid"></a>

##### buildingId

```ts
readonly buildingId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:82](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L82)

<a id="quantity"></a>

##### quantity

```ts
readonly quantity: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:83](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L83)

***

<a id="claimstakecargoamountdata"></a>

### ClaimStakeCargoAmountData

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:93](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L93)

One unresolved resource quantity in the nested production CargoPod.

#### Example

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

#### Properties

<a id="amount"></a>

##### amount

```ts
readonly amount: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:95](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L95)

<a id="cargoid"></a>

##### cargoId

```ts
readonly cargoId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:94](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L94)

***

<a id="claimstakecargopoddata"></a>

### ClaimStakeCargoPodData

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L105)

The translated nested production CargoPod.

#### Example

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

#### Properties

<a id="amounts"></a>

##### amounts

```ts
readonly amounts: readonly ClaimStakeCargoAmountData[];
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L108)

<a id="seqid"></a>

##### seqId

```ts
readonly seqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L106)

<a id="storagecost"></a>

##### storageCost

```ts
readonly storageCost: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L107)

***

<a id="claimstakeresourcerate"></a>

### ClaimStakeResourceRate

Defined in: [packages/sage/src/internal/claim-stake.ts:19](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L19)

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

#### Example

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

#### Extends

- [`CargoDefinitionSummary`](/reference/#cargodefinitionsummary)

#### Properties

<a id="categoryid"></a>

##### categoryId

```ts
readonly categoryId: number;
```

Defined in: [packages/sage/src/registry/index.ts:105](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L105)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`categoryId`](/reference/#cargodefinitionsummary)

<a id="id"></a>

##### id

```ts
readonly id: number;
```

Defined in: [packages/sage/src/registry/index.ts:106](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L106)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`id`](/reference/#cargodefinitionsummary)

<a id="mint"></a>

##### mint

```ts
readonly mint: Address;
```

Defined in: [packages/sage/src/registry/index.ts:107](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L107)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`mint`](/reference/#cargodefinitionsummary)

<a id="name"></a>

##### name

```ts
readonly name: string;
```

Defined in: [packages/sage/src/registry/index.ts:108](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L108)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`name`](/reference/#cargodefinitionsummary)

<a id="ratepersecond"></a>

##### ratePerSecond

```ts
readonly ratePerSecond: number;
```

Defined in: [packages/sage/src/internal/claim-stake.ts:20](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L20)

<a id="ratepersecondraw"></a>

##### ratePerSecondRaw

```ts
readonly ratePerSecondRaw: bigint;
```

Defined in: [packages/sage/src/internal/claim-stake.ts:21](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L21)

<a id="storagecost-1"></a>

##### storageCost

```ts
readonly storageCost: number;
```

Defined in: [packages/sage/src/registry/index.ts:109](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/registry/index.ts#L109)

###### Inherited from

[`CargoDefinitionSummary`](/reference/#cargodefinitionsummary).[`storageCost`](/reference/#cargodefinitionsummary)

***

<a id="claimstakeresourceratedata"></a>

### ClaimStakeResourceRateData

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:118](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L118)

One unresolved net resource production rate.

#### Example

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

#### Properties

<a id="cargoid-1"></a>

##### cargoId

```ts
readonly cargoId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:119](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L119)

<a id="ratepersecond-1"></a>

##### ratePerSecond

```ts
readonly ratePerSecond: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:120](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L120)

<a id="ratepersecondraw-1"></a>

##### ratePerSecondRaw

```ts
readonly ratePerSecondRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:121](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L121)

***

<a id="claimstakeresources"></a>

### ClaimStakeResources

Defined in: [packages/sage/src/internal/claim-stake.ts:31](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L31)

Registry-resolved Claim Stake resource state.

#### Example

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

#### Properties

<a id="capacity"></a>

##### capacity

```ts
readonly capacity: CargoCapacity;
```

Defined in: [packages/sage/src/internal/claim-stake.ts:33](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L33)

<a id="inventory"></a>

##### inventory

```ts
readonly inventory: CargoPodInventory;
```

Defined in: [packages/sage/src/internal/claim-stake.ts:32](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L32)

<a id="lasttickatunixseconds"></a>

##### lastTickAtUnixSeconds

```ts
readonly lastTickAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/claim-stake.ts:35](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L35)

<a id="netproduction"></a>

##### netProduction

```ts
readonly netProduction: readonly ClaimStakeResourceRate[];
```

Defined in: [packages/sage/src/internal/claim-stake.ts:34](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/claim-stake.ts#L34)

***

<a id="claimstakesnapshot"></a>

### ClaimStakeSnapshot

Defined in: [packages/sage/src/claim-stakes/index.ts:68](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L68)

Immutable, translated Claim Stake snapshot.

#### Example

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

#### Extends

- `Omit`\<[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata), `"body"` \| `"ownerCharacter"` \| `"production"`\>

#### Extended by

- [`ClaimStakeView`](/reference/#claimstakeview)

#### Properties

<a id="address"></a>

##### address

```ts
readonly address: Address;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:73](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L73)

<a id="body-1"></a>

##### body

```ts
readonly body: EntityRef<"celestialBody">;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:74](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L74)

<a id="buildingdefinitionseqid-1"></a>

##### buildingDefinitionSeqId

```ts
readonly buildingDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:157](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L157)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`buildingDefinitionSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="buildings-1"></a>

##### buildings

```ts
readonly buildings: readonly ClaimStakeBuildingData[];
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:164](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L164)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`buildings`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="claimstakedefinitionid-1"></a>

##### claimStakeDefinitionId

```ts
readonly claimStakeDefinitionId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:155](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L155)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`claimStakeDefinitionId`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="claimstakedefinitionseqid-1"></a>

##### claimStakeDefinitionSeqId

```ts
readonly claimStakeDefinitionSeqId: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:156](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L156)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`claimStakeDefinitionSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="constructionprogressatunixseconds-1"></a>

##### constructionProgressAtUnixSeconds

```ts
readonly constructionProgressAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:161](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L161)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`constructionProgressAtUnixSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="constructionremainingseconds-1"></a>

##### constructionRemainingSeconds

```ts
readonly constructionRemainingSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:160](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L160)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`constructionRemainingSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="game-1"></a>

##### game

```ts
readonly game: Address;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:153](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L153)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`game`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="kind"></a>

##### kind

```ts
readonly kind: "claimStakeInstance";
```

Defined in: [packages/sage/src/claim-stakes/index.ts:72](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L72)

<a id="lastrentatunixseconds-1"></a>

##### lastRentAtUnixSeconds

```ts
readonly lastRentAtUnixSeconds: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:159](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L159)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`lastRentAtUnixSeconds`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="neededcrew-1"></a>

##### neededCrew

```ts
readonly neededCrew: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:163](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L163)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`neededCrew`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="ownercharacter-1"></a>

##### ownerCharacter

```ts
readonly ownerCharacter: EntityRef<"character">;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:75](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L75)

<a id="rentbalanceraw-1"></a>

##### rentBalanceRaw

```ts
readonly rentBalanceRaw: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:162](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L162)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`rentBalanceRaw`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="resources"></a>

##### resources

```ts
readonly resources: ClaimStakeResources;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:76](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L76)

<a id="state-1"></a>

##### state

```ts
readonly state: ClaimStakeStateData;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:165](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L165)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`state`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="systemseqid-1"></a>

##### systemSeqId

```ts
readonly systemSeqId: bigint;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:158](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L158)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`systemSeqId`](/reference/claim-stakes/#claimstakeaccountdata)

<a id="version-1"></a>

##### version

```ts
readonly version: number;
```

Defined in: [packages/sage/src/internal/c4/claim-stake.ts:151](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L151)

###### Inherited from

[`ClaimStakeAccountData`](/reference/claim-stakes/#claimstakeaccountdata).[`version`](/reference/claim-stakes/#claimstakeaccountdata)

#### Methods

<a id="tojson"></a>

##### toJSON()

```ts
toJSON(): unknown;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:77](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L77)

###### Returns

`unknown`

## Type Aliases

<a id="claimstakebuildingdefinition"></a>

### ClaimStakeBuildingDefinition

```ts
type ClaimStakeBuildingDefinition = GameClaimStakeBuildingDefinitionData;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:295](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L295)

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

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

***

<a id="claimstakedefinition"></a>

### ClaimStakeDefinition

```ts
type ClaimStakeDefinition = GameClaimStakeDefinitionData;
```

Defined in: [packages/sage/src/claim-stakes/index.ts:250](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L250)

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

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

***

<a id="claimstakediscoveryoptions"></a>

### ClaimStakeDiscoveryOptions

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

Defined in: [packages/sage/src/claim-stakes/index.ts:56](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L56)

Options supported by targeted Claim Stake discovery.

#### Example

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

***

<a id="claimstakestatedata"></a>

### ClaimStakeStateData

```ts
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](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/internal/c4/claim-stake.ts#L131)

Stable translated Claim Stake lifecycle state.

#### Example

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

## Functions

<a id="getclaimstake"></a>

### getClaimStake()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:154](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L154)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<[`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot)\>

#### Example

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

***

<a id="getclaimstakebuildingdefinition"></a>

### getClaimStakeBuildingDefinition()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:305](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L305)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `id` | `number` |

#### Returns

`Promise`\<`GameClaimStakeBuildingDefinitionData`\>

#### Example

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

***

<a id="getclaimstakedefinition"></a>

### getClaimStakeDefinition()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:261](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L261)

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`](/reference/#sagecontext) |
| `id` | `number` |

#### Returns

`Promise`\<`GameClaimStakeDefinitionData`\>

#### Example

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

***

<a id="getclaimstakesbybody"></a>

### getClaimStakesByBody()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:229](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L229)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `body` | [`Address`](/reference/#address-20) |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

#### Returns

`Promise`\<readonly [`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot)[]\>

#### Example

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

***

<a id="getclaimstakesbycharacter"></a>

### getClaimStakesByCharacter()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:209](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L209)

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `character` | [`Address`](/reference/#address-20) |
| `options?` | [`ClaimStakeDiscoveryOptions`](/reference/claim-stakes/#claimstakediscoveryoptions) |

#### Returns

`Promise`\<readonly [`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot)[]\>

#### Example

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

***

<a id="listclaimstakebuildingdefinitions"></a>

### listClaimStakeBuildingDefinitions()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:321](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L321)

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`](/reference/#sagecontext) |

#### Returns

`Promise`\<readonly `GameClaimStakeBuildingDefinitionData`[]\>

#### Example

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

***

<a id="listclaimstakedefinitions"></a>

### listClaimStakeDefinitions()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:277](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L277)

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`](/reference/#sagecontext) |

#### Returns

`Promise`\<readonly `GameClaimStakeDefinitionData`[]\>

#### Example

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

***

<a id="maybegetclaimstake"></a>

### maybeGetClaimStake()

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

Defined in: [packages/sage/src/claim-stakes/index.ts:174](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/claim-stakes/index.ts#L174)

Reads an optional Claim Stake by address.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `context` | [`SageContext`](/reference/#sagecontext) |
| `address` | [`Address`](/reference/#address-20) |
| `options?` | [`ReadOptions`](/reference/client/#readoptions) |

#### Returns

`Promise`\<
  \| [`ClaimStakeSnapshot`](/reference/claim-stakes/#claimstakesnapshot)
  \| `undefined`\>

#### Example

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