Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore: foundry migration #40

Merged
merged 14 commits into from
Sep 5, 2024
Merged

chore: foundry migration #40

merged 14 commits into from
Sep 5, 2024

Conversation

0xteddybear
Copy link

@0xteddybear 0xteddybear commented Aug 30, 2024 •
edited
Loading

Running the Medusa fuzzing campaign currently under development via foundry. I'd appreciate feedback on the following items:

  • should the medusa campaign be more 'invisible' to facilitate merging into OP's repositories? -- feedback welcome of course, but made it as invisible as possible
  • would you think it'd be better for most files of the fuzzing campaign to live under test/invariant/OptimismSuperchainERC20/ instead, and have a separate directory for the medusa-specific parts? -- defaulted to this, medusa-specific files live in other repo now
  • should we increase the default runs and depth parameters in foundry invariant tests? they're configured to very low values.
  • should we have a writeup on the differences between foundry and medusa invariant testing and when should developers run each?
  • what level of integration should we strive to have with the invariant's current docs? they are auto-generated from custom natspec tags, however I'm not sure we won't lose information or hit edge cases of the generation scripts in the following cases:
    • would a single property having multiple tags referencing it in different files cause duplications, for example in the case of guided vs unguided calls to the same function?
    • where to put all the info that isn't a property id or definition

I've pushed a lazy solution to the last item, and moved most docs to a separate, for-now-private repository.

drgorillamd
drgorillamd requested changes Aug 30, 2024
View reviewed changes
Copy link
Member

@drgorillamd drgorillamd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor stuff, ggwp!

packages/contracts-bedrock/test/properties/helpers/CompatibleAssert.t.sol Outdated

/// @title CompatibleAssert
/// @notice meant to add compatibility between medusa assertion tests and
/// foundry invariant test's required arquitecture
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// foundry invariant test's required arquitecture
/// foundry invariant test's required architecture

packages/contracts-bedrock/test/properties/helpers/CompatibleAssert.t.sol Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noiice

packages/contracts-bedrock/test/properties/helpers/CompatibleAssert.t.sol Outdated Show resolved Hide resolved
packages/contracts-bedrock/test/properties/medusa/handlers/Protocol.t.sol Outdated Show resolved Hide resolved
packages/contracts-bedrock/test/properties/medusa/handlers/Protocol.t.sol Outdated Show resolved Hide resolved
packages/contracts-bedrock/test/properties/medusa/handlers/Protocol.t.sol Show resolved Hide resolved
packages/contracts-bedrock/test/properties/medusa/fuzz/Protocol.guided.t.sol Outdated Show resolved Hide resolved
@0xteddybear 0xteddybear mentioned this pull request Sep 2, 2024
Closed
@0xteddybear 0xteddybear changed the base branch from test/non-atomic-bridging to feat/invariant-testing September 2, 2024 18:25
@0xteddybear 0xteddybear marked this pull request as ready for review September 3, 2024 21:40
@drgorillamd
Copy link
Member

  • should we increase the default runs and depth parameters in foundry invariant tests? they're configured to very low values.

Configured for us or in their CI?

  • should we have a writeup on the differences between foundry and medusa invariant testing and when should developers run each?

Maybe after closure, for the "take home messages"?

  • what level of integration should we strive to have with the invariant's current docs? they are auto-generated from custom natspec tags, however I'm not sure we won't lose information or hit edge cases of the generation scripts in the following cases:

    • would a single property having multiple tags referencing it in different files cause duplications, for example in the case of guided vs unguided calls to the same function?
    • where to put all the info that isn't a property id or definition

I've pushed a lazy solution to the last item, and moved most docs to a separate, for-now-private repository.

Hmmm, yeah, shouldn't alway do it like you did (ie the summary.md for instance? So only the invariant id and "summary" is included, while details are gathered somewhere)?

@0xteddybear 0xteddybear merged commit 50df837 into feat/invariant-testing Sep 5, 2024
3 checks passed
0xteddybear added a commit that referenced this pull request Sep 10, 2024
@0xteddybear
chore: foundry migration (#40)
60d8457 
* chore: track assertion failures

this is so foundry's invariant contract can check that an assertion
returned false in the handler, while still allowing `fail_on_revert =
false` so we can still take full advantage of medusa's fuzzer & coverage
reports

* fix: explicitly skip duplicate supertoken deployments

* chore: remove duplicated PROPERTIES.md file

* chore: expose data to foundry's external invariant checker

* test: run medusa fuzzing campaign from within foundry

* fix: eagerly check for duplicate deployments

* fix: feedback from doc

* chore: shoehorn medusa campaign into foundry dir structure

* chore: remove PROPERTIES.md file

* chore: delete medusa config

* docs: limited support for subdirectories in test/invariant

* chore: rename contracts to be more sneaky about medusa

* docs: rewrite invariant docs in a way compliant with autogen scripts
0xteddybear added a commit that referenced this pull request Sep 16, 2024
@0xteddybear
chore: foundry migration (#40)
32616bd 
* chore: track assertion failures

this is so foundry's invariant contract can check that an assertion
returned false in the handler, while still allowing `fail_on_revert =
false` so we can still take full advantage of medusa's fuzzer & coverage
reports

* fix: explicitly skip duplicate supertoken deployments

* chore: remove duplicated PROPERTIES.md file

* chore: expose data to foundry's external invariant checker

* test: run medusa fuzzing campaign from within foundry

* fix: eagerly check for duplicate deployments

* fix: feedback from doc

* chore: shoehorn medusa campaign into foundry dir structure

* chore: remove PROPERTIES.md file

* chore: delete medusa config

* docs: limited support for subdirectories in test/invariant

* chore: rename contracts to be more sneaky about medusa

* docs: rewrite invariant docs in a way compliant with autogen scripts
0xteddybear added a commit that referenced this pull request Sep 17, 2024
@0xteddybear
chore: foundry migration (#40)
5969d60 
* chore: track assertion failures

this is so foundry's invariant contract can check that an assertion
returned false in the handler, while still allowing `fail_on_revert =
false` so we can still take full advantage of medusa's fuzzer & coverage
reports

* fix: explicitly skip duplicate supertoken deployments

* chore: remove duplicated PROPERTIES.md file

* chore: expose data to foundry's external invariant checker

* test: run medusa fuzzing campaign from within foundry

* fix: eagerly check for duplicate deployments

* fix: feedback from doc

* chore: shoehorn medusa campaign into foundry dir structure

* chore: remove PROPERTIES.md file

* chore: delete medusa config

* docs: limited support for subdirectories in test/invariant

* chore: rename contracts to be more sneaky about medusa

* docs: rewrite invariant docs in a way compliant with autogen scripts
0xng added a commit that referenced this pull request Sep 18, 2024
@0xteddybear @0xDiscotech
@agusduha @0xng
test: invariant tests for OptimismSuperchainERC20 (ethereum-optimism#…
9de48fc 
…11776)

* chore: configure medusa with basic supERC20 self-bridging (#19)

- used --foundry-compile-all to ensure the test contract under
  `test/properties` is compiled (otherwise it is not compiled and medusa
  crashes when it can't find it's compiled representation)
- set src,test,script to test/properties/medusa to not waste time
  compiling contracts that are not required for the medusa campaign
- used an atomic bridge, which doesnt allow for testing of several of
  the proposed invariants

fix: delete dead code
test: give the fuzzer a head start
docs: fix properties order
test: document & implement assertions 22, 23  and 24
fix: fixes from self-review
test: guide the fuzzer a little bit less
  previously: initial mint, bound on transfer amount: 146625 calls in 200s
  now: no initial mint, no bound on transfer amount: 176835 calls in 200s
  it doesn't seem to slow the fuzzer down
fix: fixes after lovely feedback by disco
docs: merge both documents and categorized properties by their milestone
fix: fixes from parti's review
fix: feedback from disco
fix: feedback from doc
refactor: separate state transitions from pure properties
docs: update tested properties
refactor: move all assertions into properties contract
fix: move function without assertions back into handler
test: only use assertion mode
fix: improve justfile recipie for medusa

* feat: halmos symbolic tests (#21)

* feat: introduce OptimismSuperchainERC20

* fix: contract fixes

* feat: add snapshots and semver

* test: add supports interface tests

* test: add invariant test

* feat: add parameters to the RelayERC20 event

* fix: typo

* fix: from param description

* fix: event signature and interface pragma

* feat: add initializer

* feat: use unstructured storage and OZ v5

* feat: update superchain erc20 interfaces

* fix: adapt storage to ERC7201

* test: add initializable OZ v5 test

* fix: invariant docs

* fix: ERC165 implementation

* test: improve superc20 invariant (#11)

* fix: gas snapshot

* chore: configure medusa with basic supERC20 self-bridging

- used --foundry-compile-all to ensure the test contract under
  `test/properties` is compiled (otherwise it is not compiled and medusa
  crashes when it can't find it's compiled representation)
- set src,test,script to test/properties/medusa to not waste time
  compiling contracts that are not required for the medusa campaign
- used an atomic bridge, which doesnt allow for testing of several of
  the proposed invariants

* fix: delete dead code

* test: give the fuzzer a head start

* feat: create suite for sybolic tests with halmos

* test: setup and 3 properties with symbolic tests

* chore: remove todo comment

* docs: fix properties order

* test: document & implement assertions 22, 23  and 24

* fix: fixes from self-review

* test: guide the fuzzer a little bit less

previously: initial mint, bound on transfer amount: 146625 calls in 200s
now: no initial mint, no bound on transfer amount: 176835 calls in 200s

it doesn't seem to slow the fuzzer down

* feat: add property for burn

* refactor: remove symbolic address on mint property

* refactor: order the tests based on the property id

* feat: checkpoint

* chore: set xdomain sender on failing test

* chore: enhance mocks

* Revert "Merge branch 'chore/setup-medusa' into feat/halmos-symbolic-tests"

This reverts commit 945d6b6, reversing
changes made to 5dcb3a8.

* refactor: remove symbolic addresses to make all of the test work

* chore: remove console logs

* feat: add properties file

* chore: polish

* refactor: enhance test on property 7 using direct try catch (now works)

* fix: review comments

* refactor: add symbolic addresses on test functions

* feat: create halmos toml

* chore: polish test contract and mock

* chore: update property

* refactor: move symbolic folder into properties one

* feat: create advanced tests helper contract

* refactor: enhance tests using symbolic addresses instead of concrete ones

* chore: remove 0 property natspec

* feat: add halmos profile and just script

* chore: rename symbolic folder to halmos

* feat: add halmos commands to justfile

* chore: reorder assertions on one test

* refactor: complete test property seven

* chore: mark properties as completed

* chore: add halmos-cheatcodes dependency

* chore: rename advancedtest->halmosbase

* chore: minimize mocked messenger

* chore: delete empty halmos file

* chore: revert changes to medusa.json

* docs: update changes to PROPERTIES.md from base branch

* test: sendERC20 destination fix

* chore: natspec fixes

---------

Co-authored-by: agusduha <[email protected]>
Co-authored-by: 0xng <[email protected]>
Co-authored-by: teddy <[email protected]>

* test: remaining protocol properties (#26)

* test: cross-user fuzzed bridges + actor setup

* test: fuzz properties 8 and 9

* test: properties 7 and 25

* fix: implement doc's feedback

* test: superc20 tob properties (#27)

* chore: add crytic/properties dependency

* test: extend protocol properties so it also covers ToB erc20 properties

* chore: small linter fixes

* docs: update property list

* test: handlers for remaining superc20 state transitions

* fix: disable ToB properties we are not using and guide the fuzzer a bit more

* fix: disable another ToB property not implemented by solady

* chore: remove zero-initializations

* fix: feedback from disco

* chore: separate fuzz campaign tests in guided vs unguided

* test: dont revert on successful unguided relay

* test: add fuzzed calls to burn and mint

* docs: document the separation of fuzz test functions

* chore: move the properties file to its own directory

* chore: consistently use fuzz_ and property_ + camelcase

* chore: fix typo

* chore: camelcase for handlers as well

* fix: revert change that broke halmos campaign compile :D

* test: fuzz non atomic bridging (#31)

* test: changed mocked messenger ABI for message sending but kept assertions the same

* docs: add new properties 26&27

* test: queue cross-chain messages and test related properties

* test: relay random messages from queue and check associated invariants

* chore: rename bridge->senderc20 method for consistency with relayerc20

* test: not-yet-deployed supertokens can get funds sent to them

* chore: medusa runs forever by default

doable since it also handles SIGINTs gracefully

* chore: document the reason behind relay zero and send zero inconsistencies

* fix: feedback from doc

* fix: walk around possible medusa issue

I'm getting an 'unknown opcode 0x4e' in ProtocolAtomic constructor when
calling the MockL2ToL2CrossDomainMessenger for the first time

* test: unguided handler for sendERC20

* fix: feedback from disco

* chore: remove halmos testsuite

* chore: foundry migration (#40)

* chore: track assertion failures

this is so foundry's invariant contract can check that an assertion
returned false in the handler, while still allowing `fail_on_revert =
false` so we can still take full advantage of medusa's fuzzer & coverage
reports

* fix: explicitly skip duplicate supertoken deployments

* chore: remove duplicated PROPERTIES.md file

* chore: expose data to foundry's external invariant checker

* test: run medusa fuzzing campaign from within foundry

* fix: eagerly check for duplicate deployments

* fix: feedback from doc

* chore: shoehorn medusa campaign into foundry dir structure

* chore: remove PROPERTIES.md file

* chore: delete medusa config

* docs: limited support for subdirectories in test/invariant

* chore: rename contracts to be more sneaky about medusa

* docs: rewrite invariant docs in a way compliant with autogen scripts

* chore: fixes from rebase

* fix: cleanup superc20 invariants (#46)

* chore: revert modifications from medusa campaign

* docs: extra docs on why ForTest contract is required

* doc: add list of all supertoken properties

* chore: run forge fmt

* ci: allow for testfiles to be deleted

* fix: run doc autogen script after rebase

---------

Co-authored-by: Disco <[email protected]>
Co-authored-by: agusduha <[email protected]>
Co-authored-by: 0xng <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drgorillamd drgorillamd drgorillamd approved these changes

@0xDiscotech 0xDiscotech Awaiting requested review from 0xDiscotech

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@0xteddybear @drgorillamd