Struct Commander

pub struct Commander { /* private fields */ }

Commander allows you to start localnet, build programs, run tests and do other useful operations.

Implementations

impl Commander

pub fn new() -> Self

Creates a new Commander instance with the default root "../../".

pub fn with_root(root: impl Into<Cow<'static, str>>) -> Self

Creates a new Commander instance with the provided root.

pub async fn build_programs(&self) -> Result<(), Error>

Builds programs (smart contracts).

pub async fn run_tests(&self) -> Result<(), Error>

Runs standard Rust tests.

Note: The –nocapture argument is used to allow you read println outputs in your terminal window.

pub async fn create_program_client_crate(&self) -> Result<(), Error>

Creates the program_client crate.

It’s used internally by the #[trdelnik_test] macro.

pub fn program_packages(&self) -> impl Iterator<Item = Package>

Returns an Iterator of program Packages read from Cargo.toml files.

pub async fn generate_program_client_deps(&self) -> Result<(), Error>

Updates the program_client dependencies.

It’s used internally by the #[trdelnik_test] macro.

pub async fn generate_program_client_lib_rs(&self) -> Result<(), Error>

Updates the program_client lib.rs.

It’s used internally by the #[trdelnik_test] macro.

pub async fn format_program_code(code: &str) -> Result<String, Error>

Formats program code.

pub async fn start_localnet(&self) -> Result<LocalnetHandle, Error>

Starts the localnet (Solana validator).

pub async fn parse_program_client_imports(&self) -> Result<Vec<ItemUse>, Error>

Returns use modules / statements The goal of this method is to find all use statements defined by the user in the .program_client crate. It solves the problem with regenerating the program client and removing imports defined by the user.

Trait Implementations

impl Default for Commander

fn default() -> Self

Creates a new Commander instance with the default root "../../".