add Token Voter plugin (Mythic-Project#99)

* add Token Voter plugin

* resolve merge conflicts 1

* update yarn.lock

* fix test error

Author: 0xShuk

BonkVotePlugin/client.ts

@@ -28,7 +28,7 @@ export class BonkClient extends Client<BonkPlugin> {
   constructor(
     public program: Program<BonkPlugin>,
     tokenVoterProgram: Program<TokenVoter>,
-    splTokenProgram: Program<SplTokenStaking>,
+    splTokenProgram: Program<SplTokenStaking>
   ) {
     super(program)
     this.tokenPlugin = tokenVoterProgram
@@ -219,4 +219,4 @@ export class BonkClient extends Client<BonkPlugin> {
   ): Promise<TransactionInstruction | null> {
     return null
   }
-}
+}

BonkVotePlugin/token-client.ts

@@ -0,0 +1,103 @@
+import { SequenceType } from "@blockworks-foundation/mangolana/lib/globalTypes"
+import { BN, Program } from "@coral-xyz/anchor"
+import { TOKEN_2022_PROGRAM_ID, getAssociatedTokenAddressSync } from "@solana/spl-token-new"
+import { WalletContextState } from "@solana/wallet-adapter-react"
+import { Connection, PublicKey, SYSVAR_INSTRUCTIONS_PUBKEY, TransactionInstruction } from "@solana/web3.js"
+import { sendTransactionsV3, txBatchesToInstructionSetWithSigners } from "@utils/sendTransactions"
+import { TokenVoter } from "BonkVotePlugin/token-type"
+import { tokenRegistrarKey, tokenVoterKey, tokenVwrKey } from "BonkVotePlugin/utils"
+import { SplGovernance } from "governance-idl-sdk"
+
+async function addTokensHandler(
+    connection: Connection,
+    wallet: WalletContextState,
+    ixClient: SplGovernance,
+    realmAccount: PublicKey,
+    tokenMint: PublicKey,
+    depositMint: PublicKey,
+    tokenAccount: PublicKey,
+    userAccount: PublicKey,
+    amount: BN,
+    tokenVoterClient?: Program<TokenVoter> | undefined
+) {
+  const ixs: TransactionInstruction[] = []
+
+  // Plugin Deposit
+  if (tokenVoterClient) {
+    const tokenOwnerRecordKey = ixClient.pda.tokenOwnerRecordAccount({
+      realmAccount, governingTokenMintAccount: tokenMint, governingTokenOwner: userAccount
+    }).publicKey
+
+    const tokenOwnerRecord = await connection.getAccountInfo(tokenOwnerRecordKey)
+
+    if (!tokenOwnerRecord) {
+      const createTokenOwnerRecordIx = await ixClient.createTokenOwnerRecordInstruction(
+        realmAccount, userAccount, tokenMint, userAccount
+      )
+      ixs.push(createTokenOwnerRecordIx)
+    }
+
+    const registrarKey = tokenRegistrarKey(realmAccount, tokenMint, tokenVoterClient.programId)
+    const [voterKey] = tokenVoterKey(realmAccount, tokenMint, userAccount, tokenVoterClient.programId)
+    const [tokenVwr] = tokenVwrKey(realmAccount, tokenMint, userAccount, tokenVoterClient.programId)
+    const vault = getAssociatedTokenAddressSync(depositMint, voterKey, true, TOKEN_2022_PROGRAM_ID)
+
+    try {
+      await tokenVoterClient.account.voter.fetch(voterKey)
+    } catch {
+      const createVoterIx = await tokenVoterClient.methods.createVoterWeightRecord()
+      .accounts({
+        registrar: registrarKey,
+        voter: voterKey,
+        voterWeightRecord: tokenVwr,
+        voterAuthority: userAccount,
+        instructions: SYSVAR_INSTRUCTIONS_PUBKEY
+      }).instruction()
+  
+      ixs.push(createVoterIx)
+    }
+
+    const depositEntryIndex = 0
+
+    const depositIx = await tokenVoterClient.methods.deposit(
+      depositEntryIndex, 
+      amount
+    ).accounts({
+      mint: depositMint,
+      tokenOwnerRecord: tokenOwnerRecordKey,
+      depositAuthority: wallet.publicKey ?? undefined,
+      tokenProgram: TOKEN_2022_PROGRAM_ID,
+      registrar: registrarKey,
+      instructions: SYSVAR_INSTRUCTIONS_PUBKEY,
+      voter: voterKey,
+      vault,
+      voterWeightRecord: tokenVwr,
+      depositToken: tokenAccount,
+    }).instruction()
+    
+    ixs.push(depositIx)
+  } else {
+    const vanillaDepositIx = await ixClient.depositGoverningTokensInstruction(
+      realmAccount,
+      tokenMint,
+      tokenAccount,
+      userAccount,
+      userAccount,
+      userAccount,
+      amount,
+    )
+
+    ixs.push(vanillaDepositIx)
+  }
+
+  await sendTransactionsV3({
+    connection,
+    wallet,
+    transactionInstructions: [{
+      instructionsSet: txBatchesToInstructionSetWithSigners(ixs, []),
+      sequenceType: SequenceType.Sequential
+    }]
+  })
+}
+
+export default addTokensHandler

TokenVoterPlugin/actions/depositTokens.ts

@@ -0,0 +1,77 @@
+import { BN, Program } from "@coral-xyz/anchor"
+import { PublicKey } from "@metaplex-foundation/js"
+import { TOKEN_2022_PROGRAM_ID, createAssociatedTokenAccountInstruction, getAssociatedTokenAddressSync } from "@solana/spl-token-new"
+import { WalletContextState } from "@solana/wallet-adapter-react"
+import { Connection, TransactionInstruction } from "@solana/web3.js"
+import { SequenceType, sendTransactionsV3, txBatchesToInstructionSetWithSigners } from "@utils/sendTransactions"
+import { TokenVoter } from "BonkVotePlugin/token-type"
+import { tokenRegistrarKey, tokenVoterKey, tokenVwrKey } from "BonkVotePlugin/utils"
+import { SplGovernance, TokenOwnerRecord } from "governance-idl-sdk"
+
+export async function withdrawTokensHandler(
+  connection: Connection,
+  wallet: WalletContextState,
+  govClient: SplGovernance,
+  realmAccount: PublicKey,
+  tokenMint: PublicKey,
+  depositMint: PublicKey,
+  userAccount: PublicKey,
+  amount: BN,
+  tokenOwnerRecord: TokenOwnerRecord,
+  tokenVoterClient?: Program<TokenVoter> | undefined,
+) {
+    const ixs: TransactionInstruction[] = []
+
+    if (tokenOwnerRecord.outstandingProposalCount > 0) {
+      throw new Error("The user has the outstanding proposals. Can't withdraw the tokens.")
+    }
+
+    const userAta = getAssociatedTokenAddressSync(depositMint, userAccount, undefined, TOKEN_2022_PROGRAM_ID)
+    const doesUserAtaExist = await connection.getAccountInfo(userAta)
+
+    if (!doesUserAtaExist) {
+      const createAtaIx = createAssociatedTokenAccountInstruction(
+        userAccount,
+        userAta,
+        userAccount,
+        depositMint,
+        TOKEN_2022_PROGRAM_ID
+      )
+
+      ixs.push(createAtaIx)
+    }
+
+    if (tokenVoterClient) {
+      const registrarKey = tokenRegistrarKey(realmAccount, tokenMint, tokenVoterClient.programId)
+      const [voterKey] = tokenVoterKey(realmAccount, tokenMint, userAccount, tokenVoterClient.programId)
+      const [tokenVwr] = tokenVwrKey(realmAccount, tokenMint, userAccount, tokenVoterClient.programId)
+      const vault = getAssociatedTokenAddressSync(depositMint, voterKey, true, TOKEN_2022_PROGRAM_ID)
+
+      const withdawIx = await tokenVoterClient.methods.withdraw(
+        0, 
+        amount
+      ).accounts({
+        registrar: registrarKey,
+        voter: voterKey,
+        voterAuthority: userAccount,
+        tokenOwnerRecord: tokenOwnerRecord.publicKey,
+        mint: depositMint,
+        voterWeightRecord: tokenVwr,
+        tokenProgram: TOKEN_2022_PROGRAM_ID,
+        vault,
+        destination: userAta
+      })
+      .instruction()
+
+      ixs.push(withdawIx)
+    }
+
+    await sendTransactionsV3({
+      connection,
+      wallet,
+      transactionInstructions: [{
+        instructionsSet: txBatchesToInstructionSetWithSigners(ixs, []),
+        sequenceType: SequenceType.Sequential
+      }]
+    })
+}