Skip to content

Commit

Permalink
Removing section about sanity
Browse files Browse the repository at this point in the history
  • Loading branch information
johspaeth committed Feb 6, 2025
1 parent 22ec631 commit be07c93
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 28 deletions.
1 change: 0 additions & 1 deletion docs/solana/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ The *Certora Solana Prover* allows formal verification of Solana smart contracts
speclanguage
options
output
sanity
troubleshooting


Expand Down
29 changes: 2 additions & 27 deletions docs/solana/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,35 +120,10 @@ this:
* But then we assert `amount1 < 100`
* This is impossible to satisfy, hence the counterexample


## Rule Sanity Checking

To ensure rules aren't passing vacuously (due to contradictory assumptions), add sanity checking to your configuration:

```json
{
"rule_sanity": "basic"
}
```

This adds an implicit `cvlr_assert!(false)` at the end of each rule. If this assertion is unreachable, it confirms that:

1. Your assumptions aren't contradictory
2. The rule's success is meaningful

### Common Sanity Check Results

1. **Sanity Check PASSED**: Desired outcome - confirms rule isn't vacuously true
2. **Sanity Check WARNING**: Warning sign - indicates contradictory assumptions

See [Rule Sanity Checks](./sanity.md) for more details.


## Best Practices

1. Always enable rule sanity checking in your configuration
2. Review full call traces when investigating failures
3. Validate counterexamples against your program's expected state space
1. Review full call traces when investigating failures
2. Validate counterexamples against your program's expected state space

## Advanced Topics

Expand Down

0 comments on commit be07c93

Please sign in to comment.