-
Notifications
You must be signed in to change notification settings - Fork 584
Document verifier library #18210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: compatible
Are you sure you want to change the base?
Document verifier library #18210
Conversation
af3fcde to
f2e6739
Compare
|
!ci-bypass-changelog |
|
!ci-build-me |
src/lib/verifier/verifier_intf.ml
Outdated
| - [`Valid_assuming proofs]: Signatures valid, proofs need async verification | ||
| - [invalid]: Verification failed | ||
| The outer [Or_error.t] represents communication failure with verifier process. *) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also document the inner error?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it will be better to remove this comment. The set of errors that can be returned is not trivial.
| module Base = struct | ||
| module type S = sig | ||
| type t | ||
| (** The verifier instance. *) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a fan of documents that are basically repeating the code.
Verifier.mli: - Module purpose (transaction and SNARK verification) - Usage locations (transaction pool, staged ledger, mina lib, snark profiler) - Verification types (commands, blockchain SNARKs, transaction SNARKs) - Implementations (Prod, Dummy) - Common module functions (check_signatures_of_zkapp_command, check_signed_command) - Document Rpc_parallel process structure (Worker.T, spawn, connection) - Document daemon integration (created in Mina_lib, passed to components) Mina_lib.mli: - Document subprocesses spawned by create: Prover, Verifier, VRF evaluator - Document components initialized: Transaction_pool, Snark_pool, etc.
f2e6739 to
2336e22
Compare
Document: - Module purpose (Base.S vs S) - All invalid variants with their meanings - verify_commands return values - verify_blockchain_snarks, verify_transaction_snarks - create function parameters
2336e22 to
250885a
Compare
See commit history.
Use
dune build @doc --only-packages=verifierto build the doc.The doc is available under
_build/default/_doc/_html/verifier/index.html.Will be useful for o1-labs/mina-rust#1759