Class GameClient

constructor

• new GameClient(program, address, account?): GameClient

• Parameters

  • program: SoarProgram

  • address: PublicKey

  • Optional account: GameAccount

  Returns GameClient

account

address

program

addAchievement

• addAchievement(authority, title, description, nftMeta): Promise<AddGameAchievement>

• Parameters

  • authority: PublicKey

  • title: string

  • description: string

  • nftMeta: PublicKey

  Returns Promise<AddGameAchievement>

addLeaderBoard

• addLeaderBoard(authority, description, nftMeta, scoresToRetain, scoresOrder, decimals?, minScore?, maxScore?): Promise<AddLeaderBoard>

• Parameters

  • authority: PublicKey

  • description: string

  • nftMeta: PublicKey

  • scoresToRetain: number

  • scoresOrder: boolean

  • Optional decimals: number

  • Optional minScore: BN

  • Optional maxScore: BN

  Returns Promise<AddLeaderBoard>

fetchAchievementAccounts

• fetchAchievementAccounts(): Promise<AchievementAccount[]>

• Returns Promise<AchievementAccount[]>

fetchLeaderBoardAccounts

• fetchLeaderBoardAccounts(): Promise<LeaderBoardAccount[]>

• Returns Promise<LeaderBoardAccount[]>

init

• init(): Promise<void>

• Returns Promise<void>

nextAchievementAddress

• nextAchievementAddress(): PublicKey

• Returns PublicKey

nextLeaderBoardAddress

• nextLeaderBoardAddress(): PublicKey

• Returns PublicKey

recentAchievementAddress

• recentAchievementAddress(): PublicKey

• Returns PublicKey

recentLeaderBoardAddress

• recentLeaderBoardAddress(): PublicKey

• Returns PublicKey

refresh

• refresh(): Promise<void>

• Returns Promise<void>

registerPlayer

• registerPlayer(user, leaderBoard?): Promise<RegisterPlayerEntry>

• Parameters

  • user: PublicKey

  • Optional leaderBoard: PublicKey

  Returns Promise<RegisterPlayerEntry>

submitScore

• submitScore(user, authority, score, leaderBoard?): Promise<SubmitScore>

• Parameters

  • user: PublicKey

  • authority: PublicKey

  • score: BN

  • Optional leaderBoard: PublicKey

  Returns Promise<SubmitScore>

update

• update(authority, newMeta?, newAuths?): Promise<UpdateGame>

• Parameters

  • authority: PublicKey

  • Optional newMeta: GameAttributes

  • Optional newAuths: PublicKey[]

  Returns Promise<UpdateGame>

updateAchievement

• updateAchievement(authority, achievement, newTitle?, newDescription?, newNftMeta?): Promise<UpdateAchievement>

• Parameters

  • authority: PublicKey

  • achievement: PublicKey

  • Optional newTitle: string

  • Optional newDescription: string

  • Optional newNftMeta: PublicKey

  Returns Promise<UpdateAchievement>

Static register

• register(program, title, description, genre, gameType, nftMeta, auths): Promise<GameClient>

• Parameters

  • program: SoarProgram

  • title: string

  • description: string

  • genre: Genre

  • gameType: GameType

  • nftMeta: PublicKey

  • auths: PublicKey[]

  Returns Promise<GameClient>