Ethos is a meta-compiler for The Bitcoin Protocol.

See docs/architecture.mmd for a full system diagram.

The compiler pipeline:

1. Schema Input: Projects produce schema.json files in the expected format
2. IR Generation: Convert schema.json to XXX_XXX.ir.json
3. Analysis normalizes IR and validates consistency
4. Codegen generates Rust client libraries, traits, and types

Deep Dive: docs/semantic-convergence.md

1. Rust (edition 2021, rust-version 1.70+)
2. just command runner (install with cargo install just)
3. Protocol executable (for integration tests): bitcoind (Bitcoin Core)

Run the complete code generation workflow:

just ethos

This will:

1. Generate client libraries from IR files (resources/ir/)
2. Run end-to-end tests against spawned protocol nodes

Contributors are warmly welcome, see CONTRIBUTING.md.

CC0-1.0

This is experimental software in active development. Please use appropriate caution.