Call the Kani harnesses model checks, not proofs - #170
Merged
Merged
Conversation
Kani is a model checker: a harness tries every value of its declared inputs and reports that every assertion held or the input that breaks one. The docs called them formal-verification proofs. Every kani-proofs README, module doc, the program READMEs that mention them, the top-level README and the kani.yml comments now say model check, and each first mention explains that the kani-proofs and proof_* names come from Kani's #[kani::proof] attribute. No code, identifier or job name changed. Also: - "money math" becomes "arithmetic" throughout. - The lending Kani README named proof_interest_index_monotonic, which does not exist; the harness is proof_accumulation_factor_monotonic. - A token-swap comment said the harness caps each quantity at 1023; the code caps at 63. Claude-Session: https://claude.ai/code/session_01JGEoAUjMm7Evv69k46eNcn
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Kani is a model checker. Each harness tries every value of the inputs it declares and reports either that every assertion held or the input that breaks one. The docs called these "formal-verification harnesses" that "prove the mathematical correctness" of each program. A formal proof is something else: a mathematical argument written in a proof assistant such as Lean. This repository has none. The companion book now draws that distinction (quicknode/solana-book#190), and these docs now match it.
What changed
finance/*/kani-proofs/README.mdandsrc/lib.rsmodule doc, the program READMEs that mention the harnesses, the top-levelREADME.md, the crate descriptions inCargo.tomland the comments in.github/workflows/kani.ymlnow say "model check", "Kani harness" and "checks".#[kani::proof], which is why the crate iskani-proofsand the harnesses are namedproof_*.proof_interest_index_monotonic, which doesn't exist. The harness isproof_accumulation_factor_monotonic.proof_swap_preserves_constant_productcaps each quantity at 1023. The code caps at 63.What did not change
No code, identifiers,
#[kani::proof]attributes,proof_*names, crate or directory names, commands, or workflow job names. Thekani.ymljob namesKani proofs (...)andProof unit tests (...)stay in case branch protection references them by name. Every.rs,.tomland.ymlchange is to comment text or a TOML description string.cargo fmt --checkpasses in everykani-proofscrate.🤖 Generated with Claude Code
https://claude.ai/code/session_01JGEoAUjMm7Evv69k46eNcn
Generated by Claude Code