tasm-lib 0.43.0

Code snippets for Triton VM assembly with tests and statistics.
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206

use rand::prelude::*;
use triton_vm::prelude::*;
use triton_vm::twenty_first::prelude::AlgebraicHasher;

use crate::data_type::DataType;
use crate::empty_stack;
use crate::library::Library;
use crate::push_encodable;
use crate::snippet_bencher::BenchmarkCase;
use crate::traits::basic_snippet::BasicSnippet;
use crate::traits::procedure::Procedure;
use crate::traits::procedure::ProcedureInitialState;

/// `merkle_step` but for index of type `u64`
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
pub struct MerkleStepU64Index;

impl BasicSnippet for MerkleStepU64Index {
    fn inputs(&self) -> Vec<(DataType, String)> {
        vec![
            (DataType::U64, "Merkle tree node index".to_owned()),
            (DataType::Digest, "node digest".to_owned()),
        ]
    }

    fn outputs(&self) -> Vec<(DataType, String)> {
        vec![
            (DataType::U64, "Merkle tree node index".to_owned()),
            (DataType::Digest, "parent digest".to_owned()),
        ]
    }

    fn entrypoint(&self) -> String {
        "tasmlib_hashing_merkle_step_u64_index".to_owned()
    }

    fn code(&self, _library: &mut Library) -> Vec<LabelledInstruction> {
        triton_asm!(
            {self.entrypoint()}:
                            // _ mt_index_hi mt_index_lo       [digest'; 5]
                merkle_step // _ mt_index_hi (mt_index_lo / 2) [digest; 5]
                push 2      // _ mt_index_hi (mt_index_lo / 2) [digest; 5] 2
                push 0      // _ mt_index_hi (mt_index_lo / 2) [digest; 5] 2 0
                swap 8      // _ 0 (mt_index_lo / 2) [digest; 5] 2 mt_index_hi
                div_mod     // _ 0 (mt_index_lo / 2) [digest; 5] (mt_index_hi / 2) (mt_index_hi % 2)

                push {1u32 << 31}
                hint two_pow_31: u32 = stack[0]
                mul         // _ 0 (mt_index_lo / 2) [digest; 5] (mt_index_hi / 2) carry
                swap 1      // _ 0 (mt_index_lo / 2) [digest; 5] carry (mt_index_hi / 2)
                swap 8      // _ (mt_index / 2)_hi (mt_index_lo / 2) [digest; 5] carry 0
                swap 7      // _ (mt_index / 2)_hi 0 [digest; 5] carry (mt_index_lo / 2)
                add         // _ (mt_index / 2)_hi 0 [digest; 5] (mt_index / 2)_lo
                swap 6      // _ (mt_index / 2)_hi (mt_index / 2)_lo [digest; 5] 0
                pop 1       // _ (mt_index / 2)_hi (mt_index / 2)_lo [digest; 5]
                return
        )
    }
}

impl Procedure for MerkleStepU64Index {
    fn rust_shadow(
        &self,
        stack: &mut Vec<BFieldElement>,
        _memory: &mut std::collections::HashMap<BFieldElement, BFieldElement>,
        nondeterminism: &NonDeterminism,
        _public_input: &[BFieldElement],
        _sponge: &mut Option<Tip5>,
    ) -> Vec<BFieldElement> {
        let stack_digest: Digest = Digest::new([
            stack.pop().unwrap(),
            stack.pop().unwrap(),
            stack.pop().unwrap(),
            stack.pop().unwrap(),
            stack.pop().unwrap(),
        ]);
        let ap_digest: Digest = nondeterminism.digests[0];

        let leaf_index_lo: u32 = stack.pop().unwrap().try_into().unwrap();
        let leaf_index_hi: u32 = stack.pop().unwrap().try_into().unwrap();
        let leaf_index: u64 = ((leaf_index_hi as u64) << 32) | (leaf_index_lo as u64);
        let stack_digest_is_left_sibling = leaf_index % 2 == 0;
        let (left_digest, right_digest) = if stack_digest_is_left_sibling {
            (stack_digest, ap_digest)
        } else {
            (ap_digest, stack_digest)
        };
        let parent_digest = Tip5::hash_pair(left_digest, right_digest);

        let parent_index = leaf_index / 2;
        stack.push(BFieldElement::new(parent_index >> 32));
        stack.push(BFieldElement::new(parent_index & u32::MAX as u64));

        push_encodable(stack, &parent_digest);

        vec![]
    }

    fn pseudorandom_initial_state(
        &self,
        seed: [u8; 32],
        bench_case: Option<BenchmarkCase>,
    ) -> ProcedureInitialState {
        let mut rng: StdRng = SeedableRng::from_seed(seed);

        let (stack, nondeterminism) = match bench_case {
            Some(BenchmarkCase::CommonCase) => self.prepare_stack_and_non_determinism(1 << 33),
            Some(BenchmarkCase::WorstCase) => self.prepare_stack_and_non_determinism(1 << 63),
            None => self.prepare_stack_and_non_determinism(rng.gen()),
        };

        ProcedureInitialState {
            stack,
            nondeterminism,
            public_input: vec![],
            sponge: None,
        }
    }
}

impl MerkleStepU64Index {
    fn prepare_stack_and_non_determinism(
        &self,
        leaf_index: u64,
    ) -> (Vec<BFieldElement>, NonDeterminism) {
        let mut init_stack = empty_stack();
        init_stack.push(BFieldElement::new(leaf_index >> 32));
        init_stack.push(BFieldElement::new(leaf_index & u32::MAX as u64));

        let digest: Digest = random();
        for elem in digest.values() {
            init_stack.push(elem);
        }

        (
            init_stack,
            NonDeterminism::default().with_digests(vec![random()]),
        )
    }
}

#[cfg(test)]
mod tests {
    use itertools::Itertools;

    use super::*;
    use crate::traits::procedure::ShadowedProcedure;
    use crate::traits::rust_shadow::RustShadow;

    #[test]
    fn prop() {
        for _ in 0..10 {
            ShadowedProcedure::new(MerkleStepU64Index).test();
        }
    }

    #[test]
    fn unit_test() {
        prop(1 << 32, 1 << 31);
        prop(1 << 33, 1 << 32);
        prop(1 << 34, 1 << 33);
        prop((1 << 34) + (1 << 32), (1 << 33) + (1 << 31));
        prop(u64::MAX, (1u64 << 63) - 1);

        fn prop(mt_index: u64, expected_parent_index: u64) {
            let shadowed_procedure = ShadowedProcedure::new(MerkleStepU64Index);
            let (init_stack, non_determinism) =
                MerkleStepU64Index.prepare_stack_and_non_determinism(mt_index);
            let tasm_final_state = crate::test_helpers::tasm_final_state(
                &shadowed_procedure,
                &init_stack,
                &[],
                non_determinism,
                &None,
            );
            println!(
                "final final_stack\n{}",
                tasm_final_state.op_stack.stack.iter().join(", ")
            );

            let mut final_stack = tasm_final_state.op_stack.stack;

            // Pop and ignore digest
            for _ in 0..Digest::LEN {
                final_stack.pop();
            }

            // Verify expected value of parent index
            let calculated_parent_index_lo: u32 =
                final_stack.pop().unwrap().value().try_into().unwrap();
            let calculated_parent_index_hi: u32 =
                final_stack.pop().unwrap().value().try_into().unwrap();
            let calculated_parent_index: u64 =
                calculated_parent_index_lo as u64 + ((calculated_parent_index_hi as u64) << 32);
            assert_eq!(
                expected_parent_index, calculated_parent_index,
                "TASM-calculated parent MT index must match provided expected value"
            );
            assert_eq!(
                mt_index / 2,
                calculated_parent_index,
                "TASM-calculated parent MT index must match Rust-calculated expected value"
            );
        }
    }
}