dusk-cdf 0.5.0

PLONK debugger CDF implementation
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

use std::io;

use crate::{
    Config, DecodableElement, DecoderContext, Element, EncodableElement, EncoderContext, Preamble,
    Scalar,
};

/// Polynomial selectors
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Selectors {
    /// Qm (mult) selector
    pub qm: Scalar,
    /// Ql (left) selector
    pub ql: Scalar,
    /// Qr (right) selector
    pub qr: Scalar,
    /// Qd (fourth) selector
    pub qd: Scalar,
    /// Qc (constant) selector
    pub qc: Scalar,
    /// Qo (output) selector
    pub qo: Scalar,
    /// Public input
    pub pi: Scalar,
    /// Qarith (arithmetic) internal selector
    pub qarith: Scalar,
    /// Qlogic (logical) internal selector
    pub qlogic: Scalar,
    /// Qrange (range check) internal selector
    pub qrange: Scalar,
    /// Qgroup_variable (ecc group variable add) internal selector
    pub qgroup_variable: Scalar,
    /// Qgroup_fixed (ecc group fixed add) internal selector
    pub qfixed_add: Scalar,
}

impl Element for Selectors {
    fn len(ctx: &Config) -> usize {
        12 * Scalar::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.qm.validate(preamble)?;
        self.ql.validate(preamble)?;
        self.qr.validate(preamble)?;
        self.qd.validate(preamble)?;
        self.qc.validate(preamble)?;
        self.qo.validate(preamble)?;
        self.pi.validate(preamble)?;
        self.qarith.validate(preamble)?;
        self.qlogic.validate(preamble)?;
        self.qrange.validate(preamble)?;
        self.qgroup_variable.validate(preamble)?;
        self.qfixed_add.validate(preamble)?;

        Ok(())
    }
}

impl EncodableElement for Selectors {
    fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8]) {
        let buf = self.qm.encode(ctx, buf);
        let buf = self.ql.encode(ctx, buf);
        let buf = self.qr.encode(ctx, buf);
        let buf = self.qd.encode(ctx, buf);
        let buf = self.qc.encode(ctx, buf);
        let buf = self.qo.encode(ctx, buf);
        let buf = self.pi.encode(ctx, buf);
        let buf = self.qarith.encode(ctx, buf);
        let buf = self.qlogic.encode(ctx, buf);
        let buf = self.qrange.encode(ctx, buf);
        let buf = self.qgroup_variable.encode(ctx, buf);
        let _ = self.qfixed_add.encode(ctx, buf);
    }
}

impl DecodableElement for Selectors {
    fn try_from_buffer_in_place<'a, 'b>(
        &'a mut self,
        ctx: &DecoderContext<'a>,
        buf: &'b [u8],
    ) -> io::Result<()> {
        Self::validate_buffer(ctx.config(), buf)?;

        let buf = self.qm.try_decode_in_place(ctx, buf)?;
        let buf = self.ql.try_decode_in_place(ctx, buf)?;
        let buf = self.qr.try_decode_in_place(ctx, buf)?;
        let buf = self.qd.try_decode_in_place(ctx, buf)?;
        let buf = self.qc.try_decode_in_place(ctx, buf)?;
        let buf = self.qo.try_decode_in_place(ctx, buf)?;
        let buf = self.pi.try_decode_in_place(ctx, buf)?;
        let buf = self.qarith.try_decode_in_place(ctx, buf)?;
        let buf = self.qlogic.try_decode_in_place(ctx, buf)?;
        let buf = self.qrange.try_decode_in_place(ctx, buf)?;
        let buf = self.qgroup_variable.try_decode_in_place(ctx, buf)?;
        let _ = self.qfixed_add.try_decode_in_place(ctx, buf)?;

        Ok(())
    }
}

/// Polynomial witnesses allocated to a constraint system
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct WiredWitnesses {
    /// Wired `a`
    pub a: usize,
    /// Wired `b`
    pub b: usize,
    /// Wired `d` (fourth)
    pub d: usize,
    /// Wired `o` (output)
    pub o: usize,
}

impl Element for WiredWitnesses {
    fn len(ctx: &Config) -> usize {
        4 * usize::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.a.validate(preamble)?;
        self.b.validate(preamble)?;
        self.d.validate(preamble)?;
        self.o.validate(preamble)?;

        Ok(())
    }
}

impl EncodableElement for WiredWitnesses {
    fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8]) {
        let buf = self.a.encode(ctx, buf);
        let buf = self.b.encode(ctx, buf);
        let buf = self.d.encode(ctx, buf);
        let _ = self.o.encode(ctx, buf);
    }
}

impl DecodableElement for WiredWitnesses {
    fn try_from_buffer_in_place<'a, 'b>(
        &'a mut self,
        ctx: &DecoderContext<'a>,
        buf: &'b [u8],
    ) -> io::Result<()> {
        let buf = self.a.try_decode_in_place(ctx, buf)?;
        let buf = self.b.try_decode_in_place(ctx, buf)?;
        let buf = self.d.try_decode_in_place(ctx, buf)?;
        let _ = self.o.try_decode_in_place(ctx, buf)?;

        Ok(())
    }
}

/// PLONK polynomial expression representation with its selectors and witnesses.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Polynomial {
    /// Selectors of the polynomial
    pub selectors: Selectors,
    /// Wired witnesses
    pub witnesses: WiredWitnesses,
    /// Polynomial evaluated to zero?
    pub evaluation: bool,
}

impl Element for Polynomial {
    fn len(ctx: &Config) -> usize {
        Selectors::len(ctx) + WiredWitnesses::len(ctx) + bool::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.selectors.validate(preamble)?;
        self.witnesses.validate(preamble)?;
        self.evaluation.validate(preamble)?;

        Ok(())
    }
}

impl EncodableElement for Polynomial {
    fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8]) {
        let buf = self.selectors.encode(ctx, buf);
        let buf = self.witnesses.encode(ctx, buf);
        let _ = self.evaluation.encode(ctx, buf);
    }
}

impl DecodableElement for Polynomial {
    fn try_from_buffer_in_place<'a, 'b>(
        &'a mut self,
        ctx: &DecoderContext<'a>,
        buf: &'b [u8],
    ) -> io::Result<()> {
        let buf = self.selectors.try_decode_in_place(ctx, buf)?;
        let buf = self.witnesses.try_decode_in_place(ctx, buf)?;
        let _ = self.evaluation.try_decode_in_place(ctx, buf)?;

        Ok(())
    }
}

impl Polynomial {
    /// Create a new polynomial with evaluation to either correct or incorrect
    pub const fn new(selectors: Selectors, witnesses: WiredWitnesses, evaluation: bool) -> Self {
        Self {
            selectors,
            witnesses,
            evaluation,
        }
    }

    /// Check if the polynomial evaluation is ok
    pub const fn is_ok(&self) -> bool {
        self.evaluation
    }

    /// Wire selectors
    pub const fn selectors(&self) -> &Selectors {
        &self.selectors
    }

    /// Wired witnesses
    pub const fn witnesses(&self) -> &WiredWitnesses {
        &self.witnesses
    }
}