Rust is the most common programming language to write Solana programs with. This quickstart guide will demonstrate how to quickly setup, build, and deploy your first Rust based Solana program to the blockchain.
NOTE: This guide uses the Solana CLI and assumes you have setup your local development environment. Checkout our local development quickstart guide here to quickly get setup.
- How to install the Rust language locally
- How to initialize a new Solana Rust program
- How to code a basic Solana program in Rust
- How to build and deploy your Rust program
To be able to compile Rust based Solana programs, install the Rust language and Cargo (the Rust package manager) using Rustup:
The Solana CLI comes with the test validator built in. This command line tool will allow you to run a full blockchain cluster on your machine.
PRO TIP: Run the Solana test validator in a new/separate terminal window that will remain open. This command line program must remain running for your localhost validator to remain online and ready for action.
Configure your Solana CLI to use your localhost validator for all your future terminal commands and Solana program deployment:
Solana programs written in Rust are libraries which are compiled to BPF bytecode and saved in the
Initialize a new Rust library named
hello_world via the Cargo command line:
solana-program crate to your new Rust library:
Cargo.toml file and add these required Rust library configuration settings, updating your project name as appropriate:
The code for your Rust based Solana program will live in your
src/lib.rs file. Inside
src/lib.rs you will be able to import your Rust crates and define your logic. Open your
src/lib.rs file in your favorite editor.
At the top of
lib.rs, import the
solana-program crate and bring our needed items into the local namespace:
Every Solana program must define an
entrypoint that tells the Solana runtime where to start executing your on chain code. Your program's entrypoint should provide a public function named
Every on chain program should return the
Ok result enum with a value of
(). This tells the Solana runtime that your program executed successfully without errors.
This program above will simply log a message of "Hello, world!" to the blockchain cluster, then gracefully exit with
Inside a terminal window, you can build your Solana Rust program by running in the root of your project (i.e. the directory with your
NOTE: After each time you build your Solana program, the above command will output the build path of your compiled program's
.sofile and the default keyfile that will be used for the program's address.
Using the Solana CLI, you can deploy your program to your currently selected cluster:
Once your Solana program has been deployed (and the transaction finalized), the above command will output your program's public address (aka its "program id").
You have successfully setup, built, and deployed a Solana program using the Rust language.
PS: Check your Solana wallet's balance again after you deployed. See how much SOL it cost to deploy your simple program?
See the links below to learn more about writing Rust based Solana programs: