Class StarbasePlayer

Hierarchy

StarbasePlayer

Implements

Account

Index

Constructors

constructor

new StarbasePlayer(_data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>, _key: PublicKey, _wrappedShipEscrows: WrappedShipEscrow[]): StarbasePlayer
Parameters
- _data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
- _key: PublicKey
- _wrappedShipEscrows: WrappedShipEscrow[]
Returns StarbasePlayer

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = STAR_BASE_PLAYER_MIN_DATA_SIZE

Accessors

data

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

key

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

Implementation of Account.key

wrappedShipEscrows

get wrappedShipEscrows(): readonly WrappedShipEscrow[]
Returns readonly WrappedShipEscrow[]

Methods

`Static` closeStarbaseCargoTokenAccount

closeStarbaseCargoTokenAccount(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, fundsTo: PublicKey | "funder", playerProfile: PublicKey, profileFaction: PublicKey, starbase: PublicKey, cargoPod: PublicKey, cargoType: PublicKey, cargoStatsDefinition: PublicKey, token: PublicKey, tokenMint: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Closes a token account that is owned by the StarbasePlayer (burns any token balance)

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- fundsTo: PublicKey | "funder"
  
  recipient of the rent refund
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- starbase: PublicKey
  
  the Starbase
- cargoPod: PublicKey
  
  the cargo pod - owned by starbasePlayer
- cargoType: PublicKey
  
  the cargo type
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- token: PublicKey
  
  the token account - owned by the cargoPod
- tokenMint: PublicKey
  
  the token mint
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

`Static` createCargoPod

createCargoPod(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, playerProfile: PublicKey, profileFaction: PublicKey, starbase: PublicKey, cargoStatsDefinition: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Creates a new cargo pod for the player at the Starbase

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- starbase: PublicKey
  
  the Starbase
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

`Static` decodeData

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

`Static` depositCargoToGame

depositCargoToGame(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, playerProfile: PublicKey, profileFaction: PublicKey, starbase: PublicKey, cargoPod: PublicKey, cargoType: PublicKey, cargoStatsDefinition: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Deposits cargo to the game

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- starbase: PublicKey
  
  the Starbase
- cargoPod: PublicKey
  
  the cargo pod
- cargoType: PublicKey
  
  the cargo type
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- tokenFrom: PublicKey
  
  the source token account - owned by the key
- tokenTo: PublicKey
  
  the destination token account - owned by the cargoPod
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

`Static` findAddress

findAddress(program: SageIDLProgram, starbase: PublicKey, sagePlayerProfile: PublicKey, starbaseSeqId: number): [PublicKey, number]
Find the StarbasePlayer account address

Returns
The PDA and bump respectively
Parameters
- program: SageIDLProgram
  
  SAGE program
- starbase: PublicKey
  
  the Starbase
- sagePlayerProfile: PublicKey
  
  the SAGE player profile
- starbaseSeqId: number
  
  the Starbase sequence id
Returns [PublicKey, number]

`Static` registerStarbasePlayer

registerStarbasePlayer(program: SageIDLProgram, profileFaction: PublicKey, sagePlayerProfile: PublicKey, starbase: PublicKey, gameId: PublicKey, gameState: PublicKey, starbaseSeqId: number): InstructionReturn
Register a StarbasePlayer

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- profileFaction: PublicKey
  
  the faction of profile associated with the sagePlayerProfile
- sagePlayerProfile: PublicKey
  
  the SAGE player profile
- starbase: PublicKey
  
  the Starbase
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state
- starbaseSeqId: number
  
  the Starbase sequence id
Returns InstructionReturn

`Static` removeCargoPod

removeCargoPod(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, playerProfile: PublicKey, profileFaction: PublicKey, fundsTo: PublicKey | "funder", starbase: PublicKey, cargoPod: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Closes an empty cargo pod account owned by the player at a Starbase

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- fundsTo: PublicKey | "funder"
  
  recipient of the rent refund
- starbase: PublicKey
  
  the Starbase
- cargoPod: PublicKey
  
  the cargo pod
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

`Static` syncStarbasePlayer

syncStarbasePlayer(program: SageIDLProgram, starbasePlayer: PublicKey, starbase: PublicKey, gameId: PublicKey, gameState: PublicKey): InstructionReturn
Sync the Starbase player account

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- starbasePlayer: PublicKey
  
  the Starbase player
- starbase: PublicKey
  
  the Starbase tied to the starbasePlayer
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
Returns InstructionReturn

`Static` transferCargoAtStarbase

transferCargoAtStarbase(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, fundsTo: PublicKey | "funder", playerProfile: PublicKey, profileFaction: PublicKey, starbase: PublicKey, cargoPodFrom: PublicKey, cargoPodTo: PublicKey, cargoType: PublicKey, cargoStatsDefinition: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, tokenMint: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Transfers cargo from one pod to another at the same Starbase owned by the same player

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- fundsTo: PublicKey | "funder"
  
  recipient of the rent refund
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- starbase: PublicKey
  
  the Starbase
- cargoPodFrom: PublicKey
  
  the source cargo pod
- cargoPodTo: PublicKey
  
  the destination cargo pod
- cargoType: PublicKey
  
  the cargo type
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- tokenFrom: PublicKey
  
  the source token account - owned by the cargoPodFrom
- tokenTo: PublicKey
  
  the destination token account - owned by the cargoPodTo
- tokenMint: PublicKey
  
  the token mint
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

`Static` withdrawCargoFromGame

withdrawCargoFromGame(program: SageIDLProgram, cargoProgram: CargoIDLProgram, starbasePlayer: PublicKey, key: AsyncSigner<unknown>, fundsTo: PublicKey | "funder", playerProfile: PublicKey, profileFaction: PublicKey, starbase: PublicKey, cargoPod: PublicKey, cargoType: PublicKey, cargoStatsDefinition: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, tokenMint: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Withdraws cargo from the game

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- starbasePlayer: PublicKey
  
  the Starbase player
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- fundsTo: PublicKey | "funder"
  
  recipient of the rent refund
- playerProfile: PublicKey
  
  the profile with the required permissions for the instruction
- profileFaction: PublicKey
  
  the profile's faction
- starbase: PublicKey
  
  the Starbase
- cargoPod: PublicKey
  
  the cargo pod
- cargoType: PublicKey
  
  the cargo type
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- tokenFrom: PublicKey
  
  the source token account - owned by the cargoPod
- tokenTo: PublicKey
  
  the destination token account - owned by the key
- tokenMint: PublicKey
  
  the token mint
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state account
- input: AnchorTypeDef<Object, Record<string, never>>
  
  the instruction input params
Returns InstructionReturn

Class StarbasePlayer

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

_wrappedShipEscrows: WrappedShipEscrow[]

Returns StarbasePlayer

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Accessors

data

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

key

Returns Readonly<PublicKey>

wrappedShipEscrows

Returns readonly WrappedShipEscrow[]

Methods

Static closeStarbaseCargoTokenAccount

Returns

Parameters

program: SageIDLProgram

cargoProgram: CargoIDLProgram

starbasePlayer: PublicKey

key: AsyncSigner<unknown>

fundsTo: PublicKey | "funder"

playerProfile: PublicKey

profileFaction: PublicKey

starbase: PublicKey

cargoPod: PublicKey

cargoType: PublicKey

cargoStatsDefinition: PublicKey

token: PublicKey

tokenMint: PublicKey

gameId: PublicKey

gameState: PublicKey

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

Returns InstructionReturn

Static createCargoPod

Returns

Parameters

program: SageIDLProgram

cargoProgram: CargoIDLProgram

starbasePlayer: PublicKey

key: AsyncSigner<unknown>

playerProfile: PublicKey

profileFaction: PublicKey

starbase: PublicKey

cargoStatsDefinition: PublicKey

gameId: PublicKey

gameState: PublicKey

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

Returns InstructionReturn

Static decodeData

Parameters

account: KeyedAccountInfo

program: SageIDLProgram

Returns DecodedAccountData<StarbasePlayer>

Static depositCargoToGame

Returns

Parameters

program: SageIDLProgram

cargoProgram: CargoIDLProgram

starbasePlayer: PublicKey

key: AsyncSigner<unknown>

playerProfile: PublicKey

profileFaction: PublicKey

starbase: PublicKey

cargoPod: PublicKey

cargoType: PublicKey

cargoStatsDefinition: PublicKey

tokenFrom: PublicKey

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` closeStarbaseCargoTokenAccount

`Static` createCargoPod

`Static` decodeData

`Static` depositCargoToGame

`Static` findAddress

`Static` registerStarbasePlayer

`Static` removeCargoPod

`Static` syncStarbasePlayer

`Static` transferCargoAtStarbase