crafting

Interfaces

CraftingCargoInventory

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

A registry-resolved nested crafting CargoPod.

Example

declare const inventory: CraftingCargoInventory;
console.log(inventory.items);

Properties

items

readonly items: readonly CraftingCargoItem[];

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

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

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

---

CraftingCargoItem

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

A registry-resolved cargo amount used by a Recipe or Crafting Process.

Example

declare const item: CraftingCargoItem;
console.log(item.name, item.quantityRaw);

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

quantityRaw

readonly quantityRaw: bigint;

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

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

---

CraftingDefinitionCargoItem

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

One resolved cargo quantity used by a Hab building definition.

Example

declare const item: CraftingDefinitionCargoItem;
console.log(item.quantityRaw);

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

quantityRaw

readonly quantityRaw: bigint;

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

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

---

CraftingHabBuilding

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

A resolved Crafting Hab building definition and placed quantity.

Example

declare const building: CraftingHabBuilding;
console.log(building.definition.name, building.quantity);

Properties

definition

readonly definition: {
  constructionCost: readonly CraftingDefinitionCargoItem[];
  constructionDurationSeconds: bigint;
  crewSlots: number;
  hubValue: number;
  id: number;
  jobCapacity: number;
  minimumTier: "one" | "two" | "three" | "four" | "five";
  modifiers: CraftingModifierData;
  name: string;
  neededCrew: number;
  netRates: readonly CargoDefinitionSummary & {
     unitsPerSecond: number;
     unitsPerSecondRaw: bigint;
  }[];
  providedTagIds: readonly number[];
  refunds: readonly CraftingDefinitionCargoItem[];
  requiredTagIds: readonly number[];
  researchRequirementIds: readonly number[];
  resourceCapacityRaw: bigint;
  slots: number;
  unlockedRecipes: readonly EntityRef<"recipe">[];
  xpValue: {
     raw: bigint;
     value: number;
  };
};

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

constructionCost

readonly constructionCost: readonly CraftingDefinitionCargoItem[];

constructionDurationSeconds

readonly constructionDurationSeconds: bigint;

crewSlots

readonly crewSlots: number;

hubValue

readonly hubValue: number;

id

readonly id: number;

jobCapacity

readonly jobCapacity: number;

minimumTier

readonly minimumTier: "one" | "two" | "three" | "four" | "five";

modifiers

readonly modifiers: CraftingModifierData;

name

readonly name: string;

neededCrew

readonly neededCrew: number;

netRates

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

providedTagIds

readonly providedTagIds: readonly number[];

refunds

readonly refunds: readonly CraftingDefinitionCargoItem[];

requiredTagIds

readonly requiredTagIds: readonly number[];

researchRequirementIds

readonly researchRequirementIds: readonly number[];

resourceCapacityRaw

readonly resourceCapacityRaw: bigint;

slots

readonly slots: number;

unlockedRecipes

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

xpValue

readonly xpValue: {
  raw: bigint;
  value: number;
};

xpValue.raw

readonly raw: bigint;

xpValue.value

readonly value: number;

quantity

readonly quantity: number;

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

---

CraftingHabDefinitionSummary

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

A resolved Crafting Hab definition from the Game registry.

Example

declare const definition: CraftingHabDefinitionSummary;
console.log(definition.name, definition.placementCargo.name);

Properties

evictionGracePeriodSeconds

readonly evictionGracePeriodSeconds: bigint;

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

hubValue

readonly hubValue: number;

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

id

readonly id: number;

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

name

readonly name: string;

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

placementCargo

readonly placementCargo: CargoDefinitionSummary;

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

placementFeeMultiplier

readonly placementFeeMultiplier: {
  raw: bigint;
  value: number;
};

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

raw

readonly raw: bigint;

value

readonly value: number;

providedTagIds

readonly providedTagIds: readonly number[];

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

rentMultiplier

readonly rentMultiplier: {
  raw: bigint;
  value: number;
};

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

raw

readonly raw: bigint;

value

readonly value: number;

requiredTagIds

readonly requiredTagIds: readonly number[];

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

respawnDurationSeconds

readonly respawnDurationSeconds: bigint;

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

slots

readonly slots: number;

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

tier

readonly tier: "one" | "two" | "three" | "four" | "five";

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

---

CraftingHabSnapshot

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

Immutable translated Crafting Hab infrastructure and production state.

Example

declare const hab: CraftingHabSnapshot;
console.log(hab.definition.name, hab.production.inventory.items);

Extends

• Omit<CraftingHabAccountData, | "buildings" | "game" | "ownerProfile" | "production" | "system" | "unlockedRecipeIds">

Extended by

• CraftingHabView

Properties

address

readonly address: Address;

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

availableJobSlots

readonly availableJobSlots: number;

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

buildingDefinitionSequenceId

readonly buildingDefinitionSequenceId: number;

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

Inherited from

Omit.buildingDefinitionSequenceId

buildings

readonly buildings: readonly CraftingHabBuilding[];

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

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

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

Inherited from

Omit.constructionProgressAtUnixSeconds

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

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

Inherited from

Omit.constructionRemainingSeconds

definition

readonly definition: CraftingHabDefinitionSummary;

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

definitionId

readonly definitionId: number;

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

Inherited from

Omit.definitionId

definitionSequenceId

readonly definitionSequenceId: number;

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

Inherited from

Omit.definitionSequenceId

game

readonly game: EntityRef<"game">;

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

jobCapacity

readonly jobCapacity: number;

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

Inherited from

Omit.jobCapacity

jobsRunning

readonly jobsRunning: number;

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

Inherited from

Omit.jobsRunning

kind

readonly kind: "craftingHabInstance";

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

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

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

Inherited from

Omit.lastRentAtUnixSeconds

modifiers

readonly modifiers: CraftingModifierData;

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

Inherited from

Omit.modifiers

neededCrew

readonly neededCrew: number;

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

Crew the Hab reserved, on a version-1 instance. A version-0 instance stores an unverified nominal value instead.

Inherited from

Omit.neededCrew

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

production

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

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

inventory

readonly inventory: CraftingCargoInventory;

lastTickAtUnixSeconds

readonly lastTickAtUnixSeconds: bigint;

netRates

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

resourceCapacityRaw

readonly resourceCapacityRaw: bigint;

rentBalanceRaw

readonly rentBalanceRaw: bigint;

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

Inherited from

Omit.rentBalanceRaw

state

readonly state: CraftingHabStateData;

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

Inherited from

Omit.state

system

readonly system: EntityRef<"starSystem">;

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

systemSequenceId

readonly systemSequenceId: bigint;

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

Inherited from

Omit.systemSequenceId

unlockedRecipes

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

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

CraftingProcessSnapshot

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

Immutable translated Crafting Process with resolved Recipe and inputs.

Example

declare const process: CraftingProcessSnapshot;
console.log(process.recipe.name, process.numCrew);

Extends

• Omit<CraftingProcessAccountData, | "craftingHab" | "inputs" | "profile" | "recipe" | "starbasePlayer" | "system">

Extended by

• CraftingProcessView

Properties

address

readonly address: Address;

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

craftingHab?

readonly optional craftingHab?: EntityRef<"craftingHabInstance">;

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

The Process Hab, or absent when crafting without a Hab.

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

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

Inherited from

Omit.endsAtUnixSeconds

feeEscrowAtlas

readonly feeEscrowAtlas: number;

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

feeEscrowRaw

readonly feeEscrowRaw: bigint;

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

Inherited from

Omit.feeEscrowRaw

feeGovernance?

readonly optional feeGovernance?: Address;

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

Captured governance address, if present; never inferred from the current Recipe.

Inherited from

Omit.feeGovernance

feeRecipient?

readonly optional feeRecipient?: "atlas" | "dao-atlas";

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

Captured original recipe destination; absent on legacy version 0 processes.

Inherited from

Omit.feeRecipient

feeSnapshot?

readonly optional feeSnapshot?: {
  craftingFeeBasisPoints: number;
  localMarketFeeBasisPoints: number;
  localTreasuryShareBasisPoints: number;
};

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

Captured routing rates; absent on legacy version 0 processes.

craftingFeeBasisPoints

readonly craftingFeeBasisPoints: number;

localMarketFeeBasisPoints

readonly localMarketFeeBasisPoints: number;

localTreasuryShareBasisPoints

readonly localTreasuryShareBasisPoints: number;

Inherited from

Omit.feeSnapshot

inputs

readonly inputs: CraftingCargoInventory;

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

kind

readonly kind: "craftingProcess";

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

numCrew

readonly numCrew: number;

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

Inherited from

Omit.numCrew

profile

readonly profile: EntityRef<"profile">;

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

quantityRaw

readonly quantityRaw: bigint;

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

Inherited from

Omit.quantityRaw

recipe

readonly recipe: RecipeSnapshot;

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

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

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

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

Inherited from

Omit.starbaseSequenceId

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

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

Inherited from

Omit.startsAtUnixSeconds

system

readonly system: EntityRef<"starSystem">;

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

RecipeSnapshot

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

Immutable translated Recipe definition.

usageCountRaw and usageLimitRaw are the stored u64 counters: how many Crafting Processes have been started from the Recipe and its maximum. A start consumes one use whatever its quantity, and is possible only while the count is below the limit, so a stored limit of 0n is never usable. Every Recipe observed on z.ink PTR stores 9007199254740991 (2^53 - 1) as its limit; see docs/evidence/crafting-zero-usage-limit.md.

Example

declare const recipe: RecipeSnapshot;
console.log(recipe.ingredients, recipe.outputs);

Extends

• Omit<RecipeAccountData, "game" | "id" | "inputs" | "outputs">

Extended by

• RecipeView

Properties

address

readonly address: Address;

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

craftingDurationSeconds

readonly craftingDurationSeconds: bigint;

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

Inherited from

Omit.craftingDurationSeconds

fee

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

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

amountAtlas

readonly amountAtlas: number;

amountRaw

readonly amountRaw: bigint;

recipient

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

Inherited from

Omit.fee

game

readonly game: EntityRef<"game">;

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

habRequired

readonly habRequired: boolean;

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

Inherited from

Omit.habRequired

id

readonly id: number;

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

ingredients

readonly ingredients: readonly CraftingCargoItem[];

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

kind

readonly kind: "recipe";

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

minimumDurationSeconds

readonly minimumDurationSeconds: bigint;

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

Inherited from

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

Inherited from

Omit.minimumStarbaseLevel

modifierBounds

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

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

crewCount

readonly crewCount: CraftingModifierBoundsData;

efficiency

readonly efficiency: CraftingModifierBoundsData;

fee

readonly fee: CraftingModifierBoundsData;

speed

readonly speed: CraftingModifierBoundsData;

Inherited from

Omit.modifierBounds

name

readonly name: string;

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

Inherited from

Omit.name

outputs

readonly outputs: readonly CraftingCargoItem[];

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

researchRequirementIds

readonly researchRequirementIds: readonly number[];

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

Inherited from

Omit.researchRequirementIds

status

readonly status: "active" | "deactivated";

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

Inherited from

Omit.status

usageCountRaw

readonly usageCountRaw: bigint;

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

Inherited from

Omit.usageCountRaw

usageLimitRaw

readonly usageLimitRaw: bigint;

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

Inherited from

Omit.usageLimitRaw

version

readonly version: number;

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

Inherited from

Omit.version

xpValueRaw

readonly xpValueRaw: bigint;

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

Inherited from

Omit.xpValueRaw

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

CraftingDiscoveryOptions

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

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

Options supported by targeted crafting discovery.

Example

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

---

CraftingHabDefinition

type CraftingHabDefinition = GameCraftingHabDefinitionData;

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

Immutable Crafting Hab container definition from the loaded Game catalog.

Unlike a placed Hab’s CraftingHabDefinitionSummary, this independent definition keeps its placement cargoId without resolving cargo. Multipliers retain dimensionless exact raw bigint and ergonomic values. Global eviction and respawn durations remain exact seconds. JSON serializes bigint as decimal strings; the loaded catalog does not assert current chain freshness.

Example

declare const definition: CraftingHabDefinition;
console.log(definition.name, definition.cargoId, definition.rentMultiplier.raw);

---

CraftingProcessState

type CraftingProcessState =
  | {
  kind: "scheduled";
}
  | {
  kind: "in-progress";
  remainingSeconds: bigint;
}
  | {
  kind: "complete";
};

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

Pure lifecycle projection for one Crafting Process at a given Unix time.

Example

const state: CraftingProcessState = { kind: 'scheduled' };

---

HabBuildingDefinition

type HabBuildingDefinition = GameHabBuildingDefinitionData;

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

Immutable Hab building definition from the loaded Game catalog. Keeps the existing Hab-specific modifiers, job capacity and unlocked recipes; this is configuration, not the output of a placed building. Fixed-point values retain exact raw bigint, and JSON serializes bigint as decimal strings.

Example

declare const definition: HabBuildingDefinition;
console.log(definition.modifiers.speed.value, definition.unlockedRecipeIds);

Functions

deriveCraftingProcessState()

function deriveCraftingProcessState(process, atUnixSeconds): CraftingProcessState;

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

Derives the scheduled, active, or complete state at a Unix timestamp.

Parameters

Parameter	Type
process	Pick<CraftingProcessSnapshot, "startsAtUnixSeconds" | "endsAtUnixSeconds">
atUnixSeconds	bigint

Returns

CraftingProcessState

Example

declare const process: CraftingProcessSnapshot;
const state = deriveCraftingProcessState(process, 1_700_000_000n);

---

getCraftingHab()

function getCraftingHab(
   context,
   address,
options?): Promise<CraftingHabSnapshot>;

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

Reads a required Crafting Hab by its signer-created account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<CraftingHabSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const hab = await getCraftingHab(ctx, address);

---

getCraftingHabDefinition()

function getCraftingHabDefinition(context, id): Promise<GameCraftingHabDefinitionData>;

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

Loads one Crafting Hab container definition by its Game table id. The catalog loads lazily without fetching a placed Hab or its placement cargo.

Parameters

Parameter	Type
context	SageContext
id	number

Returns

Promise<GameCraftingHabDefinitionData>

Example

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

---

getCraftingHabsByCharacter()

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

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

Discovers Crafting Habs for the Profile stored by one Character.

Parameters

Parameter	Type
context	SageContext
character	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingHabSnapshot[]>

Example

declare const ctx: SageContext;
declare const character: Address;
const habs = await getCraftingHabsByCharacter(ctx, character);

---

getCraftingHabsByProfile()

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

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

Discovers Crafting Habs owned by one Player Profile.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingHabSnapshot[]>

Example

declare const ctx: SageContext;
declare const profile: Address;
const habs = await getCraftingHabsByProfile(ctx, profile);

---

getCraftingHabsByStarbasePlayer()

function getCraftingHabsByStarbasePlayer(
   context,
   player,
options?): Promise<readonly CraftingHabSnapshot[]>;

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

Discovers Crafting Habs for the Profile and System stored by a StarbasePlayer.

Parameters

Parameter	Type
context	SageContext
player	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingHabSnapshot[]>

Example

declare const ctx: SageContext;
declare const player: Address;
const habs = await getCraftingHabsByStarbasePlayer(ctx, player);

---

getCraftingProcess()

function getCraftingProcess(
   context,
   address,
options?): Promise<CraftingProcessSnapshot>;

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

Reads a required Crafting Process by its signer-created account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<CraftingProcessSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const process = await getCraftingProcess(ctx, address);

---

getCraftingProcessesByCharacter()

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

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

Discovers Crafting Processes for the Profile stored by one Character.

Parameters

Parameter	Type
context	SageContext
character	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingProcessSnapshot[]>

Example

declare const ctx: SageContext;
declare const character: Address;
const processes = await getCraftingProcessesByCharacter(ctx, character);

---

getCraftingProcessesByProfile()

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

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

Discovers Crafting Processes belonging to one Player Profile.

Parameters

Parameter	Type
context	SageContext
profile	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingProcessSnapshot[]>

Example

declare const ctx: SageContext;
declare const profile: Address;
const processes = await getCraftingProcessesByProfile(ctx, profile);

---

getCraftingProcessesByStarbasePlayer()

function getCraftingProcessesByStarbasePlayer(
   context,
   player,
options?): Promise<readonly CraftingProcessSnapshot[]>;

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

Discovers Crafting Processes linked to one StarbasePlayer.

Parameters

Parameter	Type
context	SageContext
player	Address
options?	CraftingDiscoveryOptions

Returns

Promise<readonly CraftingProcessSnapshot[]>

Example

declare const ctx: SageContext;
declare const player: Address;
const processes = await getCraftingProcessesByStarbasePlayer(ctx, player);

---

getHabBuildingDefinition()

function getHabBuildingDefinition(context, id): Promise<GameHabBuildingDefinitionData>;

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

Loads one Hab building definition without fetching a placed Crafting Hab. The returned definition reflects the loaded section, not proven-current chain state.

Parameters

Parameter	Type
context	SageContext
id	number

Returns

Promise<GameHabBuildingDefinitionData>

Example

declare const ctx: SageContext;
const building = await getHabBuildingDefinition(ctx, 7);
console.log(building.jobCapacity, building.constructionDurationSeconds);

---

getRecipe()

function getRecipe(
   context,
   address,
options?): Promise<RecipeSnapshot>;

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

Reads a required Recipe by its derived account address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<RecipeSnapshot>

Example

declare const ctx: SageContext;
declare const address: Address;
const recipe = await getRecipe(ctx, address);

---

getRecipeById()

function getRecipeById(
   context,
   recipeId,
options?): Promise<RecipeSnapshot>;

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

Derives and reads one Recipe from the configured Game and recipe id.

Parameters

Parameter	Type
context	SageContext
recipeId	number
options?	ReadOptions

Returns

Promise<RecipeSnapshot>

Example

declare const ctx: SageContext;
const recipe = await getRecipeById(ctx, 7);

---

listCraftingHabDefinitions()

function listCraftingHabDefinitions(context): Promise<readonly GameCraftingHabDefinitionData[]>;

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

Lists the loaded Crafting Hab containers as immutable canonical definitions. The array is retained per section generation and shares by-id lookup objects. Refresh replaces both together; previously returned arrays remain immutable snapshots. This catalog carries no proof of latest chain state or sort order.

Parameters

Parameter	Type
context	SageContext

Returns

Promise<readonly GameCraftingHabDefinitionData[]>

Example

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

---

listHabBuildingDefinitions()

function listHabBuildingDefinitions(context): Promise<readonly GameHabBuildingDefinitionData[]>;

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

Lists the loaded Hab building catalog as immutable canonical definitions. Shares objects with by-id lookups and retains the array for its section generation. Refresh replaces both together; older returned arrays remain immutable snapshots. No sort order or latest-chain freshness is promised.

Parameters

Parameter	Type
context	SageContext

Returns

Promise<readonly GameHabBuildingDefinitionData[]>

Example

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

---

listRecipes()

function listRecipes(context, options?): Promise<readonly RecipeSnapshot[]>;

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

Discovers every Recipe reported for the configured Game, active or deactivated. Returns frozen snapshots sorted by numeric id; reported failures reject the entire catalog. Each completed call reconsults discovery (a configured indexer takes precedence), but cargo definitions may be reused by the context registry. no-store prevents discovered Recipe cache writes, not registry retention. Recipe commitment applies to discovery and direct candidate validation; cargo resolution uses the context commitment. Read metadata is provenance, not an atomic-slot or provider-completeness guarantee.

Parameters

Parameter	Type
context	SageContext
options?	CraftingDiscoveryOptions

Returns

Promise<readonly RecipeSnapshot[]>

Example

declare const ctx: SageContext;
const recipes = await listRecipes(ctx, { policy: 'no-store' });
console.log(recipes.map(recipe => recipe.name));

---

maybeGetCraftingHab()

function maybeGetCraftingHab(
   context,
   address,
   options?): Promise<
  | CraftingHabSnapshot
| undefined>;

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

Reads an optional Crafting Hab by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | CraftingHabSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const hab = await maybeGetCraftingHab(ctx, address);

---

maybeGetCraftingProcess()

function maybeGetCraftingProcess(
   context,
   address,
   options?): Promise<
  | CraftingProcessSnapshot
| undefined>;

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

Reads an optional Crafting Process by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise< | CraftingProcessSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const process = await maybeGetCraftingProcess(ctx, address);

---

maybeGetRecipe()

function maybeGetRecipe(
   context,
   address,
options?): Promise<RecipeSnapshot | undefined>;

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

Reads an optional Recipe by address.

Parameters

Parameter	Type
context	SageContext
address	Address
options?	ReadOptions

Returns

Promise<RecipeSnapshot | undefined>

Example

declare const ctx: SageContext;
declare const address: Address;
const recipe = await maybeGetRecipe(ctx, address);