bbapi_shared.hpp File Reference

Shared type definitions for the Barretenberg RPC API. More...

#include "barretenberg/chonk/chonk.hpp"
#include "barretenberg/common/throw_or_abort.hpp"
#include "barretenberg/dsl/acir_format/acir_format.hpp"
#include "barretenberg/flavor/ultra_flavor.hpp"
#include "barretenberg/flavor/ultra_keccak_flavor.hpp"
#include "barretenberg/flavor/ultra_keccak_zk_flavor.hpp"
#include "barretenberg/flavor/ultra_zk_flavor.hpp"
#include "barretenberg/honk/execution_trace/mega_execution_trace.hpp"
#include "barretenberg/stdlib/special_public_inputs/special_public_inputs.hpp"
#include "barretenberg/stdlib_circuit_builders/ultra_circuit_builder.hpp"
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	bb::bbapi::BBApiRequest

Namespaces
namespace	bb
	Entry point for Barretenberg command-line interface.
namespace	bb::bbapi

Macros
#define	BBAPI_ERROR(request, msg)
	Macro to set error in BBApiRequest and return default response.

Enumerations
enum class	bb::bbapi::VkPolicy { bb::bbapi::DEFAULT , bb::bbapi::CHECK , bb::bbapi::RECOMPUTE , bb::bbapi::REWRITE }
	Policy for handling verification keys during IVC accumulation. More...

Functions
template<typename VK >
void	bb::bbapi::validate_vk_size (const std::vector< uint8_t > &vk_bytes)
	Validate verification key size before deserialization.
VkPolicy	bb::bbapi::parse_vk_policy (const std::string &policy)
	Convert VK policy string to enum for internal use.
template<typename Flavor >
Flavor::Transcript::Proof	bb::bbapi::concatenate_proof (const std::vector< uint256_t > &public_inputs, const std::vector< uint256_t > &proof)
	Concatenate public inputs and proof into a complete proof for verification.
template<typename VK >
std::vector< uint256_t >	bb::bbapi::vk_to_uint256_fields (const VK &vk)
	Convert VK to uint256 field elements, handling flavor-specific return types.
template<typename Settings >
void	bb::bbapi::validate_rollup_settings (const Settings &settings)
	Validate rollup circuit settings.
template<typename Settings , typename Operation >
auto	bb::bbapi::dispatch_by_settings (const Settings &settings, Operation &&operation)
	Dispatch to the correct Flavor and IO type based on proof system settings.

Detailed Description

Shared type definitions for the Barretenberg RPC API.

This file contains shared state and helpers used across bbapi modules.

Definition in file bbapi_shared.hpp.

Macro Definition Documentation

BBAPI_ERROR

#define BBAPI_ERROR	(		request,
			msg
	)

Value:

    do {                                                                                                               \
        (request).error_message = (msg);                                                                               \
        return {};                                                                                                     \
    } while (0)

Macro to set error in BBApiRequest and return default response.

Definition at line 102 of file bbapi_shared.hpp.