# Stoffel Documentation

## Docs

- [Architecture](https://docs.stoffelmpc.com/architecture/architecture.md): Technical overview of Stoffel VM's register-based architecture with separate clear and secret value handling.
- [MPC Integration](https://docs.stoffelmpc.com/architecture/mpc.md): How Stoffel integrates with MPC backends, secret sharing, client inputs, and backend-specific security models.
- [Design Rationale](https://docs.stoffelmpc.com/architecture/rationale.md): Design decisions behind Stoffel's protocol-agnostic architecture, extensibility, and future-proofing strategies.
- [Sources](https://docs.stoffelmpc.com/architecture/sources.md): Comprehensive list of resources and references used when designing and building the Stoffel framework.
- [System Architecture](https://docs.stoffelmpc.com/architecture/system.md): Complete Stoffel system architecture showing how CLI, compiler, VM, SDKs, and MPC protocols interact.
- [VM Architecture Details](https://docs.stoffelmpc.com/architecture/vm.md): Detailed Stoffel VM architecture including dual register spaces for clear and secret values in MPC operations.
- [Stoffel CLI Overview](https://docs.stoffelmpc.com/cli/overview.md): Use the Stoffel CLI to create, check, build, run, and iterate on private-computation projects.
- [Stoffel Developer Skills](https://docs.stoffelmpc.com/developer-skills/overview.md): Agent-ready playbooks for building applications with the Stoffel framework.
- [Stoffel AI Agent Implementation](https://docs.stoffelmpc.com/developer-skills/stoffel-ai-agent-implementation.md): Give AI coding agents the context they need to build and validate Stoffel applications correctly.
- [Stoffel App Getting Started](https://docs.stoffelmpc.com/developer-skills/stoffel-app-getting-started.md): Install Stoffel, create your first app, run local checks, and choose the build path your product needs.
- [Stoffel App Network and Off-Chain Integration](https://docs.stoffelmpc.com/developer-skills/stoffel-app-network-and-offchain-integration.md): Move from local bytecode to client/server builders, network config, and off-chain coordinator integration.
- [Stoffel App Troubleshooting](https://docs.stoffelmpc.com/developer-skills/stoffel-app-troubleshooting.md): Diagnose app-level init, check, build, run, local MPC, binding, SDK, and network failures with evidence.
- [Stoffel CLI App Workflow](https://docs.stoffelmpc.com/developer-skills/stoffel-cli-app-workflow.md): Use the stoffel CLI to init, check, build, compile, run, test, inspect, and troubleshoot Stoffel apps.
- [Stoffel Deployment Runbook](https://docs.stoffelmpc.com/developer-skills/stoffel-deployment-runbook.md): Prepare and verify a production-shaped Stoffel deployment with compiled bytecode, typed client IO, node topology, coordinator settings, identity material, and operational checks.
- [Stoffel Full App Golden Path](https://docs.stoffelmpc.com/developer-skills/stoffel-full-app-golden-path.md): Build a complete Stoffel app from boundary design through StoffelLang, Rust SDK integration, local MPC validation, typed bindings, and deployment handoff.
- [Stoffel-Lang App Programming](https://docs.stoffelmpc.com/developer-skills/stoffel-lang-app-programming.md): Write .stfl application logic using supported Stoffel-Lang syntax, types, builtins, and example patterns.
- [Stoffel Local MPC Dev Loop](https://docs.stoffelmpc.com/developer-skills/stoffel-local-mpc-dev-loop.md): Run local MPC smoke tests, ClientStore input flows, hot reload, and SDK local coordinator-backed execution.
- [Stoffel Rust App SDK](https://docs.stoffelmpc.com/developer-skills/stoffel-rust-app-sdk.md): Embed Stoffel in Rust apps using the SDK for compilation, bytecode loading, local execution, clients, and servers.
- [Stoffel Secret MPC Programming](https://docs.stoffelmpc.com/developer-skills/stoffel-secret-mpc-programming.md): Build MPC apps with secret types, Share, ClientStore, Mpc, MpcOutput, and runnable private-input examples.
- [Stoffel Typed Client IO Bindings](https://docs.stoffelmpc.com/developer-skills/stoffel-typed-client-io-bindings.md): Generate and use Rust typed client input/output bindings from exact Stoffel bytecode manifests.
- [Basic Usage](https://docs.stoffelmpc.com/getting-started/basic-usage.md): Daily Stoffel CLI workflows for checking, building, running, testing, and debugging Stoffel projects.
- [Your First MPC Project](https://docs.stoffelmpc.com/getting-started/first-project.md): Build and run a small secret-shared eligibility example with the Stoffel CLI and Rust SDK workflow.
- [Installation](https://docs.stoffelmpc.com/getting-started/installation.md): Install the Stoffel CLI and verify the `stoffel` command line tool for building Stoffel apps.
- [Quick Start](https://docs.stoffelmpc.com/getting-started/quick-start.md): Create a Stoffel project, build bytecode, run local MPC, and understand the recommended development loop.
- [Introduction](https://docs.stoffelmpc.com/introduction.md): Write StoffelLang programs, build `.stflb` bytecode, run local MPC, and integrate private computation into Rust applications.
- [What is Multi-Party Computation?](https://docs.stoffelmpc.com/introduction/what-is-mpc.md): A developer mental model for MPC: plaintext becomes shares, parties compute over shares, and only explicit outputs become visible.
- [Why Stoffel?](https://docs.stoffelmpc.com/introduction/why-stoffel.md): Why Stoffel exists as a developer workflow for building applications with secure multiparty computation.
- [AVSS](https://docs.stoffelmpc.com/mpc-protocols/avss.md): AVSS backend details for Feldman commitments, verifiable scalar shares, and curve-compatible workflows in Stoffel.
- [HoneyBadgerMPC](https://docs.stoffelmpc.com/mpc-protocols/honeybadger-mpc.md): HoneyBadgerMPC backend details for asynchronous, robust, field-based MPC in Stoffel.
- [How Backend Selection Works](https://docs.stoffelmpc.com/mpc-protocols/implementation.md): How Stoffel carries MPC backend selection through config, bytecode, the VM, local runs, and SDK network/client configuration.
- [MPC Backends](https://docs.stoffelmpc.com/mpc-protocols/overview.md): Choose the Stoffel MPC backend that matches your program's secret value representation, cost model, and verifier-facing outputs.
- [Performance and Circuit Shaping](https://docs.stoffelmpc.com/mpc-protocols/performance-and-circuit-shaping.md): How to reason about secret-dependent work, preprocessing demand, type choices, and transcript shape across Stoffel MPC backends.
- [API Reference](https://docs.stoffelmpc.com/python-sdk/api.md): Current Python SDK status and the supported CLI/Rust SDK alternatives.
- [Examples](https://docs.stoffelmpc.com/python-sdk/examples.md): Python template examples and current alternatives for Stoffel 0.1.0.
- [Installation](https://docs.stoffelmpc.com/python-sdk/installation.md): Install the Stoffel CLI and create a Python-oriented project scaffold.
- [Python SDK Overview](https://docs.stoffelmpc.com/python-sdk/overview.md): Current status of Python integration in the Stoffel 0.1.0 release.
- [API Reference](https://docs.stoffelmpc.com/rust-sdk/api.md): Current Rust SDK API surface for compiling, loading, executing, and configuring Stoffel programs.
- [Examples](https://docs.stoffelmpc.com/rust-sdk/examples.md): Current Rust SDK examples for clear execution, local MPC, bytecode, ClientStore inputs, network config, and observability.
- [Installation](https://docs.stoffelmpc.com/rust-sdk/installation.md): Install the Stoffel CLI and add the Rust SDK to your app.
- [Rust SDK Overview](https://docs.stoffelmpc.com/rust-sdk/overview.md): Primary 0.1.0 application API for compiling, loading, and running Stoffel programs from Rust.
- [Access Control](https://docs.stoffelmpc.com/solidity-sdk/access-control.md): Role-based access control for MPC parties with PARTY_ROLE and DESIGNATED_PARTY_ROLE permissions.
- [StoffelCoordinator](https://docs.stoffelmpc.com/solidity-sdk/coordinator.md): Abstract contract implementing a 7-phase state machine for orchestrating MPC computations on-chain.
- [Input Manager](https://docs.stoffelmpc.com/solidity-sdk/input-manager.md): Contract for handling client input submission with privacy-preserving masking and ECDSA authentication.
- [Solidity SDK Overview](https://docs.stoffelmpc.com/solidity-sdk/overview.md): Smart contracts for coordinating MPC computations on-chain with trustless orchestration, verifiable inputs, and guaranteed outputs.
- [Security Best Practices](https://docs.stoffelmpc.com/solidity-sdk/security.md): Security considerations for MPC applications including access control, input integrity, and threshold configuration.
- [Using the Solidity Templates](https://docs.stoffelmpc.com/solidity-sdk/template-guide.md): Guide to creating on-chain MPC applications with Foundry or Hardhat templates via the Stoffel CLI.
- [Compilation](https://docs.stoffelmpc.com/stoffel-lang/compilation.md): How StoffelLang source is validated, compiled, optimized, disassembled, and executed in current Stoffel programs.
- [Runnable Examples](https://docs.stoffelmpc.com/stoffel-lang/examples.md): A guided path through runnable StoffelLang examples in the Stoffel repository.
- [FFI / C Bindings](https://docs.stoffelmpc.com/stoffel-lang/ffi.md): Status and guidance for using StoffelLang from non-Rust environments.
- [StoffelLang Overview](https://docs.stoffelmpc.com/stoffel-lang/overview.md): The current Stoffel language for clear local logic and MPC-aware computations compiled to Stoffel VM bytecode.
- [Syntax and Examples](https://docs.stoffelmpc.com/stoffel-lang/syntax.md): Current StoffelLang syntax for functions, variables, control flow, lists, Share values, and ClientStore inputs.
- [Built-in Functions](https://docs.stoffelmpc.com/stoffel-vm/builtins.md): Current Stoffel VM standard and MPC builtin functions, including Share, ClientStore, Mpc, MpcOutput, storage, and protocol helper modules.
- [Stoffel VM Implementation](https://docs.stoffelmpc.com/stoffel-vm/implementation.md): Architecture notes for Stoffel VM runtime state, bytecode loading, execution, table memory, hooks, and MPC effects.
- [Instructions and Types](https://docs.stoffelmpc.com/stoffel-vm/instructions.md): Stoffel VM instruction, register, value, function, and bytecode format reference.
- [Virtual Machine Overview](https://docs.stoffelmpc.com/stoffel-vm/overview.md): How Stoffel VM executes bytecode, manages clear and secret registers, and connects StoffelLang programs to local or network MPC runtimes.
- [VM Usage](https://docs.stoffelmpc.com/stoffel-vm/usage.md): Run Stoffel VM bytecode through the CLI and Rust SDK, inspect generated artifacts, and know when to avoid low-level VM internals.

## OpenAPI Specs

- [openapi](https://docs.stoffelmpc.com/api-reference/openapi.json)