Class InstructionBuilder

constructor

• new InstructionBuilder(provider, programId): InstructionBuilder

• Parameters

  • provider: AnchorProvider

  • programId: PublicKey

  Returns InstructionBuilder

Readonly accounts

instructions

Readonly program

signers

Readonly utils

addAchievementStep

• addAchievementStep(args, game, authority, nextAchievement?): Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      newAchievement: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
  }]>

• Parameters

  • args: AddAchievementArgs

  • game: PublicKey

  • authority: PublicKey

  • Optional nextAchievement: PublicKey

  Returns Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      newAchievement: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
  }]>

addFungibleRewardStep

• addFungibleRewardStep(args, authority, newReward, achievement, sourceTokenAccount, tokenAccountOwner, mint, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      delegateFromTokenAccount: PublicKey;
      game: PublicKey;
      newReward: PublicKey;
      payer: PublicKey;
      rewardTokenMint: PublicKey;
      systemProgram: PublicKey;
      tokenAccountOwner: PublicKey;
      tokenProgram: PublicKey;
  }]>

• Parameters

  • args: AddFtRewardArgs

  • authority: PublicKey

  • newReward: PublicKey

  • achievement: PublicKey

  • sourceTokenAccount: PublicKey

  • tokenAccountOwner: PublicKey

  • mint: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      delegateFromTokenAccount: PublicKey;
      game: PublicKey;
      newReward: PublicKey;
      payer: PublicKey;
      rewardTokenMint: PublicKey;
      systemProgram: PublicKey;
      tokenAccountOwner: PublicKey;
      tokenProgram: PublicKey;
  }]>

addLeaderBoardStep

• addLeaderBoardStep(args, gameAddress, authority, nextLeaderboard?): Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
      topEntries: null | PublicKey;
  }]>

• Parameters

  • args: AddLeaderBoardArgs

  • gameAddress: PublicKey

  • authority: PublicKey

  • Optional nextLeaderboard: PublicKey

  Returns Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
      topEntries: null | PublicKey;
  }]>

addNonFungibleRewardStep

• addNonFungibleRewardStep(args, authority, newReward, achievement, collectionMint?, collectionUpdateAuthority?, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      collectionMetadata: null | PublicKey;
      collectionUpdateAuth: null | PublicKey;
      game: PublicKey;
      newReward: PublicKey;
      payer: PublicKey;
      rewardCollectionMint: null | PublicKey;
      systemProgram: PublicKey;
      tokenMetadataProgram: null | PublicKey;
  }]>

• Parameters

  • args: AddNftRewardArgs

  • authority: PublicKey

  • newReward: PublicKey

  • achievement: PublicKey

  • Optional collectionMint: PublicKey

  • Optional collectionUpdateAuthority: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      collectionMetadata: null | PublicKey;
      collectionUpdateAuth: null | PublicKey;
      game: PublicKey;
      newReward: PublicKey;
      payer: PublicKey;
      rewardCollectionMint: null | PublicKey;
      systemProgram: PublicKey;
      tokenMetadataProgram: null | PublicKey;
  }]>

append

• append(instructions): InstructionBuilder

• Parameters

  • instructions: TransactionInstruction[]

  Returns InstructionBuilder

build

• build(): Transaction

• Bundle instructions into a single transaction.

  Returns Transaction

claimFtRewardStep

• claimFtRewardStep(authority, achievement, user, reward?, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
      mint: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      reward: PublicKey;
      sourceTokenAccount: PublicKey;
      tokenProgram: PublicKey;
      user: PublicKey;
      userTokenAccount: PublicKey;
  }]>

• Parameters

  • authority: PublicKey

  • achievement: PublicKey

  • user: PublicKey

  • Optional reward: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
      mint: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      reward: PublicKey;
      sourceTokenAccount: PublicKey;
      tokenProgram: PublicKey;
      user: PublicKey;
      userTokenAccount: PublicKey;
  }]>

claimNftRewardStep

• claimNftRewardStep(authority, achievement, mint, user, reward?, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      associatedTokenProgram: PublicKey;
      authority: PublicKey;
      claim: PublicKey;
      game: PublicKey;
      mintTo: PublicKey;
      newMasterEdition: PublicKey;
      newMetadata: PublicKey;
      newMint: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      rent: PublicKey;
      reward: PublicKey;
      systemProgram: PublicKey;
      tokenMetadataProgram: PublicKey;
      tokenProgram: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • authority: PublicKey

  • achievement: PublicKey

  • mint: PublicKey

  • user: PublicKey

  • Optional reward: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      associatedTokenProgram: PublicKey;
      authority: PublicKey;
      claim: PublicKey;
      game: PublicKey;
      mintTo: PublicKey;
      newMasterEdition: PublicKey;
      newMetadata: PublicKey;
      newMint: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      rent: PublicKey;
      reward: PublicKey;
      systemProgram: PublicKey;
      tokenMetadataProgram: PublicKey;
      tokenProgram: PublicKey;
      user: PublicKey;
  }]>

clean

• clean(): void

• Internally reset the instruction list in this instance.

  Returns void

complete

• complete(opts?): Promise<string>

• Send and confirm the bundled transaction.

  Parameters

  • Optional opts: ConfirmOptions

  Returns Promise<string>

initGameStep

• initGameStep(args, newGame): Promise<[InstructionBuilder, {
      creator: PublicKey;
      game: PublicKey;
      systemProgram: PublicKey;
  }]>

• Parameters

  • args: InitializeGameArgs

  • newGame: PublicKey

  Returns Promise<[InstructionBuilder, {
      creator: PublicKey;
      game: PublicKey;
      systemProgram: PublicKey;
  }]>

initMergeStep

• initMergeStep(args, user, newMergeAccount): Promise<[InstructionBuilder, {
      mergeAccount: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • args: InitMergeArgs

  • user: PublicKey

  • newMergeAccount: PublicKey

  Returns Promise<[InstructionBuilder, {
      mergeAccount: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

initPlayerStep

• initPlayerStep(args, user): Promise<[InstructionBuilder, {
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • args: InitializePlayerArgs

  • user: PublicKey

  Returns Promise<[InstructionBuilder, {
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

registerMergeApprovalStep

• registerMergeApprovalStep(user, mergeAccount): Promise<[InstructionBuilder, {
      mergeAccount: PublicKey;
      playerAccount: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • user: PublicKey

  • mergeAccount: PublicKey

  Returns Promise<[InstructionBuilder, {
      mergeAccount: PublicKey;
      playerAccount: PublicKey;
      user: PublicKey;
  }]>

registerPlayerEntryStep

• registerPlayerEntryStep(user, leaderboard, game?): Promise<[InstructionBuilder, {
      game: PublicKey;
      leaderboard: PublicKey;
      newList: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • user: PublicKey

  • leaderboard: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      game: PublicKey;
      leaderboard: PublicKey;
      newList: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      systemProgram: PublicKey;
      user: PublicKey;
  }]>

sign

• sign(signers): void

• Parameters

  • signers: Signer[]

  Returns void

submitScoreStep

• submitScoreStep(args, user, authority, leaderboard, game?): Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerScores: PublicKey;
      systemProgram: PublicKey;
      topEntries: null | PublicKey;
  }]>

• Parameters

  • args: SubmitScoreArgs

  • user: PublicKey

  • authority: PublicKey

  • leaderboard: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerScores: PublicKey;
      systemProgram: PublicKey;
      topEntries: null | PublicKey;
  }]>

unlockPlayerAchievementStep

• unlockPlayerAchievementStep(user, authority, achievement, leaderboard, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      playerScores: PublicKey;
  }]>

• Parameters

  • user: PublicKey

  • authority: PublicKey

  • achievement: PublicKey

  • leaderboard: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      playerScores: PublicKey;
  }]>

updateAchievementStep

• updateAchievementStep(args, authority, achievement, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
  }]>

• Parameters

  • args: UpdateAchievementArgs

  • authority: PublicKey

  • achievement: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      authority: PublicKey;
      game: PublicKey;
  }]>

updateGameStep

• updateGameStep(args, game, authority): Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
  }]>

• Parameters

  • args: UpdateGameArgs

  • game: PublicKey

  • authority: PublicKey

  Returns Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      payer: PublicKey;
      systemProgram: PublicKey;
  }]>

updateLeaderboardStep

• updateLeaderboardStep(args, authority, leaderboard, game?): Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
  }]>

• Parameters

  • args: UpdateLeaderboardArgs

  • authority: PublicKey

  • leaderboard: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      authority: PublicKey;
      game: PublicKey;
      leaderboard: PublicKey;
  }]>

updatePlayerStep

• updatePlayerStep(args, user): Promise<[InstructionBuilder, {
      playerAccount: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • args: UpdatePlayerArgs

  • user: PublicKey

  Returns Promise<[InstructionBuilder, {
      playerAccount: PublicKey;
      user: PublicKey;
  }]>

verifyPlayerNftRewardStep

• verifyPlayerNftRewardStep(user, achievement, mint, reward?, game?): Promise<[InstructionBuilder, {
      achievement: PublicKey;
      claim: PublicKey;
      collectionEdition: PublicKey;
      collectionMetadata: PublicKey;
      collectionMint: PublicKey;
      game: PublicKey;
      metadataToVerify: PublicKey;
      mint: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      reward: PublicKey;
      tokenMetadataProgram: PublicKey;
      user: PublicKey;
  }]>

• Parameters

  • user: PublicKey

  • achievement: PublicKey

  • mint: PublicKey

  • Optional reward: PublicKey

  • Optional game: PublicKey

  Returns Promise<[InstructionBuilder, {
      achievement: PublicKey;
      claim: PublicKey;
      collectionEdition: PublicKey;
      collectionMetadata: PublicKey;
      collectionMint: PublicKey;
      game: PublicKey;
      metadataToVerify: PublicKey;
      mint: PublicKey;
      payer: PublicKey;
      playerAccount: PublicKey;
      playerAchievement: PublicKey;
      reward: PublicKey;
      tokenMetadataProgram: PublicKey;
      user: PublicKey;
  }]>