Class CraftingProcess

Hierarchy

CraftingProcess

Implements

Account

Index

Constructors

constructor

new CraftingProcess(_data: AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>, _key: PublicKey): CraftingProcess
Parameters
- _data: AnchorTypeDef<Object, AnchorDefined<CraftingIDL, Record<string, never>>>
- _key: PublicKey
Returns CraftingProcess

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

Accessors

data

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

key

get key(): PublicKey
Returns PublicKey

Implementation of Account.key

Methods

`Static` addRecipeIngredient

addRecipeIngredient(program: CraftingIDLProgram, location: AsyncSigner<unknown>, authority: AsyncSigner<unknown>, craftingProcess: PublicKey, recipe: PublicKey, craftingFacility: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, input: RecipeIngredientInput): InstructionReturn
Add an ingredient to a crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- craftingFacility: PublicKey
  
  the crafting facility
- tokenFrom: PublicKey
  
  the source token account
- tokenTo: PublicKey
  
  the destination token account (must be owned by the crafting process account)
- input: RecipeIngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` burnConsumableIngredient

burnConsumableIngredient(program: CraftingIDLProgram, craftingProcess: PublicKey, recipe: PublicKey, tokenFrom: PublicKey, mint: PublicKey, input: IngredientInput): InstructionReturn
Burn a consumable ingredient from a crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- tokenFrom: PublicKey
  
  the source token account (owned by crafting process)
- mint: PublicKey
  
  the token mint
- input: IngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` cancelCraftingProcess

cancelCraftingProcess(program: CraftingIDLProgram, location: AsyncSigner<unknown>, authority: AsyncSigner<unknown>, fundsTo: PublicKey | "funder", craftingProcess: PublicKey, craftingFacility: PublicKey): InstructionReturn
Cancel the crafting process and close the crafting process account can only be done if the crafting process was not started

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- fundsTo: PublicKey | "funder"
  
  receives rent refund
- craftingProcess: PublicKey
  
  the crafting process
- craftingFacility: PublicKey
  
  the crafting facility
Returns InstructionReturn

`Static` claimNonConsumableIngredient

claimNonConsumableIngredient(program: CraftingIDLProgram, craftingProcess: PublicKey, authority: PublicKey, recipe: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, mint: PublicKey, input: IngredientInput): InstructionReturn
Claim a non-consumable ingredient from a crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- craftingProcess: PublicKey
  
  the crafting process
- authority: PublicKey
  
  the authority for the crafting process account
- recipe: PublicKey
  
  the crafting recipe
- tokenFrom: PublicKey
  
  the source token account (owned by crafting process)
- tokenTo: PublicKey
  
  the destination token account
- mint: PublicKey
  
  the token mint
- input: IngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` claimRecipeOutput

claimRecipeOutput(program: CraftingIDLProgram, craftingProcess: PublicKey, authority: PublicKey, recipe: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, craftableItem: PublicKey, input: IngredientInput): InstructionReturn
Claim an output from a crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- craftingProcess: PublicKey
  
  the crafting process
- authority: PublicKey
  
  the authority for the crafting process account
- recipe: PublicKey
  
  the crafting recipe
- tokenFrom: PublicKey
  
  the source token account (owned by the craftableItem)
- tokenTo: PublicKey
  
  the destination token account
- craftableItem: PublicKey
  
  the craftable item
- input: IngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` closeCraftingProcess

closeCraftingProcess(program: CraftingIDLProgram, authority: AsyncSigner<unknown>, fundsTo: PublicKey | "funder", craftingProcess: PublicKey, recipe: PublicKey, craftingFacility: PublicKey): InstructionReturn
Close the crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- fundsTo: PublicKey | "funder"
  
  receives rent refund
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- craftingFacility: PublicKey
  
  the crafting facility
Returns InstructionReturn

`Static` createCraftingProcess

createCraftingProcess(program: CraftingIDLProgram, location: AsyncSigner<unknown>, authority: AsyncSigner<unknown>, craftingFacility: PublicKey, recipe: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Create or Initialize a CraftingProcess Account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- craftingFacility: PublicKey
  
  the crafting facility
- recipe: PublicKey
  
  the crafting recipe
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the input parameters
Returns InstructionReturn

`Static` decodeData

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

`Static` findAddress

findAddress(program: CraftingIDLProgram, craftingFacility: PublicKey, recipe: PublicKey, craftingId: BN): [PublicKey, number]
Find the CraftingProcess address

Returns
PDA and bump
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- craftingFacility: PublicKey
  
  the crafting facility
- recipe: PublicKey
  
  the crafting recipe
- craftingId: BN
  
  the crafting process id
Returns [PublicKey, number]

`Static` getCargoPodSeeds

getCargoPodSeeds(): Buffer
Returns Buffer

`Static` legitimizeRecipeIngredient

legitimizeRecipeIngredient(program: CraftingIDLProgram, location: AsyncSigner<unknown>, authority: AsyncSigner<unknown>, craftingProcess: PublicKey, recipe: PublicKey, craftingFacility: PublicKey, craftingTokenAccount: PublicKey, input: RecipeIngredientInput): InstructionReturn
Legitimize an ingredient The token accounts that hold ingredients can receive tokens from anyone. However, only tokens received through the crafting program are recognized as valid ingredients. This instruction can be used in cases where one wants to "legitimize" such token account balances

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- craftingFacility: PublicKey
  
  the crafting facility
- craftingTokenAccount: PublicKey
  
  the token account owned by the crafting process which holds the ingredient in escrow
- input: RecipeIngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` removeRecipeIngredient

removeRecipeIngredient(program: CraftingIDLProgram, location: AsyncSigner<unknown>, authority: AsyncSigner<unknown>, craftingProcess: PublicKey, recipe: PublicKey, craftingFacility: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, mint: PublicKey, input: RecipeIngredientInput): InstructionReturn
Remove an ingredient from a crafting process account

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- authority: AsyncSigner<unknown>
  
  the authority for the crafting process account
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- craftingFacility: PublicKey
  
  the crafting facility
- tokenFrom: PublicKey
  
  the source token account (must be owned by the crafting process)
- tokenTo: PublicKey
  
  the destination token account
- mint: PublicKey
  
  the token mint
- input: RecipeIngredientInput
  
  the input parameters
Returns InstructionReturn

`Static` startCraftingProcess

startCraftingProcess(program: CraftingIDLProgram, location: AsyncSigner<unknown>, craftingProcess: PublicKey, recipe: PublicKey, craftingFacility: PublicKey, recipeDurationOverride?: BN, tokenFromAuthority?: AsyncSigner<unknown>, tokenFrom?: PublicKey, tokenTo?: PublicKey): InstructionReturn
Start the crafting process

Returns
InstructionReturn
Parameters
- program: CraftingIDLProgram
  
  Crafting program
- location: AsyncSigner<unknown>
  
  the crafting facility's location
- craftingProcess: PublicKey
  
  the crafting process
- recipe: PublicKey
  
  the crafting recipe
- craftingFacility: PublicKey
  
  the crafting facility
- Optional recipeDurationOverride: BN
  
  the recipe duration (overrides the duration set on the recipe account)
- Optional tokenFromAuthority: AsyncSigner<unknown>
  
  the transfer authority of tokenFrom
- Optional tokenFrom: PublicKey
  
  the source token account for crafting fees
- Optional tokenTo: PublicKey
  
  the destination token account for crafting fees, should be as defined in Recipe account
Returns InstructionReturn

Class CraftingProcess

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

Returns CraftingProcess

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Accessors

data

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

key

Returns PublicKey

Methods

Static addRecipeIngredient

Returns

Parameters

program: CraftingIDLProgram

location: AsyncSigner<unknown>

authority: AsyncSigner<unknown>

craftingProcess: PublicKey

recipe: PublicKey

craftingFacility: PublicKey

tokenFrom: PublicKey

tokenTo: PublicKey

input: RecipeIngredientInput

Returns InstructionReturn

Static burnConsumableIngredient

Returns

Parameters

program: CraftingIDLProgram

craftingProcess: PublicKey

recipe: PublicKey

tokenFrom: PublicKey

mint: PublicKey

input: IngredientInput

Returns InstructionReturn

Static cancelCraftingProcess

Returns

Parameters

program: CraftingIDLProgram

location: AsyncSigner<unknown>

authority: AsyncSigner<unknown>

fundsTo: PublicKey | "funder"

craftingProcess: PublicKey

craftingFacility: PublicKey

Returns InstructionReturn

Static claimNonConsumableIngredient

Returns

Parameters

program: CraftingIDLProgram

craftingProcess: PublicKey

authority: PublicKey

recipe: PublicKey

tokenFrom: PublicKey

tokenTo: PublicKey

mint: PublicKey

input: IngredientInput

Returns InstructionReturn

Static claimRecipeOutput

Returns

Parameters

program: CraftingIDLProgram

craftingProcess: PublicKey

authority: PublicKey

recipe: PublicKey

tokenFrom: PublicKey

tokenTo: PublicKey

craftableItem: PublicKey

input: IngredientInput

Returns InstructionReturn

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` addRecipeIngredient

`Static` burnConsumableIngredient

`Static` cancelCraftingProcess

`Static` claimNonConsumableIngredient

`Static` claimRecipeOutput

`Static` closeCraftingProcess

`Static` createCraftingProcess

`Static` decodeData

`Static` findAddress

`Static` getCargoPodSeeds

`Static` legitimizeRecipeIngredient

`Static` removeRecipeIngredient

`Static` startCraftingProcess

`Optional` recipeDurationOverride: BN