Enum darkfi::zkas::opcode::Opcode

#[repr(u8)]
pub enum Opcode {
    Noop = 0,
    EcAdd = 1,
    EcMul = 2,
    EcMulBase = 3,
    EcMulShort = 4,
    EcMulVarBase = 5,
    EcGetX = 8,
    EcGetY = 9,
    PoseidonHash = 16,
    MerkleRoot = 32,
    SparseMerkleRoot = 33,
    BaseAdd = 48,
    BaseMul = 49,
    BaseSub = 50,
    WitnessBase = 64,
    RangeCheck = 80,
    LessThanStrict = 81,
    LessThanLoose = 82,
    BoolCheck = 83,
    CondSelect = 96,
    ZeroCondSelect = 97,
    ConstrainEqualBase = 224,
    ConstrainEqualPoint = 225,
    ConstrainInstance = 240,
    DebugPrint = 255,
}

Opcodes supported by the zkas VM

Variants

Noop = 0

Intermediate opcode for the compiler, should never appear in the result

EcAdd = 1

Elliptic curve addition

EcMul = 2

Elliptic curve multiplication

EcMulBase = 3

Elliptic curve multiplication with a Base field element

EcMulShort = 4

Elliptic curve multiplication with a Base field element of 64bit width

EcMulVarBase = 5

Variable Elliptic curve multiplication with a Base field element

EcGetX = 8

Get the x coordinate of an elliptic curve point

EcGetY = 9

Get the y coordinate of an elliptic curve point

PoseidonHash = 16

Poseidon hash of N Base field elements

MerkleRoot = 32

Calculate Merkle root, given a position, Merkle path, and an element

SparseMerkleRoot = 33

Calculate sparse Merkle root, given the position, path and a member

BaseAdd = 48

Base field element addition

BaseMul = 49

Base field element multiplication

BaseSub = 50

Base field element subtraction

WitnessBase = 64

Witness an unsigned integer into a Base field element

RangeCheck = 80

Range check a Base field element, given bit-width (up to 253)

LessThanStrict = 81

Strictly compare two Base field elements and see if a is less than b This enforces the sum of remaining bits to be zero.

LessThanLoose = 82

Loosely two Base field elements and see if a is less than b This does not enforce the sum of remaining bits to be zero.

BoolCheck = 83

Check if a field element fits in a boolean (Either 0 or 1)

CondSelect = 96

Conditionally select between two base field elements given a boolean

ZeroCondSelect = 97

Conditionally select between a and b (return a if a is zero, and b if a is nonzero)

ConstrainEqualBase = 224

Constrain equality of two Base field elements inside the circuit

ConstrainEqualPoint = 225

Constrain equality of two EcPoint elements inside the circuit

ConstrainInstance = 240

Constrain a Base field element to a circuit’s public input

DebugPrint = 255

Debug a variable’s value in the ZK circuit table.

Implementations

impl Opcode

pub fn from_name(n: &str) -> Option<Self>

pub fn from_repr(b: u8) -> Option<Self>

pub fn name(&self) -> &str

pub fn arg_types(&self) -> (Vec<VarType>, Vec<VarType>)

Return a tuple of vectors of types that are accepted by a specific opcode. r.0 is the return type(s), and r.1 is the argument type(s).

Trait Implementations

impl Clone for Opcode

fn clone(&self) -> Opcode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Opcode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Opcode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Opcode

fn eq(&self, other: &Opcode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Opcode

impl Eq for Opcode

impl StructuralPartialEq for Opcode