[Sierra-Emu] implement some todos from const and cast libfuncs (#1191)

FrancoGiachetta · gabrielbosio · JulianGCalderon · DiegoCivi · commit 167934d2af95 · 2025-06-13T19:26:43.000-03:00
* Add sierra-emu as a debug utility

* Change working dir in sierra-emu job

* Remove repeated lines in sierra-emu gitignore

* Exclude debug_utils from coverage job

* remove some todos from value and implement Coupon libfunc

* start adding corelib test

* run tests from corelib

* remove unwanted file

* remove not related things

* get return_value from trace

* replace ids for debug info

* add common folder for integration tests

* fix tests

* remove todo

* ignore test for now

* add enum in const::inner

* remove todos and fix some failures

* filter ignored tests

* Update debug_utils/sierra-emu/tests/common/mod.rs

Co-authored-by: Julian Gonzalez Calderon &lt;gonzalezcalderonjulian@gmail.com&gt;

* run ignored test from the ci

* better ignoring

* ignore test

* fmt

* remove debug_name in enums

* refactor

* remove unused dependency

* More expressive naming for the workflow

Co-authored-by: Gabriel Bosio &lt;38794644+gabrielbosio@users.noreply.github.com&gt;

* reviews

* reviews

* fmt

* fmt ci

* revert last commit

* fmt

* accidentally removed rayon usage

* avoid map's short-circuiting

* catch panics the avoid loosing the test name

* log ignored tests

* clippy

* Add "(WIP)" to corelib's test job

Co-authored-by: Gabriel Bosio &lt;38794644+gabrielbosio@users.noreply.github.com&gt;

* print progress as the test runs

* fmt

* format makefile

Co-authored-by: Julian Gonzalez Calderon &lt;gonzalezcalderonjulian@gmail.com&gt;

* fix name test in ci

* add dependencies removed in merge

* dependencies

* clippy

* remove unused import

* better indent in makefile

* uppercase tests summary comment for better sight

* fix clippy

* clippy

* remove unnecesary pubs

* better docs

* better panic message in get_numberic_args_as_bigints()

Co-authored-by: Julian Gonzalez Calderon &lt;gonzalezcalderonjulian@gmail.com&gt;

* reviews

* remove unnecessary comment

Co-authored-by: Julian Gonzalez Calderon &lt;gonzalezcalderonjulian@gmail.com&gt;

* use slices in get_numeric_args_as_bigints

* fmt

* remove unnecesary to_vec

* fmt

* use iter instead of into_iter

* reviews changes

* better error message

* fix typo

---------

Co-authored-by: gabrielbosio &lt;gabrielbosio95@gmail.com&gt;
Co-authored-by: Julian Gonzalez Calderon &lt;gonzalezcalderonjulian@gmail.com&gt;
Co-authored-by: Gabriel Bosio &lt;38794644+gabrielbosio@users.noreply.github.com&gt;
diff --git a/debug_utils/sierra-emu/src/lib.rs b/debug_utils/sierra-emu/src/lib.rs
@@ -19,6 +19,7 @@ mod dump;
 mod gas;
 pub mod starknet;
 mod test_utils;
+mod utils;
 mod value;
 mod vm;
 
diff --git a/debug_utils/sierra-emu/src/utils.rs b/debug_utils/sierra-emu/src/utils.rs
@@ -0,0 +1,55 @@
+use cairo_lang_sierra::{
+    extensions::core::{CoreLibfunc, CoreType, CoreTypeConcrete},
+    program_registry::ProgramRegistry,
+};
+use num_bigint::BigInt;
+use num_traits::ToPrimitive;
+
+use crate::Value;
+
+/// Receives a vector of values, filters any which is non numeric and returns a `Vec<BigInt>`
+/// Useful when a binary operation takes generic values (like with bounded ints).
+pub fn get_numeric_args_as_bigints(args: &[Value]) -> Vec<BigInt> {
+    args.iter()
+        .map(|v| match v {
+            Value::BoundedInt { value, .. } => value.to_owned(),
+            Value::I8(value) => BigInt::from(*value),
+            Value::I16(value) => BigInt::from(*value),
+            Value::I32(value) => BigInt::from(*value),
+            Value::I64(value) => BigInt::from(*value),
+            Value::I128(value) => BigInt::from(*value),
+            Value::U8(value) => BigInt::from(*value),
+            Value::U16(value) => BigInt::from(*value),
+            Value::U32(value) => BigInt::from(*value),
+            Value::U64(value) => BigInt::from(*value),
+            Value::U128(value) => BigInt::from(*value),
+            Value::Felt(value) => value.to_bigint(),
+            Value::Bytes31(value) => value.to_bigint(),
+            value => panic!("argument should be an integer: {:?}", value),
+        })
+        .collect()
+}
+
+pub fn get_value_from_integer(
+    registry: &ProgramRegistry<CoreType, CoreLibfunc>,
+    ty: &CoreTypeConcrete,
+    value: BigInt,
+) -> Value {
+    match ty {
+        CoreTypeConcrete::NonZero(info) => {
+            let ty = registry.get_type(&info.ty).unwrap();
+            get_value_from_integer(registry, ty, value)
+        }
+        CoreTypeConcrete::Sint8(_) => Value::I8(value.to_i8().unwrap()),
+        CoreTypeConcrete::Sint16(_) => Value::I16(value.to_i16().unwrap()),
+        CoreTypeConcrete::Sint32(_) => Value::I32(value.to_i32().unwrap()),
+        CoreTypeConcrete::Sint64(_) => Value::I64(value.to_i64().unwrap()),
+        CoreTypeConcrete::Sint128(_) => Value::I128(value.to_i128().unwrap()),
+        CoreTypeConcrete::Uint8(_) => Value::U8(value.to_u8().unwrap()),
+        CoreTypeConcrete::Uint16(_) => Value::U16(value.to_u16().unwrap()),
+        CoreTypeConcrete::Uint32(_) => Value::U32(value.to_u32().unwrap()),
+        CoreTypeConcrete::Uint64(_) => Value::U64(value.to_u64().unwrap()),
+        CoreTypeConcrete::Uint128(_) => Value::U128(value.to_u128().unwrap()),
+        _ => panic!("cannot get integer value for a non-integer type"),
+    }
+}
diff --git a/debug_utils/sierra-emu/src/vm/bounded_int.rs b/debug_utils/sierra-emu/src/vm/bounded_int.rs
@@ -1,5 +1,5 @@
 use super::EvalAction;
-use crate::Value;
+use crate::{utils::get_numeric_args_as_bigints, Value};
 use cairo_lang_sierra::{
     extensions::{
         bounded_int::{
@@ -15,29 +15,6 @@ use cairo_lang_sierra::{
 use num_bigint::BigInt;
 use smallvec::smallvec;
 
-// All binary operations have generic arguments, this function takes their values
-// and builds bigints out of them (since Bigints are used to represent bounded ints' values)
-fn get_numberic_args_as_bigints(args: Vec<Value>) -> Vec<BigInt> {
-    args.into_iter()
-        // remove builtins, if any
-        .filter(|v| !matches!(v, Value::Unit))
-        .map(|v| match v {
-            Value::BoundedInt { value, .. } => value,
-            Value::I8(value) => BigInt::from(value),
-            Value::I16(value) => BigInt::from(value),
-            Value::I32(value) => BigInt::from(value),
-            Value::I64(value) => BigInt::from(value),
-            Value::I128(value) => BigInt::from(value),
-            Value::U8(value) => BigInt::from(value),
-            Value::U16(value) => BigInt::from(value),
-            Value::U32(value) => BigInt::from(value),
-            Value::U64(value) => BigInt::from(value),
-            Value::U128(value) => BigInt::from(value),
-            _ => panic!("Not a numeric value"),
-        })
-        .collect()
-}
-
 pub fn eval(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     selector: &BoundedIntConcreteLibfunc,
@@ -62,7 +39,7 @@ pub fn eval_add(
     info: &SignatureOnlyConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [lhs, rhs]: [BigInt; 2] = get_numberic_args_as_bigints(args).try_into().unwrap();
+    let [lhs, rhs]: [BigInt; 2] = get_numeric_args_as_bigints(&args).try_into().unwrap();
 
     let range = match registry
         .get_type(&info.signature.branch_signatures[0].vars[0].ty)
@@ -91,7 +68,7 @@ pub fn eval_sub(
     info: &SignatureOnlyConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [lhs, rhs]: [BigInt; 2] = get_numberic_args_as_bigints(args).try_into().unwrap();
+    let [lhs, rhs]: [BigInt; 2] = get_numeric_args_as_bigints(&args).try_into().unwrap();
 
     let range = match registry
         .get_type(&info.signature.branch_signatures[0].vars[0].ty)
@@ -120,7 +97,7 @@ pub fn eval_mul(
     info: &SignatureOnlyConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [lhs, rhs]: [BigInt; 2] = get_numberic_args_as_bigints(args).try_into().unwrap();
+    let [lhs, rhs]: [BigInt; 2] = get_numeric_args_as_bigints(&args).try_into().unwrap();
 
     let range = match registry
         .get_type(&info.signature.branch_signatures[0].vars[0].ty)
@@ -149,7 +126,7 @@ pub fn eval_div_rem(
     info: &BoundedIntDivRemConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [lhs, rhs]: [BigInt; 2] = get_numberic_args_as_bigints(args).try_into().unwrap();
+    let [lhs, rhs]: [BigInt; 2] = get_numeric_args_as_bigints(&args).try_into().unwrap();
 
     let quo = &lhs / &rhs;
     let rem = lhs % rhs;
diff --git a/debug_utils/sierra-emu/src/vm/cast.rs b/debug_utils/sierra-emu/src/vm/cast.rs
@@ -1,15 +1,17 @@
 use super::EvalAction;
-use crate::Value;
+use crate::{
+    utils::{get_numeric_args_as_bigints, get_value_from_integer},
+    Value,
+};
 use cairo_lang_sierra::{
     extensions::{
         casts::{CastConcreteLibfunc, DowncastConcreteLibfunc},
-        core::{CoreLibfunc, CoreType, CoreTypeConcrete},
+        core::{CoreLibfunc, CoreType},
         lib_func::SignatureOnlyConcreteLibfunc,
-        ConcreteType,
+        ConcreteLibfunc,
     },
     program_registry::ProgramRegistry,
 };
-use num_bigint::BigInt;
 use smallvec::smallvec;
 
 pub fn eval(
@@ -23,85 +25,40 @@ pub fn eval(
     }
 }
 
-pub fn eval_downcast(
+fn eval_downcast(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     info: &DowncastConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [range_check @ Value::Unit, value]: [Value; 2] = args.try_into().unwrap() else {
+    let range_check @ Value::Unit: Value = args[0].clone() else {
         panic!()
     };
+    let [value] = get_numeric_args_as_bigints(&args[1..]).try_into().unwrap();
 
-    let value = match value {
-        Value::BoundedInt { value, .. } => value,
-        Value::U128(value) => BigInt::from(value),
-        Value::U64(value) => BigInt::from(value),
-        Value::U32(value) => BigInt::from(value),
-        Value::U16(value) => BigInt::from(value),
-        Value::U8(value) => BigInt::from(value),
-        _ => todo!(),
-    };
-
+    let int_ty = registry.get_type(&info.to_ty).unwrap();
     let range = info.to_range.lower.clone()..info.to_range.upper.clone();
     if range.contains(&value) {
         EvalAction::NormalBranch(
             0,
-            smallvec![
-                range_check,
-                match registry.get_type(&info.to_ty).unwrap() {
-                    CoreTypeConcrete::Sint8(_) => Value::I8(value.try_into().unwrap()),
-                    CoreTypeConcrete::Sint128(_) => Value::I128(value.try_into().unwrap()),
-                    CoreTypeConcrete::Uint8(_) => Value::U8(value.try_into().unwrap()),
-                    CoreTypeConcrete::Uint16(_) => Value::U16(value.try_into().unwrap()),
-                    CoreTypeConcrete::Uint32(_) => Value::U32(value.try_into().unwrap()),
-                    CoreTypeConcrete::Uint64(_) => Value::U64(value.try_into().unwrap()),
-                    CoreTypeConcrete::Uint128(_) => Value::U128(value.try_into().unwrap()),
-                    CoreTypeConcrete::BoundedInt(_) => Value::BoundedInt { range, value },
-                    x => todo!("{:?}", x.info()),
-                }
-            ],
+            smallvec![range_check, get_value_from_integer(registry, int_ty, value)],
         )
     } else {
         EvalAction::NormalBranch(1, smallvec![range_check])
     }
 }
 
-pub fn eval_upcast(
+fn eval_upcast(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     info: &SignatureOnlyConcreteLibfunc,
     args: Vec<Value>,
 ) -> EvalAction {
-    let [value] = args.try_into().unwrap();
-
-    let value = match value {
-        Value::BoundedInt { value, .. } => value,
-        Value::U128(value) => BigInt::from(value),
-        Value::U64(value) => BigInt::from(value),
-        Value::U32(value) => BigInt::from(value),
-        Value::U16(value) => BigInt::from(value),
-        Value::U8(value) => BigInt::from(value),
-        _ => todo!(),
-    };
+    let [value] = get_numeric_args_as_bigints(&args).try_into().unwrap();
+    let int_ty = registry
+        .get_type(&info.branch_signatures()[0].vars[0].ty)
+        .unwrap();
 
     EvalAction::NormalBranch(
         0,
-        smallvec![match registry
-            .get_type(&info.signature.branch_signatures[0].vars[0].ty)
-            .unwrap()
-        {
-            CoreTypeConcrete::Sint8(_) => Value::I8(value.try_into().unwrap()),
-            CoreTypeConcrete::Sint32(_) => Value::I32(value.try_into().unwrap()),
-            CoreTypeConcrete::Sint128(_) => Value::I128(value.try_into().unwrap()),
-            CoreTypeConcrete::Uint8(_) => Value::U8(value.try_into().unwrap()),
-            CoreTypeConcrete::Uint16(_) => Value::U16(value.try_into().unwrap()),
-            CoreTypeConcrete::Uint32(_) => Value::U32(value.try_into().unwrap()),
-            CoreTypeConcrete::Uint64(_) => Value::U64(value.try_into().unwrap()),
-            CoreTypeConcrete::Uint128(_) => Value::U128(value.try_into().unwrap()),
-            CoreTypeConcrete::Felt252(_) => Value::Felt(value.into()),
-            CoreTypeConcrete::Sint16(_) => todo!("Sint16"),
-            CoreTypeConcrete::Sint64(_) => todo!("Sint64"),
-            CoreTypeConcrete::BoundedInt(_) => todo!("BoundedInt"),
-            _ => todo!(),
-        }],
+        smallvec![get_value_from_integer(registry, int_ty, value)],
     )
 }
diff --git a/debug_utils/sierra-emu/src/vm/const.rs b/debug_utils/sierra-emu/src/vm/const.rs
@@ -6,11 +6,13 @@ use cairo_lang_sierra::{
             ConstAsBoxConcreteLibfunc, ConstAsImmediateConcreteLibfunc, ConstConcreteLibfunc,
         },
         core::{CoreLibfunc, CoreType, CoreTypeConcrete},
+        starknet::StarknetTypeConcrete,
     },
     ids::ConcreteTypeId,
     program::GenericArg,
     program_registry::ProgramRegistry,
 };
+use num_traits::ToPrimitive;
 use smallvec::smallvec;
 
 pub fn eval(
@@ -24,7 +26,7 @@ pub fn eval(
     }
 }
 
-pub fn eval_as_immediate(
+fn eval_as_immediate(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     info: &ConstAsImmediateConcreteLibfunc,
     args: Vec<Value>,
@@ -41,7 +43,7 @@ pub fn eval_as_immediate(
     )
 }
 
-pub fn eval_as_box(
+fn eval_as_box(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     info: &ConstAsBoxConcreteLibfunc,
     args: Vec<Value>,
@@ -89,52 +91,56 @@ fn inner(
             },
             _ => unreachable!(),
         },
+        CoreTypeConcrete::Bytes31(_) => match inner_data {
+            [GenericArg::Value(value)] => Value::Bytes31(value.into()),
+            _ => unreachable!(),
+        },
         CoreTypeConcrete::Sint128(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::I128(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::I128(value.to_i128().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Sint64(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U64(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::I64(value.to_i64().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Sint32(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::I32(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::I32(value.to_i32().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Sint16(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::I16(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::I16(value.to_i16().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Sint8(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::I8(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::I8(value.to_i8().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Uint128(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U128(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::U128(value.to_u128().unwrap()),
             [GenericArg::Type(type_id)] => match registry.get_type(type_id).unwrap() {
                 CoreTypeConcrete::Const(info) => inner(registry, &info.inner_ty, &info.inner_data),
                 _ => unreachable!(),
             },
             _ => unreachable!(),
         },
         CoreTypeConcrete::Uint64(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U64(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::U64(value.to_u64().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Uint32(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U32(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::U32(value.to_u32().unwrap()),
             [GenericArg::Type(type_id)] => match registry.get_type(type_id).unwrap() {
                 CoreTypeConcrete::Const(info) => inner(registry, &info.inner_ty, &info.inner_data),
                 _ => unreachable!(),
             },
             _ => unreachable!(),
         },
         CoreTypeConcrete::Uint16(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U16(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::U16(value.to_u16().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Uint8(_) => match inner_data {
-            [GenericArg::Value(value)] => Value::U8(value.try_into().unwrap()),
+            [GenericArg::Value(value)] => Value::U8(value.to_u8().unwrap()),
             _ => unreachable!(),
         },
         CoreTypeConcrete::Struct(_) => {
@@ -160,6 +166,37 @@ fn inner(
 
             Value::Struct(fields)
         }
+        CoreTypeConcrete::Enum(_) => match inner_data {
+            [GenericArg::Value(value_idx), GenericArg::Type(payload_ty)] => {
+                let payload_type = registry.get_type(payload_ty).unwrap();
+                let const_payload_type = match payload_type {
+                    CoreTypeConcrete::Const(inner) => inner,
+                    _ => {
+                        panic!("matched an unexpected CoreTypeConcrete that is not a Const")
+                    }
+                };
+                let payload = inner(registry, payload_ty, &const_payload_type.inner_data);
+                let index: usize = value_idx.to_usize().unwrap();
+
+                Value::Enum {
+                    self_ty: type_id.clone(),
+                    index,
+                    payload: Box::new(payload),
+                }
+            }
+            _ => panic!("const data mismatch"),
+        },
+        CoreTypeConcrete::Const(info) => inner(registry, &info.inner_ty, &info.inner_data),
+        CoreTypeConcrete::Starknet(selector) => match selector {
+            StarknetTypeConcrete::ClassHash(_)
+            | StarknetTypeConcrete::ContractAddress(_)
+            | StarknetTypeConcrete::StorageAddress(_)
+            | StarknetTypeConcrete::StorageBaseAddress(_) => match inner_data {
+                [GenericArg::Value(value)] => Value::Felt(value.into()),
+                _ => unreachable!(),
+            },
+            _ => todo!(""),
+        },
         _ => todo!("{}", type_id),
     }
 }
