API Reference - Stoffel Documentation

Stoffel currently provides a Python project template, not a finalized Python SDK package API. Do not depend on design sketches such as StoffelProgram, StoffelClient, or execute_with_inputs as release APIs.

Supported Python-oriented workflow

Use the CLI template to scaffold a Python project that contains a Stoffel program:

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

Run the nested Stoffel program through the CLI:

stoffel run stoffel --input a=40 --input b=2
stoffel run stoffel --client-input 0=42 --parties 5 --threshold 1

Use the generated README and nested Stoffel.toml as the source of truth for the exact file names and inputs created by your installed CLI.

Executable application API

For applications that need to compile, load, or run Stoffel programs directly, use the Rust SDK:

use stoffel::prelude::*;

# async fn example() -> stoffel::Result<()> {
let result = Stoffel::load_file("target/debug/hello-mpc.stflb")?
    .parties(5)
    .threshold(1)
    .with_client_input(0, &[42_i64])
    .execute_local()
    .await?;
# Ok(())
# }

A Python service can shell out to the CLI around a nested Stoffel project, or call a Rust service/library boundary that uses the Rust SDK.

Future Python package shape

A future Python package should mirror the same concepts as the CLI and Rust SDK:

loading .stflb bytecode;
passing named inputs and ClientStore slot inputs;
running local MPC development flows;
connecting to network configurations for deployed MPC nodes;
keeping private input boundaries explicit.

Until that package is finalized, treat Python API examples as design notes only.

​Supported Python-oriented workflow

​Executable application API

​Future Python package shape

​See also

Supported Python-oriented workflow

Executable application API

Future Python package shape

See also