Crate trdelnik_sandbox_client

Trdelnik is a suite of tools and libraries for testing, auditing and developing Solana / Anchor programs (smart contracts).

Trdelnik could be useful for writing Rust dApps, too.

Re-exports

pub use anchor_client;

pub use anchor_client::anchor_lang;

pub use anchor_client::solana_sdk;

pub use anyhow;

pub use futures;

pub use serial_test;

pub use tokio;

pub use test_generator::TestGenerator;

pub use error_reporter::*;

Modules

error_reporter

idl

The idl module contains structs and functions for Anchor program code parsing.

program_client_generator

test_generator

Structs

Client

Client allows you to send typed RPC requests to a Solana cluster.

Commander

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

EncodedConfirmedTransactionWithStatusMeta

Error

The Error type, a wrapper around a dynamic error type.

Instruction

A directive for a single invocation of a Solana program.

Keypair

A vanilla Ed25519 key pair

LocalnetHandle

Localnet (the validator process) handle.

Pubkey

Reader

Reader allows you to read Pubkey, Keypair and other entities from files.

Signature

System

Tester

Tester is used primarily by #[trdelnik_test] macro.

Enums

ClientError

Traits

FutureExt

An extension trait for Futures that provides a variety of convenient adapters.

Id

Defines the id of a program.

InstructionData

Calculates the data for an instruction invocation, where the data is Sha256(<namespace>:<method_name>)[..8] || BorshSerialize(args). args is a borsh serialized struct of named fields for each argument given to an instruction.

PrintableTransaction

Utility trait for printing transaction results.

Signer

The Signer trait declares operations that all digital signature providers must support. It is the primary interface by which signers are specified in Transaction signing interfaces

TempClone

The TempClone trait is used as a workaround for making non-cloneable foreign types cloneable.

ToAccountMetas

Transformation to AccountMeta structs.

Functions

keypair

Returns a recognisable Keypair / wallet that can be used for the mint account for example. The public key will start with Txxx, where xxx are the three digits of the number. You shouldn’t call the method with the same n twice. o is used instead of 0, as 0 is not part of the base58 charset. The n must be a number between 0 and 255.

program_keypair

Returns a recognisable Keypair of your created program. The public key will start with Pxx, where xx are the three digits of the number. o is used instead of 0, as 0 is not part of the base58 charset. You shouldn’t call the method with the same n twice. The n must be a number between 0 and 29.

random_keypair

Generate a random keypair.

system_keypair

Returns a system wallet (wallet which is owned by the system) but it is not required, you can also use the keypair method bellow. The public key will start with Sxx, where xx are the three digits of the number. You shouldn’t call the method with the same n twice. o is used instead of 0, as 0 is not part of the base58 charset. Returns a recognisable Keypair. This is NOT the same as anchor_lang::system_program::System::id()! The n must be a number between 0 and 29.

Attribute Macros

fixture

Define a fixture that you can use in all rstest’s test arguments. You should just mark your function as #[fixture] and then use it as a test’s argument. Fixture functions can also use other fixtures.

rstest

The attribute that you should use for your tests. Your annotated function’s arguments can be injected with [fixture]s, provided by parametrized cases or by value lists.

trdelnik_test

The macro starts the Solana validator (localnet), runs your program test and then shuts down the validator.