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

.gitmodules

@@ -29,6 +29,3 @@
 [submodule "packages/contracts-bedrock/lib/openzeppelin-contracts-v5"]
 	path = packages/contracts-bedrock/lib/openzeppelin-contracts-v5
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
-[submodule "packages/contracts-bedrock/lib/properties"]
-	path = packages/contracts-bedrock/lib/properties
-	url = https://github.com/crytic/properties

packages/contracts-bedrock/foundry.toml

@@ -99,8 +99,3 @@ out = 'kout-proofs'
 test = 'test/kontrol/proofs'
 script = 'test/kontrol/proofs'
 
-[profile.medusa]
-src = 'test/properties/medusa/'
-test = 'test/properties/medusa/'
-script = 'test/properties/medusa/'
-via-ir=true

packages/contracts-bedrock/invariant-docs/OptimismSuperchainERC20.md

@@ -1,5 +1,20 @@
 # `OptimismSuperchainERC20` Invariants
 
+## sum of supertoken total supply across all chains is always <= to convert(legacy, super)- convert(super, legacy)
+**Test:** [`OptimismSuperchainERC20#L36`](../test/invariants/OptimismSuperchainERC20#L36)
+
+
+
+## sum of supertoken total supply across all chains is equal to convert(legacy, super)- convert(super, legacy) when all when all cross-chain messages are processed
+**Test:** [`OptimismSuperchainERC20#L57`](../test/invariants/OptimismSuperchainERC20#L57)
+
+
+
+## many other assertion mode invariants are also defined  under `test/invariants/OptimismSuperchainERC20/fuzz/` .
+**Test:** [`OptimismSuperchainERC20#L79`](../test/invariants/OptimismSuperchainERC20#L79)
+
+since setting`fail_on_revert=false` also ignores StdAssertion failures, this invariant explicitly asks the handler for assertion test failures 
+
 ## Calls to sendERC20 should always succeed as long as the actor has enough balance. Actor's balance should also not increase out of nowhere but instead should decrease by the amount sent.
 **Test:** [`OptimismSuperchainERC20.t.sol#L196`](../test/invariants/OptimismSuperchainERC20.t.sol#L196)
 

packages/contracts-bedrock/justfile

@@ -26,9 +26,6 @@ test-kontrol: build-go-ffi build kontrol-summary-full test-kontrol-no-build
 test-kontrol-no-build:
   ./test/kontrol/scripts/run-kontrol.sh script
 
-test-medusa timeout='100':
-  FOUNDRY_PROFILE=medusa medusa fuzz --timeout {{timeout}}
-
 test-rerun: build-go-ffi
   forge test --rerun -vvv
 

packages/contracts-bedrock/scripts/autogen/generate-invariant-docs/main.go

@@ -77,6 +77,12 @@ func docGen(invariantsDir, docsDir string) error {
 		// Read the contents of the invariant test file.
 		fileName := file.Name()
 		filePath := filepath.Join(invariantsDir, fileName)
+		// where invariants for a module have their own directory, interpret
+		// the test file with the same name as the directory as a 'main' of
+		// sorts, from where documentation is pulled
+		if file.IsDir() {
+			filePath = filepath.Join(filePath, strings.Join([]string{fileName, ".t.sol"}, ""))
+		}
 		fileContents, err := os.ReadFile(filePath)
 		if err != nil {
 			return fmt.Errorf("error reading file %q: %w", filePath, err)