Merge pull request #51 from ZYJLiu/main

update anchor basics examples

Author: nickfrosty

.github/workflows/anchor.yml

@@ -30,6 +30,7 @@ jobs:
             "basics/pda-rent-payer/anchor"
             "basics/processing-instructions/anchor"
             "basics/program-derived-addresses/anchor"
+            "basics/realloc/anchor"
             "basics/rent/anchor"
             "basics/repository-layout/anchor"
             "basics/transfer-sol/anchor"

basics/account-data/anchor/Anchor.toml

@@ -1,13 +1,15 @@
 [features]
 seeds = false
+skip-lint = false
+
 [programs.localnet]
-anchor_program_example = "FFKtnYFyzPj1qFjE9epkrfYHJwZMdh8CvJrB6XsKeFVz"
+anchor_program_example = "GpVcgWdgVErgLqsn8VYUch6EqDerMgNqoLSmGyKrd6MR"
 
 [registry]
-url = "https://anchor.projectserum.com"
+url = "https://api.apr.dev"
 
 [provider]
-cluster = "localnet"
+cluster = "Localnet"
 wallet = "~/.config/solana/id.json"
 
 [scripts]

basics/account-data/anchor/programs/anchor-program-example/src/instructions/create.rs

@@ -1,44 +1,32 @@
+use crate::state::AddressInfo;
 use anchor_lang::prelude::*;
-use anchor_lang::system_program;
 
-use crate::state::AddressInfo;
+#[derive(Accounts)]
+pub struct CreateAddressInfo<'info> {
+    #[account(mut)]
+    payer: Signer<'info>,
+
+    #[account(
+        init,
+        payer = payer,
+        space = 8 + AddressInfo::INIT_SPACE,
+    )]
+    address_info: Account<'info, AddressInfo>,
+    system_program: Program<'info, System>,
+}
 
-#[allow(clippy::result_large_err)]
 pub fn create_address_info(
     ctx: Context<CreateAddressInfo>,
     name: String,
     house_number: u8,
     street: String,
     city: String,
 ) -> Result<()> {
-    let address_info = AddressInfo::new(name, house_number, street, city);
-
-    let account_span = (address_info.try_to_vec()?).len();
-    let lamports_required = (Rent::get()?).minimum_balance(account_span);
-
-    system_program::create_account(
-        CpiContext::new(
-            ctx.accounts.system_program.to_account_info(),
-            system_program::CreateAccount {
-                from: ctx.accounts.payer.to_account_info(),
-                to: ctx.accounts.address_info.to_account_info(),
-            },
-        ),
-        lamports_required,
-        account_span as u64,
-        &ctx.accounts.system_program.key(),
-    )?;
-
-    let address_info_account = &mut ctx.accounts.address_info;
-    address_info_account.set_inner(address_info);
+    *ctx.accounts.address_info = AddressInfo {
+        name,
+        house_number,
+        street,
+        city,
+    };
     Ok(())
 }
-
-#[derive(Accounts)]
-pub struct CreateAddressInfo<'info> {
-    #[account(mut)]
-    address_info: Account<'info, AddressInfo>,
-    #[account(mut)]
-    payer: Signer<'info>,
-    system_program: Program<'info, System>,
-}

basics/account-data/anchor/programs/anchor-program-example/src/instructions/mod.rs

@@ -1,3 +1,2 @@
 pub mod create;
-
 pub use create::*;

basics/account-data/anchor/programs/anchor-program-example/src/lib.rs

@@ -1,26 +1,23 @@
 #![allow(clippy::result_large_err)]
-
 use anchor_lang::prelude::*;
-
 use instructions::*;
 
 pub mod instructions;
 pub mod state;
 
-declare_id!("FFKtnYFyzPj1qFjE9epkrfYHJwZMdh8CvJrB6XsKeFVz");
+declare_id!("GpVcgWdgVErgLqsn8VYUch6EqDerMgNqoLSmGyKrd6MR");
 
 #[program]
 pub mod anchor_program_example {
     use super::*;
 
-    #[allow(clippy::result_large_err)]
     pub fn create_address_info(
         ctx: Context<CreateAddressInfo>,
         name: String,
         house_number: u8,
         street: String,
         city: String,
     ) -> Result<()> {
-        instructions::create::create_address_info(ctx, name, house_number, street, city)
+        create::create_address_info(ctx, name, house_number, street, city)
     }
 }

basics/account-data/anchor/programs/anchor-program-example/src/state/address_info.rs

@@ -1,20 +1,13 @@
 use anchor_lang::prelude::*;
 
 #[account]
+#[derive(InitSpace)] // automatically calculate the space required for the struct
 pub struct AddressInfo {
-    pub name: String,
-    pub house_number: u8,
-    pub street: String,
-    pub city: String,
-}
-
-impl AddressInfo {
-    pub fn new(name: String, house_number: u8, street: String, city: String) -> Self {
-        AddressInfo {
-            name,
-            house_number,
-            street,
-            city,
-        }
-    }
+    #[max_len(50)] // set a max length for the string
+    pub name: String, // 4 bytes + 50 bytes
+    pub house_number: u8, // 1 byte
+    #[max_len(50)]
+    pub street: String, // 4 bytes + 50 bytes
+    #[max_len(50)]
+    pub city: String, // 4 bytes + 50 bytes
 }

basics/account-data/anchor/tests/test.ts

@@ -1,36 +1,51 @@
-import * as anchor from "@coral-xyz/anchor";
-import { AnchorProgramExample } from "../target/types/anchor_program_example";
+import * as anchor from "@coral-xyz/anchor"
+import { AnchorProgramExample } from "../target/types/anchor_program_example"
+import { Keypair } from "@solana/web3.js"
 
 describe("Account Data!", () => {
-  const provider = anchor.AnchorProvider.env();
-  anchor.setProvider(provider);
-  const payer = provider.wallet as anchor.Wallet;
+  const provider = anchor.AnchorProvider.env()
+  anchor.setProvider(provider)
+  const payer = provider.wallet as anchor.Wallet
   const program = anchor.workspace
-    .AnchorProgramExample as anchor.Program<AnchorProgramExample>;
+    .AnchorProgramExample as anchor.Program<AnchorProgramExample>
 
-  const addressInfoAccount = anchor.web3.Keypair.generate();
+  // Generate a new keypair for the addressInfo account
+  const addressInfoAccount = new Keypair()
 
   it("Create the address info account", async () => {
-    console.log(`Payer Address      : ${payer.publicKey}`);
-    console.log(`Address Info Acct  : ${addressInfoAccount.publicKey}`);
+    console.log(`Payer Address      : ${payer.publicKey}`)
+    console.log(`Address Info Acct  : ${addressInfoAccount.publicKey}`)
+
+    // Instruction data
+    const addressInfo = {
+      name: "Joe C",
+      houseNumber: 136,
+      street: "Mile High Dr.",
+      city: "Solana Beach",
+    }
+
     await program.methods
-      .createAddressInfo("Joe C", 136, "Mile High Dr.", "Solana Beach")
+      .createAddressInfo(
+        addressInfo.name,
+        addressInfo.houseNumber,
+        addressInfo.street,
+        addressInfo.city
+      )
       .accounts({
         addressInfo: addressInfoAccount.publicKey,
         payer: payer.publicKey,
-        systemProgram: anchor.web3.SystemProgram.programId,
       })
-      .signers([payer.payer])
-      .rpc();
-  });
+      .signers([addressInfoAccount])
+      .rpc()
+  })
 
   it("Read the new account's data", async () => {
     const addressInfo = await program.account.addressInfo.fetch(
       addressInfoAccount.publicKey
-    );
-    console.log(`Name     : ${addressInfo.name}`);
-    console.log(`House Num: ${addressInfo.houseNumber}`);
-    console.log(`Street   : ${addressInfo.street}`);
-    console.log(`City     : ${addressInfo.city}`);
-  });
-});
+    )
+    console.log(`Name     : ${addressInfo.name}`)
+    console.log(`House Num: ${addressInfo.houseNumber}`)
+    console.log(`Street   : ${addressInfo.street}`)
+    console.log(`City     : ${addressInfo.city}`)
+  })
+})

basics/checking-accounts/anchor/programs/anchor-program-example/src/lib.rs

@@ -8,20 +8,25 @@ declare_id!("ECWPhR3rJbaPfyNFgphnjxSEexbTArc7vxD8fnW6tgKw");
 pub mod anchor_program_example {
     use super::*;
 
-    #[allow(clippy::result_large_err)]
     pub fn check_accounts(_ctx: Context<CheckingAccounts>) -> Result<()> {
         Ok(())
     }
 }
 
+// Account validation in Anchor is done using the types and constraints specified in the #[derive(Accounts)] structs
+// This is a simple example and does not include all possible constraints and types
 #[derive(Accounts)]
 pub struct CheckingAccounts<'info> {
-    payer: Signer<'info>,
-    #[account(mut)]
-    /// CHECK: This account's data is empty
-    account_to_create: AccountInfo<'info>,
+    payer: Signer<'info>, // checks account is signer
+
+    /// CHECK: No checks performed, example of an unchecked account
     #[account(mut)]
-    /// CHECK: This account's data is empty
-    account_to_change: AccountInfo<'info>,
-    system_program: Program<'info, System>,
+    account_to_create: UncheckedAccount<'info>,
+    /// CHECK: Perform owner check using constraint
+    #[account(
+        mut,
+        owner = id()
+    )]
+    account_to_change: UncheckedAccount<'info>,
+    system_program: Program<'info, System>, // checks account is executable, and is the system program
 }

basics/checking-accounts/anchor/tests/test.ts

@@ -1,45 +1,50 @@
-import * as anchor from "@coral-xyz/anchor";
-import { AnchorProgramExample } from "../target/types/anchor_program_example";
+import * as anchor from "@coral-xyz/anchor"
+import { AnchorProgramExample } from "../target/types/anchor_program_example"
+import {
+  Keypair,
+  SystemProgram,
+  Transaction,
+  sendAndConfirmTransaction,
+} from "@solana/web3.js"
 
 describe("Anchor example", () => {
-  const provider = anchor.AnchorProvider.env();
-  anchor.setProvider(provider);
+  const provider = anchor.AnchorProvider.env()
+  anchor.setProvider(provider)
   const program = anchor.workspace
-    .AnchorProgramExample as anchor.Program<AnchorProgramExample>;
-  const payer = provider.wallet as anchor.Wallet;
+    .AnchorProgramExample as anchor.Program<AnchorProgramExample>
+  const wallet = provider.wallet as anchor.Wallet
 
   // We'll create this ahead of time.
   // Our program will try to modify it.
-  const accountToChange = anchor.web3.Keypair.generate();
+  const accountToChange = new Keypair()
   // Our program will create this.
-  const accountToCreate = anchor.web3.Keypair.generate();
+  const accountToCreate = new Keypair()
 
   it("Create an account owned by our program", async () => {
-    let ix = anchor.web3.SystemProgram.createAccount({
+    let instruction = SystemProgram.createAccount({
       fromPubkey: provider.wallet.publicKey,
       newAccountPubkey: accountToChange.publicKey,
       lamports: await provider.connection.getMinimumBalanceForRentExemption(0),
       space: 0,
       programId: program.programId, // Our program
-    });
+    })
 
-    await anchor.web3.sendAndConfirmTransaction(
-      provider.connection,
-      new anchor.web3.Transaction().add(ix),
-      [payer.payer, accountToChange]
-    );
-  });
+    const transaction = new Transaction().add(instruction)
+
+    await sendAndConfirmTransaction(provider.connection, transaction, [
+      wallet.payer,
+      accountToChange,
+    ])
+  })
 
   it("Check accounts", async () => {
     await program.methods
       .checkAccounts()
       .accounts({
-        payer: provider.wallet.publicKey,
+        payer: wallet.publicKey,
         accountToCreate: accountToCreate.publicKey,
         accountToChange: accountToChange.publicKey,
-        systemProgram: anchor.web3.SystemProgram.programId,
       })
-      .signers([payer.payer])
-      .rpc();
-  });
-});
+      .rpc()
+  })
+})

basics/close-account/anchor/Anchor.toml

@@ -1,14 +1,15 @@
 [features]
 seeds = false
 skip-lint = false
+
 [programs.localnet]
-close_account_program = "9SWqhEABWnKXTPvSLc4aQAJyESVxtRvYBvwF2WuBy7jf"
+close_account_program = "99TQtoDdQ5NS2v5Ppha93aqEmv3vV9VZVfHTP5rGST3c"
 
 [registry]
 url = "https://api.apr.dev"
 
 [provider]
-cluster = "localnet"
+cluster = "Localnet"
 wallet = "~/.config/solana/id.json"
 
 [scripts]