Native Solana Onboarding guide for Rust Developers
Install Rust and Cargo
- To be able to compile Rust based Solana programs, install the Rust language and Cargo (the Rust package manager) using Rustup:
Install the Solana CLI
- Install the Solana CLI tool running command
Run your localhost validator
- 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.
Configure your Solana CLI to use your localhost validator for all your future terminal commands and Solana program deployment:
solana config set --url localhost
Create a new Rust library with Cargo
- Solana programs written in Rust are libraries which are compiled to BPF bytecode and saved in the .so format.
Initialize a new Rust library named hello_world via the Cargo command line:
Add the solana-program crate to your new Rust library:
Open your Cargo.toml file and add these required Rust library configuration settings, updating your project name as appropriate:
Create your first Solana program
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.
1. At the top of lib.rs, import the solana-program crate and bring our needed items into the local namespace.
2. Every Solana program must define an entrypoint that tells the Solana runtime where to start executing your onchain code. Your program's entrypoint should provide a public function named process_instruction
3. Every onchain program should return the Ok result enum with a value of (). This tells the Solana runtime that your program executed successfully without errors.
Build your Rust program
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 Cargo.toml file):
Deploy your Solana program
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").