Class Sector

Hierarchy

Sector

Implements

Account

Index

Constructors

constructor

new Sector(_data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>, _key: PublicKey, _connections: SectorConnection[]): Sector
Parameters
- _data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
- _key: PublicKey
- _connections: SectorConnection[]
Returns Sector

Properties

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

MIN_DATA_SIZE: number = ...

Accessors

connections

get connections(): readonly SectorConnection[]
Returns readonly SectorConnection[]

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` addConnection

addConnection(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, sector1: PublicKey, sector2: PublicKey, gameId: PublicKey, subCoordinates1: [BN, BN], flags1: ConnectionFlags, subCoordinates2: [BN, BN], flags2: ConnectionFlags, keyIndex: number): InstructionReturn
Add connection between 2 sectors for warping

See
- ConnectionFlags for more details on flags
- ConnectionFlags for more details on flags
Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  The SAGE IDL program
- key: AsyncSigner<unknown>
  
  The key authorized to use this instruction
- profile: PublicKey
  
  The Profile with permissions required
- sector1: PublicKey
  
  The first sector
- sector2: PublicKey
  
  The second sector
- gameId: PublicKey
  
  The Game PublicKey
- subCoordinates1: [BN, BN]
  
  The sub coordinate for warp gate within sector 1
- flags1: ConnectionFlags
  
  The flags for warp gate 1.
- subCoordinates2: [BN, BN]
  
  The sub coordinate for warp gate within sector 2
- flags2: ConnectionFlags
  
  The flags for warp gate 2
- keyIndex: number
  
  The Index of the key in the permission list
Returns InstructionReturn

`Static` decodeData

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

`Static` findAddress

findAddress(program: SageIDLProgram, gameId: PublicKey, coordinates: [BN, BN]): [PublicKey, number]
Finds the Sector PDA

Returns
- The PDA address and bump respectively
Parameters
- program: SageIDLProgram
  
  The SAGE Program IDL
- gameId: PublicKey
  
  The Game PublicKey
- coordinates: [BN, BN]
  
  The Sector Coordinates
Returns [PublicKey, number]

`Static` registerSector

registerSector(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, discoverer: PublicKey, gameId: PublicKey, coordinates: [BN, BN], name: string, keyIndex: number): {
instructions: InstructionReturn;
sectorKey: [PublicKey, number];
}
Register a Sector with SAGE

Returns
Returns an object with 2 fields: sectorKey and instructions. sectorKey is the PDA for the registered Sector.
Parameters
- program: SageIDLProgram
  
  The SAGE program IDL
- key: AsyncSigner<unknown>
  
  The key authorized for this instruction
- profile: PublicKey
  
  The Profile with required Permissions
- discoverer: PublicKey
  
  The discoverer of this sector
- gameId: PublicKey
  
  The Game PublicKey
- coordinates: [BN, BN]
  
  The coordinates for the sector
- name: string
  
  Name of the sector
- keyIndex: number
  
  The Index of the key in the permission list
Returns {
instructions: InstructionReturn;
sectorKey: [PublicKey, number];
}
- instructions: InstructionReturn
- sectorKey: [PublicKey, number]

`Static` removeConnection

removeConnection(program: SageIDLProgram, key: AsyncSigner<unknown>, profile: PublicKey, fundsTo: PublicKey | "funder", sector1: Sector, sector2: Sector, keyIndex: number, gameId: PublicKey): InstructionReturn
Remove an existing connection between 2 sectors for warping

Returns
InstructionReturn
Parameters
- program: SageIDLProgram
  
  The SAGE IDL program
- key: AsyncSigner<unknown>
  
  The key authorized to use this instruction
- profile: PublicKey
  
  The Profile with permissions required
- fundsTo: PublicKey | "funder"
  
  Account where rent fees go
- sector1: Sector
  
  The first sector
- sector2: Sector
  
  The second sector
- keyIndex: number
  
  The Index of the key in the permission list
- gameId: PublicKey
  
  The Game PublicKey
Returns InstructionReturn

Class Sector

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

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

_key: PublicKey

_connections: SectorConnection[]

Returns Sector

Properties

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

Accessors

connections

Returns readonly SectorConnection[]

data

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

key

Returns PublicKey

Methods

Static addConnection

See

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

sector1: PublicKey

sector2: PublicKey

gameId: PublicKey

subCoordinates1: [BN, BN]

flags1: ConnectionFlags

subCoordinates2: [BN, BN]

flags2: ConnectionFlags

keyIndex: number

Returns InstructionReturn

Static decodeData

Parameters

account: KeyedAccountInfo

program: SageIDLProgram

Returns DecodedAccountData<Sector>

Static findAddress

Returns

Parameters

program: SageIDLProgram

gameId: PublicKey

coordinates: [BN, BN]

Returns [PublicKey, number]

Static registerSector

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

discoverer: PublicKey

gameId: PublicKey

coordinates: [BN, BN]

name: string

keyIndex: number

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

instructions: InstructionReturn

sectorKey: [PublicKey, number]

Static removeConnection

Returns

Parameters

program: SageIDLProgram

key: AsyncSigner<unknown>

profile: PublicKey

fundsTo: PublicKey | "funder"

sector1: Sector

sector2: Sector

keyIndex: number

gameId: PublicKey

Returns InstructionReturn

`Static` `Readonly` ACCOUNT_NAME

`Static` `Readonly` MIN_DATA_SIZE

`Static` addConnection

`Static` decodeData

`Static` findAddress

`Static` registerSector

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

`Static` removeConnection