Trait Environment

pub trait Environment:
    'static
    + Copy
    + Clone
    + Debug
    + Display
    + Eq
    + PartialEq
    + Hash {
    type Network: Network<Affine = Self::Affine, Field = Self::BaseField, Scalar = Self::ScalarField>;
    type Affine: AffineCurve<BaseField = Self::BaseField, ScalarField = Self::ScalarField, Coordinates = (Self::BaseField, Self::BaseField)>;
    type BaseField: PrimeField + SquareRootField + Copy;
    type ScalarField: PrimeField<BigInteger = <Self::BaseField as PrimeField>::BigInteger> + Copy;

    const EDWARDS_A: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_A;
    const EDWARDS_D: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_D;
    const MONTGOMERY_A: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_A;
    const MONTGOMERY_B: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_B;
    const MAX_STRING_BYTES: u32 = <Self::Network as console::Environment>::MAX_STRING_BYTES;

    // Required methods
    fn zero() -> LinearCombination<Self::BaseField>;
    fn one() -> LinearCombination<Self::BaseField>;
    fn new_variable(
        mode: Mode,
        value: Self::BaseField,
    ) -> Variable<Self::BaseField>;
    fn new_witness<Fn: FnOnce() -> Output::Primitive, Output: Inject>(
        mode: Mode,
        value: Fn,
    ) -> Output;
    fn scope<S: Into<String>, Fn, Output>(name: S, logic: Fn) -> Output
       where Fn: FnOnce() -> Output;
    fn enforce<Fn, A, B, C>(constraint: Fn)
       where Fn: FnOnce() -> (A, B, C),
             A: Into<LinearCombination<Self::BaseField>>,
             B: Into<LinearCombination<Self::BaseField>>,
             C: Into<LinearCombination<Self::BaseField>>;
    fn is_satisfied() -> bool;
    fn is_satisfied_in_scope() -> bool;
    fn num_constants() -> u64;
    fn num_public() -> u64;
    fn num_private() -> u64;
    fn num_variables() -> u64;
    fn num_constraints() -> u64;
    fn num_nonzeros() -> (u64, u64, u64);
    fn num_constants_in_scope() -> u64;
    fn num_public_in_scope() -> u64;
    fn num_private_in_scope() -> u64;
    fn num_constraints_in_scope() -> u64;
    fn num_nonzeros_in_scope() -> (u64, u64, u64);
    fn get_variable_limit() -> Option<u64>;
    fn set_variable_limit(limit: Option<u64>);
    fn get_constraint_limit() -> Option<u64>;
    fn set_constraint_limit(limit: Option<u64>);
    fn inject_r1cs(r1cs: R1CS<Self::BaseField>);
    fn eject_r1cs_and_reset() -> R1CS<Self::BaseField>;
    fn eject_assignment_and_reset(    ) -> Assignment<<Self::Network as Environment>::Field>;
    fn reset();

    // Provided methods
    fn assert<Boolean: Into<LinearCombination<Self::BaseField>>>(
        boolean: Boolean,
    ) { ... }
    fn assert_eq<A, B>(a: A, b: B)
       where A: Into<LinearCombination<Self::BaseField>>,
             B: Into<LinearCombination<Self::BaseField>> { ... }
    fn assert_neq<A, B>(a: A, b: B)
       where A: Into<LinearCombination<Self::BaseField>>,
             B: Into<LinearCombination<Self::BaseField>> { ... }
    fn count() -> (u64, u64, u64, u64, (u64, u64, u64)) { ... }
    fn count_in_scope() -> (u64, u64, u64, u64, (u64, u64, u64)) { ... }
    fn halt<S: Into<String>, T>(message: S) -> T { ... }
}

Attention: Do not use Send + Sync on this trait, as it is not thread-safe.

Provided Associated Constants

const EDWARDS_A: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_A

The coefficient A of the twisted Edwards curve.

const EDWARDS_D: Self::BaseField = <Self::Network as console::Environment>::EDWARDS_D

The coefficient D of the twisted Edwards curve.

const MONTGOMERY_A: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_A

The coefficient A of the Montgomery curve.

const MONTGOMERY_B: Self::BaseField = <Self::Network as console::Environment>::MONTGOMERY_B

The coefficient B of the Montgomery curve.

const MAX_STRING_BYTES: u32 = <Self::Network as console::Environment>::MAX_STRING_BYTES

The maximum number of bytes allowed in a string.

Required Associated Types

type Network: Network<Affine = Self::Affine, Field = Self::BaseField, Scalar = Self::ScalarField>

type Affine: AffineCurve<BaseField = Self::BaseField, ScalarField = Self::ScalarField, Coordinates = (Self::BaseField, Self::BaseField)>

type BaseField: PrimeField + SquareRootField + Copy

type ScalarField: PrimeField<BigInteger = <Self::BaseField as PrimeField>::BigInteger> + Copy

Required Methods

fn zero() -> LinearCombination<Self::BaseField>

Returns the zero constant.

fn one() -> LinearCombination<Self::BaseField>

Returns the one constant.

fn new_variable(mode: Mode, value: Self::BaseField) -> Variable<Self::BaseField>

Returns a new variable of the given mode and value.

fn new_witness<Fn: FnOnce() -> Output::Primitive, Output: Inject>( mode: Mode, value: Fn, ) -> Output

Returns a new witness of the given mode and value.

fn scope<S: Into<String>, Fn, Output>(name: S, logic: Fn) -> Output

where Fn: FnOnce() -> Output,

Enters a new scope for the environment.

fn enforce<Fn, A, B, C>(constraint: Fn)

where Fn: FnOnce() -> (A, B, C), A: Into<LinearCombination<Self::BaseField>>, B: Into<LinearCombination<Self::BaseField>>, C: Into<LinearCombination<Self::BaseField>>,

Adds one constraint enforcing that (A * B) == C.

fn is_satisfied() -> bool

Returns true if all constraints in the environment are satisfied.

fn is_satisfied_in_scope() -> bool

Returns true if all constraints in the current scope are satisfied.

fn num_constants() -> u64

Returns the number of constants in the entire environment.

fn num_public() -> u64

Returns the number of public variables in the entire environment.

fn num_private() -> u64

Returns the number of private variables in the entire environment.

fn num_variables() -> u64

Returns the number of constant, public, and private variables in the entire environment.

fn num_constraints() -> u64

Returns the number of constraints in the entire environment.

fn num_nonzeros() -> (u64, u64, u64)

Returns the number of nonzeros in the entire circuit.

fn num_constants_in_scope() -> u64

Returns the number of constants for the current scope.

fn num_public_in_scope() -> u64

Returns the number of public variables for the current scope.

fn num_private_in_scope() -> u64

Returns the number of private variables for the current scope.

fn num_constraints_in_scope() -> u64

Returns the number of constraints for the current scope.

fn num_nonzeros_in_scope() -> (u64, u64, u64)

Returns the number of nonzeros for the current scope.

fn get_variable_limit() -> Option<u64>

Returns the variable limit for the circuit, if one exists.

fn set_variable_limit(limit: Option<u64>)

Sets the variable limit for the circuit.

fn get_constraint_limit() -> Option<u64>

Returns the constraint limit for the circuit, if one exists.

fn set_constraint_limit(limit: Option<u64>)

Sets the constraint limit for the circuit.

fn inject_r1cs(r1cs: R1CS<Self::BaseField>)

Returns the R1CS circuit, resetting the circuit.

fn eject_r1cs_and_reset() -> R1CS<Self::BaseField>

Returns the R1CS circuit, resetting the circuit.

fn eject_assignment_and_reset() -> Assignment<<Self::Network as Environment>::Field>

Returns the R1CS assignment of the circuit, resetting the circuit.

fn reset()

Clears and initializes an empty environment.

Provided Methods

fn assert<Boolean: Into<LinearCombination<Self::BaseField>>>(boolean: Boolean)

Adds one constraint enforcing that the given boolean is true.

fn assert_eq<A, B>(a: A, b: B)

where A: Into<LinearCombination<Self::BaseField>>, B: Into<LinearCombination<Self::BaseField>>,

Adds one constraint enforcing that the A == B.

fn assert_neq<A, B>(a: A, b: B)

where A: Into<LinearCombination<Self::BaseField>>, B: Into<LinearCombination<Self::BaseField>>,

Adds one constraint enforcing that the A != B.

fn count() -> (u64, u64, u64, u64, (u64, u64, u64))

Returns a tuple containing the number of constants, public variables, private variables, constraints, and nonzeros in the entire environment.

fn count_in_scope() -> (u64, u64, u64, u64, (u64, u64, u64))

Returns a tuple containing the number of constants, public variables, private variables, constraints, and nonzeros for the current scope.

fn halt<S: Into<String>, T>(message: S) -> T

Halts the program from further synthesis, evaluation, and execution in the current environment.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Environment for CanaryCircuit

type Affine = <CanaryV0 as Environment>::Affine

type BaseField = <CanaryV0 as Environment>::Field

type Network = CanaryV0

type ScalarField = <CanaryV0 as Environment>::Scalar

impl Environment for Circuit

type Affine = <MainnetV0 as Environment>::Affine

type BaseField = <MainnetV0 as Environment>::Field

type Network = MainnetV0

type ScalarField = <MainnetV0 as Environment>::Scalar

impl Environment for TestnetCircuit

type Affine = <TestnetV0 as Environment>::Affine

type BaseField = <TestnetV0 as Environment>::Field

type Network = TestnetV0

type ScalarField = <TestnetV0 as Environment>::Scalar