Enum Instruction Copy item path

Abs(Abs<N>)

Compute the absolute value of first, checking for overflow, and storing the outcome in destination.

AbsWrapped(AbsWrapped<N>)

Compute the absolute value of first, wrapping around at the boundary of the type, and storing the outcome in destination.

Add(Add<N>)

Adds first with second, storing the outcome in destination.

AddWrapped(AddWrapped<N>)

Adds first with second, wrapping around at the boundary of the type, and storing the outcome in destination.

And(And<N>)

Performs a bitwise and operation on first and second, storing the outcome in destination.

AssertEq(AssertEq<N>)

Asserts first and second are equal.

AssertNeq(AssertNeq<N>)

Asserts first and second are not equal.

Async(Async<N>)

Calls a finalize asynchronously on the operands.

Call(Call<N>)

Calls a closure or function on the operands.

Cast(Cast<N>)

Casts the operands into the declared type.

CastLossy(CastLossy<N>)

Casts the operands into the declared type, with lossy truncation if applicable.

CommitBHP256(CommitBHP256<N>)

Performs a BHP commitment on inputs of 256-bit chunks.

CommitBHP512(CommitBHP512<N>)

Performs a BHP commitment on inputs of 512-bit chunks.

CommitBHP768(CommitBHP768<N>)

Performs a BHP commitment on inputs of 768-bit chunks.

CommitBHP1024(CommitBHP1024<N>)

Performs a BHP commitment on inputs of 1024-bit chunks.

CommitPED64(CommitPED64<N>)

Performs a Pedersen commitment on up to a 64-bit input.

CommitPED128(CommitPED128<N>)

Performs a Pedersen commitment on up to a 128-bit input.

Div(Div<N>)

Divides first by second, storing the outcome in destination.

DivWrapped(DivWrapped<N>)

Divides first by second, wrapping around at the boundary of the type, and storing the outcome in destination.

Double(Double<N>)

Doubles first, storing the outcome in destination.

GreaterThan(GreaterThan<N>)

Computes whether first is greater than second as a boolean, storing the outcome in destination.

GreaterThanOrEqual(GreaterThanOrEqual<N>)

Computes whether first is greater than or equal to second as a boolean, storing the outcome in destination.

HashBHP256(HashBHP256<N>)

Performs a BHP hash on inputs of 256-bit chunks.

HashBHP512(HashBHP512<N>)

Performs a BHP hash on inputs of 512-bit chunks.

HashBHP768(HashBHP768<N>)

Performs a BHP hash on inputs of 768-bit chunks.

HashBHP1024(HashBHP1024<N>)

Performs a BHP hash on inputs of 1024-bit chunks.

HashKeccak256(HashKeccak256<N>)

Performs a Keccak hash, outputting 256 bits.

HashKeccak384(HashKeccak384<N>)

Performs a Keccak hash, outputting 384 bits.

HashKeccak512(HashKeccak512<N>)

Performs a Keccak hash, outputting 512 bits.

HashPED64(HashPED64<N>)

Performs a Pedersen hash on up to a 64-bit input.

HashPED128(HashPED128<N>)

Performs a Pedersen hash on up to a 128-bit input.

HashPSD2(HashPSD2<N>)

Performs a Poseidon hash with an input rate of 2.

HashPSD4(HashPSD4<N>)

Performs a Poseidon hash with an input rate of 4.

HashPSD8(HashPSD8<N>)

Performs a Poseidon hash with an input rate of 8.

HashSha3_256(HashSha3_256<N>)

Performs a SHA-3 hash, outputting 256 bits.

HashSha3_384(HashSha3_384<N>)

Performs a SHA-3 hash, outputting 384 bits.

HashSha3_512(HashSha3_512<N>)

Performs a SHA-3 hash, outputting 512 bits.

HashManyPSD2(HashManyPSD2<N>)

Performs a Poseidon hash with an input rate of 2.

HashManyPSD4(HashManyPSD4<N>)

Performs a Poseidon hash with an input rate of 4.

HashManyPSD8(HashManyPSD8<N>)

Performs a Poseidon hash with an input rate of 8.

Inv(Inv<N>)

Computes the multiplicative inverse of first, storing the outcome in destination.

IsEq(IsEq<N>)

Computes whether first equals second as a boolean, storing the outcome in destination.

IsNeq(IsNeq<N>)

Computes whether first does not equals second as a boolean, storing the outcome in destination.

LessThan(LessThan<N>)

Computes whether first is less than second as a boolean, storing the outcome in destination.

LessThanOrEqual(LessThanOrEqual<N>)

Computes whether first is less than or equal to second as a boolean, storing the outcome in destination.

Modulo(Modulo<N>)

Computes first mod second, storing the outcome in destination.

Mul(Mul<N>)

Multiplies first with second, storing the outcome in destination.

MulWrapped(MulWrapped<N>)

Multiplies first with second, wrapping around at the boundary of the type, and storing the outcome in destination.

Nand(Nand<N>)

Returns false if first and second are true, storing the outcome in destination.

Neg(Neg<N>)

Negates first, storing the outcome in destination.

Nor(Nor<N>)

Returns true if neither first nor second is true, storing the outcome in destination.

Not(Not<N>)

Flips each bit in the representation of first, storing the outcome in destination.

Or(Or<N>)

Performs a bitwise or on first and second, storing the outcome in destination.

Pow(Pow<N>)

Raises first to the power of second, storing the outcome in destination.

PowWrapped(PowWrapped<N>)

Raises first to the power of second, wrapping around at the boundary of the type, storing the outcome in destination.

Rem(Rem<N>)

Divides first by second, storing the remainder in destination.

RemWrapped(RemWrapped<N>)

Divides first by second, wrapping around at the boundary of the type, storing the remainder in destination.

Shl(Shl<N>)

Shifts first left by second bits, storing the outcome in destination.

ShlWrapped(ShlWrapped<N>)

Shifts first left by second bits, wrapping around at the boundary of the type, storing the outcome in destination.

Shr(Shr<N>)

Shifts first right by second bits, storing the outcome in destination.

ShrWrapped(ShrWrapped<N>)

Shifts first right by second bits, wrapping around at the boundary of the type, storing the outcome in destination.

SignVerify(SignVerify<N>)

Computes whether signature is valid for the given address and message.

Square(Square<N>)

Squares ‘first’, storing the outcome in destination.

SquareRoot(SquareRoot<N>)

Compute the square root of ‘first’, storing the outcome in destination.

Sub(Sub<N>)

Computes first - second, storing the outcome in destination.

SubWrapped(SubWrapped<N>)

Computes first - second, wrapping around at the boundary of the type, and storing the outcome in destination.

Ternary(Ternary<N>)

Selects first, if condition is true, otherwise selects second, storing the result in destination.

Xor(Xor<N>)

Performs a bitwise xor on first and second, storing the outcome in destination.

Implementations§

impl<N: Network> Instruction<N>

pub const OPCODES: &'static [Opcode] = _

The list of all instruction opcodes.

pub const fn opcode(&self) -> Opcode

Returns the opcode of the instruction.

pub fn operands(&self) -> &[Operand<N>]

Returns the operands of the instruction.

pub fn evaluate( &self, stack: &(impl StackMatches<N> + StackProgram<N>), registers: &mut (impl RegistersSigner<N> + RegistersLoad<N> + RegistersStore<N>), ) -> Result<()>

Evaluates the instruction.

pub fn execute<A: Aleo<Network = N>>( &self, stack: &(impl StackMatches<N> + StackProgram<N>), registers: &mut (impl RegistersSignerCircuit<N, A> + RegistersLoadCircuit<N, A> + RegistersStoreCircuit<N, A>), ) -> Result<()>

Executes the instruction.

pub fn finalize( &self, stack: &(impl StackMatches<N> + StackProgram<N>), registers: &mut (impl RegistersLoad<N> + RegistersStore<N>), ) -> Result<()>

Finalizes the instruction.

pub fn output_types( &self, stack: &impl StackProgram<N>, input_types: &[RegisterType<N>], ) -> Result<Vec<RegisterType<N>>>

Returns the output type from the given input types.

Trait Implementations§

impl<N: Clone + Network> Clone for Instruction<N>

fn clone(&self) -> Instruction<N>

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

impl<N: Network> Debug for Instruction<N>

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

Prints the instruction as a string.

impl<N: Network> Display for Instruction<N>

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

Prints the instruction as a string.