Add support for Anchor (#48)

Author: lorisleiva

.changeset/popular-tomatoes-train.md

@@ -0,0 +1,5 @@
+---
+"create-solana-program": patch
+---
+
+Add support for Anchor

.github/workflows/main.yml

@@ -33,7 +33,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        project: ["counter-anchor", "counter-shank"]
         solana: ["1.17.24", "1.18.12"]
+        include:
+          - anchor: "0.30.0"
+            project: "counter-anchor"
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
@@ -52,8 +56,13 @@ jobs:
         uses: metaplex-foundation/actions/install-solana@v1
         with:
           version: ${{ matrix.solana }}
+      - name: Install Anchor
+        if: ${{ matrix.anchor }}
+        uses: metaplex-foundation/actions/install-anchor-cli@v1
+        with:
+          version: ${{ matrix.anchor }}
       - name: Pre-scaffold projects for caching purposes
-        run: pnpm snapshot --scaffold-only
+        run: pnpm snapshot ${{ matrix.project }} --scaffold-only
       - name: Cache cargo crates
         uses: actions/cache@v4
         with:
@@ -68,7 +77,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-crates-solana-v${{ matrix.solana }}
       - name: Build and run tests
-        run: pnpm test
+        run: pnpm snapshot ${{ matrix.project }} --test
 
   release:
     name: Release

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "projects/counter-anchor"]
+path = projects/counter-anchor
+url = [email protected]:solana-program/counter-anchor.git
+
 [submodule "projects/counter-shank"]
 path = projects/counter-shank
 url = [email protected]:solana-program/counter-shank.git

index.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 import * as path from 'node:path';
+import * as fs from 'node:fs';
 
 import { createOrEmptyTargetDirectory } from './utils/fsHelpers';
 import { getInputs } from './utils/getInputs';
@@ -9,6 +10,7 @@ import { logBanner, logDone, logStep } from './utils/getLogs';
 import { RenderContext, getRenderContext } from './utils/getRenderContext';
 import { renderTemplate } from './utils/renderTemplates';
 import {
+  detectAnchorVersion,
   detectSolanaVersion,
   generateKeypair,
   patchSolanaDependencies,
@@ -28,12 +30,21 @@ import {
     inputs.shouldOverride
   );
 
-  // Detect the solana version.
+  // Detect the Solana version.
   const solanaVersionDetected = await logStep(
     language.infos.detectSolanaVersion,
     () => detectSolanaVersion(language)
   );
 
+  // Detect the Anchor version.
+  let anchorVersionDetected: string | undefined;
+  if (inputs.programFramework === 'anchor') {
+    anchorVersionDetected = await logStep(
+      language.infos.detectAnchorVersion,
+      () => detectAnchorVersion(language)
+    );
+  }
+
   // Generate a keypair if needed.
   const programAddress =
     inputs.programAddress ??
@@ -53,6 +64,7 @@ import {
     inputs,
     programAddress,
     solanaVersionDetected,
+    anchorVersionDetected,
   });
 
   // Render the templates.
@@ -63,7 +75,7 @@ import {
     ),
     async () => {
       renderTemplates(ctx);
-      await patchSolanaDependencies(ctx.targetDirectory, ctx.solanaVersion);
+      await patchSolanaDependencies(ctx);
     }
   );
 
@@ -74,22 +86,20 @@ import {
 function renderTemplates(ctx: RenderContext) {
   const render = (templateName: string) => {
     const directory = path.resolve(ctx.templateDirectory, templateName);
+    if (!fs.existsSync(directory)) return;
     renderTemplate(ctx, directory, ctx.targetDirectory);
   };
 
   render('base');
-
-  if (ctx.programFramework === 'anchor') {
-    render('programs/counter-anchor');
-  } else {
-    render('programs/counter-shank');
-  }
+  render(`${ctx.programFramework}/base`);
 
   if (ctx.clients.length > 0) {
     render('clients/base');
+    render(`${ctx.programFramework}/clients/base`);
   }
 
   ctx.clients.forEach((client) => {
     render(`clients/${client}`);
+    render(`${ctx.programFramework}/clients/${client}`);
   });
 }

locales/en-US.json

@@ -47,6 +47,7 @@
     "message": "Rust client crate name:"
   },
   "errors": {
+    "anchorCliNotFound": "Command `$command` unavailable. Please install the Anchor CLI.",
     "cannotOverrideDirectory": "Cannot override target directory \"$targetDirectory\". Run with option --force to override.",
     "invalidSolanaVersion": "Invalid Solana version: $version.",
     "operationCancelled": "Operation cancelled",
@@ -62,6 +63,7 @@
     "multiselect": "[↑/↓]: Select / [space]: Toggle selection / [a]: Toggle all / [enter]: Submit answer"
   },
   "infos": {
+    "detectAnchorVersion": "Detect Anchor version",
     "detectSolanaVersion": "Detect Solana version",
     "generateKeypair": "Generate program keypair",
     "scaffold": "Scaffold project in $targetDirectory",

locales/fr-FR.json

@@ -50,6 +50,7 @@
     "message": "Ajouter TypeScript\u00a0?"
   },
   "errors": {
+    "anchorCliNotFound": "Commande `$command` indisponible. Veuillez installer Anchor dans votre terminal.",
     "cannotOverrideDirectory": "Impossible de remplacer le répertoire cible \"$targetDirectory\". Exécutez avec l'option --force pour remplacer.",
     "invalidSolanaVersion": "Version Solana invalide\u00a0: $version.",
     "operationCancelled": "Operation annulée",
@@ -65,6 +66,7 @@
     "multiselect": "[↑/↓]: Sélectionner / [espace]: Basculer la sélection / [a]: Basculer tout / [entrée]: Valider"
   },
   "infos": {
+    "detectAnchorVersion": "Détect la version d'Anchor",
     "detectSolanaVersion": "Détect la version de Solana",
     "generateKeypair": "Génére la paire de clés du program",
     "scaffold": "Génére le projet dans $targetDirectory",

projects/counter-anchor

@@ -1,6 +1,7 @@
 export const COUNTER_ADDRESS = 'CounterProgram111111111111111111111111111111';
 export const CLIENTS = ['js', 'rust'];
 export const PROJECTS = {
+  'counter-anchor': ['counter', '--anchor', '--address', COUNTER_ADDRESS],
   'counter-shank': ['counter', '--shank', '--address', COUNTER_ADDRESS],
 };
 

scripts/utils.mjs

@@ -0,0 +1,6 @@
+[provider]
+cluster = "localnet"
+wallet = "~/.config/solana/id.json"
+
+[programs.localnet]
+{{ programName | snakeCase }} = "{{ programAddress }}"

template/anchor/base/Anchor.toml.njk

@@ -0,0 +1,6 @@
+[workspace]
+resolver = "2"
+members = ["program"]
+
+[profile.release]
+overflow-checks = true

template/anchor/base/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "{{ programCrateName }}"
+version = "0.0.0"
+edition = "2021"
+readme = "./README.md"
+license-file = "../LICENSE"
+publish = false
+
+[package.metadata.solana]
+program-id = "{{ programAddress }}"
+program-dependencies = []
+
+[lib]
+crate-type = ["cdylib", "lib"]
+
+[features]
+no-entrypoint = []
+cpi = ["no-entrypoint"]
+idl-build = ["anchor-lang/idl-build"]
+
+[dependencies]
+anchor-lang = "{{ anchorVersion }}"
+solana-program = "~{{ solanaVersion }}"

template/anchor/base/program/Cargo.toml.njk

@@ -0,0 +1,49 @@
+use anchor_lang::prelude::*;
+
+declare_id!("{{ programAddress }}");
+
+#[program]
+mod {{ programCrateName | snakeCase }} {
+    use super::*;
+
+    pub fn create(ctx: Context<Create>, authority: Pubkey) -> Result<()> {
+        let counter = &mut ctx.accounts.counter;
+        counter.authority = authority;
+        counter.count = 0;
+        Ok(())
+    }
+
+    pub fn increment(ctx: Context<Increment>) -> Result<()> {
+        let counter = &mut ctx.accounts.counter;
+        counter.count += 1;
+        Ok(())
+    }
+}
+
+#[derive(Accounts)]
+pub struct Create<'info> {
+    #[account(init, payer = payer, space = 8 + 40)]
+    pub counter: Account<'info, Counter>,
+    #[account(mut)]
+    pub payer: Signer<'info>,
+    pub system_program: Program<'info, System>,
+}
+
+#[derive(Accounts)]
+pub struct Increment<'info> {
+    #[account(mut, has_one = authority @ CounterError::InvalidAuthority)]
+    pub counter: Account<'info, Counter>,
+    pub authority: Signer<'info>,
+}
+
+#[account]
+pub struct Counter {
+    pub authority: Pubkey,
+    pub count: u64,
+}
+
+#[error_code]
+pub enum {{ programName | pascalCase }}Error {
+    #[msg("The provided authority doesn't match the counter account's authority")]
+    InvalidAuthority,
+}

template/programs/counter-shank/program/README.md.njk renamed to template/anchor/base/program/README.md.njk

@@ -0,0 +1,103 @@
+import {
+  Address,
+  Commitment,
+  CompilableTransactionMessage,
+  TransactionMessageWithBlockhashLifetime,
+  Rpc,
+  RpcSubscriptions,
+  SolanaRpcApi,
+  SolanaRpcSubscriptionsApi,
+  TransactionSigner,
+  airdropFactory,
+  appendTransactionMessageInstruction,
+  createSolanaRpc,
+  createSolanaRpcSubscriptions,
+  createTransactionMessage,
+  generateKeyPairSigner,
+  getSignatureFromTransaction,
+  lamports,
+  pipe,
+  sendAndConfirmTransactionFactory,
+  setTransactionMessageFeePayerSigner,
+  setTransactionMessageLifetimeUsingBlockhash,
+  signTransactionMessageWithSigners,
+} from '@solana/web3.js';
+import { getCreateInstruction } from '../src';
+
+type Client = {
+  rpc: Rpc<SolanaRpcApi>;
+  rpcSubscriptions: RpcSubscriptions<SolanaRpcSubscriptionsApi>;
+};
+
+export const createDefaultSolanaClient = (): Client => {
+  const rpc = createSolanaRpc('http://127.0.0.1:8899');
+  const rpcSubscriptions = createSolanaRpcSubscriptions('ws://127.0.0.1:8900');
+  return { rpc, rpcSubscriptions };
+};
+
+export const generateKeyPairSignerWithSol = async (
+  client: Client,
+  putativeLamports: bigint = 1_000_000_000n
+) => {
+  const signer = await generateKeyPairSigner();
+  await airdropFactory(client)({
+    recipientAddress: signer.address,
+    lamports: lamports(putativeLamports),
+    commitment: 'confirmed',
+  });
+  return signer;
+};
+
+export const createDefaultTransaction = async (
+  client: Client,
+  feePayer: TransactionSigner
+) => {
+  const { value: latestBlockhash } = await client.rpc
+    .getLatestBlockhash()
+    .send();
+  return pipe(
+    createTransactionMessage({ version: 0 }),
+    (tx) => setTransactionMessageFeePayerSigner(feePayer, tx),
+    (tx) => setTransactionMessageLifetimeUsingBlockhash(latestBlockhash, tx)
+  );
+};
+
+export const signAndSendTransaction = async (
+  client: Client,
+  transactionMessage: CompilableTransactionMessage &
+    TransactionMessageWithBlockhashLifetime,
+  commitment: Commitment = 'confirmed'
+) => {
+  const signedTransaction =
+    await signTransactionMessageWithSigners(transactionMessage);
+  const signature = getSignatureFromTransaction(signedTransaction);
+  await sendAndConfirmTransactionFactory(client)(signedTransaction, {
+    commitment,
+  });
+  return signature;
+};
+
+export const getBalance = async (client: Client, address: Address) =>
+  (await client.rpc.getBalance(address, { commitment: 'confirmed' }).send())
+    .value;
+
+export const createCounterForAuthority = async (
+  client: Client,
+  authority: TransactionSigner
+): Promise<Address> => {
+  const [transaction, counter] = await Promise.all([
+    createDefaultTransaction(client, authority),
+    generateKeyPairSigner(),
+  ]);
+  const createIx = getCreateInstruction({
+    counter,
+    payer: authority,
+    authority: authority.address,
+  });
+  await pipe(
+    transaction,
+    (tx) => appendTransactionMessageInstruction(createIx, tx),
+    (tx) => signAndSendTransaction(client, tx)
+  );
+  return counter.address;
+};