dusk-cdf 0.1.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

use std::io;

use crate::{
    AtomicConfig, Config, Context, ContextUnit, Element, Polynomial, Preamble, Scalar, Source,
};

/// Constraint gate of a circuit
#[derive(Debug, Default, Clone, PartialEq, Eq, Hash)]
pub struct Constraint {
    id: usize,
    polynomial: Polynomial,
    source: Source,
}

impl Constraint {
    /// Generate a new constraint
    pub const fn new(id: usize, polynomial: Polynomial, source: Source) -> Self {
        Self {
            id,
            polynomial,
            source,
        }
    }

    /// Id of the gate in the constraint system
    pub const fn id(&self) -> usize {
        self.id
    }

    /// Polynomial of the gate in the constraint system
    pub const fn polynomial(&self) -> &Polynomial {
        &self.polynomial
    }

    /// Source file that originated the constraint
    pub const fn source(&self) -> &Source {
        &self.source
    }

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

impl Element for Constraint {
    type Config = Config;

    fn zeroed() -> Self {
        Self::default()
    }

    fn len(config: &Self::Config) -> usize {
        usize::len(&AtomicConfig)
            + Scalar::len(config)
            + Polynomial::len(config)
            + Source::len(config)
    }

    fn to_buffer(&self, config: &Self::Config, context: &mut ContextUnit, buf: &mut [u8]) {
        let buf = self.id.encode(&AtomicConfig, context, buf);
        let buf = self.polynomial.encode(config, context, buf);
        let _ = self.source.encode(config, context, buf);
    }

    fn try_from_buffer_in_place<S>(
        &mut self,
        config: &Self::Config,
        context: &mut Context<S>,
        buf: &[u8],
    ) -> io::Result<()>
    where
        S: io::Read + io::Seek,
    {
        Self::validate_buffer_len(config, buf.len())?;

        let buf = self.id.try_decode_in_place(&AtomicConfig, context, buf)?;
        let buf = self.polynomial.try_decode_in_place(config, context, buf)?;
        let _ = self.source.try_decode_in_place(config, context, buf)?;

        Ok(())
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.id.validate(preamble)?;
        self.polynomial.validate(preamble)?;
        self.source.validate(preamble)?;

        Ok(())
    }
}

#[test]
fn validate_works() {
    Constraint::zeroed()
        .validate(&Default::default())
        .expect("default config validate should pass");
}