Installation

This guide will help you install Starkbiter and set up your development environment.

Prerequisites

Before installing Starkbiter, you need to have Rust installed on your system.

Installing Rust

If you don't have Rust installed, you can install it using rustup:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

After installation, make sure your Rust toolchain is up to date:

rustup update

Starkbiter requires Rust 1.75 or later. You can check your Rust version with:

rustc --version

Installing Starkbiter CLI

The Starkbiter CLI tool is useful for generating contract bindings and managing your projects.

Install from crates.io

cargo install starkbiter

Verify Installation

Check that Starkbiter was installed correctly:

starkbiter --help

You should see the Starkbiter help menu with available commands.

Adding Starkbiter to Your Project

To use Starkbiter in your Rust project, add the necessary crates to your Cargo.toml:

[dependencies]
starkbiter-core = "0.1"
starkbiter-engine = "0.1"
starkbiter-bindings = "0.1"
starkbiter-macros = "0.1"

# Required dependencies
starknet = "0.11"
tokio = { version = "1.0", features = ["full"] }

Optional Tools

cargo-generate

For creating new projects from templates, install cargo-generate:

cargo install cargo-generate

Next Steps

Now that you have Starkbiter installed, continue to the Quick Start guide to create your first simulation!

Troubleshooting

Common Issues

Compilation Errors

If you encounter compilation errors, make sure you have the latest stable Rust toolchain:

rustup update stable
rustup default stable

Missing System Dependencies

On Linux, you may need to install additional development packages:

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install build-essential pkg-config libssl-dev

Fedora:

sudo dnf install gcc pkg-config openssl-devel

macOS:

xcode-select --install

Getting Help

If you continue to have issues:

• Check the GitHub Issues
• Start a Discussion
• Read the FAQ