Skip to main content

Crate airbender_core

Crate airbender_core 

Source
Expand description

§airbender-core Build status License: MIT OR Apache-2.0 rust nightly required host and guest

Documentation: API docs | Platform guide

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

[!NOTE] Support crate. For guest programs, use airbender-sdk. For host programs, use airbender-host, which re-exports the necessary types. Depend on this crate directly only when building tooling that bridges the host/guest boundary.

airbender-core contains the shared data model that other Airbender crates build on. It keeps the host and guest boundary explicit: commit layouts, framed input words, and the manifest schema for packaged guest artifacts.

§What It Provides

  • guest::Commit for mapping values into the public output registers (x10..x17).
  • wire helpers for the canonical host-to-guest framed input format.
  • manifest types and parsers for the packaged guest artifact schema used by host tooling.

§Features

  • host (default): enables manifest parsing and serialization support via serde, toml, and thiserror.

Disable default features for no_std guest-side use:

[dependencies]
airbender-core = { git = "https://github.com/matter-labs/airbender-platform", branch = "main", default-features = false }

§License

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

Modules§

guest
Guest-side output commitment traits shared between host and guest crates.
host
manifest
Manifest schema shared between build and host tooling.
wire
Canonical host/guest input wire format.