Class SurveyDataUnitTracker

Hierarchy

SurveyDataUnitTracker

Implements

Account

Constructors

constructor

new SurveyDataUnitTracker(_data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>, _key: PublicKey, _sectors: BN[]): SurveyDataUnitTracker
Parameters
- _data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
- _key: PublicKey
- _sectors: BN[]
Returns SurveyDataUnitTracker

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` GRID_WIDTH

GRID_WIDTH: 100 = 100

`Static` `Readonly` MAX_COORDINATE

MAX_COORDINATE: 50 = 50

`Static` `Readonly` MAX_SECONDS

MAX_SECONDS: 60 = 60

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

`Static` `Readonly` NUM_SECTORS

NUM_SECTORS: number = ...

`Static` `Readonly` SECTOR_SIZE

SECTOR_SIZE: 8 = 8

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

sectors

get sectors(): readonly BN[]
Returns readonly BN[]

Methods

`Static` decodeData

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

`Static` deregisterSurveyDataUnitTracker

deregisterSurveyDataUnitTracker(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, surveyDataUnitTracker: PublicKey, fundsTo: PublicKey | "funder", gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Deregister a Survey Data Unit Tracker

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
- surveyDataUnitTracker: PublicKey
  
  the new survey data unit tracker
- fundsTo: PublicKey | "funder"
  
  the entity that should receive rent refunds
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  instruction input params
Returns InstructionReturn

`Static` drainSurveyDataUnitsBank

drainSurveyDataUnitsBank(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", surveyDataUnitTracker: PublicKey, gameId: PublicKey, tokenFrom: PublicKey, tokenTo: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Drain a Survey Data Units 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
- surveyDataUnitTracker: PublicKey
  
  the survey data unit tracker
- 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>>
  
  instruction input params
Returns InstructionReturn

`Static` findSectorIndex

findSectorIndex(coordinates: [BN, BN]): number
Calculate index from Sector coordinates

Returns
the index of the sector in the sector array
Parameters
- coordinates: [BN, BN]
  
  the sector's coordinates
Returns number

`Static` findSignerAddress

findSignerAddress(program: SageIDLProgram, tracker: PublicKey): [PublicKey, number]
Finds the address of a SurveyDataUnitTracker signer

Returns
- The PDA and bump respectively
Parameters
- program: SageIDLProgram
  
  the SAGE program
- tracker: PublicKey
  
  the survey data units tracker
Returns [PublicKey, number]

`Static` findSignerTokenAccountAddress

findSignerTokenAccountAddress(trackerAccount: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>): PublicKey
Finds the address of the SDU token account owned by the SurveyDataUnitTracker signer

Returns
- The associated token account address
Parameters
- trackerAccount: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
  
  the survey data units tracker account
Returns PublicKey

`Static` fundSurveyDataUnitTrackerBank

fundSurveyDataUnitTrackerBank(trackerAccount: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>, tokenFromOwner: AsyncSigner<unknown>, tokenFrom: PublicKey, amount: number): InstructionReturn
Fund a SurveyDataUnitTracker SDU bank The bank token account must already exist

Returns
InstructionReturn
Parameters
- trackerAccount: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
  
  the survey data units tracker account
- 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` registerSurveyDataUnitTracker

registerSurveyDataUnitTracker(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, surveyDataUnitTracker: AsyncSigner<unknown>, mint: PublicKey, gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Register a Survey Data Unit Tracker Only use this if the empty surveyDataUnitTracker account has already been created on-chain

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
- surveyDataUnitTracker: AsyncSigner<unknown>
  
  the new survey data unit tracker
- mint: PublicKey
  
  the mint for the survey data units
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  instruction input params
Returns InstructionReturn

`Static` registerSurveyDataUnitTrackerWithConnection

registerSurveyDataUnitTrackerWithConnection(program: SageIDLProgram, connection: Connection, key: AsyncSigner<unknown>, profile: PublicKey, surveyDataUnitTracker: AsyncSigner<unknown>, mint: PublicKey, gameId: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): Promise<InstructionReturn[]>
Register a Survey Data Unit Tracker with Solana connection Takes a connection to create an empty surveyDataUnitTracker account, which is necessary

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- connection: Connection
  
  Solana connection object
- key: AsyncSigner<unknown>
  
  the key authorized to run this instruction
- profile: PublicKey
  
  the profile with the required permissions for the instruction
- surveyDataUnitTracker: AsyncSigner<unknown>
  
  the new survey data unit tracker
- mint: PublicKey
  
  the mint for the survey data units
- gameId: PublicKey
  
  the SAGE game id
- input: AnchorTypeDef<Object, Record<string, never>>
  
  instruction input params
Returns Promise<InstructionReturn[]>

`Static` scanForSurveyDataUnits

scanForSurveyDataUnits(program: SageIDLProgram, cargoProgram: CargoIDLProgram, key: AsyncSigner<unknown>, playerProfile: PublicKey, profileFaction: PublicKey, fleet: PublicKey, surveyDataUnitTracker: PublicKey, cargoHold: PublicKey, sduCargoType: PublicKey, repairKitCargoType: PublicKey, cargoStatsDefinition: PublicKey, sduTokenFrom: PublicKey, sduTokenTo: PublicKey, repairKitTokenFrom: PublicKey, repairKitMint: PublicKey, gameId: PublicKey, gameState: PublicKey, input: AnchorTypeDef<Object, Record<string, never>>): InstructionReturn
Scan For Survey Data Units

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  SAGE program
- cargoProgram: CargoIDLProgram
  
  cargo program
- 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
- fleet: PublicKey
  
  the fleet
- surveyDataUnitTracker: PublicKey
  
  the new survey data unit tracker
- cargoHold: PublicKey
  
  the fleet's cargo hold cargo pod
- sduCargoType: PublicKey
  
  the SDU cargo type
- repairKitCargoType: PublicKey
  
  the repairKit cargo type
- cargoStatsDefinition: PublicKey
  
  the cargo stats definition
- sduTokenFrom: PublicKey
  
  the source token SDU account, owned by the survey data unit tracker's signer (must match SDU mint in surveyDataUnitTracker)
- sduTokenTo: PublicKey
  
  the destination SDU token account, owned by cargoHold (must match SDU mint in surveyDataUnitTracker)
- repairKitTokenFrom: PublicKey
  
  the source repairKit token account, owned by cargoHold
- repairKitMint: PublicKey
  
  the repairKit token mint
- gameId: PublicKey
  
  the SAGE game id
- gameState: PublicKey
  
  the game state
- input: AnchorTypeDef<Object, Record<string, never>>
  
  instruction input params
Returns InstructionReturn

`Static` updateSurveyDataUnitTracker

updateSurveyDataUnitTracker(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, surveyDataUnitTracker: PublicKey, gameId: PublicKey, input: UpdateSurveyDataUnitTrackerParams, mint?: PublicKey): InstructionReturn
Update a Survey Data Unit Tracker

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
- surveyDataUnitTracker: PublicKey
  
  the survey data unit tracker
- gameId: PublicKey
  
  the SAGE game id
- input: UpdateSurveyDataUnitTrackerParams
  
  instruction input params
- Optional mint: PublicKey
  
  the mint for the survey data units
Returns InstructionReturn

Class SurveyDataUnitTracker

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

_sectors: BN[]

Returns SurveyDataUnitTracker

Properties

Static Readonly ACCOUNT_NAME

Static Readonly GRID_WIDTH

Static Readonly MAX_COORDINATE

Static Readonly MAX_SECONDS

Static Readonly MIN_DATA_SIZE

Static Readonly NUM_SECTORS

Static Readonly SECTOR_SIZE

Accessors

data

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

key

Returns PublicKey

sectors

Returns readonly BN[]

Methods

Static decodeData

Parameters

account: KeyedAccountInfo

program: SageIDLProgram

Returns DecodedAccountData<SurveyDataUnitTracker>

Static deregisterSurveyDataUnitTracker

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

surveyDataUnitTracker: PublicKey

fundsTo: PublicKey | "funder"

gameId: PublicKey

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

Returns InstructionReturn

Static drainSurveyDataUnitsBank

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

surveyDataUnitTracker: PublicKey

gameId: PublicKey

tokenFrom: PublicKey

tokenTo: PublicKey

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

Returns InstructionReturn

Static findSectorIndex

Returns

Parameters

coordinates: [BN, BN]

Returns number

Static findSignerAddress

Returns

Parameters

program: SageIDLProgram

tracker: PublicKey

Returns [PublicKey, number]

Static findSignerTokenAccountAddress

Returns

Parameters

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

Returns PublicKey

Static fundSurveyDataUnitTrackerBank

Returns

Parameters

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

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` GRID_WIDTH

`Static` `Readonly` MAX_COORDINATE

`Static` `Readonly` MAX_SECONDS

`Static` `Readonly` MIN_DATA_SIZE

`Static` `Readonly` NUM_SECTORS

`Static` `Readonly` SECTOR_SIZE

`Static` decodeData

`Static` deregisterSurveyDataUnitTracker

`Static` drainSurveyDataUnitsBank

`Static` findSectorIndex

`Static` findSignerAddress

`Static` findSignerTokenAccountAddress

`Static` fundSurveyDataUnitTrackerBank

`Static` registerSurveyDataUnitTracker

`Static` registerSurveyDataUnitTrackerWithConnection

`Static` scanForSurveyDataUnits

`Static` updateSurveyDataUnitTracker

`Optional` mint: PublicKey