Getting Started with Anchor

Create a new Project

To start a new project, use the anchor init command followed by your project's name. This command creates a new directory with the specified name and sets up a default program and test file.

anchor init my-project

Navigate to the new project directory and open it in your code editor.

cd my-project

The default Anchor program is located at programs/my-project/src/lib.rs.

The default Typescript test file is located at /tests/my-project.ts.

If you prefer Rust for testing, initialize your project with the --test-template rust flag.

anchor init --test-template rust my-project

The Rust test file will be at /tests/src/test_initialize.rs.

Build the Program

Build the program by running anchor build.

anchor build

The compiled program will be at /target/deploy/my_project.so. The content of this file is what gets stored on the Solana network (as an executable account) when you deploy your program.

Test the Program

To test the program, run anchor test.

anchor test

By default, the Anchor.toml config file specifies the localnet cluster. When developing on localnet, anchor test will automatically:

1. Start a local Solana validator
2. Build and deploy your program to the local cluster
3. Run the tests in the tests folder
4. Stop the local Solana validator

Alternatively, you can manually start a local Solana validator and run tests against it. This is useful if you want to keep the validator running while you iterate on your program. It allows you to inspect accounts and transaction logs on the Solana Explorer while developing locally.

Open a new terminal and start a local Solana validator by running the solana-test-validator command.

solana-test-validator

In a separate terminal, run the tests against the local cluster. Use the --skip-local-validator flag to skip starting the local validator since it's already running.

anchor test --skip-local-validator

Deploy to Devnet

By default, the Anchor.toml config file in an Anchor project specifies the localnet cluster.

[toolchain]
 
[features]
resolution = true
skip-lint = false
 
[programs.localnet]
my_program = "3ynNB373Q3VAzKp7m4x238po36hjAGFXFJB4ybN2iTyg"
 
[registry]
url = "https://api.apr.dev"
 
[provider]
cluster = "Localnet"
wallet = "~/.config/solana/id.json"
 
[scripts]
test = "yarn run ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.ts"

To deploy your program to devnet, change the cluster value to Devnet. Note that this requires your wallet to have enough SOL on Devnet to cover deployment cost.

-cluster = "Localnet"
+cluster = "Devnet"

[provider]
cluster = "Devnet"
wallet = "~/.config/solana/id.json"

Now when you run anchor deploy, your program will be deployed to the devnet cluster. The anchor test command will also use the cluster specified in the Anchor.toml file.

anchor deploy

To deploy to mainnet, simply update the Anchor.toml file to specify the mainnet cluster.

[provider]
cluster = "Mainnet"
wallet = "~/.config/solana/id.json"

Update the Program

Solana programs can be updated by redeploying the program to the same program ID.

To update a program, simply make changes to your program's code and run the anchor build command to generated an updated .so file.

anchor build

Then run the anchor deploy command to redeploy the updated program.

anchor deploy

Close the Program

To reclaim the SOL allocated to a program account, you can close your Solana program.

To close a program, use the solana program close <PROGRAM_ID> command. For example:

solana program close 3ynNB373Q3VAzKp7m4x238po36hjAGFXFJB4ybN2iTyg --bypass-warning

Note that once a program is closed, the program ID cannot be reused to deploy a new program.