A reference for the Axiom Rust Client SDK.
Cargo.toml
:
~/.axiom/config.json
:
BuildSdk
trait provides functionality for building OpenVM guest programs on Axiom’s cloud infrastructure.
BuildArgs
struct. This allows you to fine-tune the build process, control which files are included, and manage project organization.
Cargo.toml
contains multiple targets (such as both a library and binary), you can specify which binary to build. This is particularly useful in workspace setups where you have multiple crates or when you want to build a specific executable target.
keep_tarball
option allows you to retain the source archive after upload, which can be valuable for debugging build issues or auditing what was actually included in your build.
ProveSdk
trait handles proof generation for your built programs.
RunSdk
trait allows you to execute programs without generating proofs, useful for testing and debugging.
VerifySdk
trait provides proof verification capabilities.
ConfigSdk
trait provides access to VM configurations and related artifacts.
ProjectSdk
trait helps organize your programs into projects.
CLI not initialized
Error
API key not valid or inactive
Error
Not in a git repository
Error
Cargo.toml
and Cargo.lock
are tracked by git0x01
(bytes) or 0x02
(field elements)"input"
arrayAxiomSdk
: Main SDK structAxiomConfig
: Configuration for API endpoint, key, and default config IDProgressCallback
: Trait for handling progress eventsNoopCallback
: Silent progress callback implementationBuildSdk
: Program building functionalityProveSdk
: Proof generation functionalityRunSdk
: Program execution functionalityVerifySdk
: Proof verification functionalityConfigSdk
: Configuration management functionalityProjectSdk
: Project management functionalityProofType
: Evm
or Stark
ConfigSource
: ConfigId(String)
or ConfigPath(String)