Crate cruiser

source · [−]

Expand description

A generator program that will be able to generate solana program code from a much easier starting place.

How it works

The standard lifecycle of an instruction (standard derive of InstructionListProcessor):

Instruction::Data is deserialized with BorshDeserialize::deserialize from incoming data
Instruction::Data is split into InstructionProcessor::FromAccountsData, InstructionProcessor::ValidateData, and InstructionProcessor::InstructionData with InstructionProcessor::data_to_instruction_arg
Instruction::Accounts is created from InstructionProcessor::FromAccountsData by FromAccounts::from_accounts
InstructionProcessor::process is called with InstructionProcessor::InstructionData and Instruction::Accounts
Instruction::Accounts is cleaned up by with AccountArgument::write_back

Re-exports

pub use borsh;

pub use indexer::AllAny;

pub use solana_program;

pub use static_assertions;

Modules

account_argument

TODO: Write big docs here

Account types list of a program.

Standard account types. These are all optional, you can build your own if you don’t like something in one of them.

compressed_numbers

Numbers that can be decompressed/compressed on read/write

Contains all the entrypoint functions to start a program.

Custom Error support.

Indexing helpers, specifically for AllAny.

An individual instruction for a program.

instruction_list

A list of instructions serving as an interface and entrypoint for the program.

Automatic size calculation for on-chain data. Derive not created yet, must be done manually for now.

Support for type based PDAs

Programs as accounts support. Will eventually support InstructionLists and interfaces.

Additional serializable types

Helper utility functions

Macros

delegate_account_argument

Implements AccountArgument for a type with a certain accessor.

The entrypoint macro, replaces solana_program::entrypoint macro. Requires a function that can be passed to entry.

entrypoint_list

Similar to the entrypoint macro but only requires passing a type that implements InstructionList.

impl_account_info

Implementations for a type that impls AccountInfo.

Print a message to the log.

verify_account_arg_impl

Verifies a given type implements the proper traits

Structs

CPI functions that check each account for outstanding usages. Less efficient than CPIUnchecked but will avoid unsafe situations. Suggested to use this for validation and then swap to CPIUnchecked. Uses solana_program::program::invoke_signed

CPI functions that doesn’t check each account for outstanding usages. Can result in unsafe situations but is more efficient than CPIChecked. Uses solana_program::program::invoke_signed_unchecked

CruiserAccountInfo

A custom version of Solana’s AccountInfo that allows for owner changes.

SolanaAccountInfo

Account information

SolanaAccountMeta

Describes a single account read or written by a program during instruction execution.

SolanaInstruction

A directive for a single invocation of a Solana program.

Enums

General errors issued by the generator.

GenericErrorDiscriminants

Auto-generated discriminant enum variants

Traits

A trait representing accounts on Solana. Can take many different forms.

AccountInfoAccess

A trait representing accounts on Solana. Can take many different forms. Use AccountInfo.

A way of executing CPI calls

SafeOwnerChange

Account info can safely assign the owner.

SafeOwnerChangeAccess

Account info can safely assign the owner. Use SafeOwnerChange.

Account info can safely realloc.

SafeReallocAccess

Account info can safely realloc. Use SafeRealloc.

ToSolanaAccountInfo

Account info can be turned into a SolanaAccountInfo.

ToSolanaAccountInfoAccess

Account info can be turned into a SolanaAccountInfo. Use ToSolanaAccountInfo.

Type Definitions

A version of Result returned by many cruiser functions.

UnixTimestamp is an approximate measure of real-world time, expressed as Unix time (ie. seconds since the Unix epoch)