# Stoffel Documentation

## Docs

- [Architecture](https://docs.stoffelmpc.com/architecture/architecture.md): Technical overview of StoffelVM'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 protocols including HoneyBadger, secret sharing, and cryptographic field support.
- [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 StoffelVM architecture including dual register spaces for clear and secret values in MPC operations.
- [Stoffel CLI Overview](https://docs.stoffelmpc.com/cli/overview.md): Comprehensive command-line interface for developing, building, testing, and running privacy-preserving MPC applications.
- [Basic Usage](https://docs.stoffelmpc.com/getting-started/basic-usage.md): Essential Stoffel CLI commands and workflows for daily development including compilation, execution, and debugging.
- [Your First MPC Project](https://docs.stoffelmpc.com/getting-started/first-project.md): Build a complete real-world privacy-preserving salary benchmarking system using Stoffel and secure multi-party computation.
- [Installation](https://docs.stoffelmpc.com/getting-started/installation.md): Step-by-step guide to install Stoffel CLI, StoffelLang compiler, StoffelVM, and related components from source.
- [Quick Start](https://docs.stoffelmpc.com/getting-started/quick-start.md): Create your first privacy-preserving MPC application with Stoffel in just a few minutes.
- [Introduction](https://docs.stoffelmpc.com/introduction.md): Overview of Stoffel, a comprehensive framework for building privacy-preserving applications using secure Multi-Party Computation (MPC).
- [Ecosystem Overview](https://docs.stoffelmpc.com/introduction/ecosystem.md): Complete overview of the Stoffel ecosystem including CLI, compiler, virtual machine, MPC protocols, and language SDKs.
- [What is Multi-Party Computation?](https://docs.stoffelmpc.com/introduction/what-is-mpc.md): An introduction to MPC - a cryptographic technique that allows multiple parties to jointly compute a function while keeping their inputs private.
- [Why Stoffel?](https://docs.stoffelmpc.com/introduction/why-stoffel.md): How Stoffel solves MPC development challenges with a developer-friendly framework that makes privacy-preserving computation accessible.
- [Implementation Details](https://docs.stoffelmpc.com/mpc-protocols/implementation.md): Technical details of HoneyBadger MPC implementation including message formats, state machines, and Rust SDK integration.
- [Protocol Overview](https://docs.stoffelmpc.com/mpc-protocols/overview.md): HoneyBadger MPC protocol overview with Byzantine fault tolerance for secure multi-party computation in Stoffel.
- [API Reference](https://docs.stoffelmpc.com/python-sdk/api.md): Python SDK API reference for StoffelProgram compilation and StoffelClient MPC network communication.
- [Examples](https://docs.stoffelmpc.com/python-sdk/examples.md): Python SDK examples demonstrating secure computation, salary benchmarking, and MPC network integration.
- [Installation](https://docs.stoffelmpc.com/python-sdk/installation.md): Install the Stoffel Python SDK using Poetry or pip for development and integration with Python applications.
- [Python SDK Overview](https://docs.stoffelmpc.com/python-sdk/overview.md): High-level Python interface for Stoffel MPC applications using StoffelProgram and StoffelClient classes.
- [RFC-0001: MPC Preprocessing Configuration](https://docs.stoffelmpc.com/rfcs/0001-preprocessing-configuration.md): Program-aware bytecode analysis for automatic preprocessing configuration
- [API Reference](https://docs.stoffelmpc.com/rust-sdk/api.md): Complete Rust SDK API reference including StoffelBuilder, Program, MPCClient, MPCServer, and MPCNode types.
- [Examples](https://docs.stoffelmpc.com/rust-sdk/examples.md): Rust SDK usage examples from simple local execution to full MPC workflows with HoneyBadger protocol.
- [Installation](https://docs.stoffelmpc.com/rust-sdk/installation.md): Install the Stoffel Rust SDK using Cargo or the Stoffel CLI template for quick project setup.
- [Rust SDK Overview](https://docs.stoffelmpc.com/rust-sdk/overview.md): High-level Rust API for building MPC applications, bridging StoffelLang, StoffelVM, and HoneyBadger protocol.
- [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): StoffelLang compilation pipeline from source to bytecode, including optimization levels, error handling, and debugging capabilities.
- [FFI / C Bindings](https://docs.stoffelmpc.com/stoffel-lang/ffi.md): Foreign Function Interface for using the StoffelLang compiler from C, C++, Python, and other languages via C-compatible ABI.
- [StoffelLang Overview](https://docs.stoffelmpc.com/stoffel-lang/overview.md): Modern programming language for MPC applications with familiar syntax inspired by Rust and Python, featuring native secret types and strong typing.
- [Syntax and Examples](https://docs.stoffelmpc.com/stoffel-lang/syntax.md): Comprehensive guide to StoffelLang syntax including variables, functions, control flow, secret types, and the ClientStore API.
- [Built-in Functions](https://docs.stoffelmpc.com/stoffel-vm/builtins.md): StoffelVM standard library reference including print, array operations, and the ClientStore API for MPC computations.
- [StoffelVM Implementation](https://docs.stoffelmpc.com/stoffel-vm/implementation.md): Technical details of StoffelVM architecture, register system, value types, instruction set, and MPC protocol integration.
- [Instructions and Types](https://docs.stoffelmpc.com/stoffel-vm/instructions.md): Complete StoffelVM instruction set reference including memory operations, arithmetic, control flow, and bytecode format.
- [Using the VM](https://docs.stoffelmpc.com/stoffel-vm/usage.md): Running compiled StoffelLang programs with StoffelVM, including command-line options, debugging, and MPC integration.

## OpenAPI Specs

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