aeri 0.2.2

Aeri is the Cardano smart contract language created by Trevor Knott at Knott Dynamics, with its official compiler and CLI.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Official compiler and tooling API for Aeri, the Cardano smart contract
//! language created by Trevor Knott at Knott Dynamics.
//!
//! Aeri defines a typed `.aeri` source language for validators, helper
//! functions, custom data types, constants, pattern matches, and pure tests.
//! This crate provides the official compiler, CLI, and Rust API for checking,
//! testing, formatting, linting, inspecting, documenting, and compiling Aeri
//! contracts. The supported backend subset emits Plutus V2 UPLC/CBOR artifacts;
//! unsupported ledger behavior is reported as a blocker instead of being
//! presented as deployable output.
//!
//! # Compile A Module
//!
//! ```
//! use aeri::compile_source;
//!
//! let source = r#"
//! module demo;
//!
//! validator gate(redeemer: ByteArray, ctx: Tx) {
//!   redeemer == #01
//! }
//! "#;
//!
//! let output = compile_source("demo.aeri", source)?;
//! assert_eq!(output.validator_count, 1);
//! # Ok::<(), aeri::AeriError>(())
//! ```
//!
//! # Main Entry Points
//!
//! - [`compile_source`] parses, checks, and lowers one module.
//! - [`format_source`] returns canonical Aeri source formatting.
//! - [`run_tests_source`] executes deterministic pure test blocks.
//! - [`lint_source`] reports contract-oriented lint warnings.
//! - [`estimate_source`] produces static size and budget estimates.
//! - [`docs_source`] generates Markdown API summaries for Aeri modules.
//!
//! The `aeri` binary provides project-level build, check, test, lint, format,
//! inspect, documentation, cost, and verification workflows.
#![warn(rustdoc::broken_intra_doc_links)]

/// Abstract syntax tree definitions for parsed Aeri modules.
pub mod ast;
/// Backend target metadata and preview rendering.
pub mod backend;
/// Source checking, lowering, and blueprint generation.
pub mod compile;
/// Deterministic static cost estimation.
pub mod cost;
/// Source spans, compiler errors, and the crate result type.
pub mod diagnostic;
/// Markdown documentation generation for Aeri modules.
pub mod docs;
/// Deterministic evaluator for pure Aeri test blocks.
pub mod eval;
/// Canonical Aeri source formatting.
pub mod format;
/// Structured compiler and UPLC inspection reports.
pub mod inspect;
/// Aeri intermediate representation and validation.
pub mod ir;
/// Source tokenization.
pub mod lexer;
/// Contract-oriented source linting.
pub mod lint;
/// Aeri module parsing.
pub mod parser;
/// Builtin and source type definitions.
pub mod types;
/// UPLC lowering, validation, flat encoding, and CBOR emission.
pub mod uplc;

pub use compile::{
    CompileOutput, UplcValidatorArtifact, build_uplc_blueprint, build_uplc_project_blueprint,
    compile_source, merge_blueprints, try_merge_blueprints,
};
pub use cost::{CostReport, ValidatorCost, estimate_source};
pub use diagnostic::{AeriError, Result};
pub use docs::{docs_source, render_module_docs};
pub use eval::{TestReport, TestResult, run_tests_source};
pub use format::format_source;
pub use lint::{LintWarning, lint_source};