dusk-plonk 0.23.0

A pure-Rust implementation of the PLONK ZK-Proof algorithm
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright (c) DUSK NETWORK. All rights reserved.

//! PLONK runtime controller

#[cfg(feature = "debug")]
use dusk_curves::bls12_381::BlsScalar;

#[cfg(feature = "debug")]
use crate::debugger::Debugger;
#[cfg(feature = "debug")]
use crate::prelude::{Constraint, Witness};

/// Runtime events
#[derive(Debug, Clone, Copy)]
#[allow(clippy::large_enum_variant)]
pub enum RuntimeEvent {
    /// A witness was appended to the constraint system
    WitnessAppended {
        #[cfg(feature = "debug")]
        /// Appended witness
        w: Witness,
        #[cfg(feature = "debug")]
        /// Witness value
        v: BlsScalar,
    },

    /// A constraint was appended
    ConstraintAppended {
        #[cfg(feature = "debug")]
        /// Appended constraint
        c: Constraint,
    },

    /// The proof construction was finished
    ProofFinished,
}

/// Runtime structure with debugger
#[derive(Debug, Clone)]
pub struct Runtime {
    #[cfg(feature = "debug")]
    debugger: Debugger,
}

impl Default for Runtime {
    fn default() -> Self {
        Self::new()
    }
}

impl Runtime {
    /// Create a new PLONK runtime
    #[allow(unused_variables)]
    pub fn new() -> Self {
        Self {
            #[cfg(feature = "debug")]
            debugger: Debugger::new(),
        }
    }

    #[allow(unused_variables)]
    pub(crate) fn event(&mut self, event: RuntimeEvent) {
        #[cfg(feature = "debug")]
        self.debugger.event(event);
    }
}

#[cfg(test)]
mod tests {
    #[cfg(feature = "debug")]
    use dusk_curves::bls12_381::BlsScalar;

    use super::*;
    #[cfg(feature = "debug")]
    use crate::prelude::{Constraint, Witness};

    #[test]
    fn runtime_new_default_and_events_do_not_panic() {
        let mut rt = Runtime::new();

        rt.event(RuntimeEvent::WitnessAppended {
            #[cfg(feature = "debug")]
            w: Witness::ZERO,
            #[cfg(feature = "debug")]
            v: BlsScalar::from(42u64),
        });

        rt.event(RuntimeEvent::ConstraintAppended {
            #[cfg(feature = "debug")]
            c: Constraint::new(),
        });
        rt.event(RuntimeEvent::ProofFinished);

        // `Default` delegates to `new()`.
        let mut rt2 = Runtime::default();
        rt2.event(RuntimeEvent::ProofFinished);
    }
}