Class MineItem

Hierarchy

MineItem

Implements

Account

Index

Constructors

constructor

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

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

`Static` `Readonly` RESOURCE_HARDNESS_DECIMALS

RESOURCE_HARDNESS_DECIMALS: 100 = 100

Accessors

data

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

key

get key(): PublicKey
Returns PublicKey

Implementation of Account.key

Methods

`Static` decodeData

decodeData(account: KeyedAccountInfo, program: SageIDLProgram): DecodedAccountData<MineItem>
Parameters
- account: KeyedAccountInfo
- program: SageIDLProgram
Returns DecodedAccountData<MineItem>

`Static` deregisterMineItem

deregisterMineItem(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", mineItem: PublicKey, gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Delete or remove a MineItem

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- profile: PublicKey
  
  the profile with the required permissions for the instruction
- fundsTo: PublicKey | "funder"
  
  the entity that should receive rent refunds
- mineItem: PublicKey
  
  the MineItem
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  input params
Returns InstructionReturn

`Static` drainMineItemBank

drainMineItemBank(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", mineItem: PublicKey, gameId: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Drain a MineItem token account

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- profile: PublicKey
  
  the profile with the required permissions for the instruction
- fundsTo: PublicKey | "funder"
  
  the entity that should receive rent refunds
- mineItem: PublicKey
  
  the MineItem
- gameId: PublicKey
  
  the SAGE game id
- tokenFrom: PublicKey
  
  The mine item token bank to drain
- tokenTo: PublicKey
  
  Where to send tokens from the bank
- input: AnchorTypeDef<Object, Record<string, never>>
  
  input params
Returns InstructionReturn

`Static` findAddress

findAddress(program: SageIDLProgram, gameId: PublicKey, mint: PublicKey): [PublicKey, number]
Finds the MineItem account address

Returns
- The PDA and bump respectively
Parameters
- program: SageIDLProgram
  
  SAGE program
- gameId: PublicKey
  
  the SAGE game id
- mint: PublicKey
  
  the MineItem mint
Returns [PublicKey, number]

`Static` fundMineItemBank

fundMineItemBank(mineItem: PublicKey, mint: PublicKey, tokenFromOwner: AsyncSigner<unknown>, tokenFrom: PublicKey, amount: number): InstructionReturn
Fund a MineItem bank

Returns
InstructionReturn
Parameters
- mineItem: PublicKey
  
  the MineItem
- mint: PublicKey
  
  the MineItem mint
- tokenFromOwner: AsyncSigner<unknown>
  
  the owner of the source token account
- tokenFrom: PublicKey
  
  the source token account
- amount: number
  
  the amount of tokens
Returns InstructionReturn

`Static` registerMineItem

registerMineItem(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, mint: PublicKey, gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): {
instructions: InstructionReturn;
mineItemKey: [PublicKey, number];
}
Register MineItem

Returns
- the new MineItem address and InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- profile: PublicKey
  
  the profile with the required permissions for the instruction
- mint: PublicKey
  
  the MineItem mint
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  input params
Returns {
instructions: InstructionReturn;
mineItemKey: [PublicKey, number];
}
- instructions: InstructionReturn
- mineItemKey: [PublicKey, number]

`Static` updateMineItem

updateMineItem(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, mineItem: PublicKey, gameId: PublicKey, input: CustomUpdateMineItemInput): InstructionReturn
Update a MineItem

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- profile: PublicKey
  
  the profile with the required permissions for the instruction
- mineItem: PublicKey
  
  the MineItem
- gameId: PublicKey
  
  the SAGE game id
- input: CustomUpdateMineItemInput
  
  input params
Returns InstructionReturn

Class MineItem

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

Returns MineItem

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Static Readonly RESOURCE_HARDNESS_DECIMALS

Accessors

data

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

key

Returns PublicKey

Methods

Static decodeData

Parameters

account: KeyedAccountInfo

program: SageIDLProgram

Returns DecodedAccountData<MineItem>

Static deregisterMineItem

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

mineItem: PublicKey

gameId: PublicKey

input: AnchorTypeDef<Object, Record<string, never>>

Returns InstructionReturn

Static drainMineItemBank

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

mineItem: PublicKey

gameId: PublicKey

tokenFrom: PublicKey

tokenTo: PublicKey

input: AnchorTypeDef<Object, Record<string, never>>

Returns InstructionReturn

Static findAddress

Returns

Parameters

program: SageIDLProgram

gameId: PublicKey

mint: PublicKey

Returns [PublicKey, number]

Static fundMineItemBank

Returns

Parameters

mineItem: PublicKey

mint: PublicKey

tokenFromOwner: AsyncSigner<unknown>

tokenFrom: PublicKey

amount: number

Returns InstructionReturn

Static registerMineItem

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

mint: PublicKey

gameId: PublicKey

input: AnchorTypeDef<Object, Record<string, never>>

Returns { instructions: InstructionReturn; mineItemKey: [PublicKey, number]; }

instructions: InstructionReturn

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` `Readonly` RESOURCE_HARDNESS_DECIMALS

`Static` decodeData

`Static` deregisterMineItem

`Static` drainMineItemBank

`Static` findAddress

`Static` fundMineItemBank

`Static` registerMineItem

Returns {
instructions: InstructionReturn;
mineItemKey: [PublicKey, number];
}

`Static` updateMineItem