Skip to content

Commit

Permalink
docs: mention correctness in Prove/Verify traits (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
themighty1 authored Mar 26, 2024
1 parent a6127ce commit eed88d1
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions garble/mpz-garble/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,8 @@ pub trait Execute {
) -> Result<(), ExecutionError>;
}

/// This trait provides methods for proving the output of a circuit.
/// This trait provides methods for proving the authenticity and correctness of the output of a
/// circuit.
#[async_trait]
pub trait Prove {
/// Executes the provided circuit as the prover, assigning to the provided output values.
Expand All @@ -354,11 +355,12 @@ pub trait Prove {
outputs: &[ValueRef],
) -> Result<(), ProveError>;

/// Proves the provided values.
/// Proves the the authenticity and correctness of the provided values.
async fn prove(&mut self, values: &[ValueRef]) -> Result<(), ProveError>;
}

/// This trait provides methods for verifying the output of a circuit.
/// This trait provides methods for verifying the authenticity and correctness of the output of a
/// circuit.
#[async_trait]
pub trait Verify {
/// Executes the provided circuit as the verifier, assigning to the provided output values.
Expand All @@ -369,7 +371,7 @@ pub trait Verify {
outputs: &[ValueRef],
) -> Result<(), VerifyError>;

/// Verifies the provided values against the expected values.
/// Verifies the authenticity and correctness of the provided values against the expected values.
async fn verify(
&mut self,
values: &[ValueRef],
Expand Down

0 comments on commit eed88d1

Please sign in to comment.