Examples - Stoffel Documentation

Status: Python template examplesStoffel 0.1.0 provides a Python project template, not a finalized Python SDK package. Use the Rust SDK examples for verified end-to-end execution.

Create a Python template project

stoffel init my-python-project --template python
cd my-python-project

Inspect the generated files:

find . -maxdepth 3 -type f | sort
cat README.md

The template includes a nested Stoffel program that you can check and run through the CLI:

stoffel check stoffel
stoffel run stoffel --input a=40 --input b=2

If the generated program has different inputs, use the generated README.md and stoffel/src/program.stfl as the source of truth.

Use Rust SDK examples for executable flows

The Stoffel repository includes verified Rust SDK examples:

cd /path/to/stoffel
cargo run -p stoffel-rust-sdk --example quickstart
cargo run -p stoffel-rust-sdk --example local_mpc_named_inputs
cargo run -p stoffel-rust-sdk --example local_mpc_client_input

Use the CLI directly from Python projects

Until a Python package is finalized, a Python application can treat Stoffel as a build/run tool invoked around a nested Stoffel project:

stoffel check stoffel
stoffel build stoffel
stoffel run stoffel --input a=40 --input b=2

For ClientStore examples, use client-slot inputs:

stoffel run stoffel --client-input 0=42 --parties 5 --threshold 1

Python package API status

Some design sketches use names such as StoffelProgram, StoffelClient, or execute_with_inputs. Do not present those as 0.1.0 Python package APIs; use the Python template for scaffolding and the Rust SDK for executable application flows.

​Create a Python template project

​Use Rust SDK examples for executable flows

​Use the CLI directly from Python projects

​Python package API status

​Next steps

Create a Python template project

Use Rust SDK examples for executable flows

Use the CLI directly from Python projects

Python package API status

Next steps