doc(example): add minor comments (#761)

* Add comments.

* Remove commented leftover.

* Remove example tweak.

* fmt.

---------

Co-authored-by: yuroitaki <>

Author: yuroitaki

crates/examples/Cargo.toml

@@ -9,7 +9,6 @@ notary-client = { workspace = true }
 tlsn-common = { workspace = true }
 tlsn-core = { workspace = true }
 tlsn-prover = { workspace = true }
-tlsn-utils = { workspace = true }
 tlsn-verifier = { workspace = true }
 tlsn-formats = { workspace = true }
 tlsn-tls-core = { workspace = true }

crates/examples/attestation/present.rs

@@ -40,12 +40,14 @@ async fn create_presentation(example_type: &ExampleType) -> Result<(), Box<dyn s
     // Build a transcript proof.
     let mut builder = secrets.transcript_proof_builder();
 
+    // Here is where we reveal all or some of the parts we committed in `prove.rs`
+    // previously.
     let request = &transcript.requests[0];
     // Reveal the structure of the request without the headers or body.
     builder.reveal_sent(&request.without_data())?;
     // Reveal the request target.
     builder.reveal_sent(&request.request.target)?;
-    // Reveal all headers except the values of User-Agent and Authorization.
+    // Reveal all request headers except the values of User-Agent and Authorization.
     for header in &request.headers {
         if !(header
             .name
@@ -64,7 +66,9 @@ async fn create_presentation(example_type: &ExampleType) -> Result<(), Box<dyn s
 
     // Reveal only parts of the response
     let response = &transcript.responses[0];
+    // Reveal the structure of the response without the headers or body.
     builder.reveal_recv(&response.without_data())?;
+    // Reveal all response headers.
     for header in &response.headers {
         builder.reveal_recv(header)?;
     }

crates/examples/attestation/prove.rs

@@ -164,7 +164,6 @@ async fn notarize(
 
     // Parse the HTTP transcript.
     let transcript = HttpTranscript::parse(prover.transcript())?;
-    // dbg!(&transcript);
 
     let body_content = &transcript.responses[0].body.as_ref().unwrap().content;
     let body = String::from_utf8_lossy(body_content.span().as_bytes());
@@ -183,6 +182,9 @@ async fn notarize(
     // Commit to the transcript.
     let mut builder = TranscriptCommitConfig::builder(prover.transcript());
 
+    // This commits to various parts of the transcript separately (e.g. request
+    // headers, response headers, response body and more). See https://docs.tlsnotary.org//protocol/commit_strategy.html
+    // for other strategies that can be used to generate commitments.
     DefaultHttpCommitter::default().commit_transcript(&mut builder, &transcript)?;
 
     prover.transcript_commit(builder.build()?);