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
//! Definition of the constraint system trait. use super::{LinearCombination, R1CSError, Variable}; use curve25519_dalek::scalar::Scalar; use merlin::Transcript; /// The interface for a constraint system, abstracting over the prover /// and verifier's roles. /// /// Statements to be proved by an [`R1CSProof`](::r1cs::R1CSProof) are specified by /// programmatically constructing constraints. These constraints need /// to be identical between the prover and verifier, since the prover /// and verifier need to construct the same statement. /// /// To prevent code duplication or mismatches between the prover and /// verifier, gadgets for the constraint system should be written /// using the `ConstraintSystem` trait, so that the prover and /// verifier share the logic for specifying constraints. pub trait ConstraintSystem { /// Leases the proof transcript to the user, so they can /// add extra data to which the proof must be bound, but which /// is not available before creation of the constraint system. fn transcript(&mut self) -> &mut Transcript; /// Allocate and constrain multiplication variables. /// /// Allocate variables `left`, `right`, and `out` /// with the implicit constraint that /// ```text /// left * right = out /// ``` /// and add the explicit constraints that /// ```text /// left = left_constraint /// right = right_constraint /// ``` /// /// Returns `(left, right, out)` for use in further constraints. fn multiply( &mut self, left: LinearCombination, right: LinearCombination, ) -> (Variable, Variable, Variable); /// Allocate a single variable. /// /// This either allocates a new multiplier and returns its `left` variable, /// or returns a `right` variable of a multiplier previously allocated by this method. /// The output of a multiplier is assigned on a even call, when `right` is assigned. /// /// When CS is committed at the end of the first or second phase, the half-assigned multiplier /// has the `right` assigned to zero and all its variables committed. /// /// Returns unconstrained `Variable` for use in further constraints. fn allocate(&mut self, assignment: Option<Scalar>) -> Result<Variable, R1CSError>; /// Allocate variables `left`, `right`, and `out` /// with the implicit constraint that /// ```text /// left * right = out /// ``` /// /// Returns `(left, right, out)` for use in further constraints. fn allocate_multiplier( &mut self, input_assignments: Option<(Scalar, Scalar)>, ) -> Result<(Variable, Variable, Variable), R1CSError>; /// Counts the amount of allocated multipliers. fn multipliers_len(&self) -> usize; /// Enforce the explicit constraint that /// ```text /// lc = 0 /// ``` fn constrain(&mut self, lc: LinearCombination); } /// An extension to the constraint system trait that permits randomized constraints. /// Gadgets that do not use randomization should use trait bound `CS: ConstraintSystem`, /// while gadgets that need randomization should use trait bound `CS: RandomizedConstraintSystem`. /// Gadgets generally _should not_ use this trait as a bound on the CS argument: it should be used /// by the higher-order protocol that composes gadgets together. pub trait RandomizableConstraintSystem: ConstraintSystem { /// Represents a concrete type for the CS in a randomization phase. type RandomizedCS: RandomizedConstraintSystem; /// Specify additional variables and constraints randomized using a challenge scalar /// bound to the assignments of the non-randomized variables. /// /// If the constraint system’s low-level variables have not been committed yet, /// the call returns `Ok()` and saves a callback until later. /// /// If the constraint system’s low-level variables are committed already, /// the callback is invoked immediately and its result is return from this method. /// /// ### Usage /// /// Inside the closure you can generate one or more challenges using `challenge_scalar` method. /// /// ```text /// cs.specify_randomized_constraints(move |cs| { /// let z = cs.challenge_scalar(b"some challenge"); /// // ... /// }) /// ``` fn specify_randomized_constraints<F>(&mut self, callback: F) -> Result<(), R1CSError> where F: 'static + Fn(&mut Self::RandomizedCS) -> Result<(), R1CSError>; } /// Represents a constraint system in the second phase: /// when the challenges can be sampled to create randomized constraints. /// /// Note: this trait also includes `ConstraintSystem` trait /// in order to allow composition of gadgets: e.g. a shuffle gadget can be used in both phases. pub trait RandomizedConstraintSystem: ConstraintSystem { /// Generates a challenge scalar. /// /// ### Usage /// /// This method is available only within the scope of a closure provided /// to `specify_randomized_constraints`, which implements /// the "randomization" phase of the protocol. /// /// Arbitrary number of challenges can be generated with additional calls. /// /// ```text /// cs.specify_randomized_constraints(move |cs| { /// let z = cs.challenge_scalar(b"some challenge"); /// // ... /// }) /// ``` fn challenge_scalar(&mut self, label: &'static [u8]) -> Scalar; }