universal-sierra-compiler 2.7.0

Universal-Sierra-Compiler is the tool for Sierra compilation. It compiles any ever-existing Sierra version to CASM.
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

use anyhow::{Context, Result};
use cairo_lang_starknet_classes::casm_contract_class::CasmContractClass;
use cairo_lang_starknet_classes::contract_class::ContractClass;
use cairo_lang_starknet_sierra_0_1_0::casm_contract_class::CasmContractClass as CasmContractClassSierraV0;
use cairo_lang_starknet_sierra_0_1_0::contract_class::ContractClass as ContractClassSierraV0;
use cairo_lang_starknet_sierra_1_0_0::casm_contract_class::CasmContractClass as CasmContractClassSierraV1;
use cairo_lang_starknet_sierra_1_0_0::contract_class::ContractClass as ContractClassSierraV1;
use clap::Args;
use serde_json::Value;
use std::path::PathBuf;

#[derive(Args)]
pub struct CompileContract {
    /// Path to the sierra json file, which should have
    /// `sierra_program` and `entry_points_by_type` fields
    #[arg(short, long)]
    pub sierra_path: PathBuf,

    /// Path to where casm json file will be saved.
    /// It will be serialized [`cairo_lang_starknet::casm_contract_class::CasmContractClass`]
    #[arg(short, long)]
    pub output_path: Option<PathBuf>,
}

/// Compiles Sierra of the Starknet contract.
#[tracing::instrument(skip_all, level = "info")]
pub fn compile(mut sierra_json: Value) -> Result<Value> {
    sierra_json["abi"] = Value::Null;
    sierra_json["sierra_program_debug_info"] = Value::Null;
    sierra_json["contract_class_version"] = Value::String(String::new());

    macro_rules! compile_contract {
        ($sierra_type:ty, $casm_type:ty) => {{
            let sierra_class = serde_json::from_value::<$sierra_type>(sierra_json.clone()).unwrap();
            let casm_class = <$casm_type>::from_contract_class(sierra_class, true).unwrap();
            return Ok(serde_json::to_value(&casm_class)?);
        }};
    }

    let sierra_version = parse_sierra_version(&sierra_json)?;
    match sierra_version.as_slice() {
        [1, 2..=7, ..] => {
            let sierra_class: ContractClass = serde_json::from_value(sierra_json.clone()).unwrap();
            let casm_class =
                CasmContractClass::from_contract_class(sierra_class, true, usize::MAX).unwrap();
            Ok(serde_json::to_value(casm_class)?)
        }
        [1, 0..=1, 0] => compile_contract!(ContractClassSierraV1, CasmContractClassSierraV1),
        [0, ..] => compile_contract!(ContractClassSierraV0, CasmContractClassSierraV0),
        _ => {
            anyhow::bail!(
                "Unable to compile Sierra to Casm. No matching ContractClass or CasmContractClass found for version "
                    .to_string() + &sierra_version.iter().map(|&num| num.to_string()).collect::<Vec<String>>().join("."),
            )
        }
    }
}

/// Extracts sierra version from the program
/// It will not be possible to convert sierra 0.1.0 version because it keeps its version only in the first felt252
/// (as a shortstring) while other versions keep it on the first 3 (major, minor, patch)
/// That's why it fallbacks to 0 when converting from Value to u8
fn parse_sierra_version(sierra_json: &Value) -> Result<Vec<u8>> {
    let parsed_values: Vec<u8> = sierra_json["sierra_program"]
        .as_array()
        .context("Unable to read sierra_program. Make sure it is an array of felts")?
        .iter()
        .take(3)
        .map(|x| u8::from_str_radix(&x.as_str().unwrap()[2..], 16).unwrap_or_default())
        .collect();

    Ok(parsed_values)
}