Class SageProgram

Hierarchy

ListenProgram<SageAccounts, SageIDL>
- SageProgram

Index

Constructors

constructor

new SageProgram(program: SageIDLProgram): SageProgram
Parameters
- program: SageIDLProgram
Returns SageProgram

Overrides ListenProgram<SageAccounts, SageIDL>.constructor

Properties

`Protected` accountClosedListener

accountClosedListener: null | ((update: AccountClosedUpdate) => void)

`Protected` `Readonly` accountDiscriminants

accountDiscriminants: {
    craftingInstance: Readonly<Buffer>;
    disbandedFleet: Readonly<Buffer>;
    fleet: Readonly<Buffer>;
    fleetShips: Readonly<Buffer>;
    game: Readonly<Buffer>;
    gameState: Readonly<Buffer>;
    mineItem: Readonly<Buffer>;
    planet: Readonly<Buffer>;
    resource: Readonly<Buffer>;
    sagePlayerProfile: Readonly<Buffer>;
    sector: Readonly<Buffer>;
    ship: Readonly<Buffer>;
    star: Readonly<Buffer>;
    starbase: Readonly<Buffer>;
    starbasePlayer: Readonly<Buffer>;
    surveyDataUnitTracker: Readonly<Buffer>;
}

Type declaration

craftingInstance: Readonly<Buffer>
disbandedFleet: Readonly<Buffer>
fleet: Readonly<Buffer>
fleetShips: Readonly<Buffer>
game: Readonly<Buffer>
gameState: Readonly<Buffer>
mineItem: Readonly<Buffer>
planet: Readonly<Buffer>
resource: Readonly<Buffer>
sagePlayerProfile: Readonly<Buffer>
sector: Readonly<Buffer>
ship: Readonly<Buffer>
star: Readonly<Buffer>
starbase: Readonly<Buffer>
starbasePlayer: Readonly<Buffer>
surveyDataUnitTracker: Readonly<Buffer>

`Protected` parsers

parsers: {
    craftingInstance: (new (...args: never[]) => CraftingInstance & Account) & AccountStatic<CraftingInstance, SageIDL>;
    disbandedFleet: (new (...args: never[]) => DisbandedFleet & Account) & AccountStatic<DisbandedFleet, SageIDL>;
    fleet: (new (...args: never[]) => Fleet & Account) & AccountStatic<Fleet, SageIDL>;
    fleetShips: (new (...args: never[]) => FleetShips & Account) & AccountStatic<FleetShips, SageIDL>;
    game: (new (...args: never[]) => Game & Account) & AccountStatic<Game, SageIDL>;
    gameState: (new (...args: never[]) => GameState & Account) & AccountStatic<GameState, SageIDL>;
    mineItem: (new (...args: never[]) => MineItem & Account) & AccountStatic<MineItem, SageIDL>;
    planet: (new (...args: never[]) => Planet & Account) & AccountStatic<Planet, SageIDL>;
    resource: (new (...args: never[]) => Resource & Account) & AccountStatic<Resource, SageIDL>;
    sagePlayerProfile: (new (...args: never[]) => SagePlayerProfile & Account) & AccountStatic<SagePlayerProfile, SageIDL>;
    sector: (new (...args: never[]) => Sector & Account) & AccountStatic<Sector, SageIDL>;
    ship: (new (...args: never[]) => Ship & Account) & AccountStatic<Ship, SageIDL>;
    star: (new (...args: never[]) => Star & Account) & AccountStatic<Star, SageIDL>;
    starbase: (new (...args: never[]) => Starbase & Account) & AccountStatic<Starbase, SageIDL>;
    starbasePlayer: (new (...args: never[]) => StarbasePlayer & Account) & AccountStatic<StarbasePlayer, SageIDL>;
    surveyDataUnitTracker: (new (...args: never[]) => SurveyDataUnitTracker & Account) & AccountStatic<SurveyDataUnitTracker, SageIDL>;
}

Type declaration

craftingInstance: (new (...args: never[]) => CraftingInstance & Account) & AccountStatic<CraftingInstance, SageIDL>
disbandedFleet: (new (...args: never[]) => DisbandedFleet & Account) & AccountStatic<DisbandedFleet, SageIDL>
fleet: (new (...args: never[]) => Fleet & Account) & AccountStatic<Fleet, SageIDL>
fleetShips: (new (...args: never[]) => FleetShips & Account) & AccountStatic<FleetShips, SageIDL>
game: (new (...args: never[]) => Game & Account) & AccountStatic<Game, SageIDL>
gameState: (new (...args: never[]) => GameState & Account) & AccountStatic<GameState, SageIDL>
mineItem: (new (...args: never[]) => MineItem & Account) & AccountStatic<MineItem, SageIDL>
planet: (new (...args: never[]) => Planet & Account) & AccountStatic<Planet, SageIDL>
resource: (new (...args: never[]) => Resource & Account) & AccountStatic<Resource, SageIDL>
sagePlayerProfile: (new (...args: never[]) => SagePlayerProfile & Account) & AccountStatic<SagePlayerProfile, SageIDL>
sector: (new (...args: never[]) => Sector & Account) & AccountStatic<Sector, SageIDL>
ship: (new (...args: never[]) => Ship & Account) & AccountStatic<Ship, SageIDL>
star: (new (...args: never[]) => Star & Account) & AccountStatic<Star, SageIDL>
starbase: (new (...args: never[]) => Starbase & Account) & AccountStatic<Starbase, SageIDL>
starbasePlayer: (new (...args: never[]) => StarbasePlayer & Account) & AccountStatic<StarbasePlayer, SageIDL>
surveyDataUnitTracker: (new (...args: never[]) => SurveyDataUnitTracker & Account) & AccountStatic<SurveyDataUnitTracker, SageIDL>

`Protected` program

program: ProgramMethods<SageIDL>

Accessors

programId

get programId(): PublicKey
Returns PublicKey

Inherited from ListenProgram.programId

Methods

accountDiscriminant

accountDiscriminant(accountId: keyof SageAccounts): Buffer
Parameters
- accountId: keyof SageAccounts
Returns Buffer

Inherited from ListenProgram.accountDiscriminant

discriminantToAccountId

discriminantToAccountId(data: Buffer): null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}
Parameters
- data: Buffer
Returns null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}

Inherited from ListenProgram.discriminantToAccountId

discriminantToAccountIdNoSubarray

discriminantToAccountIdNoSubarray(discriminant: Buffer): null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}
Parameters
- discriminant: Buffer
Returns null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}

Inherited from ListenProgram.discriminantToAccountIdNoSubarray

provideAccountClosedEvent

provideAccountClosedEvent(key: PublicKey, oldOwner: PublicKey, newOwner: PublicKey, slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", writeVersion: number, accountInfo: AccountInfo<Buffer>): void
Parameters
- key: PublicKey
- oldOwner: PublicKey
- newOwner: PublicKey
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- writeVersion: number
- accountInfo: AccountInfo<Buffer>
Returns void

Inherited from ListenProgram.provideAccountClosedEvent

provideAccountEvent

provideAccountEvent(account: KeyedAccountInfo, slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", isStartup: boolean, writeVersion: number, unknownAccountHandler?: ((key: PublicKey) => void)): void
Parameters
- account: KeyedAccountInfo
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- isStartup: boolean
- writeVersion: number
- Optional unknownAccountHandler: ((key: PublicKey) => void)
  - - (key: PublicKey): void
    - Parameters
      
      key: PublicKey
      
      Returns void
Returns void

Inherited from ListenProgram.provideAccountEvent

provideDecodedAccountEvent

provideDecodedAccountEvent<AccountId>(accountId: AccountId, account: SageAccounts[AccountId], slot: number, confirmationStatus: TransactionConfirmationStatus | "recent", isStartup: boolean, accountInfo: AccountInfo<Buffer>, writeVersion: number): void
Type Parameters
- AccountId extends keyof SageAccounts
Parameters
- accountId: AccountId
- account: SageAccounts[AccountId]
- slot: number
- confirmationStatus: TransactionConfirmationStatus | "recent"
- isStartup: boolean
- accountInfo: AccountInfo<Buffer>
- writeVersion: number
Returns void

Inherited from ListenProgram.provideDecodedAccountEvent

setAccountClosedListener

setAccountClosedListener(listener: ((update: AccountClosedUpdate) => null | void)): void
Parameters
- listener: ((update: AccountClosedUpdate) => null | void)
  - - (update: AccountClosedUpdate): null | void
    - Parameters
      
      update: AccountClosedUpdate
      
      Returns null | void
Returns void

Inherited from ListenProgram.setAccountClosedListener

setAccountListener

setAccountListener<AccountId>(accountId: AccountId, accountType: (new (...args: never[]) => SageAccounts[AccountId]), listener: null | AccountUpdateHandler<SageAccounts[AccountId]>): void
Type Parameters
- AccountId extends keyof SageAccounts
Parameters
- accountId: AccountId
- accountType: (new (...args: never[]) => SageAccounts[AccountId])
  - - new (...args: never[]): SageAccounts[AccountId]
    - Parameters
      
      Rest ...args: never[]
      
      Returns SageAccounts[AccountId]
- listener: null | AccountUpdateHandler<SageAccounts[AccountId]>
Returns void

Inherited from ListenProgram.setAccountListener

`Static` buildProgram

buildProgram(programId: PublicKey, provider?: default, coder?: Coder<string, string>): SageIDLProgram
Parameters
- programId: PublicKey
- Optional provider: default
- Optional coder: Coder<string, string>
Returns SageIDLProgram

Class SageProgram

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

program: SageIDLProgram

Returns SageProgram

Properties

Protected accountClosedListener

Protected Readonly accountDiscriminants

Type declaration

craftingInstance: Readonly<Buffer>

disbandedFleet: Readonly<Buffer>

fleet: Readonly<Buffer>

fleetShips: Readonly<Buffer>

game: Readonly<Buffer>

gameState: Readonly<Buffer>

mineItem: Readonly<Buffer>

planet: Readonly<Buffer>

resource: Readonly<Buffer>

sagePlayerProfile: Readonly<Buffer>

sector: Readonly<Buffer>

ship: Readonly<Buffer>

star: Readonly<Buffer>

starbase: Readonly<Buffer>

starbasePlayer: Readonly<Buffer>

surveyDataUnitTracker: Readonly<Buffer>

Protected parsers

Type declaration

craftingInstance: (new (...args: never[]) => CraftingInstance & Account) & AccountStatic<CraftingInstance, SageIDL>

disbandedFleet: (new (...args: never[]) => DisbandedFleet & Account) & AccountStatic<DisbandedFleet, SageIDL>

fleet: (new (...args: never[]) => Fleet & Account) & AccountStatic<Fleet, SageIDL>

fleetShips: (new (...args: never[]) => FleetShips & Account) & AccountStatic<FleetShips, SageIDL>

game: (new (...args: never[]) => Game & Account) & AccountStatic<Game, SageIDL>

gameState: (new (...args: never[]) => GameState & Account) & AccountStatic<GameState, SageIDL>

mineItem: (new (...args: never[]) => MineItem & Account) & AccountStatic<MineItem, SageIDL>

planet: (new (...args: never[]) => Planet & Account) & AccountStatic<Planet, SageIDL>

resource: (new (...args: never[]) => Resource & Account) & AccountStatic<Resource, SageIDL>

sagePlayerProfile: (new (...args: never[]) => SagePlayerProfile & Account) & AccountStatic<SagePlayerProfile, SageIDL>

sector: (new (...args: never[]) => Sector & Account) & AccountStatic<Sector, SageIDL>

ship: (new (...args: never[]) => Ship & Account) & AccountStatic<Ship, SageIDL>

star: (new (...args: never[]) => Star & Account) & AccountStatic<Star, SageIDL>

starbase: (new (...args: never[]) => Starbase & Account) & AccountStatic<Starbase, SageIDL>

starbasePlayer: (new (...args: never[]) => StarbasePlayer & Account) & AccountStatic<StarbasePlayer, SageIDL>

surveyDataUnitTracker: (new (...args: never[]) => SurveyDataUnitTracker & Account) & AccountStatic<SurveyDataUnitTracker, SageIDL>

Protected program

Accessors

programId

Returns PublicKey

Methods

accountDiscriminant

Parameters

accountId: keyof SageAccounts

Returns Buffer

discriminantToAccountId

Parameters

data: Buffer

Returns null | { discriminantLength: number; key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker"; }

discriminantToAccountIdNoSubarray

Parameters

discriminant: Buffer

Returns null | { discriminantLength: number; key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker"; }

provideAccountClosedEvent

Parameters

key: PublicKey

oldOwner: PublicKey

newOwner: PublicKey

slot: number

confirmationStatus: TransactionConfirmationStatus | "recent"

writeVersion: number

accountInfo: AccountInfo<Buffer>

Returns void

provideAccountEvent

Parameters

account: KeyedAccountInfo

`Protected` accountClosedListener

`Protected` `Readonly` accountDiscriminants

`Protected` parsers

`Protected` program

Returns null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}

Returns null | {
discriminantLength: number;
key: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker";
}

`Optional` unknownAccountHandler: ((key: PublicKey) => void)

`Rest` ...args: never[]

`Static` buildProgram

`Optional` provider: default

`Optional` coder: Coder<string, string>