brillig::black_box

Enum BlackBoxOp

Source
pub enum BlackBoxOp {
Show 17 variants AES128Encrypt { inputs: HeapVector, iv: HeapArray, key: HeapArray, outputs: HeapVector, }, Blake2s { message: HeapVector, output: HeapArray, }, Blake3 { message: HeapVector, output: HeapArray, }, Keccakf1600 { input: HeapArray, output: HeapArray, }, EcdsaSecp256k1 { hashed_msg: HeapVector, public_key_x: HeapArray, public_key_y: HeapArray, signature: HeapArray, result: MemoryAddress, }, EcdsaSecp256r1 { hashed_msg: HeapVector, public_key_x: HeapArray, public_key_y: HeapArray, signature: HeapArray, result: MemoryAddress, }, MultiScalarMul { points: HeapVector, scalars: HeapVector, outputs: HeapArray, }, EmbeddedCurveAdd { input1_x: MemoryAddress, input1_y: MemoryAddress, input1_infinite: MemoryAddress, input2_x: MemoryAddress, input2_y: MemoryAddress, input2_infinite: MemoryAddress, result: HeapArray, }, BigIntAdd { lhs: MemoryAddress, rhs: MemoryAddress, output: MemoryAddress, }, BigIntSub { lhs: MemoryAddress, rhs: MemoryAddress, output: MemoryAddress, }, BigIntMul { lhs: MemoryAddress, rhs: MemoryAddress, output: MemoryAddress, }, BigIntDiv { lhs: MemoryAddress, rhs: MemoryAddress, output: MemoryAddress, }, BigIntFromLeBytes { inputs: HeapVector, modulus: HeapVector, output: MemoryAddress, }, BigIntToLeBytes { input: MemoryAddress, output: HeapVector, }, Poseidon2Permutation { message: HeapVector, output: HeapArray, len: MemoryAddress, }, Sha256Compression { input: HeapArray, hash_values: HeapArray, output: HeapArray, }, ToRadix { input: MemoryAddress, radix: MemoryAddress, output_pointer: MemoryAddress, num_limbs: MemoryAddress, output_bits: MemoryAddress, },
}
Expand description

These opcodes provide an equivalent of ACIR blackbox functions. They are implemented as native functions in the VM.

Variants§

§

AES128Encrypt

Encrypts a message using AES128.

Fields

§inputs: HeapVector
§outputs: HeapVector
§

Blake2s

Calculates the Blake2s hash of the inputs.

Fields

§message: HeapVector
§output: HeapArray
§

Blake3

Calculates the Blake3 hash of the inputs.

Fields

§message: HeapVector
§output: HeapArray
§

Keccakf1600

Keccak Permutation function of 1600 width

Fields

§output: HeapArray
§

EcdsaSecp256k1

Verifies a ECDSA signature over the secp256k1 curve.

Fields

§hashed_msg: HeapVector
§public_key_x: HeapArray
§public_key_y: HeapArray
§signature: HeapArray
§

EcdsaSecp256r1

Verifies a ECDSA signature over the secp256r1 curve.

Fields

§hashed_msg: HeapVector
§public_key_x: HeapArray
§public_key_y: HeapArray
§signature: HeapArray
§

MultiScalarMul

Performs multi scalar multiplication over the embedded curve.

Fields

§points: HeapVector
§scalars: HeapVector
§outputs: HeapArray
§

EmbeddedCurveAdd

Performs addition over the embedded curve.

Fields

§input1_x: MemoryAddress
§input1_y: MemoryAddress
§input1_infinite: MemoryAddress
§input2_x: MemoryAddress
§input2_y: MemoryAddress
§input2_infinite: MemoryAddress
§result: HeapArray
§

BigIntAdd

BigInt addition

§

BigIntSub

BigInt subtraction

§

BigIntMul

BigInt multiplication

§

BigIntDiv

BigInt division

§

BigIntFromLeBytes

BigInt from le bytes

Fields

§inputs: HeapVector
§modulus: HeapVector
§

BigIntToLeBytes

BigInt to le bytes

Fields

§output: HeapVector
§

Poseidon2Permutation

Applies the Poseidon2 permutation function to the given state, outputting the permuted state.

Fields

§message: HeapVector
§output: HeapArray
§

Sha256Compression

Applies the SHA-256 compression function to the input message

Fields

§hash_values: HeapArray
§output: HeapArray
§

ToRadix

Returns a decomposition in num_limbs limbs of the given input over the given radix.

  • The value stored in radix must be in the range [2, 256]
  • num_limbs must be at least one if the value stored in input is not zero.
  • The value stored in output_bits must have a bit_size of one. That value specifies whether we should decompose into bits. The value stored in the radix address must be two if the value stored in output_bits is equal to one.

Native to the Brillig VM and not supported as an ACIR black box function.

Fields

§output_pointer: MemoryAddress
§num_limbs: MemoryAddress
§output_bits: MemoryAddress

Trait Implementations§

Source§

impl Clone for BlackBoxOp

Source§

fn clone(&self) -> BlackBoxOp

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BlackBoxOp

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for BlackBoxOp

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Hash for BlackBoxOp

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BlackBoxOp

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for BlackBoxOp

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for BlackBoxOp

Source§

impl Eq for BlackBoxOp

Source§

impl StructuralPartialEq for BlackBoxOp

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,