Class Recipe

Hierarchy

Recipe

Implements

Account

Index

Constructors

constructor

new Recipe(_data: AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>, _key: PublicKey, _ingredientInputsOutputs: RecipeInputsOutputs[]): Recipe
Parameters
- _data: AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>
- _key: PublicKey
- _ingredientInputsOutputs: RecipeInputsOutputs[]
Returns Recipe

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = RECIPE_MIN_DATA_SIZE

Accessors

data

get data(): Readonly<AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>>
Returns Readonly<AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>>

ingredientInputsOutputs

get ingredientInputsOutputs(): readonly RecipeInputsOutputs[]
Returns readonly RecipeInputsOutputs[]

key

get key(): Readonly<PublicKey>
Returns Readonly<PublicKey>

Implementation of Account.key

Methods

`Static` addConsumableInputToRecipe

addConsumableInputToRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, mint: PublicKey, recipeIngredient: RecipeInputsOutputs): InstructionReturn
Add a consumable input to a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- mint: PublicKey
  
  the ingredient's mint
- recipeIngredient: RecipeInputsOutputs
  
  the amount and mint for this ingredient
Returns InstructionReturn

`Static` addNonConsumableInputToRecipe

addNonConsumableInputToRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, mint: PublicKey, recipeIngredient: RecipeInputsOutputs): InstructionReturn
Add a non-consumable input to a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- mint: PublicKey
  
  the ingredient's mint
- recipeIngredient: RecipeInputsOutputs
  
  the amount and mint for this ingredient- the amount and mint for this ingredient
Returns InstructionReturn

`Static` addOutputToRecipe

addOutputToRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, craftableItem: PublicKey, recipeIngredient: RecipeInputsOutputs): InstructionReturn
Add an output to a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- craftableItem: PublicKey
  
  the craftable item for this output
- recipeIngredient: RecipeInputsOutputs
  
  the amount and mint for this ingredient
Returns InstructionReturn

`Static` decodeData

decodeData(account: KeyedAccountInfo, program: CraftingIDLProgram): DecodedAccountData<Recipe>
Parameters
- account: KeyedAccountInfo
- program: CraftingIDLProgram
Returns DecodedAccountData<Recipe>

`Static` deregisterRecipe

deregisterRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", domain: PublicKey, recipeCategory: PublicKey, input: KeyIndexInput): InstructionReturn
Deregister a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- fundsTo: PublicKey | "funder"
  
  receives rent refund
- domain: PublicKey
  
  the crafting domain
- recipeCategory: PublicKey
  
  the crafting recipe category
- input: KeyIndexInput
  
  the input parameters
Returns InstructionReturn

`Static` registerRecipe

registerRecipe(program: CraftingIDLProgram, recipe: AsyncSigner<unknown>, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, recipeCategory: PublicKey, input: RegisterRecipeInput, feeRecipient?: PublicKey): InstructionReturn
Register a Recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: AsyncSigner<unknown>
  
  the new crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- recipeCategory: PublicKey
  
  the crafting recipe category
- input: RegisterRecipeInput
  
  the input parameters
- Optional feeRecipient: PublicKey
  
  The token account that receives the Recipe's feeAmount
Returns InstructionReturn

`Static` removeConsumableInputFromRecipe

removeConsumableInputFromRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, input: RemoveRecipeIngredients): InstructionReturn
Remove a consumable input from a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- input: RemoveRecipeIngredients
  
  the input parameters
Returns InstructionReturn

`Static` removeNonConsumableInputFromRecipe

removeNonConsumableInputFromRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, input: RemoveRecipeIngredients): InstructionReturn
Remove a non-consumable input from a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- input: RemoveRecipeIngredients
  
  the input parameters
Returns InstructionReturn

`Static` removeOutputFromRecipe

removeOutputFromRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, input: RemoveRecipeIngredients): InstructionReturn
Remove an output from a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- input: RemoveRecipeIngredients
  
  the input parameters
Returns InstructionReturn

`Static` updateRecipe

updateRecipe(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, updateRecipeInput: UpdateRecipeInput, feeRecipient?: PublicKey): InstructionReturn
Update a recipe

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- updateRecipeInput: UpdateRecipeInput
  
  input params
- Optional feeRecipient: PublicKey
  
  The token account that receives the Recipe's feeAmount
Returns InstructionReturn

`Static` updateRecipeCategory

updateRecipeCategory(program: CraftingIDLProgram, recipe: PublicKey, key: AsyncSigner<unknown>, profile: PublicKey, domain: PublicKey, recipeCategoryOld: PublicKey, recipeCategoryNew: PublicKey, input: KeyIndexInput): InstructionReturn
Update a recipe's category

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- recipe: PublicKey
  
  the crafting recipe
- key: AsyncSigner<unknown>
  
  Key authorized to use this instruction
- profile: PublicKey
  
  Profile Account with required Crafting Permissions
- domain: PublicKey
  
  the crafting domain
- recipeCategoryOld: PublicKey
  
  the old recipe category
- recipeCategoryNew: PublicKey
  
  the new recipe category
- input: KeyIndexInput
  
  the input parameters
Returns InstructionReturn

Class Recipe

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_data: AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>

_key: PublicKey

_ingredientInputsOutputs: RecipeInputsOutputs[]

Returns Recipe

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Accessors

data

Returns Readonly<AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>>

ingredientInputsOutputs

Returns readonly RecipeInputsOutputs[]

key

Returns Readonly<PublicKey>

Methods

Static addConsumableInputToRecipe

Returns

Parameters

program: CraftingIDLProgram

recipe: PublicKey

key: AsyncSigner<unknown>

profile: PublicKey

domain: PublicKey

mint: PublicKey

recipeIngredient: RecipeInputsOutputs

Returns InstructionReturn

Static addNonConsumableInputToRecipe

Returns

Parameters

program: CraftingIDLProgram

recipe: PublicKey

key: AsyncSigner<unknown>

profile: PublicKey

domain: PublicKey

mint: PublicKey

recipeIngredient: RecipeInputsOutputs

Returns InstructionReturn

Static addOutputToRecipe

Returns

Parameters

program: CraftingIDLProgram

recipe: PublicKey

key: AsyncSigner<unknown>

profile: PublicKey

domain: PublicKey

craftableItem: PublicKey

recipeIngredient: RecipeInputsOutputs

Returns InstructionReturn

Static decodeData

Parameters

account: KeyedAccountInfo

program: CraftingIDLProgram

Returns DecodedAccountData<Recipe>

Static deregisterRecipe

Returns

Parameters

program: CraftingIDLProgram

recipe: PublicKey

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

domain: PublicKey

recipeCategory: PublicKey

input: KeyIndexInput

Returns InstructionReturn

Static registerRecipe

Returns

Parameters

program: CraftingIDLProgram

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` addConsumableInputToRecipe

`Static` addNonConsumableInputToRecipe

`Static` addOutputToRecipe

`Static` decodeData

`Static` deregisterRecipe

`Static` registerRecipe

`Optional` feeRecipient: PublicKey

`Static` removeConsumableInputFromRecipe

`Static` removeNonConsumableInputFromRecipe

`Static` removeOutputFromRecipe

`Static` updateRecipe

`Optional` feeRecipient: PublicKey

`Static` updateRecipeCategory