sgns::IBasicProof

Base proof class header file. More...

#include <IBasicProof.hpp>

Inherited by sgns::ProcessingProof, sgns::TransferProof

Public Types

	Name
enum class	Error { INSUFFICIENT_FUNDS = 0, INVALID_PROOF, BYTECODE_NOT_FOUND, INVALID_CIRCUIT, INVALID_PROTO_PROOF, INVALID_PROOF_TYPE, UNEXPECTED_PROOF_TYPE, INVALID_PUBLIC_PARAMETERS} Enumeration of error codes used in the proof classes.
using std::function< outcome::result< std::pair< boost::json::array, boost::json::array > >(const std::vector< uint8_t > &)>	PublicParamDeserializeFn Alias for the de-serializer method type to be implemented in derived classes.

Public Functions

	Name
	IBasicProof(std::string bytecode_payload) Constructs a proof and informs the bytecode that will be used.
virtual	~IBasicProof() =default Virtual destructor for IBasicProof.
virtual std::string	GetProofType() const =0 Pure virtual function to get the proof type.
outcome::result< std::vector< uint8_t > >	GenerateFullProof() Generates a full proof using the internal class values.
outcome::result< bool >	VerifyFullProof(const std::vector< uint8_t > & full_proof_data) Verifies the proof with the public parameters.
outcome::result< bool >	VerifyFullProof(const std::pair< boost::json::array, boost::json::array > & parameters, const SGProof::BaseProofData & proof_data, std::string proof_bytecode) Verifies the proof with parameters and bytecode.
boost::json::object	GenerateIntParameter(uint64_t value) Generates a JSON object for an integer parameter.
template <std::size_t N> boost::json::object	GenerateArrayParameter(const std::array< uint64_t, N > & values) Generates a JSON object for an array parameter.
boost::json::object	GenerateFieldParameter(uint64_t value) Generates a JSON object for a field parameter.

Protected Functions

	Name
void	RegisterDeserializer(const std::string & proof_type, PublicParamDeserializeFn fn) Registers a deserializer function for a specific proof type.
void	RegisterBytecode(const std::string & proof_type, std::string bytecode) Registers a bytecode for a specific proof type.
outcome::result< SGProof::BaseProofProto >	DeSerializeBaseProof(const std::vector< uint8_t > & proof_data) Deserializes a BaseProofProto from the provided proof data.
virtual outcome::result< std::vector< uint8_t > >	SerializeFullProof(const SGProof::BaseProofData & base_proof_data) =0 Pure virtual function to serialize a full proof using the snark and internal public parameters.

Protected Attributes

	Name
std::map< std::string, PublicParamDeserializeFn >	PublicParamDeSerializers A map of deserialization functions for public parameters by proof type.
std::map< std::string, std::string >	ByteCodeMap A map of bytecodes associated with each proof type.

Detailed Description

class sgns::IBasicProof;

Base proof class header file.

This class provides methods for generating full proofs and verifying them, along with virtual methods for derived proofs

Public Types Documentation

enum Error

Enumerator	Value	Description
INSUFFICIENT_FUNDS	0	Insufficient funds error.
INVALID_PROOF		Invalid proof error.
BYTECODE_NOT_FOUND		Bytecode not found error.
INVALID_CIRCUIT		Invalid circuit error.
INVALID_PROTO_PROOF		Invalid protobuf proof error.
INVALID_PROOF_TYPE		Invalid proof type error.
UNEXPECTED_PROOF_TYPE		Unexpected proof type error.
INVALID_PUBLIC_PARAMETERS		Invalid public parameters error.

Enumeration of error codes used in the proof classes.

using PublicParamDeserializeFn

using sgns::IBasicProof::PublicParamDeserializeFn = std::function<
           outcome::result<std::pair<boost::json::array, boost::json::array>>( const std::vector<uint8_t> & )>;

Alias for the de-serializer method type to be implemented in derived classes.

Public Functions Documentation

function IBasicProof

explicit IBasicProof(
    std::string bytecode_payload
)

Constructs a proof and informs the bytecode that will be used.

Parameters:

• bytecode_payload Bytecode generated by zkllvm's modified clang

function ~IBasicProof

virtual ~IBasicProof() =default

Virtual destructor for IBasicProof.

function GetProofType

virtual std::string GetProofType() const =0

Pure virtual function to get the proof type.

Return: A string representing the type of proof.

Reimplemented by: sgns::ProcessingProof::GetProofType, sgns::RecursiveTransferProof::GetProofType, sgns::TransferProof::GetProofType

function GenerateFullProof

outcome::result< std::vector< uint8_t > > GenerateFullProof()

Generates a full proof using the internal class values.

Return: A protobuf compatible serialized vector of proof data in bytes.

function VerifyFullProof

static outcome::result< bool > VerifyFullProof(
    const std::vector< uint8_t > & full_proof_data
)

Verifies the proof with the public parameters.

Parameters:

• full_proof_data The protobuf byte vector representing the proof data and public parameters

Return: If successful returns the validity of the proof. Otherwise it returns IBasicProof::Error

function VerifyFullProof

static outcome::result< bool > VerifyFullProof(
    const std::pair< boost::json::array, boost::json::array > & parameters,
    const SGProof::BaseProofData & proof_data,
    std::string proof_bytecode
)

Verifies the proof with parameters and bytecode.

Parameters:

• parameters Deserialized public parameters and zeroed private parameters.
• proof_data Proof data to verify.
• proof_bytecode Serialized proof bytecode.

Return: If successful returns the validity of the proof. Otherwise it returns IBasicProof::Error.

function GenerateIntParameter

static boost::json::object GenerateIntParameter(
    uint64_t value
)

Generates a JSON object for an integer parameter.

Parameters:

• value The integer value to be converted to a JSON object.

Return: A JSON object containing the parameter.

function GenerateArrayParameter

template <std::size_t N>
static inline boost::json::object GenerateArrayParameter(
    const std::array< uint64_t, N > & values
)

Generates a JSON object for an array parameter.

Parameters:

• values The array of values to be converted to a JSON object.

Return: A JSON object containing the array parameter.

function GenerateFieldParameter

static boost::json::object GenerateFieldParameter(
    uint64_t value
)

Generates a JSON object for a field parameter.

Parameters:

• value The field value to be converted to a JSON object.

Return: A JSON object containing the field parameter.

Protected Functions Documentation

function RegisterDeserializer

static void RegisterDeserializer(
    const std::string & proof_type,
    PublicParamDeserializeFn fn
)

Registers a deserializer function for a specific proof type.

Parameters:

• proof_type The proof type for which the deserializer is registered.
• fn The deserializer function to be registered.

function RegisterBytecode

static inline void RegisterBytecode(
    const std::string & proof_type,
    std::string bytecode
)

Registers a bytecode for a specific proof type.

Parameters:

• proof_type The proof type for which the bytecode is registered.
• bytecode The bytecode to be registered.

function DeSerializeBaseProof

static outcome::result< SGProof::BaseProofProto > DeSerializeBaseProof(
    const std::vector< uint8_t > & proof_data
)

Deserializes a BaseProofProto from the provided proof data.

Parameters:

• proof_data The byte vector representing the proof data.

Return: A result containing the deserialized BaseProofProto.

function SerializeFullProof

virtual outcome::result< std::vector< uint8_t > > SerializeFullProof(
    const SGProof::BaseProofData & base_proof_data
) =0

Pure virtual function to serialize a full proof using the snark and internal public parameters.

Parameters:

• base_proof_data The snark that will be embedded on the proof data

Return: A result containing the serialized full proof data in bytes.

Reimplemented by: sgns::ProcessingProof::SerializeFullProof, sgns::RecursiveTransferProof::SerializeFullProof, sgns::TransferProof::SerializeFullProof

Protected Attributes Documentation

variable PublicParamDeSerializers

static std::map< std::string, PublicParamDeserializeFn > PublicParamDeSerializers;

A map of deserialization functions for public parameters by proof type.

variable ByteCodeMap

static std::map< std::string, std::string > ByteCodeMap;

A map of bytecodes associated with each proof type.

---

Updated on 2026-03-04 at 13:10:43 -0800