bbapi_shared.hpp File Reference

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

#include "barretenberg/chonk/chonk.hpp"
#include "barretenberg/dsl/acir_format/acir_format.hpp"
#include "barretenberg/honk/execution_trace/mega_execution_trace.hpp"
#include <cstdint>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
struct	bb::bbapi::CircuitInputNoVK
	A circuit to be used in either ultrahonk or chonk verification key derivation. More...
struct	bb::bbapi::CircuitInput
	A circuit to be used in either ultrahonk or Chonk proving. More...
struct	bb::bbapi::ProofSystemSettings
struct	bb::bbapi::BBApiRequest
struct	bb::bbapi::ErrorResponse
	Error response returned when a command fails. More...
struct	bb::bbapi::Shutdown
struct	bb::bbapi::Shutdown::Response

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...
enum class	bb::bbapi::OracleHashType { bb::bbapi::POSEIDON2 , bb::bbapi::KECCAK , bb::bbapi::STARKNET }
	Convert oracle hash type string to enum for internal use. More...

Functions
OracleHashType	bb::bbapi::parse_oracle_hash_type (const std::string &type)
VkPolicy	bb::bbapi::parse_vk_policy (const std::string &policy)
	Convert VK policy string to enum for internal use.

Detailed Description

Shared type definitions for the Barretenberg RPC API.

This file contains common data structures used across multiple bbapi modules, including circuit input types and proof system settings.

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 176 of file bbapi_shared.hpp.