chore: misc comments for PR83 #86
Conversation
| /// This trait provides methods for the evaluator to prove the authenticity of the evaluated garbled | ||
| /// circuit's output. |
There was a problem hiding this comment.
These traits are meant to be protocol generic, ie no mention of garbled circuits here. (I know its in the garble crate, but these will be moving)
There was a problem hiding this comment.
Ok. Can we keep the garbling terminology now and when we move, we will adapt the wording to be generic?
There was a problem hiding this comment.
I don't agree we should do that, the traits are already generic and I don't think coupling the trait docs to DEAP semantics helps any more than just understanding how DEAP implements them
garble/mpz-garble/src/lib.rs
Outdated
| async fn verify( | ||
| &mut self, | ||
| values: &[ValueRef], | ||
| expected_values: &[Value], | ||
| ) -> Result<(), VerifyError>; | ||
| } | ||
|
|
||
| /// This trait provides methods for decoding values. | ||
| /// This trait provides methods for decoding output values. |
There was a problem hiding this comment.
These don't have to be output values, input values can be decoded as well.
There was a problem hiding this comment.
I can't think of any concrete scenarios where there would be a need to decode input values. I think we should try to keep the comments less abstract where possible (it will cause less abstraction fatigue for the reader). Later, when there is a real use-case for using these traits on input values, we can modify the comments accordingly.
There was a problem hiding this comment.
We do it in @th4s latest PR to prove substrings of plaintext
There was a problem hiding this comment.
ah, ok, thx, goot to know. then i'll revisit this PR in light of that PR later on.
| @@ -332,7 +327,7 @@ impl DEAP { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| /// Sends a commitment to the provided values, proving them to the follower upon finalization. | |||
| /// Sends a commitment to the provided output values, deferring the actual proving until finalization. | |||
There was a problem hiding this comment.
| /// Sends a commitment to the provided output values, deferring the actual proving until finalization. | |
| /// Sends a commitment to the provided values, deferring the actual proving until finalization. |
| @@ -354,7 +349,7 @@ impl DEAP { | |||
| Ok(()) | |||
| } | |||
|
|
|||
| /// Receives a commitment to the provided values, and stores it until finalization. | |||
| /// Receives a commitment to the provided output values, and stores it until finalization. | |||
There was a problem hiding this comment.
| /// Receives a commitment to the provided output values, and stores it until finalization. | |
| /// Receives a commitment to the provided values, and stores it until finalization. |
themighty1
force-pushed
the
chore/misc_comments_PR83
branch
from
50dd44f
to
bc074e4
Compare
This PR adds comments to clarify: