Developer setup & guides

Installation

To work with Garaga, you need the following dependencies :

• Python 3.10, 3.11, or 3.12. One of python3.10, python3.11, or python3.12 should be available and working in your terminal.

• Scarb with the version specified in https://github.com/keep-starknet-strange/garaga/blob/main/src/.tool-versions

• Rust

Simply clone the repository :

Using git:

git clone https://github.com/keep-starknet-strange/garaga.git

Using github cli :

gh repo clone keep-starknet-strange/garaga

After that, go into the root of the directory and run the command :

make setup

Pay attention to any message indicating failure. Contact us on Garaga telegram if you have any trouble at this point.

If everything succeeded, you're good to go!

Make sure to activate the virtual environment created with this setup, using source venv/bin/activate

---

Project Architecture

Understanding the Garaga codebase structure:

garaga/
├── hydra/garaga/           # Python SDK and circuit generators
│   ├── starknet/cli/       # CLI commands (gen, declare, deploy, verify)
│   ├── precompiled_circuits/  # Circuit definitions
│   └── hints/              # Cryptographic hints for Cairo
├── src/                    # Cairo code
│   ├── src/                # Main Cairo library (garaga package)
│   └── contracts/          # Example smart contracts
├── tools/
│   ├── garaga_rs/          # Rust crate (Python/WASM bindings)
│   ├── npm/garaga_ts/      # TypeScript SDK
│   └── make/               # Build scripts
└── tests/                  # Python and E2E tests

Key Components

Component	Location	Purpose
Python SDK	hydra/garaga/	CLI, circuit generation, proof processing
Rust Crate	tools/garaga_rs/	Performance-critical operations
Cairo Library	src/src/	On-chain verification
TypeScript SDK	tools/npm/garaga_ts/	Browser/Node.js integration

---

Common Commands

Development

# Format code
make fmt

# Regenerate Cairo code from Python circuits
make rewrite

# Run Python tests
pytest -n auto

# Run Cairo tests
scarb test

# Run Rust tests
cargo test -p garaga_rs

Building

# Build Python package with Rust extension
maturin develop --release --features python

# Build WASM package
make wasm

Profiling

# Profile a specific test
make profile-test TEST=<test_name>

# Generate benchmarks
make benchmarks

---

Next Steps

• Working with auto-generated Cairo Code

• garaga-rs crate — Rust library and bindings