Add isTransferring check to transfer hook examples

Author: Woody4618

tokens/token-2022/transfer-hook/counter/anchor/programs/transfer-hook/src/lib.rs

@@ -26,7 +26,7 @@ use spl_transfer_hook_interface::instruction::ExecuteInstruction;
 declare_id!("1qahDxKHeCLZhbBU2NyMU6vQCQmEUmdeSEBrG5drffK");
 
 #[error_code]
-pub enum MyError {
+pub enum TransferError {
     #[msg("The amount is too big")]
     AmountTooBig,
     #[msg("The token is not currently transferring")]
@@ -60,13 +60,13 @@ pub mod transfer_hook {
         // Check if the amount is too big
         if amount > 50 {
             msg!("The amount is too big: {}", amount);
-            //return err!(MyError::AmountTooBig);
+            //return err!(TransferError::AmountTooBig);
         }
 
         // Increment the transfer count safely
         let count = ctx.accounts.counter_account.counter
             .checked_add(1)
-            .ok_or(MyError::AmountTooBig)?;
+            .ok_or(TransferError::AmountTooBig)?;
 
         msg!("This token has been transferred {} times", count);
 
@@ -81,7 +81,7 @@ fn check_is_transferring(ctx: &Context<TransferHook>) -> Result<()> {
     let account_extension = account.get_extension_mut::<TransferHookAccount>()?;
 
     if !bool::from(account_extension.transferring) {
-        return err!(MyError::IsNotCurrentlyTransferring);
+        return err!(TransferError::IsNotCurrentlyTransferring);
     }
 
     Ok(())

tokens/token-2022/transfer-hook/counter/anchor/tests/transfer-hook.ts

@@ -25,7 +25,6 @@ import { BN } from "bn.js";
 import { expect } from "chai";
 import chai from "chai";
 import chaiAsPromised from "chai-as-promised";
-import { send } from "process";
 
 chai.use(chaiAsPromised);
 
@@ -244,7 +243,7 @@ describe("transfer-hook", () => {
 
     await expect(sendPromise).to.eventually.be.rejectedWith(
       SendTransactionError,
-      /Number: 6001./
+      program.idl.errors[1].msg
     );
   });
 });

tokens/token-2022/transfer-hook/hello-world/anchor/package.json

@@ -9,9 +9,11 @@
   },
   "devDependencies": {
     "@types/bn.js": "^5.1.0",
+    "@types/chai-as-promised": "^7.1.8",
+    "chai-as-promised": "^7.1.2",
     "@types/chai": "^4.3.0",
-    "@types/mocha": "^9.0.0",
     "chai": "^4.3.4",
+    "@types/mocha": "^9.0.0",
     "mocha": "^9.0.3",
     "prettier": "^2.6.2",
     "ts-mocha": "^10.0.0",

tokens/token-2022/transfer-hook/hello-world/anchor/programs/transfer-hook/src/lib.rs

@@ -1,6 +1,16 @@
+use std::cell::RefMut;
+
 use anchor_lang::prelude::*;
 use anchor_spl::{
     associated_token::AssociatedToken,
+    token_2022::spl_token_2022::{
+        extension::{
+            transfer_hook::TransferHookAccount,
+            BaseStateWithExtensionsMut,
+            PodStateWithExtensionsMut,
+        },
+        pod::PodAccount,
+    },
     token_interface::{
         spl_pod::optional_keys::OptionalNonZeroPubkey,
         spl_token_2022::{
@@ -21,6 +31,12 @@ use spl_transfer_hook_interface::instruction::ExecuteInstruction;
 
 declare_id!("jY5DfVksJT8Le38LCaQhz5USeiGu4rUeVSS8QRAMoba");
 
+#[error_code]
+pub enum TransferError {
+    #[msg("The token is not currently transferring")]
+    IsNotCurrentlyTransferring,
+}
+
 #[program]
 pub mod transfer_hook {
     use super::*;
@@ -47,7 +63,7 @@ pub mod transfer_hook {
     }
 
     #[interface(spl_transfer_hook_interface::execute)]
-    pub fn transfer_hook(_ctx: Context<TransferHook>, _amount: u64) -> Result<()> {
+    pub fn transfer_hook(ctx: Context<TransferHook>, _amount: u64) -> Result<()> {
         // Fail this instruction if it is not called from within a transfer hook
         check_is_transferring(&ctx)?;
 
@@ -64,7 +80,7 @@ fn check_is_transferring(ctx: &Context<TransferHook>) -> Result<()> {
     let account_extension = account.get_extension_mut::<TransferHookAccount>()?;
 
     if !bool::from(account_extension.transferring) {
-        return err!(MyError::IsNotCurrentlyTransferring);
+        return err!(TransferError::IsNotCurrentlyTransferring);
     }
 
     Ok(())

tokens/token-2022/transfer-hook/hello-world/anchor/tests/transfer-hook.ts

@@ -1,17 +1,27 @@
-import * as anchor from '@coral-xyz/anchor';
-import type { Program } from '@coral-xyz/anchor';
+import * as anchor from "@coral-xyz/anchor";
+import type { Program } from "@coral-xyz/anchor";
 import {
   ASSOCIATED_TOKEN_PROGRAM_ID,
   TOKEN_2022_PROGRAM_ID,
   createAssociatedTokenAccountInstruction,
   createMintToInstruction,
   createTransferCheckedWithTransferHookInstruction,
   getAssociatedTokenAddressSync,
-} from '@solana/spl-token';
-import { Keypair, Transaction, sendAndConfirmTransaction } from '@solana/web3.js';
-import type { TransferHook } from '../target/types/transfer_hook';
-
-describe('transfer-hook', () => {
+} from "@solana/spl-token";
+import {
+  Keypair,
+  Transaction,
+  sendAndConfirmTransaction,
+  SendTransactionError,
+} from "@solana/web3.js";
+import type { TransferHook } from "../target/types/transfer_hook";
+import { expect } from "chai";
+import chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+
+chai.use(chaiAsPromised);
+
+describe("transfer-hook", () => {
   // Configure the client to use the local cluster.
   const provider = anchor.AnchorProvider.env();
   anchor.setProvider(provider);
@@ -30,7 +40,7 @@ describe('transfer-hook', () => {
     wallet.publicKey,
     false,
     TOKEN_2022_PROGRAM_ID,
-    ASSOCIATED_TOKEN_PROGRAM_ID,
+    ASSOCIATED_TOKEN_PROGRAM_ID
   );
 
   // Recipient token account address
@@ -40,21 +50,21 @@ describe('transfer-hook', () => {
     recipient.publicKey,
     false,
     TOKEN_2022_PROGRAM_ID,
-    ASSOCIATED_TOKEN_PROGRAM_ID,
+    ASSOCIATED_TOKEN_PROGRAM_ID
   );
 
-  it('Create Mint with Transfer Hook Extension', async () => {
+  it("Create Mint with Transfer Hook Extension", async () => {
     const transactionSignature = await program.methods
       .initialize(decimals)
       .accounts({ mintAccount: mint.publicKey })
       .signers([mint])
       .rpc({ skipPreflight: true });
-    console.log('Your transaction signature', transactionSignature);
+    console.log("Your transaction signature", transactionSignature);
   });
 
   // Create the two token accounts for the transfer-hook enabled mint
   // Fund the sender token account with 100 tokens
-  it('Create Token Accounts and Mint Tokens', async () => {
+  it("Create Token Accounts and Mint Tokens", async () => {
     // 100 tokens
     const amount = 100 * 10 ** decimals;
 
@@ -65,61 +75,112 @@ describe('transfer-hook', () => {
         wallet.publicKey,
         mint.publicKey,
         TOKEN_2022_PROGRAM_ID,
-        ASSOCIATED_TOKEN_PROGRAM_ID,
+        ASSOCIATED_TOKEN_PROGRAM_ID
       ),
       createAssociatedTokenAccountInstruction(
         wallet.publicKey,
         destinationTokenAccount,
         recipient.publicKey,
         mint.publicKey,
         TOKEN_2022_PROGRAM_ID,
-        ASSOCIATED_TOKEN_PROGRAM_ID,
+        ASSOCIATED_TOKEN_PROGRAM_ID
       ),
-      createMintToInstruction(mint.publicKey, sourceTokenAccount, wallet.publicKey, amount, [], TOKEN_2022_PROGRAM_ID),
+      createMintToInstruction(
+        mint.publicKey,
+        sourceTokenAccount,
+        wallet.publicKey,
+        amount,
+        [],
+        TOKEN_2022_PROGRAM_ID
+      )
     );
 
-    const txSig = await sendAndConfirmTransaction(connection, transaction, [wallet.payer], { skipPreflight: true });
+    const txSig = await sendAndConfirmTransaction(
+      connection,
+      transaction,
+      [wallet.payer],
+      { skipPreflight: true }
+    );
 
     console.log(`Transaction Signature: ${txSig}`);
   });
 
   // Account to store extra accounts required by the transfer hook instruction
-  it('Create ExtraAccountMetaList Account', async () => {
+  it("Create ExtraAccountMetaList Account", async () => {
     const initializeExtraAccountMetaListInstruction = await program.methods
       .initializeExtraAccountMetaList()
       .accounts({
         mint: mint.publicKey,
       })
       .instruction();
 
-    const transaction = new Transaction().add(initializeExtraAccountMetaListInstruction);
+    const transaction = new Transaction().add(
+      initializeExtraAccountMetaListInstruction
+    );
 
-    const txSig = await sendAndConfirmTransaction(provider.connection, transaction, [wallet.payer], { skipPreflight: true, commitment: 'confirmed' });
-    console.log('Transaction Signature:', txSig);
+    const txSig = await sendAndConfirmTransaction(
+      provider.connection,
+      transaction,
+      [wallet.payer],
+      { skipPreflight: true, commitment: "confirmed" }
+    );
+    console.log("Transaction Signature:", txSig);
   });
 
-  it('Transfer Hook with Extra Account Meta', async () => {
+  it("Transfer Hook with Extra Account Meta", async () => {
     // 1 tokens
     const amount = 1 * 10 ** decimals;
     const bigIntAmount = BigInt(amount);
 
     // Standard token transfer instruction
-    const transferInstruction = await createTransferCheckedWithTransferHookInstruction(
+    const transferInstruction =
+      await createTransferCheckedWithTransferHookInstruction(
+        connection,
+        sourceTokenAccount,
+        mint.publicKey,
+        destinationTokenAccount,
+        wallet.publicKey,
+        bigIntAmount,
+        decimals,
+        [],
+        "confirmed",
+        TOKEN_2022_PROGRAM_ID
+      );
+
+    const transaction = new Transaction().add(transferInstruction);
+
+    const txSig = await sendAndConfirmTransaction(
       connection,
-      sourceTokenAccount,
-      mint.publicKey,
-      destinationTokenAccount,
-      wallet.publicKey,
-      bigIntAmount,
-      decimals,
-      [],
-      'confirmed',
-      TOKEN_2022_PROGRAM_ID,
+      transaction,
+      [wallet.payer],
+      { skipPreflight: true }
     );
+    console.log("Transfer Signature:", txSig);
+  });
 
-    const transaction = new Transaction().add(transferInstruction);
+  it("Try call transfer hook without transfer", async () => {
+    const transferHookIx = await program.methods
+      .transferHook(new anchor.BN(1))
+      .accounts({
+        sourceToken: sourceTokenAccount,
+        mint: mint.publicKey,
+        destinationToken: destinationTokenAccount,
+        owner: wallet.publicKey,
+      })
+      .instruction();
 
-    const txSig = await sendAndConfirmTransaction(connection, transaction, [wallet.payer], { skipPreflight: true });
-    console.log('Transfer Signature:', txSig);
+    const transaction = new Transaction().add(transferHookIx);
+
+    const sendPromise = sendAndConfirmTransaction(
+      connection,
+      transaction,
+      [wallet.payer],
+      { skipPreflight: false }
+    );
+
+    await expect(sendPromise).to.eventually.be.rejectedWith(
+      SendTransactionError,
+      program.idl.errors[0].msg
+    );
   });
 });