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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
#[cfg(test)]
mod tests {
    static LOGGER_INITIALIZED: Once = Once::new();

    use alloc::sync::Arc;
    use std::sync::Once;

    use itertools::Itertools;
    use log::{Level, LevelFilter};

    use crate::gadgets::lookup::{OTHER_TABLE, SMALLER_TABLE, TIP5_TABLE};
    use crate::gates::lookup_table::LookupTable;
    use crate::gates::noop::NoopGate;
    use crate::plonk::prover::prove;
    use crate::util::timing::TimingTree;

    #[test]
    fn test_no_lookup() -> anyhow::Result<()> {
        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        use crate::iop::witness::PartialWitness;
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);
        builder.add_gate(NoopGate, vec![]);
        let pw = PartialWitness::new();

        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove first", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;
        timing.print();
        data.verify(proof)?;

        Ok(())
    }

    #[should_panic]
    #[test]
    fn test_lookup_table_not_used() {
        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let tip5_table = TIP5_TABLE.to_vec();
        let table: LookupTable = Arc::new((0..256).zip_eq(tip5_table).collect());
        builder.add_lookup_table_from_pairs(table);

        builder.build::<C>();
    }

    #[should_panic]
    #[test]
    fn test_lookup_without_table() {
        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let dummy = builder.add_virtual_target();
        builder.add_lookup_from_index(dummy, 0);

        builder.build::<C>();
    }

    // Tests two lookups in one lookup table.
    #[test]
    fn test_one_lookup() -> anyhow::Result<()> {
        use crate::field::types::Field;
        use crate::iop::witness::{PartialWitness, WitnessWrite};
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        let tip5_table = TIP5_TABLE.to_vec();
        let table: LookupTable = Arc::new((0..256).zip_eq(tip5_table).collect());
        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let initial_a = builder.add_virtual_target();
        let initial_b = builder.add_virtual_target();

        let look_val_a = 1;
        let look_val_b = 2;

        let out_a = table[look_val_a].1;
        let out_b = table[look_val_b].1;
        let table_index = builder.add_lookup_table_from_pairs(table);
        let output_a = builder.add_lookup_from_index(initial_a, table_index);

        let output_b = builder.add_lookup_from_index(initial_b, table_index);

        builder.register_public_input(initial_a);
        builder.register_public_input(initial_b);
        builder.register_public_input(output_a);
        builder.register_public_input(output_b);

        let mut pw = PartialWitness::new();

        pw.set_target(initial_a, F::from_canonical_usize(look_val_a));
        pw.set_target(initial_b, F::from_canonical_usize(look_val_b));

        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove one lookup", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;
        timing.print();
        data.verify(proof.clone())?;

        assert!(
            proof.public_inputs[2] == F::from_canonical_u16(out_a),
            "First lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[0]
        );
        assert!(
            proof.public_inputs[3] == F::from_canonical_u16(out_b),
            "Second lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[1]
        );

        Ok(())
    }

    // Tests one lookup in two different lookup tables.
    #[test]
    pub fn test_two_luts() -> anyhow::Result<()> {
        use crate::field::types::Field;
        use crate::iop::witness::{PartialWitness, WitnessWrite};
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let initial_a = builder.add_virtual_target();
        let initial_b = builder.add_virtual_target();

        let look_val_a = 1;
        let look_val_b = 2;

        let tip5_table = TIP5_TABLE.to_vec();

        let first_out = tip5_table[look_val_a];
        let second_out = tip5_table[look_val_b];

        let table: LookupTable = Arc::new((0..256).zip_eq(tip5_table).collect());

        let other_table = OTHER_TABLE.to_vec();

        let table_index = builder.add_lookup_table_from_pairs(table);
        let output_a = builder.add_lookup_from_index(initial_a, table_index);

        let output_b = builder.add_lookup_from_index(initial_b, table_index);
        let sum = builder.add(output_a, output_b);

        let s = first_out + second_out;
        let final_out = other_table[s as usize];

        let table2: LookupTable = Arc::new((0..256).zip_eq(other_table).collect());
        let table2_index = builder.add_lookup_table_from_pairs(table2);

        let output_final = builder.add_lookup_from_index(sum, table2_index);

        builder.register_public_input(initial_a);
        builder.register_public_input(initial_b);
        builder.register_public_input(sum);
        builder.register_public_input(output_a);
        builder.register_public_input(output_b);
        builder.register_public_input(output_final);

        let mut pw = PartialWitness::new();
        pw.set_target(initial_a, F::from_canonical_usize(look_val_a));
        pw.set_target(initial_b, F::from_canonical_usize(look_val_b));
        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove two_luts", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;
        data.verify(proof.clone())?;
        timing.print();

        assert!(
            proof.public_inputs[3] == F::from_canonical_u16(first_out),
            "First lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[0]
        );
        assert!(
            proof.public_inputs[4] == F::from_canonical_u16(second_out),
            "Second lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[1]
        );
        assert!(
            proof.public_inputs[2] == F::from_canonical_u16(s),
            "Sum between the first two LUT outputs is incorrect."
        );
        assert!(
            proof.public_inputs[5] == F::from_canonical_u16(final_out),
            "Output of the second LUT at index {} is incorrect.",
            s
        );

        Ok(())
    }

    #[test]
    pub fn test_different_inputs() -> anyhow::Result<()> {
        use crate::field::types::Field;
        use crate::iop::witness::{PartialWitness, WitnessWrite};
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;
        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let initial_a = builder.add_virtual_target();
        let initial_b = builder.add_virtual_target();

        let init_a = 1;
        let init_b = 2;

        let tab: Vec<u16> = SMALLER_TABLE.to_vec();
        let table: LookupTable = Arc::new((2..10).zip_eq(tab).collect());

        let other_table = OTHER_TABLE.to_vec();

        let table2: LookupTable = Arc::new((0..256).zip_eq(other_table).collect());
        let small_index = builder.add_lookup_table_from_pairs(table.clone());
        let output_a = builder.add_lookup_from_index(initial_a, small_index);

        let output_b = builder.add_lookup_from_index(initial_b, small_index);
        let sum = builder.add(output_a, output_b);

        let other_index = builder.add_lookup_table_from_pairs(table2.clone());
        let output_final = builder.add_lookup_from_index(sum, other_index);

        builder.register_public_input(initial_a);
        builder.register_public_input(initial_b);
        builder.register_public_input(sum);
        builder.register_public_input(output_a);
        builder.register_public_input(output_b);
        builder.register_public_input(output_final);

        let mut pw = PartialWitness::new();

        let look_val_a = table[init_a].0;
        let look_val_b = table[init_b].0;
        pw.set_target(initial_a, F::from_canonical_u16(look_val_a));
        pw.set_target(initial_b, F::from_canonical_u16(look_val_b));

        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove different lookups", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;
        data.verify(proof.clone())?;
        timing.print();

        let out_a = table[init_a].1;
        let out_b = table[init_b].1;
        let s = out_a + out_b;
        let out_final = table2[s as usize].1;

        assert!(
            proof.public_inputs[3] == F::from_canonical_u16(out_a),
            "First lookup, at index {} in the smaller LUT gives an incorrect output.",
            proof.public_inputs[0]
        );
        assert!(
            proof.public_inputs[4] == F::from_canonical_u16(out_b),
            "Second lookup, at index {} in the smaller LUT gives an incorrect output.",
            proof.public_inputs[1]
        );
        assert!(
            proof.public_inputs[2] == F::from_canonical_u16(s),
            "Sum between the first two LUT outputs is incorrect."
        );
        assert!(
            proof.public_inputs[5] == F::from_canonical_u16(out_final),
            "Output of the second LUT at index {} is incorrect.",
            s
        );

        Ok(())
    }

    // This test looks up over 514 values for one LookupTableGate, which means that several LookupGates are created.
    #[test]
    pub fn test_many_lookups() -> anyhow::Result<()> {
        use crate::field::types::Field;
        use crate::iop::witness::{PartialWitness, WitnessWrite};
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;
        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let initial_a = builder.add_virtual_target();
        let initial_b = builder.add_virtual_target();

        let look_val_a = 1;
        let look_val_b = 2;

        let tip5_table = TIP5_TABLE.to_vec();
        let table: LookupTable = Arc::new((0..256).zip_eq(tip5_table).collect());

        let out_a = table[look_val_a].1;
        let out_b = table[look_val_b].1;

        let tip5_index = builder.add_lookup_table_from_pairs(table);
        let output_a = builder.add_lookup_from_index(initial_a, tip5_index);

        let output_b = builder.add_lookup_from_index(initial_b, tip5_index);
        let sum = builder.add(output_a, output_b);

        for _ in 0..514 {
            builder.add_lookup_from_index(initial_a, tip5_index);
        }

        let other_table = OTHER_TABLE.to_vec();

        let table2: LookupTable = Arc::new((0..256).zip_eq(other_table).collect());

        let s = out_a + out_b;
        let out_final = table2[s as usize].1;

        let other_index = builder.add_lookup_table_from_pairs(table2);
        let output_final = builder.add_lookup_from_index(sum, other_index);

        builder.register_public_input(initial_a);
        builder.register_public_input(initial_b);
        builder.register_public_input(sum);
        builder.register_public_input(output_a);
        builder.register_public_input(output_b);
        builder.register_public_input(output_final);

        let mut pw = PartialWitness::new();

        pw.set_target(initial_a, F::from_canonical_usize(look_val_a));
        pw.set_target(initial_b, F::from_canonical_usize(look_val_b));

        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove different lookups", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;

        data.verify(proof.clone())?;
        timing.print();

        assert!(
            proof.public_inputs[3] == F::from_canonical_u16(out_a),
            "First lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[0]
        );
        assert!(
            proof.public_inputs[4] == F::from_canonical_u16(out_b),
            "Second lookup, at index {} in the Tip5 table gives an incorrect output.",
            proof.public_inputs[1]
        );
        assert!(
            proof.public_inputs[2] == F::from_canonical_u16(s),
            "Sum between the first two LUT outputs is incorrect."
        );
        assert!(
            proof.public_inputs[5] == F::from_canonical_u16(out_final),
            "Output of the second LUT at index {} is incorrect.",
            s
        );

        Ok(())
    }

    // Tests whether, when adding the same LUT to the circuit, the circuit only adds one copy, with the same index.
    #[test]
    pub fn test_same_luts() -> anyhow::Result<()> {
        use crate::field::types::Field;
        use crate::iop::witness::{PartialWitness, WitnessWrite};
        use crate::plonk::circuit_builder::CircuitBuilder;
        use crate::plonk::circuit_data::CircuitConfig;
        use crate::plonk::config::{GenericConfig, PoseidonGoldilocksConfig};

        const D: usize = 2;
        type C = PoseidonGoldilocksConfig;
        type F = <C as GenericConfig<D>>::F;

        LOGGER_INITIALIZED.call_once(|| init_logger().unwrap());
        let config = CircuitConfig::standard_recursion_config();
        let mut builder = CircuitBuilder::<F, D>::new(config);

        let initial_a = builder.add_virtual_target();
        let initial_b = builder.add_virtual_target();

        let look_val_a = 1;
        let look_val_b = 2;

        let tip5_table = TIP5_TABLE.to_vec();
        let table: LookupTable = Arc::new((0..256).zip_eq(tip5_table).collect());

        let table_index = builder.add_lookup_table_from_pairs(table.clone());
        let output_a = builder.add_lookup_from_index(initial_a, table_index);

        let output_b = builder.add_lookup_from_index(initial_b, table_index);
        let sum = builder.add(output_a, output_b);

        let table2_index = builder.add_lookup_table_from_pairs(table);

        let output_final = builder.add_lookup_from_index(sum, table2_index);

        builder.register_public_input(initial_a);
        builder.register_public_input(initial_b);
        builder.register_public_input(sum);
        builder.register_public_input(output_a);
        builder.register_public_input(output_b);
        builder.register_public_input(output_final);

        let luts_length = builder.get_luts_length();

        assert!(
            luts_length == 1,
            "There are {} LUTs when there should be only one",
            luts_length
        );

        let mut pw = PartialWitness::new();

        pw.set_target(initial_a, F::from_canonical_usize(look_val_a));
        pw.set_target(initial_b, F::from_canonical_usize(look_val_b));

        let data = builder.build::<C>();
        let mut timing = TimingTree::new("prove two_luts", Level::Debug);
        let proof = prove(&data.prover_only, &data.common, pw, &mut timing)?;
        data.verify(proof)?;
        timing.print();

        Ok(())
    }

    fn init_logger() -> anyhow::Result<()> {
        let mut builder = env_logger::Builder::from_default_env();
        builder.format_timestamp(None);
        builder.filter_level(LevelFilter::Debug);

        builder.try_init()?;
        Ok(())
    }
}