Skip to content

Conversation

@dannywillems
Copy link
Member

@dannywillems dannywillems commented Dec 8, 2025

See commit history.

Use dune build @doc --only-packages=verifier to build the doc.
The doc is available under _build/default/_doc/_html/verifier/index.html.

Will be useful for o1-labs/mina-rust#1759

@dannywillems dannywillems requested a review from a team as a code owner December 8, 2025 00:16
@dannywillems dannywillems force-pushed the dw/document-verifier-module branch from af3fcde to f2e6739 Compare December 8, 2025 00:20
@dannywillems
Copy link
Member Author

!ci-bypass-changelog

@dannywillems
Copy link
Member Author

!ci-build-me

- [`Valid_assuming proofs]: Signatures valid, proofs need async verification
- [invalid]: Verification failed
The outer [Or_error.t] represents communication failure with verifier process. *)
Copy link
Member

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?

Copy link
Member Author

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. *)
Copy link
Member

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.
@dannywillems dannywillems force-pushed the dw/document-verifier-module branch from f2e6739 to 2336e22 Compare December 8, 2025 13:37
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
@dannywillems dannywillems force-pushed the dw/document-verifier-module branch from 2336e22 to 250885a Compare December 8, 2025 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants