bb::CommitmentKey< Curve > Class Template Reference

CommitmentKey object over a pairing group 𝔾₁. More...

#include <commitment_key.hpp>

Classes
struct	CommitBatch

Public Member Functions
	CommitmentKey ()=default
	CommitmentKey (const size_t num_points)
	Construct a new Kate Commitment Key object from existing SRS.
bool	initialized () const
	Checks the commitment key is properly initialized.
Commitment	commit (PolynomialSpan< const Fr > polynomial) const
	Uses the ProverSRS to create a commitment to p(X)
std::vector< Commitment >	batch_commit (RefSpan< Polynomial< Fr > > polynomials, size_t max_batch_size=std::numeric_limits< size_t >::max()) const
	Batch commitment to multiple polynomials.
CommitBatch	start_batch ()

Public Attributes
std::shared_ptr< srs::factories::Crs< Curve > >	srs
size_t	dyadic_size

Private Types
using	Fr = typename Curve::ScalarField
using	Commitment = typename Curve::AffineElement
using	G1 = typename Curve::AffineElement

Static Private Member Functions
static size_t	get_num_needed_srs_points (size_t num_points)

Detailed Description

template<class Curve>
class bb::CommitmentKey< Curve >

CommitmentKey object over a pairing group 𝔾₁.

Commitments are computed as C = [p(x)] = ∑ᵢ aᵢ⋅Gᵢ where Gᵢ is the i-th element of the SRS. For BN254, the SRS is given as a list of 𝔾₁ points { [xʲ]₁ }ⱼ where 'x' is unknown. For Grumpkin, they are random points. The SRS stored in the commitment key is after applying the pippenger_point_table thus being double the size of what is loaded from path.

Definition at line 43 of file commitment_key.hpp.

Member Typedef Documentation

Commitment

template<class Curve >

using bb::CommitmentKey< Curve >::Commitment = typename Curve::AffineElement

private

Definition at line 46 of file commitment_key.hpp.

Fr

template<class Curve >

using bb::CommitmentKey< Curve >::Fr = typename Curve::ScalarField

private

Definition at line 45 of file commitment_key.hpp.

G1

template<class Curve >

using bb::CommitmentKey< Curve >::G1 = typename Curve::AffineElement

private

Definition at line 47 of file commitment_key.hpp.

Constructor & Destructor Documentation

CommitmentKey() [1/2]

template<class Curve >

bb::CommitmentKey< Curve >::CommitmentKey ( )

default

CommitmentKey() [2/2]

template<class Curve >

bb::CommitmentKey< Curve >::CommitmentKey ( const size_t  num_points )

inline

Construct a new Kate Commitment Key object from existing SRS.

Parameters

n
path

Definition at line 71 of file commitment_key.hpp.

Member Function Documentation

batch_commit()

template<class Curve >

std::vector< Commitment > bb::CommitmentKey< Curve >::batch_commit ( RefSpan< Polynomial< Fr > >  polynomials, size_t  max_batch_size = std::numeric_limits<size_t>::max()  ) const

inline

Batch commitment to multiple polynomials.

Uses batch_multi_scalar_mul for more efficient processing when committing to multiple polynomials

Parameters

polynomials

vector of polynomial spans to commit to

Returns

std::vector<Commitment> vector of commitments, one for each polynomial

Definition at line 114 of file commitment_key.hpp.

commit()

template<class Curve >

Commitment bb::CommitmentKey< Curve >::commit ( PolynomialSpan< const Fr >  polynomial ) const

inline

Uses the ProverSRS to create a commitment to p(X)

Parameters

polynomial

a univariate polynomial p(X) = ∑ᵢ aᵢ⋅Xⁱ

Returns

Commitment computed as C = [p(x)] = ∑ᵢ aᵢ⋅Gᵢ

Definition at line 88 of file commitment_key.hpp.

get_num_needed_srs_points()

template<class Curve >

static size_t bb::CommitmentKey< Curve >::get_num_needed_srs_points ( size_t  num_points )

inlinestaticprivate

Definition at line 49 of file commitment_key.hpp.

initialized()

template<class Curve >

bool bb::CommitmentKey< Curve >::initialized ( ) const

inline

Checks the commitment key is properly initialized.

Returns

bool

Definition at line 80 of file commitment_key.hpp.

start_batch()

template<class Curve >

CommitBatch bb::CommitmentKey< Curve >::start_batch ( )

inline

Definition at line 182 of file commitment_key.hpp.

Member Data Documentation

dyadic_size

template<class Curve >

size_t bb::CommitmentKey< Curve >::dyadic_size

Definition at line 60 of file commitment_key.hpp.

srs

template<class Curve >

std::shared_ptr<srs::factories::Crs<Curve> > bb::CommitmentKey< Curve >::srs

Definition at line 59 of file commitment_key.hpp.

---

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

• src/barretenberg/commitment_schemes/commitment_key.hpp