Skip to main content

Crate airbender

Crate airbender 

Source
Expand description

§airbender-sdk Build status License: MIT OR Apache-2.0 rust nightly required no_std supported

Documentation: API docs | Guest program guide

[!WARNING] airbender-platform project is under active development and is in alpha state. Use at your own risk.

airbender-sdk is the main entry point for writing Airbender guest programs. It re-exports the guest API, runtime, codec helpers, and the #[airbender::main] attribute behind a single dependency, so guest code can import everything from airbender.

§What It Provides

  • #[airbender::main] for defining the guest entrypoint.
  • airbender::guest for input reads, output commits, and cycle markers.
  • airbender::rt and airbender::codec for lower-level runtime and serialization access.
  • Optional airbender::crypto re-exports for shared host/guest crypto code.

§Features

  • std: enables guest-side standard-library support.
  • crypto: re-exports airbender-crypto with proving-oriented guest backends.
  • allocator-talc (default), allocator-bump, allocator-custom: select the guest allocator model.

§Usage

[dependencies]
airbender = { package = "airbender-sdk", git = "https://github.com/matter-labs/airbender-platform", branch = "main" }

Complete guest + host examples live in examples/.

§License

Licensed under either Apache License, Version 2.0 or MIT license at your option.

Modules§

codec
guest
rt

Attribute Macros§

main