provable-contracts 0.1.0

Papers to Math to Contracts in Code — YAML contract parsing, validation, scaffold generation, and Kani harness codegen for provable Rust kernels
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

//! Generate all code artifacts from a contract: trait, tests, Kani harnesses, probar tests.
//!
//! Usage:
//!   cargo run --example codegen -- contracts/softmax-kernel-v1.yaml

use std::path::PathBuf;
use std::process;

use provable_contracts::kani_gen::generate_kani_harnesses;
use provable_contracts::probar_gen::generate_probar_tests;
use provable_contracts::scaffold::{generate_contract_tests, generate_trait};
use provable_contracts::schema::parse_contract;

fn main() {
    let path = std::env::args().nth(1).map_or_else(
        || {
            eprintln!("Usage: codegen <contract.yaml>");
            process::exit(1);
        },
        PathBuf::from,
    );

    let contract = parse_contract(&path).unwrap_or_else(|e| {
        eprintln!("Failed to parse {}: {e}", path.display());
        process::exit(1);
    });

    let name = contract
        .metadata
        .description
        .replace(' ', "_")
        .to_lowercase();
    let version = &contract.metadata.version;

    println!("// ============================================");
    println!("// Contract: {} v{version}", contract.metadata.description);
    println!("// Equations: {}", contract.equations.len());
    println!("// Obligations: {}", contract.proof_obligations.len());
    println!(
        "// Falsification tests: {}",
        contract.falsification_tests.len()
    );
    println!("// Kani harnesses: {}", contract.kani_harnesses.len());
    println!("// ============================================\n");

    // 1. Trait
    println!("// ---- {name}_trait.rs ----\n");
    println!("{}", generate_trait(&contract));

    // 2. Contract tests
    println!("// ---- {name}_contract_tests.rs ----\n");
    println!("{}", generate_contract_tests(&contract));

    // 3. Kani harnesses
    println!("// ---- {name}_kani.rs ----\n");
    println!("{}", generate_kani_harnesses(&contract));

    // 4. Probar property tests
    println!("// ---- {name}_probar.rs ----\n");
    println!("{}", generate_probar_tests(&contract));
}