comment updates

AztecProtocol · Mar 17, 2023 · e631a4c · e631a4c
1 parent d0fae8d
commit e631a4c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/cpp/src/barretenberg/honk/sumcheck/sumcheck.hpp b/cpp/src/barretenberg/honk/sumcheck/sumcheck.hpp
@@ -134,6 +134,8 @@ template <typename FF, class Transcript, template <class> class... Relations> cl
      * @brief Extract round univariate, check sum, generate challenge, compute next target sum..., repeat until final
      * round, then use purported evaluations to generate purported full Honk relation value and check against final
      * target sum.
+     *
+     * @details If verification fails, returns std::nullopt, otherwise returns SumcheckOutput
      */
     std::optional<SumcheckOutput<FF>> execute_verifier(const RelationParameters<FF>& relation_parameters)
     {

diff --git a/cpp/src/barretenberg/honk/transcript/transcript.hpp b/cpp/src/barretenberg/honk/transcript/transcript.hpp
@@ -201,6 +201,12 @@ template <typename FF> class ProverTranscript : public BaseTranscript<FF> {
         BaseTranscript<FF>::consume_prover_element_bytes(label, element_bytes);
     }
 
+    /**
+     * @brief For testing: initializes transcript with some arbitrary data so that a challenge can be generated after
+     * initialization
+     *
+     * @return ProverTranscript
+     */
     static ProverTranscript init_empty()
     {
         ProverTranscript<FF> transcript;
@@ -221,6 +227,13 @@ template <class FF> class VerifierTranscript : public BaseTranscript<FF> {
         : proof_data_(proof_data.begin(), proof_data.end())
     {}
 
+    /**
+     * @brief For testing: initializes transcript based on proof data then receives junk data produced by
+     * ProverTranscript::init_empty()
+     *
+     * @param transcript
+     * @return VerifierTranscript
+     */
     static VerifierTranscript init_empty(const ProverTranscript<FF>& transcript)
     {
         VerifierTranscript<FF> verifier_transcript{ transcript.proof_data };