crafting

Interfaces

CraftingCargoInventory

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

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

sequenceId

readonly sequenceId: number;

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

usedStorageUnitsRaw

readonly usedStorageUnitsRaw: bigint;

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

---

CraftingCargoItem

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

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

quantityRaw

readonly quantityRaw: bigint;

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

storageCost

readonly storageCost: number;

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

Inherited from

CargoDefinitionSummary.storageCost

---

CraftingDefinitionCargoItem

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

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

quantityRaw

readonly quantityRaw: bigint;

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

storageCost

readonly storageCost: number;

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

Inherited from

CargoDefinitionSummary.storageCost

---

CraftingHabBuilding

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

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

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

---

CraftingHabDefinitionSummary

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

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

hubValue

readonly hubValue: number;

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

id

readonly id: number;

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

name

readonly name: string;

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

placementCargo

readonly placementCargo: CargoDefinitionSummary;

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

placementFeeMultiplier

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

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

raw

readonly raw: bigint;

value

readonly value: number;

providedTagIds

readonly providedTagIds: readonly number[];

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

rentMultiplier

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

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

raw

readonly raw: bigint;

value

readonly value: number;

requiredTagIds

readonly requiredTagIds: readonly number[];

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

respawnDurationSeconds

readonly respawnDurationSeconds: bigint;

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

slots

readonly slots: number;

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

tier

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

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

---

CraftingHabSnapshot

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

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

availableJobSlots

readonly availableJobSlots: number;

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

buildingDefinitionSequenceId

readonly buildingDefinitionSequenceId: number;

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

Inherited from

Omit.buildingDefinitionSequenceId

buildings

readonly buildings: readonly CraftingHabBuilding[];

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

constructionProgressAtUnixSeconds

readonly constructionProgressAtUnixSeconds: bigint;

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

Inherited from

Omit.constructionProgressAtUnixSeconds

constructionRemainingSeconds

readonly constructionRemainingSeconds: bigint;

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

Inherited from

Omit.constructionRemainingSeconds

definition

readonly definition: CraftingHabDefinitionSummary;

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

definitionId

readonly definitionId: number;

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

Inherited from

Omit.definitionId

definitionSequenceId

readonly definitionSequenceId: number;

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

Inherited from

Omit.definitionSequenceId

game

readonly game: EntityRef<"game">;

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

jobCapacity

readonly jobCapacity: number;

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

Inherited from

Omit.jobCapacity

jobsRunning

readonly jobsRunning: number;

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

Inherited from

Omit.jobsRunning

kind

readonly kind: "craftingHabInstance";

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

lastRentAtUnixSeconds

readonly lastRentAtUnixSeconds: bigint;

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

Inherited from

Omit.lastRentAtUnixSeconds

modifiers

readonly modifiers: CraftingModifierData;

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

Inherited from

Omit.modifiers

neededCrew

readonly neededCrew: number;

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

Inherited from

Omit.neededCrew

ownerProfile

readonly ownerProfile: EntityRef<"profile">;

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

production

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

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

inventory

readonly inventory: CraftingCargoInventory;

lastTickAtUnixSeconds

readonly lastTickAtUnixSeconds: bigint;

netRates

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

resourceCapacityRaw

readonly resourceCapacityRaw: bigint;

rentBalanceRaw

readonly rentBalanceRaw: bigint;

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

Inherited from

Omit.rentBalanceRaw

state

readonly state: CraftingHabStateData;

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

Inherited from

Omit.state

system

readonly system: EntityRef<"starSystem">;

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

systemSequenceId

readonly systemSequenceId: bigint;

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

Inherited from

Omit.systemSequenceId

unlockedRecipes

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

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

CraftingProcessSnapshot

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

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

craftingHab

readonly craftingHab: EntityRef<"craftingHabInstance">;

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

endsAtUnixSeconds

readonly endsAtUnixSeconds: bigint;

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

Inherited from

Omit.endsAtUnixSeconds

feeEscrowAtlas

readonly feeEscrowAtlas: number;

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

feeEscrowRaw

readonly feeEscrowRaw: bigint;

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

Inherited from

Omit.feeEscrowRaw

inputs

readonly inputs: CraftingCargoInventory;

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

kind

readonly kind: "craftingProcess";

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

numCrew

readonly numCrew: number;

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

Inherited from

Omit.numCrew

profile

readonly profile: EntityRef<"profile">;

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

quantityRaw

readonly quantityRaw: bigint;

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

Inherited from

Omit.quantityRaw

recipe

readonly recipe: RecipeSnapshot;

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

starbasePlayer

readonly starbasePlayer: EntityRef<"starbasePlayer">;

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

starbaseSequenceId

readonly starbaseSequenceId: bigint;

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

Inherited from

Omit.starbaseSequenceId

startsAtUnixSeconds

readonly startsAtUnixSeconds: bigint;

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

Inherited from

Omit.startsAtUnixSeconds

system

readonly system: EntityRef<"starSystem">;

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

version

readonly version: number;

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

Inherited from

Omit.version

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

---

RecipeSnapshot

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

Immutable translated Recipe definition.

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

craftingDurationSeconds

readonly craftingDurationSeconds: bigint;

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

Inherited from

Omit.craftingDurationSeconds

fee

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

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

amountAtlas

readonly amountAtlas: number;

amountRaw

readonly amountRaw: bigint;

recipient

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

Inherited from

Omit.fee

game

readonly game: EntityRef<"game">;

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

habRequired

readonly habRequired: boolean;

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

Inherited from

Omit.habRequired

id

readonly id: number;

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

ingredients

readonly ingredients: readonly CraftingCargoItem[];

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

kind

readonly kind: "recipe";

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

minimumDurationSeconds

readonly minimumDurationSeconds: bigint;

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

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

Inherited from

Omit.minimumStarbaseLevel

modifierBounds

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

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

crewCount

readonly crewCount: CraftingModifierBoundsData;

efficiency

readonly efficiency: CraftingModifierBoundsData;

fee

readonly fee: CraftingModifierBoundsData;

speed

readonly speed: CraftingModifierBoundsData;

Inherited from

Omit.modifierBounds

name

readonly name: string;

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

Inherited from

Omit.name

outputs

readonly outputs: readonly CraftingCargoItem[];

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

researchRequirementIds

readonly researchRequirementIds: readonly number[];

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

Inherited from

Omit.researchRequirementIds

status

readonly status: "active" | "deactivated";

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

Inherited from

Omit.status

usageCountRaw

readonly usageCountRaw: bigint;

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

Inherited from

Omit.usageCountRaw

usageLimitRaw

readonly usageLimitRaw: bigint;

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

Inherited from

Omit.usageLimitRaw

version

readonly version: number;

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

Inherited from

Omit.version

xpValueRaw

readonly xpValueRaw: bigint;

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

Inherited from

Omit.xpValueRaw

Methods

toJSON()

toJSON(): unknown;

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

Returns

unknown

Type Aliases

CraftingDiscoveryOptions

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

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

Options supported by targeted crafting discovery.

Example

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

---

CraftingProcessState

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

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

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

Example

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

Functions

deriveCraftingProcessState()

function deriveCraftingProcessState(process, atUnixSeconds): CraftingProcessState;

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

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

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

---

getCraftingHabsByCharacter()

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

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

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

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

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

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

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

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

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

---

getRecipe()

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

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

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

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

---

maybeGetCraftingHab()

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

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

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

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

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