Barretenberg
The ZK-SNARK library at the core of Aztec
Loading...
Searching...
No Matches
bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata > Class Template Reference

Base Native verification key class. More...

#include <flavor.hpp>

Inheritance diagram for bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >:

Public Types

using Commitment = typename PrecomputedCommitments::DataType
 

Public Member Functions

bool operator== (const NativeVerificationKey_ &) const =default
 
template<size_t NUM_PRECOMPUTED_ENTITIES, typename StringType >
bool compare (const NativeVerificationKey_ &other, RefArray< StringType, NUM_PRECOMPUTED_ENTITIES > commitment_labels) const
 
virtual ~NativeVerificationKey_ ()=default
 
 NativeVerificationKey_ ()=default
 
 NativeVerificationKey_ (const size_t circuit_size, const size_t num_public_inputs)
 
virtual std::vector< typename Transcript::DataTypeto_field_elements () const
 Serialize verification key to field elements.
 
size_t from_field_elements (const std::span< const typename Transcript::DataType > &elements)
 Populate verification key from field elements.
 
fr hash () const
 Compute VK hash.
 
virtual Transcript::DataType hash_with_origin_tagging (const std::string &domain_separator, Transcript &transcript) const
 Tag VK components and hash.
 

Static Public Member Functions

static size_t calc_num_data_types ()
 Calculate the number of field elements needed for serialization.
 

Public Attributes

uint64_t log_circuit_size = 0
 
uint64_t num_public_inputs = 0
 
uint64_t pub_inputs_offset = 0
 

Detailed Description

template<typename PrecomputedCommitments, typename Transcript, VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
class bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >

Base Native verification key class.

We want a separate native and stdlib verification key class because we don't have nice mappings from native to stdlib and back. Examples of mappings that don't exist are from uint64_t to field_t, .get_value() doesn't have a native equivalent, and Builder also doesn't have a native equivalent.

Template Parameters
PrecomputedEntitiesAn instance of PrecomputedEntities_ with affine_element data type and handle type.

Definition at line 137 of file flavor.hpp.

Member Typedef Documentation

◆ Commitment

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
using bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::Commitment = typename PrecomputedCommitments::DataType

Definition at line 139 of file flavor.hpp.

Constructor & Destructor Documentation

◆ ~NativeVerificationKey_()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
virtual bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::~NativeVerificationKey_ ( )
virtualdefault

◆ NativeVerificationKey_() [1/2]

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::NativeVerificationKey_ ( )
default

◆ NativeVerificationKey_() [2/2]

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::NativeVerificationKey_ ( const size_t  circuit_size,
const size_t  num_public_inputs 
)
inline

Definition at line 179 of file flavor.hpp.

Member Function Documentation

◆ calc_num_data_types()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
static size_t bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::calc_num_data_types ( )
inlinestatic

Calculate the number of field elements needed for serialization.

Returns
size_t Number of field elements

Definition at line 189 of file flavor.hpp.

◆ compare()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
template<size_t NUM_PRECOMPUTED_ENTITIES, typename StringType >
bool bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::compare ( const NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata > &  other,
RefArray< StringType, NUM_PRECOMPUTED_ENTITIES >  commitment_labels 
) const
inline

Definition at line 147 of file flavor.hpp.

◆ from_field_elements()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
size_t bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::from_field_elements ( const std::span< const typename Transcript::DataType > &  elements)
inline

Populate verification key from field elements.

Parameters
elementsField elements to deserialize from

Definition at line 238 of file flavor.hpp.

◆ hash()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
fr bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::hash ( ) const
inline

Compute VK hash.

Returns
FF

Definition at line 265 of file flavor.hpp.

◆ hash_with_origin_tagging()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
virtual Transcript::DataType bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::hash_with_origin_tagging ( const std::string &  domain_separator,
Transcript transcript 
) const
inlinevirtual

Tag VK components and hash.

Needed to make sure the Origin Tag system works. We need to set the origin tags of the VK witnesses. If we instead did the hashing outside and just submitted the hash, only the origin tag of the hash would be set properly. By tagging the VK components directly, we ensure all VK witnesses have proper origin tags.

Parameters
domain_separator(currently unused, kept for API compatibility)
transcriptUsed to extract tag context (transcript_index, round_index)
Returns
The hash of the verification key

Reimplemented in bb::ECCVMFlavor::VerificationKey, and bb::TranslatorFlavor::VerificationKey.

Definition at line 281 of file flavor.hpp.

◆ operator==()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
bool bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::operator== ( const NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata > &  ) const
default

◆ to_field_elements()

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
virtual std::vector< typename Transcript::DataType > bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::to_field_elements ( ) const
inlinevirtual

Serialize verification key to field elements.

Returns
std::vector<FF>

Definition at line 208 of file flavor.hpp.

Member Data Documentation

◆ log_circuit_size

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
uint64_t bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::log_circuit_size = 0

Definition at line 140 of file flavor.hpp.

◆ num_public_inputs

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
uint64_t bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::num_public_inputs = 0

Definition at line 141 of file flavor.hpp.

◆ pub_inputs_offset

template<typename PrecomputedCommitments , typename Transcript , VKSerializationMode SerializeMetadata = VKSerializationMode::FULL>
uint64_t bb::NativeVerificationKey_< PrecomputedCommitments, Transcript, SerializeMetadata >::pub_inputs_offset = 0

Definition at line 142 of file flavor.hpp.


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