cairo-vm 3.2.0

Blazing fast Cairo interpreter
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

use starknet_types_core::qm31::QM31;

use crate::math_utils::qm31_pack_reduced;
use crate::types::relocatable::MaybeRelocatable;
use crate::types::{errors::math_errors::MathError, instruction::OpcodeExtension};
use crate::vm::errors::vm_errors::VirtualMachineError;
use crate::Felt252;

/// Adds two MaybeRelocatable values according to the specified OpcodeExtension and returns the
/// result as a MaybeRelocatable value.
/// If the OpcodeExtension is Stone it adds them as MaybeRelocatable::add does.
/// If the OpcodeExtension is QM31Operation it requires them both to be Int and it adds them
/// as packed reduced QM31 elements.
pub fn typed_add(
    x: &MaybeRelocatable,
    y: &MaybeRelocatable,
    opcode_extension: OpcodeExtension,
) -> Result<MaybeRelocatable, VirtualMachineError> {
    match opcode_extension {
        OpcodeExtension::Stone => Ok(x.add(y)?),
        OpcodeExtension::QM31Operation => {
            if let (MaybeRelocatable::Int(num_x), MaybeRelocatable::Int(num_y)) = (x, y) {
                let x_qm31 = QM31::unpack_from_felt(num_x)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let y_qm31 = QM31::unpack_from_felt(num_y)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let res = x_qm31 + y_qm31;
                Ok(MaybeRelocatable::Int(qm31_pack_reduced(res)))
            } else {
                Err(VirtualMachineError::Math(MathError::RelocatableQM31Add(
                    Box::new((x.clone(), y.clone())),
                )))
            }
        }
        _ => Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(
            "typed_add".to_owned().into_boxed_str(),
        )),
    }
}

/// Substracts two MaybeRelocatable values according to the specified OpcodeExtension and returns
/// the result as a MaybeRelocatable value.
/// If the OpcodeExtension is Stone it subtracts them as MaybeRelocatable::sub does.
/// If the OpcodeExtension is QM31Operation it requires them both to be Int and it subtracts
/// them as packed reduced QM31 elements.
pub fn typed_sub(
    x: &MaybeRelocatable,
    y: &MaybeRelocatable,
    opcode_extension: OpcodeExtension,
) -> Result<MaybeRelocatable, VirtualMachineError> {
    match opcode_extension {
        OpcodeExtension::Stone => Ok(x.sub(y)?),
        OpcodeExtension::QM31Operation => {
            if let (MaybeRelocatable::Int(num_x), MaybeRelocatable::Int(num_y)) = (x, y) {
                let x_qm31 = QM31::unpack_from_felt(num_x)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let y_qm31 = QM31::unpack_from_felt(num_y)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let res = x_qm31 - y_qm31;
                Ok(MaybeRelocatable::Int(qm31_pack_reduced(res)))
            } else {
                Err(VirtualMachineError::Math(MathError::RelocatableQM31Sub(
                    Box::new((x.clone(), y.clone())),
                )))
            }
        }
        _ => Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(
            "typed_sub".to_owned().into_boxed_str(),
        )),
    }
}

/// Multiplies two MaybeRelocatable values according to the specified OpcodeExtension and returns
/// the result as a MaybeRelocatable value.
/// Requires both operands to be Int.
/// If the OpcodeExtension is Stone it multiplies them as Felts.
/// If the OpcodeExtension is QM31Operation it multiplies them as packed reduced QM31 elements.
pub fn typed_mul(
    x: &MaybeRelocatable,
    y: &MaybeRelocatable,
    opcode_extension: OpcodeExtension,
) -> Result<MaybeRelocatable, VirtualMachineError> {
    if let (MaybeRelocatable::Int(num_x), MaybeRelocatable::Int(num_y)) = (x, y) {
        match opcode_extension {
            OpcodeExtension::Stone => Ok(MaybeRelocatable::Int(num_x * num_y)),
            OpcodeExtension::QM31Operation => {
                let x_qm31 = QM31::unpack_from_felt(num_x)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let y_qm31 = QM31::unpack_from_felt(num_y)
                    .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
                let res = x_qm31 * y_qm31;
                Ok(MaybeRelocatable::Int(qm31_pack_reduced(res)))
            }
            _ => Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(
                "typed_mul".to_owned().into_boxed_str(),
            )),
        }
    } else {
        Err(VirtualMachineError::ComputeResRelocatableMul(Box::new((
            x.clone(),
            y.clone(),
        ))))
    }
}

/// Divides two Felt252 values according to the specified OpcodeExtension and returns the result
/// as a Felt252 value.
/// If the OpcodeExtension is Stone it divides them as Felts.
/// If the OpcodeExtension is QM31Operation it divides them as packed reduced QM31 elements.
pub fn typed_div(
    x: &Felt252,
    y: &Felt252,
    opcode_extension: OpcodeExtension,
) -> Result<Felt252, VirtualMachineError> {
    match opcode_extension {
        OpcodeExtension::Stone => {
            Ok(x.field_div(&y.try_into().map_err(|_| MathError::DividedByZero)?))
        }
        OpcodeExtension::QM31Operation => {
            let x_qm31 = QM31::unpack_from_felt(x)
                .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
            let y_qm31 = QM31::unpack_from_felt(y)
                .map_err(|e| MathError::QM31UnreducedError(Box::new(e.0)))?;
            let res = (x_qm31 / y_qm31).map_err(|_| MathError::DividedByZero)?;
            Ok(qm31_pack_reduced(res))
        }
        _ => Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(
            "typed_div".to_owned().into_boxed_str(),
        )),
    }
}
#[cfg(test)]
mod decoder_test {
    use super::*;
    use assert_matches::assert_matches;

    #[test]
    fn typed_add_blake() {
        let a = &MaybeRelocatable::from(5);
        let b = &MaybeRelocatable::from(6);
        let error = typed_add(a, b, OpcodeExtension::Blake);
        assert_matches!(
            error,
            Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(ref message)) if message.as_ref() == "typed_add"
        );
    }

    #[test]
    fn typed_sub_blake() {
        let a = &MaybeRelocatable::from(7);
        let b = &MaybeRelocatable::from(3);
        let error = typed_sub(a, b, OpcodeExtension::Blake);
        assert_matches!(
            error,
            Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(ref message)) if message.as_ref() == "typed_sub"
        );
    }

    #[test]
    fn relocatable_typed_sub_q31_operation() {
        let a = &MaybeRelocatable::from((6, 8));
        let b = &MaybeRelocatable::from(2);
        let error = typed_sub(a, b, OpcodeExtension::QM31Operation);
        assert_matches!(
            error,
            Err(VirtualMachineError::Math(MathError::RelocatableQM31Sub(bx))) if *bx ==
                (MaybeRelocatable::from((6, 8)), MaybeRelocatable::from(2))
        );
    }

    #[test]
    fn typed_mul_blake_finalize() {
        let a = &MaybeRelocatable::from(4);
        let b = &MaybeRelocatable::from(9);
        let error = typed_mul(a, b, OpcodeExtension::BlakeFinalize);
        assert_matches!(
            error,
            Err(VirtualMachineError::InvalidTypedOperationOpcodeExtension(ref message)) if message.as_ref() == "typed_mul"
        );
    }
}