provekit-common 0.1.0

Common types and utilities for the ProveKit proving system
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
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
use {
    crate::{
        sparse_matrix::SparseMatrix,
        witness::{
            scheduling::DependencyInfo, ConstantOrR1CSWitness, ConstantTerm, ProductLinearTerm,
            SumTerm, WitnessBuilder, WitnessCoefficient,
        },
        R1CS,
    },
    std::{collections::HashMap, num::NonZeroU32},
};

/// Remaps witness indices to create disjoint w1 and w2 ranges.
///
/// After remapping:
/// - w1 witnesses occupy indices [0, k)
/// - w2 witnesses occupy indices [k, n)
///
/// This ensures w1 can be committed independently before challenge extraction.
pub struct WitnessIndexRemapper {
    /// Maps old witness index to new witness index
    pub old_to_new: HashMap<usize, usize>,
    /// Number of witnesses in w1 (boundary between w1 and w2)
    pub w1_size:    usize,
}

impl WitnessIndexRemapper {
    /// Creates a remapping from w1 and w2 builder lists.
    ///
    /// Assigns w1 builder outputs to [0, k) and w2 builder outputs to [k, n).
    pub fn new(w1_builders: &[WitnessBuilder], w2_builders: &[WitnessBuilder]) -> Self {
        let mut old_to_new = HashMap::new();
        let mut next_w1_idx = 0;
        let mut next_w2_idx = 0;

        // Map w1 builder outputs to [0, k)
        for builder in w1_builders {
            let writes = DependencyInfo::extract_writes(builder);
            for old_idx in writes {
                old_to_new.insert(old_idx, next_w1_idx);
                next_w1_idx += 1;
            }
        }

        let w1_size = next_w1_idx;

        // Map w2 builder outputs to [k, n)
        for builder in w2_builders {
            let writes = DependencyInfo::extract_writes(builder);
            for old_idx in writes {
                old_to_new.insert(old_idx, w1_size + next_w2_idx);
                next_w2_idx += 1;
            }
        }

        Self {
            old_to_new,
            w1_size,
        }
    }

    /// Remaps a single witness index.
    pub fn remap(&self, old_idx: usize) -> usize {
        *self
            .old_to_new
            .get(&old_idx)
            .unwrap_or_else(|| panic!("Witness index {} not in remapping", old_idx))
    }

    /// Helper to remap ConstantOrR1CSWitness variants
    pub fn remap_const_or_witness(&self, val: &ConstantOrR1CSWitness) -> ConstantOrR1CSWitness {
        match val {
            ConstantOrR1CSWitness::Constant(c) => ConstantOrR1CSWitness::Constant(*c),
            ConstantOrR1CSWitness::Witness(w) => ConstantOrR1CSWitness::Witness(self.remap(*w)),
        }
    }

    /// Remaps a witness builder, updating all witness indices it references.
    pub fn remap_builder(&self, builder: &WitnessBuilder) -> WitnessBuilder {
        match builder {
            WitnessBuilder::Constant(ConstantTerm(idx, val)) => {
                WitnessBuilder::Constant(ConstantTerm(self.remap(*idx), *val))
            }
            WitnessBuilder::Acir(idx, acir_idx) => {
                WitnessBuilder::Acir(self.remap(*idx), *acir_idx)
            }
            WitnessBuilder::Sum(idx, terms) => {
                let new_terms = terms
                    .iter()
                    .map(|SumTerm(coeff, operand_idx)| SumTerm(*coeff, self.remap(*operand_idx)))
                    .collect();
                WitnessBuilder::Sum(self.remap(*idx), new_terms)
            }
            WitnessBuilder::Product(idx, a, b) => {
                WitnessBuilder::Product(self.remap(*idx), self.remap(*a), self.remap(*b))
            }
            WitnessBuilder::MultiplicitiesForRange(start, range, values) => {
                let new_values = values.iter().map(|&v| self.remap(v)).collect();
                WitnessBuilder::MultiplicitiesForRange(self.remap(*start), *range, new_values)
            }
            WitnessBuilder::Challenge(idx) => WitnessBuilder::Challenge(self.remap(*idx)),
            WitnessBuilder::IndexedLogUpDenominator(
                idx,
                sz,
                WitnessCoefficient(coeff, index),
                rs,
                value,
            ) => WitnessBuilder::IndexedLogUpDenominator(
                self.remap(*idx),
                self.remap(*sz),
                WitnessCoefficient(*coeff, self.remap(*index)),
                self.remap(*rs),
                self.remap(*value),
            ),
            WitnessBuilder::Inverse(idx, operand) => {
                WitnessBuilder::Inverse(self.remap(*idx), self.remap(*operand))
            }
            WitnessBuilder::ProductLinearOperation(
                idx,
                ProductLinearTerm(x, a, b),
                ProductLinearTerm(y, c, d),
            ) => WitnessBuilder::ProductLinearOperation(
                self.remap(*idx),
                ProductLinearTerm(self.remap(*x), *a, *b),
                ProductLinearTerm(self.remap(*y), *c, *d),
            ),
            WitnessBuilder::LogUpDenominator(idx, sz, WitnessCoefficient(coeff, value)) => {
                WitnessBuilder::LogUpDenominator(
                    self.remap(*idx),
                    self.remap(*sz),
                    WitnessCoefficient(*coeff, self.remap(*value)),
                )
            }
            WitnessBuilder::LogUpInverse(idx, sz, WitnessCoefficient(coeff, value)) => {
                WitnessBuilder::LogUpInverse(
                    self.remap(*idx),
                    self.remap(*sz),
                    WitnessCoefficient(*coeff, self.remap(*value)),
                )
            }
            WitnessBuilder::DigitalDecomposition(dd) => {
                let new_witnesses_to_decompose = dd
                    .witnesses_to_decompose
                    .iter()
                    .map(|&w| self.remap(w))
                    .collect();
                WitnessBuilder::DigitalDecomposition(
                    crate::witness::DigitalDecompositionWitnesses {
                        log_bases:                  dd.log_bases.clone(),
                        num_witnesses_to_decompose: dd.num_witnesses_to_decompose,
                        witnesses_to_decompose:     new_witnesses_to_decompose,
                        first_witness_idx:          self.remap(dd.first_witness_idx),
                        num_witnesses:              dd.num_witnesses,
                    },
                )
            }
            WitnessBuilder::SpiceMultisetFactor(
                idx,
                sz,
                rs,
                WitnessCoefficient(addr_c, addr_w),
                value,
                WitnessCoefficient(timer_c, timer_w),
            ) => WitnessBuilder::SpiceMultisetFactor(
                self.remap(*idx),
                self.remap(*sz),
                self.remap(*rs),
                WitnessCoefficient(*addr_c, self.remap(*addr_w)),
                self.remap(*value),
                WitnessCoefficient(*timer_c, self.remap(*timer_w)),
            ),
            WitnessBuilder::SpiceWitnesses(sw) => {
                let new_memory_operations = sw
                    .memory_operations
                    .iter()
                    .map(|op| match op {
                        crate::witness::SpiceMemoryOperation::Load(addr, value, rt) => {
                            crate::witness::SpiceMemoryOperation::Load(
                                self.remap(*addr),
                                self.remap(*value),
                                self.remap(*rt),
                            )
                        }
                        crate::witness::SpiceMemoryOperation::Store(addr, old_val, new_val, rt) => {
                            crate::witness::SpiceMemoryOperation::Store(
                                self.remap(*addr),
                                self.remap(*old_val),
                                self.remap(*new_val),
                                self.remap(*rt),
                            )
                        }
                    })
                    .collect();
                WitnessBuilder::SpiceWitnesses(crate::witness::SpiceWitnesses {
                    memory_length:           sw.memory_length,
                    initial_value_witnesses: sw
                        .initial_value_witnesses
                        .iter()
                        .map(|w| self.remap(*w))
                        .collect(),
                    memory_operations:       new_memory_operations,
                    rv_final_start:          self.remap(sw.rv_final_start),
                    rt_final_start:          self.remap(sw.rt_final_start),
                    first_witness_idx:       self.remap(sw.first_witness_idx),
                    num_witnesses:           sw.num_witnesses,
                })
            }
            WitnessBuilder::U32AdditionMulti(result_idx, carry_idx, inputs) => {
                WitnessBuilder::U32AdditionMulti(
                    self.remap(*result_idx),
                    self.remap(*carry_idx),
                    inputs
                        .iter()
                        .map(|c| self.remap_const_or_witness(c))
                        .collect(),
                )
            }
            WitnessBuilder::BytePartition { lo, hi, x, k } => WitnessBuilder::BytePartition {
                lo: self.remap(*lo),
                hi: self.remap(*hi),
                x:  self.remap(*x),
                k:  *k,
            },

            WitnessBuilder::BinOpLookupDenominator(idx, sz, rs, rs2, lhs, rhs, output) => {
                WitnessBuilder::BinOpLookupDenominator(
                    self.remap(*idx),
                    self.remap(*sz),
                    self.remap(*rs),
                    self.remap(*rs2),
                    self.remap_const_or_witness(lhs),
                    self.remap_const_or_witness(rhs),
                    self.remap_const_or_witness(output),
                )
            }
            WitnessBuilder::CombinedBinOpLookupDenominator(
                idx,
                sz,
                rs,
                rs2,
                rs3,
                lhs,
                rhs,
                and_out,
                xor_out,
            ) => WitnessBuilder::CombinedBinOpLookupDenominator(
                self.remap(*idx),
                self.remap(*sz),
                self.remap(*rs),
                self.remap(*rs2),
                self.remap(*rs3),
                self.remap_const_or_witness(lhs),
                self.remap_const_or_witness(rhs),
                self.remap_const_or_witness(and_out),
                self.remap_const_or_witness(xor_out),
            ),
            WitnessBuilder::MultiplicitiesForBinOp(start, atomic_bits, pairs) => {
                let new_pairs = pairs
                    .iter()
                    .map(|(lhs, rhs)| {
                        (
                            self.remap_const_or_witness(lhs),
                            self.remap_const_or_witness(rhs),
                        )
                    })
                    .collect();
                WitnessBuilder::MultiplicitiesForBinOp(self.remap(*start), *atomic_bits, new_pairs)
            }
            WitnessBuilder::U32Addition(result_idx, carry_idx, a, b) => {
                WitnessBuilder::U32Addition(
                    self.remap(*result_idx),
                    self.remap(*carry_idx),
                    self.remap_const_or_witness(a),
                    self.remap_const_or_witness(b),
                )
            }
            WitnessBuilder::And(idx, lh, rh) => WitnessBuilder::And(
                self.remap(*idx),
                self.remap_const_or_witness(lh),
                self.remap_const_or_witness(rh),
            ),
            WitnessBuilder::Xor(idx, lh, rh) => WitnessBuilder::Xor(
                self.remap(*idx),
                self.remap_const_or_witness(lh),
                self.remap_const_or_witness(rh),
            ),
            WitnessBuilder::CombinedTableEntryInverse(data) => {
                WitnessBuilder::CombinedTableEntryInverse(
                    crate::witness::CombinedTableEntryInverseData {
                        idx:          self.remap(data.idx),
                        sz_challenge: self.remap(data.sz_challenge),
                        rs_challenge: self.remap(data.rs_challenge),
                        rs_sqrd:      self.remap(data.rs_sqrd),
                        rs_cubed:     self.remap(data.rs_cubed),
                        lhs:          data.lhs,
                        rhs:          data.rhs,
                        and_out:      data.and_out,
                        xor_out:      data.xor_out,
                    },
                )
            }
            WitnessBuilder::ChunkDecompose {
                output_start,
                packed,
                chunk_bits,
            } => WitnessBuilder::ChunkDecompose {
                output_start: self.remap(*output_start),
                packed:       self.remap(*packed),
                chunk_bits:   chunk_bits.clone(),
            },
            WitnessBuilder::SpreadWitness(output, input) => {
                WitnessBuilder::SpreadWitness(self.remap(*output), self.remap(*input))
            }
            WitnessBuilder::SpreadBitExtract {
                output_start,
                chunk_bits,
                sum_terms,
                extract_even,
            } => WitnessBuilder::SpreadBitExtract {
                output_start: self.remap(*output_start),
                chunk_bits:   chunk_bits.clone(),
                sum_terms:    sum_terms
                    .iter()
                    .map(|SumTerm(coeff, idx)| SumTerm(*coeff, self.remap(*idx)))
                    .collect(),
                extract_even: *extract_even,
            },
            WitnessBuilder::MultiplicitiesForSpread(start, num_bits, queries) => {
                let new_queries = queries
                    .iter()
                    .map(|c| self.remap_const_or_witness(c))
                    .collect();
                WitnessBuilder::MultiplicitiesForSpread(self.remap(*start), *num_bits, new_queries)
            }
            WitnessBuilder::SpreadLookupDenominator(idx, sz, rs, input, spread_output) => {
                WitnessBuilder::SpreadLookupDenominator(
                    self.remap(*idx),
                    self.remap(*sz),
                    self.remap(*rs),
                    self.remap_const_or_witness(input),
                    self.remap_const_or_witness(spread_output),
                )
            }
            WitnessBuilder::SpreadTableQuotient {
                idx,
                sz,
                rs,
                input_val,
                spread_val,
                multiplicity,
            } => WitnessBuilder::SpreadTableQuotient {
                idx:          self.remap(*idx),
                sz:           self.remap(*sz),
                rs:           self.remap(*rs),
                input_val:    *input_val,
                spread_val:   *spread_val,
                multiplicity: self.remap(*multiplicity),
            },
        }
    }

    /// Remaps witness indices in R1CS constraint matrices.
    ///
    /// Creates a new R1CS with remapped column indices (witness indices).
    /// Row indices (constraints) remain unchanged.
    pub fn remap_r1cs(&self, r1cs: R1CS) -> R1CS {
        let mut new_r1cs = R1CS::new();
        new_r1cs.num_public_inputs = r1cs.num_public_inputs;
        new_r1cs.interner = r1cs.interner;

        // Remap A, B, C in parallel - they're independent
        let (new_a, (new_b, new_c)) = rayon::join(
            || self.remap_sparse_matrix(r1cs.a),
            || {
                rayon::join(
                    || self.remap_sparse_matrix(r1cs.b),
                    || self.remap_sparse_matrix(r1cs.c),
                )
            },
        );

        new_r1cs.a = new_a;
        new_r1cs.b = new_b;
        new_r1cs.c = new_c;

        new_r1cs
    }

    /// Helper to remap a single sparse matrix
    fn remap_sparse_matrix(&self, mut matrix: SparseMatrix) -> SparseMatrix {
        matrix.remap_columns(|old_col| self.remap(old_col));
        matrix
    }

    /// Remaps ACIR witness map.
    ///
    /// The map goes from ACIR witness index -> R1CS witness index.
    /// We need to update the R1CS indices to their new remapped values.
    pub fn remap_acir_witness_map(&self, map: Vec<Option<NonZeroU32>>) -> Vec<Option<NonZeroU32>> {
        map.into_iter()
            .map(|opt_idx| {
                opt_idx.map(|idx| {
                    let old_r1cs_idx = idx.get() as usize;
                    let new_r1cs_idx = self.remap(old_r1cs_idx);
                    NonZeroU32::new(new_r1cs_idx as u32).expect("Remapped index should be non-zero")
                })
            })
            .collect()
    }
}