Class Planet

Hierarchy

Planet

Implements

Account

Index

Constructors

Properties

ACCOUNT_NAME MIN_DATA_SIZE

Accessors

data key prettyName

Methods

decodeData registerPlanet updatePlanet

Constructors

constructor

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

Properties

`Static` `Readonly` ACCOUNT_NAME

ACCOUNT_NAME: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker" = 'planet'

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

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

prettyName

get prettyName(): string
Returns string

Methods

`Static` decodeData

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

`Static` registerPlanet

registerPlanet(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, planet: AsyncSigner<unknown>, sector: PublicKey, gameId: PublicKey, input: RegisterPlanetInput): InstructionReturn
Register a planet

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
- planet: AsyncSigner<unknown>
  
  the planet being registered
- sector: PublicKey
  
  the sector in which the planet is located
- gameId: PublicKey
  
  the SAGE game id
- input: RegisterPlanetInput
  
  input params
Returns InstructionReturn

`Static` updatePlanet

updatePlanet(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, planet: PublicKey, gameId: PublicKey, input: UpdatePlanetInput): InstructionReturn
Update a planet

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
- planet: PublicKey
  
  the planet being updated
- gameId: PublicKey
  
  the SAGE game id
- input: UpdatePlanetInput
  
  input params
Returns InstructionReturn

Generated using TypeDoc