starknet_in_rust 0.4.0

A Rust implementation of Starknet execution logic
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

use cairo_vm::felt::Felt252;

use crate::definitions::constants::{QUERY_VERSION_BASE, SUPPORTED_VERSIONS};

use super::error::TransactionError;

pub fn verify_version(
    version: &Felt252,
    max_fee: u128,
    nonce: &Felt252,
    signature: &Vec<Felt252>,
) -> Result<(), TransactionError> {
    if !SUPPORTED_VERSIONS.contains(version) {
        return Err(TransactionError::UnsupportedVersion(version.to_string()));
    }

    if *version == 0.into() || *version == *QUERY_VERSION_BASE {
        if max_fee != 0 {
            return Err(TransactionError::InvalidMaxFee);
        }
        if nonce != &0.into() {
            return Err(TransactionError::InvalidNonce);
        }
        if !signature.is_empty() {
            return Err(TransactionError::InvalidSignature);
        }
    }

    Ok(())
}

#[cfg(test)]
mod test {
    // TODO: fixture tests would be better here
    use crate::{definitions::constants::QUERY_VERSION_BASE, transaction::error::TransactionError};

    use super::verify_version;

    #[test]
    fn version_0_with_max_fee_0_nonce_0_and_empty_signature_should_return_ok() {
        let version = 0.into();
        let max_fee = 0;
        let nonce = 0.into();
        let signature = vec![];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }

    #[test]
    fn version_1_should_return_ok() {
        let version = 1.into();
        let max_fee = 2;
        let nonce = 3.into();
        let signature = vec![5.into()];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }

    #[test]
    fn version_2_should_return_ok() {
        let version = 2.into();
        let max_fee = 43;
        let nonce = 4.into();
        let signature = vec![6.into()];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }

    #[test]
    fn version_3_should_fail() {
        let version = 3.into();
        let max_fee = 0;
        let nonce = 0.into();
        let signature = vec![];
        let result = verify_version(&version, max_fee, &nonce, &signature).unwrap_err();
        assert_matches!(result, TransactionError::UnsupportedVersion(_));
    }

    #[test]
    fn version_0_with_max_fee_greater_than_0_should_fail() {
        let version = 0.into();
        let max_fee = 1;
        let nonce = 0.into();
        let signature = vec![];
        let result = verify_version(&version, max_fee, &nonce, &signature).unwrap_err();
        assert_matches!(result, TransactionError::InvalidMaxFee);
    }

    #[test]
    fn version_0_with_nonce_greater_than_0_should_fail() {
        let version = 0.into();
        let max_fee = 0;
        let nonce = 1.into();
        let signature = vec![];
        let result = verify_version(&version, max_fee, &nonce, &signature).unwrap_err();
        assert_matches!(result, TransactionError::InvalidNonce);
    }

    #[test]
    fn version_0_with_non_empty_signature_should_fail() {
        let version = 0.into();
        let max_fee = 0;
        let nonce = 0.into();
        let signature = vec![2.into()];
        let result = verify_version(&version, max_fee, &nonce, &signature).unwrap_err();
        assert_matches!(result, TransactionError::InvalidSignature);
    }

    #[test]
    fn version_0_with_max_fee_0_nonce_0_and_empty_signature_and_query_version_set_should_return_ok()
    {
        let version = &0.into() | &QUERY_VERSION_BASE.clone();
        let max_fee = 0;
        let nonce = 0.into();
        let signature = vec![];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }

    #[test]
    fn version_1_with_query_version_set_should_return_ok() {
        let version = &1.into() | &QUERY_VERSION_BASE.clone();
        let max_fee = 2;
        let nonce = 3.into();
        let signature = vec![5.into()];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }

    #[test]
    fn version_2_with_query_version_set_should_return_ok() {
        let version = &2.into() | &QUERY_VERSION_BASE.clone();
        let max_fee = 43;
        let nonce = 4.into();
        let signature = vec![6.into()];
        let result = verify_version(&version, max_fee, &nonce, &signature);
        assert!(result.is_ok());
    }
}