Skip to content

docs: functional checks, the behaviour a release exists for - #4

Merged
0xrajath merged 1 commit into
mainfrom
docs/functional-checks
Oct 4, 2026
Merged

0xrajath merged 1 commit into
mainfrom
docs/functional-checks

Conversation

@0xrajath

@0xrajath 0xrajath commented Oct 4, 2026 •

Copy link
Copy Markdown
Collaborator

Motivation

docs/testing.md mapped safe-sim's structural checklist to LatticeTest helpers but said nothing about the other half of a release's tests: the behaviour the release exists for, driven end to end through the live proxies after the change.

Modifications

  • docs/testing.md: a Functional checks section — what to cover (the changed behaviour, one happy path that must keep working, failure paths the change moved), how to do it on a fork (prank the role holders, write the inputs the flow needs; nothing reaches the chain under lattice test or lattice run), everything from Env, when a release may skip it.

Result

A release writer knows a Functional.t.sol suite is expected beside the structural ones, and how to write one that runs unchanged against the sandbox and against mainnet.


Note

Low Risk
Documentation-only change to testing guidance; no runtime or contract behavior is modified.

Overview
Adds a Functional checks section to docs/testing.md that sits alongside the existing structural upgrade checklist and describes what release tests must prove about behaviour, not just proxy mechanics.

It expects a Functional.t.sol suite (via a verify step in test mode after live bytecode / post-deploy checks) to cover the changed flow end-to-end through live proxies, at least one regression happy path, and any failure paths the change moved. It documents how to run those tests on a fork—prank role holders, seed inputs, use Env for addresses—why unit tests are not a substitute, and when a release may skip the suite.

Reviewed by Cursor Bugbot for commit b07d851. Bugbot is set up for automated code reviews on this repo. Configure here.

@0xrajath
0xrajath merged commit 9530d27 into main Oct 4, 2026
4 checks passed
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.

1 participant