cargo-solana

Cargo tool to generate boilerplate Solana program to save time in basic setup.

Program creation behaviors:

• Program is added to 'workplace' members in current directory Cargo.toml
  • entry point includes starter unit test framework for BPF testing and debugging
  • Program account serialization / deserialization implemented using Pack trait assuming non-variable data
  • borsh is used in serialization and deserialization
  • Account structure
    • Includes initialization flag (u8) and verification
    • Includes version field (u8) for future change management. cookbook
  • msg! sprinkled throughout. Recommend removing these as you go as they consume Compute Units
  • Addition Cargo.toml dependencies
    • borsh : For serialize/deserialize
    • num-derive : For custom errors From into Solana ProgramError
    • num-traits : For custom errors From into Solana ProgramError
    • thiserror : Simplify custom error
  • Additional Cargo.toml dev-dependencies
    • assert_matches : For program unit testing

Install

cargo-solana is not on crates, you need to build/deploy from repo

git clone https://github.com/FrankC01/cargo-solana
cd cargo-solana
cargo install cargo-solana --path .

Uninstalling

cargo uninstall cargo-solana

Help

cargo solana --help

Scenarios

Create a new project

You want to create a new project that contains the framework for Solana program

cargo solana create -n <PROJECT_NAME>

Note: Does not initialize a VCS

Generates the following in PROJECT_NAME:

    PROJECT_NAME
    Cargo.toml # Consists only [workspace] entry for program
    program
        Cargo.toml # Adds PROJECT_NAME as the program name
        src
            entry_point.rs # Contains unit tests
            error.rs
            instruction.rs
            process.rs
            state.rs

Initialize a new program in existing project

cargo solana init -n <PROGRAM_NAME>

Adds the program folder and contents and updates the root Cargo.toml to include workspace member of "program":

    EXISTING_PROJECT_NAME
    Cargo.toml # Program folder added to `workspace` members
    program
        Cargo.toml
        src
            entry_point.rs # Contains unit tests
            error.rs
            instruction.rs
            process.rs
            state.rs

Test once created

Change into the newly created program folder:

cd program
cargo test-bpf -- --test-threads=1