Class Resource

Hierarchy

Resource

Implements

Account

Index

Constructors

constructor

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

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

`Static` `Readonly` SYSTEM_RICHNESS_DECIMALS

SYSTEM_RICHNESS_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<Resource>
Parameters
- account: KeyedAccountInfo
- program: SageIDLProgram
Returns DecodedAccountData<Resource>

`Static` deregisterResource

deregisterResource(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", resource: PublicKey, mineItem: PublicKey, location: PublicKey, gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Remove/Delete a Resource

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
- resource: PublicKey
  
  the resource
- mineItem: PublicKey
  
  the MineItem associated with the resource
- location: PublicKey
  
  the location of the resource e.g. a planet
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  input params
Returns InstructionReturn

`Static` findAddress

findAddress(program: SageIDLProgram, mineItem: PublicKey, location: PublicKey): [PublicKey, number]
Finds the Resource account address

Returns
- The PDA and bump respectively
Parameters
- program: SageIDLProgram
  
  SAGE program
- mineItem: PublicKey
  
  the MineItem associated with the resource
- location: PublicKey
  
  the location of the resource e.g. a planet
Returns [PublicKey, number]

`Static` registerResource

registerResource(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, location: PublicKey, mineItem: PublicKey, gameId: PublicKey, input: RegisterResourceInput): {
instructions: InstructionReturn;
resourceKey: [PublicKey, number];
}
Register a new Resource

Returns
- the new Resource 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
- location: PublicKey
  
  the location of the resource e.g. a planet
- mineItem: PublicKey
  
  the MineItem associated with the resource
- gameId: PublicKey
  
  the SAGE game id
- input: RegisterResourceInput
  
  input params
Returns {
instructions: InstructionReturn;
resourceKey: [PublicKey, number];
}
- instructions: InstructionReturn
- resourceKey: [PublicKey, number]

`Static` syncResource

syncResource(program: SageIDLProgram, resource: PublicKey, mineItem: PublicKey): InstructionReturn
Sync a Resource with a MineItem

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- resource: PublicKey
  
  the resource
- mineItem: PublicKey
  
  the MineItem associated with the resource
Returns InstructionReturn

`Static` updateResource

updateResource(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, resource: PublicKey, mineItem: PublicKey, gameId: PublicKey, input: UpdateResourceInput): InstructionReturn
Update a Resource

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
- resource: PublicKey
  
  the resource being updated
- mineItem: PublicKey
  
  the MineItem associated with the resource
- gameId: PublicKey
  
  the SAGE game id
- input: UpdateResourceInput
  
  input params
Returns InstructionReturn

Class Resource

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

Returns Resource

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Static Readonly SYSTEM_RICHNESS_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<Resource>

Static deregisterResource

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

resource: PublicKey

mineItem: PublicKey

location: PublicKey

gameId: PublicKey

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

Returns InstructionReturn

Static findAddress

Returns

Parameters

program: SageIDLProgram

mineItem: PublicKey

location: PublicKey

Returns [PublicKey, number]

Static registerResource

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

location: PublicKey

mineItem: PublicKey

gameId: PublicKey

input: RegisterResourceInput

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

instructions: InstructionReturn

resourceKey: [PublicKey, number]

Static syncResource

Returns

Parameters

program: SageIDLProgram

resource: PublicKey

mineItem: PublicKey

Returns InstructionReturn

Static updateResource

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

resource: PublicKey

mineItem: PublicKey

gameId: PublicKey

input: UpdateResourceInput

Returns InstructionReturn

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` `Readonly` SYSTEM_RICHNESS_DECIMALS

`Static` decodeData

`Static` deregisterResource

`Static` findAddress

`Static` registerResource

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

`Static` syncResource

`Static` updateResource