Used to construct execution trace representations of elliptic curve operations. More...

#include <ecc_op_queue.hpp>

Public Member Functions
	ECCOpQueue ()
	Instantiate an initial ECC op subtable.

void	initialize_new_subtable ()
	Initialize a new subtable for eccvm and ultra ops with the given merge settings.

size_t	get_current_subtable_size () const

void	merge (MergeSettings settings=MergeSettings::PREPEND, std::optional< size_t > ultra_fixed_offset=std::nullopt)

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH >	construct_ultra_ops_table_columns () const

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH >	construct_previous_ultra_ops_table_columns () const

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH >	construct_current_ultra_ops_subtable_columns () const

void	construct_full_eccvm_ops_table ()

void	construct_full_ultra_ops_table ()

size_t	get_ultra_ops_table_num_rows () const

size_t	get_current_ultra_ops_subtable_num_rows () const

size_t	get_previous_ultra_ops_table_num_rows () const

std::vector< ECCVMOperation > &	get_eccvm_ops ()

std::vector< UltraOp > &	get_ultra_ops ()

size_t	get_num_msm_rows () const
	Get the number of rows in the 'msm' column section, for all msms in the circuit.

size_t	get_num_rows () const
	Get the number of rows for the current ECCVM circuit.

uint32_t	get_number_of_muls () const
	get number of muls for the current ECCVM circuit

void	set_eccvm_ops_for_fuzzing (std::vector< ECCVMOperation > &eccvm_ops_in)
	A fuzzing only method for setting eccvm ops directly.

void	add_erroneous_equality_op_for_testing ()
	A testing only method that adds an erroneous equality op to the eccvm ops.

void	empty_row_for_testing ()
	Write empty row to queue.

Point	get_accumulator ()

UltraOp	add_accumulate (const Point &to_add)
	Write point addition op to queue and natively perform addition.

UltraOp	mul_accumulate (const Point &to_mul, const Fr &scalar)
	Write multiply and add op to queue and natively perform operation.

UltraOp	no_op_ultra_only ()
	Writes a no op (i.e. two zero rows) to the ultra ops table but adds no eccvm operations.

UltraOp	random_op_ultra_only ()
	Writes randomness to the ultra ops table but adds no eccvm operations.

UltraOp	eq_and_reset ()
	Write equality op using internal accumulator point.

Static Public Attributes
static const size_t	OP_QUEUE_SIZE = 1 << CONST_OP_QUEUE_LOG_SIZE

Private Types
using	Curve = curve::BN254

using	Point = Curve::AffineElement

using	Fr = Curve::ScalarField

using	Fq = Curve::BaseField

Private Member Functions
void	append_eccvm_op (const ECCVMOperation &op)
	Append an eccvm operation to the eccvm ops table; update the eccvm row tracker.

UltraOp	construct_and_populate_ultra_ops (EccOpCode op_code, const Point &point, const Fr &scalar=Fr::zero())
	Given an ecc operation and its inputs, decompose into ultra format and populate ultra_ops.

Private Attributes
Point	point_at_infinity = Curve::Group::affine_point_at_infinity

Point	accumulator = point_at_infinity

EccvmOpsTable	eccvm_ops_table

UltraEccOpsTable	ultra_ops_table

std::vector< ECCVMOperation >	eccvm_ops_reconstructed

std::vector< UltraOp >	ultra_ops_reconstructed

EccvmRowTracker	eccvm_row_tracker

Static Private Attributes
static constexpr size_t	ULTRA_TABLE_WIDTH = UltraEccOpsTable::TABLE_WIDTH

Detailed Description

Used to construct execution trace representations of elliptic curve operations.

Constructs and stores tables of ECC operations in two formats: the ECCVM format and the Ultra-arithmetization (width-4) format. The ECCVM format is used to construct the execution trace for the ECCVM circuit, while the Ultra-arithmetization is used in the Mega circuits and the Translator VM. Both tables are constructed via successive pre-pending of subtables of the same format, where each subtable represents the operations of a single circuit. TODO(https://github.com/AztecProtocol/barretenberg/issues/1267): consider possible efficiency improvements

Definition at line 25 of file ecc_op_queue.hpp.

Member Typedef Documentation

◆ Curve

using bb::ECCOpQueue::Curve = curve::BN254

private

Definition at line 26 of file ecc_op_queue.hpp.

◆ Fq

using bb::ECCOpQueue::Fq = Curve::BaseField

private

Definition at line 29 of file ecc_op_queue.hpp.

◆ Fr

using bb::ECCOpQueue::Fr = Curve::ScalarField

private

Definition at line 28 of file ecc_op_queue.hpp.

◆ Point

using bb::ECCOpQueue::Point = Curve::AffineElement

private

Definition at line 27 of file ecc_op_queue.hpp.

Constructor & Destructor Documentation

◆ ECCOpQueue()

bb::ECCOpQueue::ECCOpQueue ( )

inline

Instantiate an initial ECC op subtable.

Definition at line 55 of file ecc_op_queue.hpp.

Member Function Documentation

◆ add_accumulate()

UltraOp bb::ECCOpQueue::add_accumulate ( const Point & to_add )

inline

Write point addition op to queue and natively perform addition.

Parameters

to_add

Definition at line 177 of file ecc_op_queue.hpp.

◆ add_erroneous_equality_op_for_testing()

void bb::ECCOpQueue::add_erroneous_equality_op_for_testing ( )

inline

A testing only method that adds an erroneous equality op to the eccvm ops.

May be used to ensure that ECCVM responds as expected when encountering a bad op

Definition at line 153 of file ecc_op_queue.hpp.

◆ append_eccvm_op()

void bb::ECCOpQueue::append_eccvm_op ( const ECCVMOperation & op )

inlineprivate

Append an eccvm operation to the eccvm ops table; update the eccvm row tracker.

Definition at line 274 of file ecc_op_queue.hpp.

◆ construct_and_populate_ultra_ops()

UltraOp bb::ECCOpQueue::construct_and_populate_ultra_ops	(	EccOpCode	op_code,
		const Point &	point,
		const Fr &	scalar = `Fr::zero()`
	)

inlineprivate

Given an ecc operation and its inputs, decompose into ultra format and populate ultra_ops.

Parameters

op_code
point
scalar

Returns: UltraOp

Definition at line 287 of file ecc_op_queue.hpp.

◆ construct_current_ultra_ops_subtable_columns()

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH > bb::ECCOpQueue::construct_current_ultra_ops_subtable_columns ( ) const

inline

Definition at line 89 of file ecc_op_queue.hpp.

◆ construct_full_eccvm_ops_table()

void bb::ECCOpQueue::construct_full_eccvm_ops_table ( )

inline

Definition at line 95 of file ecc_op_queue.hpp.

◆ construct_full_ultra_ops_table()

void bb::ECCOpQueue::construct_full_ultra_ops_table ( )

inline

Definition at line 98 of file ecc_op_queue.hpp.

◆ construct_previous_ultra_ops_table_columns()

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH > bb::ECCOpQueue::construct_previous_ultra_ops_table_columns ( ) const

inline

Definition at line 83 of file ecc_op_queue.hpp.

◆ construct_ultra_ops_table_columns()

std::array< Polynomial< Fr >, ULTRA_TABLE_WIDTH > bb::ECCOpQueue::construct_ultra_ops_table_columns ( ) const

inline

Definition at line 76 of file ecc_op_queue.hpp.

◆ empty_row_for_testing()

void bb::ECCOpQueue::empty_row_for_testing ( )

inline

Write empty row to queue.

Warning: This is for testing purposes only. Currently no valid use case.

Definition at line 164 of file ecc_op_queue.hpp.

◆ eq_and_reset()

UltraOp bb::ECCOpQueue::eq_and_reset ( )

inline

Write equality op using internal accumulator point.

Returns: current internal accumulator point (prior to reset to 0)

Definition at line 257 of file ecc_op_queue.hpp.

◆ get_accumulator()

Point bb::ECCOpQueue::get_accumulator ( )

inline

Definition at line 170 of file ecc_op_queue.hpp.

◆ get_current_subtable_size()

size_t bb::ECCOpQueue::get_current_subtable_size ( ) const

inline

Definition at line 67 of file ecc_op_queue.hpp.

◆ get_current_ultra_ops_subtable_num_rows()

size_t bb::ECCOpQueue::get_current_ultra_ops_subtable_num_rows ( ) const

inline

Definition at line 101 of file ecc_op_queue.hpp.

◆ get_eccvm_ops()

std::vector< ECCVMOperation > & bb::ECCOpQueue::get_eccvm_ops ( )

inline

Definition at line 108 of file ecc_op_queue.hpp.

◆ get_num_msm_rows()

size_t bb::ECCOpQueue::get_num_msm_rows ( ) const

inline

Get the number of rows in the 'msm' column section, for all msms in the circuit.

Definition at line 127 of file ecc_op_queue.hpp.

◆ get_num_rows()

size_t bb::ECCOpQueue::get_num_rows ( ) const

inline

Get the number of rows for the current ECCVM circuit.

Definition at line 132 of file ecc_op_queue.hpp.

◆ get_number_of_muls()

uint32_t bb::ECCOpQueue::get_number_of_muls ( ) const

inline

get number of muls for the current ECCVM circuit

Definition at line 137 of file ecc_op_queue.hpp.

◆ get_previous_ultra_ops_table_num_rows()

size_t bb::ECCOpQueue::get_previous_ultra_ops_table_num_rows ( ) const

inline

Definition at line 102 of file ecc_op_queue.hpp.

◆ get_ultra_ops()

std::vector< UltraOp > & bb::ECCOpQueue::get_ultra_ops ( )

inline

Definition at line 116 of file ecc_op_queue.hpp.

◆ get_ultra_ops_table_num_rows()

size_t bb::ECCOpQueue::get_ultra_ops_table_num_rows ( ) const

inline

Definition at line 100 of file ecc_op_queue.hpp.

◆ initialize_new_subtable()

void bb::ECCOpQueue::initialize_new_subtable ( )

inline

Initialize a new subtable for eccvm and ultra ops with the given merge settings.

Definition at line 61 of file ecc_op_queue.hpp.

◆ merge()

void bb::ECCOpQueue::merge	(	MergeSettings	settings = `MergeSettings::PREPEND`,
		std::optional< size_t >	ultra_fixed_offset = `std::nullopt`
	)

inline

Definition at line 69 of file ecc_op_queue.hpp.

◆ mul_accumulate()

UltraOp bb::ECCOpQueue::mul_accumulate	(	const Point &	to_mul,
		const Fr &	scalar
	)

inline

Write multiply and add op to queue and natively perform operation.

Parameters

to_add

Definition at line 194 of file ecc_op_queue.hpp.

◆ no_op_ultra_only()

UltraOp bb::ECCOpQueue::no_op_ultra_only ( )

inline

Writes a no op (i.e. two zero rows) to the ultra ops table but adds no eccvm operations.

We want to be able to add zero rows (and, eventually, random rows https://github.com/AztecProtocol/barretenberg/issues/1360) to the ultra ops table without affecting the operations in the ECCVM.

Definition at line 222 of file ecc_op_queue.hpp.

◆ random_op_ultra_only()

UltraOp bb::ECCOpQueue::random_op_ultra_only ( )

inline

Writes randomness to the ultra ops table but adds no eccvm operations.

This method is used to add randomness to the ultra ops table with the aim of randomising the commitment and evaluations of its corresponding columns

Returns: UltraOp

Definition at line 236 of file ecc_op_queue.hpp.

◆ set_eccvm_ops_for_fuzzing()

void bb::ECCOpQueue::set_eccvm_ops_for_fuzzing ( std::vector< ECCVMOperation > & eccvm_ops_in )

inline

A fuzzing only method for setting eccvm ops directly.

Definition at line 143 of file ecc_op_queue.hpp.

Member Data Documentation

◆ accumulator

Point bb::ECCOpQueue::accumulator = point_at_infinity

private

Definition at line 34 of file ecc_op_queue.hpp.

◆ eccvm_ops_reconstructed

std::vector<ECCVMOperation> bb::ECCOpQueue::eccvm_ops_reconstructed

private

Definition at line 41 of file ecc_op_queue.hpp.

◆ eccvm_ops_table

EccvmOpsTable bb::ECCOpQueue::eccvm_ops_table

private

Definition at line 36 of file ecc_op_queue.hpp.

◆ eccvm_row_tracker

EccvmRowTracker bb::ECCOpQueue::eccvm_row_tracker

private

Definition at line 48 of file ecc_op_queue.hpp.

◆ OP_QUEUE_SIZE

const size_t bb::ECCOpQueue::OP_QUEUE_SIZE = 1 << CONST_OP_QUEUE_LOG_SIZE

static

Definition at line 51 of file ecc_op_queue.hpp.

◆ point_at_infinity

Point bb::ECCOpQueue::point_at_infinity = Curve::Group::affine_point_at_infinity

private

Definition at line 31 of file ecc_op_queue.hpp.

◆ ultra_ops_reconstructed

std::vector<UltraOp> bb::ECCOpQueue::ultra_ops_reconstructed

private

Definition at line 45 of file ecc_op_queue.hpp.

◆ ultra_ops_table

UltraEccOpsTable bb::ECCOpQueue::ultra_ops_table

private

Definition at line 37 of file ecc_op_queue.hpp.

◆ ULTRA_TABLE_WIDTH

constexpr size_t bb::ECCOpQueue::ULTRA_TABLE_WIDTH = UltraEccOpsTable::TABLE_WIDTH

staticconstexprprivate

Definition at line 30 of file ecc_op_queue.hpp.

The documentation for this class was generated from the following file:

src/barretenberg/op_queue/ecc_op_queue.hpp

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Curve

◆ Fq

◆ Fr

◆ Point

Constructor & Destructor Documentation

◆ ECCOpQueue()

Member Function Documentation

◆ add_accumulate()

◆ add_erroneous_equality_op_for_testing()

◆ append_eccvm_op()

◆ construct_and_populate_ultra_ops()

◆ construct_current_ultra_ops_subtable_columns()

◆ construct_full_eccvm_ops_table()

◆ construct_full_ultra_ops_table()

◆ construct_previous_ultra_ops_table_columns()

◆ construct_ultra_ops_table_columns()

◆ empty_row_for_testing()

◆ eq_and_reset()

◆ get_accumulator()

◆ get_current_subtable_size()

◆ get_current_ultra_ops_subtable_num_rows()

◆ get_eccvm_ops()

◆ get_num_msm_rows()

◆ get_num_rows()

◆ get_number_of_muls()

◆ get_previous_ultra_ops_table_num_rows()

◆ get_ultra_ops()

◆ get_ultra_ops_table_num_rows()

◆ initialize_new_subtable()

◆ merge()

◆ mul_accumulate()

◆ no_op_ultra_only()

◆ random_op_ultra_only()

◆ set_eccvm_ops_for_fuzzing()

Member Data Documentation

◆ accumulator

◆ eccvm_ops_reconstructed

◆ eccvm_ops_table

◆ eccvm_row_tracker

◆ OP_QUEUE_SIZE

◆ point_at_infinity

◆ ultra_ops_reconstructed

◆ ultra_ops_table

◆ ULTRA_TABLE_WIDTH