feat: Actor-Based Invariant Testing Suite developed for the Aave v3 protocol

Co-authored-by: Elpacos <[email protected]>
Co-authored-by: Víctor Nicolás Martínez Carralero <[email protected]>

Author: sakulstra

.gitignore

@@ -33,3 +33,7 @@ broadcast/
 certora-logs
 certora_debug_log.txt
 resource_errors.json
+
+# invariants
+_corpus/
+crytic-export/

.prettierignore

@@ -3,4 +3,6 @@ lib
 cache
 node_modules
 report
+_corpus
+crytic-export
 snapshots

Makefile

@@ -55,3 +55,32 @@ deploy-libs :
 
 # Gas reports
 gas-report :; forge test --mp 'tests/gas/*.t.sol' --isolate
+
+
+# Invariants
+echidna:
+	echidna tests/invariants/Tester.t.sol --contract Tester --config ./tests/invariants/_config/echidna_config.yaml --corpus-dir ./tests/invariants/_corpus/echidna/default/_data/corpus
+
+echidna-assert:
+	echidna tests/invariants/Tester.t.sol --contract Tester --test-mode assertion --config ./tests/invariants/_config/echidna_config.yaml --corpus-dir ./tests/invariants/_corpus/echidna/default/_data/corpus
+
+echidna-explore:
+	echidna tests/invariants/Tester.t.sol --contract Tester --test-mode exploration --config ./tests/invariants/_config/echidna_config.yaml --corpus-dir ./tests/invariants/_corpus/echidna/default/_data/corpus
+
+# Medusa
+medusa:
+	medusa fuzz --config ./medusa.json
+
+# Echidna Runner
+
+HOST = power-runner
+LOCAL_FOLDER = ./
+REMOTE_FOLDER = ./echidna-runner
+REMOTE_COMMAND = cd $(REMOTE_FOLDER)/aave-v3-origin && make echidna > process_output.log 2>&1
+REMOTE_COMMAND_ASSERT = cd $(REMOTE_FOLDER)/aave-v3-origin && make echidna-assert > process_output.log 2>&1
+
+echidna-runner:
+	tar --exclude='./tests/invariants/_corpus' -czf - $(LOCAL_FOLDER) | ssh $(HOST) "export PATH=$$PATH:/root/.local/bin:/root/.foundry/bin && mkdir -p $(REMOTE_FOLDER)/aave-v3-origin && tar -xzf - -C $(REMOTE_FOLDER)/aave-v3-origin && $(REMOTE_COMMAND)"
+
+echidna-assert-runner:
+	tar --exclude='./tests/invariants/_corpus' -czf - $(LOCAL_FOLDER) | ssh $(HOST) "export PATH=$$PATH:/root/.local/bin:/root/.foundry/bin && mkdir -p $(REMOTE_FOLDER)/aave-v3-origin && tar -xzf - -C $(REMOTE_FOLDER)/aave-v3-origin && $(REMOTE_COMMAND_ASSERT)"

medusa.json

@@ -0,0 +1,95 @@
+{
+  "fuzzing": {
+    "workers": 10,
+    "workerResetLimit": 50,
+    "timeout": 0,
+    "testLimit": 0,
+    "callSequenceLength": 100,
+    "corpusDirectory": "tests/invariants/_corpus/medusa",
+    "coverageEnabled": true,
+    "coverageFormats": ["html", "lcov"],
+    "deploymentOrder": ["Tester"],
+    "targetContracts": ["Tester"],
+    "targetContractsBalances": [
+      "0xffffffffffffffffffffffffffffffffffffffffffffffffffff"
+    ],
+    "predeployedContracts": {
+      "Create2Factory": "0x914d7Fec6aaC8cd542e72Bca78B30650d45643d7",
+      "Pretty": "0xf01",
+      "Strings": "0xf02",
+      "AaveV3BatchOrchestration": "0xf03",
+      "SupplyLogic": "0xf04",
+      "PoolLogic": "0xf05",
+      "LiquidationLogic": "0xf06",
+      "FlashLoanLogic": "0xf07",
+      "BridgeLogic": "0xf08",
+      "EModeLogic": "0xf09",
+      "BorrowLogic": "0xf10",
+      "ConfiguratorLogic": "0xf11"
+    },
+    "constructorArgs": {},
+    "deployerAddress": "0x30000",
+    "senderAddresses": ["0x10000", "0x20000", "0x30000"],
+    "blockNumberDelayMax": 60480,
+    "blockTimestampDelayMax": 604800,
+    "blockGasLimit": 12500000000,
+    "transactionGasLimit": 1250000000,
+    "testing": {
+      "stopOnFailedTest": false,
+      "stopOnFailedContractMatching": false,
+      "stopOnNoTests": true,
+      "testAllContracts": false,
+      "traceAll": false,
+      "assertionTesting": {
+        "enabled": true,
+        "testViewMethods": true,
+        "panicCodeConfig": {
+          "failOnCompilerInsertedPanic": false,
+          "failOnAssertion": true,
+          "failOnArithmeticUnderflow": false,
+          "failOnDivideByZero": false,
+          "failOnEnumTypeConversionOutOfBounds": false,
+          "failOnIncorrectStorageAccess": false,
+          "failOnPopEmptyArray": false,
+          "failOnOutOfBoundsArrayAccess": false,
+          "failOnAllocateTooMuchMemory": false,
+          "failOnCallUninitializedVariable": false
+        }
+      },
+      "propertyTesting": {
+        "enabled": true,
+        "testPrefixes": ["fuzz_", "echidna_"]
+      },
+      "optimizationTesting": {
+        "enabled": false,
+        "testPrefixes": ["optimize_"]
+      }
+    },
+    "chainConfig": {
+      "codeSizeCheckDisabled": true,
+      "cheatCodes": {
+        "cheatCodesEnabled": true,
+        "enableFFI": false
+      },
+      "skipAccountChecks": true
+    }
+  },
+  "compilation": {
+    "platform": "crytic-compile",
+    "platformConfig": {
+      "target": "tests/invariants/Tester.t.sol",
+      "solcVersion": "",
+      "exportDirectory": "",
+      "args": [
+        "--solc-remaps",
+        "@crytic/properties/=../../../lib/properties/ forge-std/=../../../lib/forge-std/src/ ds-test/=../../../lib/forge-std/lib/ds-test/src/",
+        "--compile-libraries=(Pretty,0xf01), (Strings,0xf02), (AaveV3BatchOrchestration,0xf03), (SupplyLogic,0xf04), (PoolLogic,0xf05), (LiquidationLogic,0xf06), (FlashLoanLogic,0xf07), (BridgeLogic,0xf08), (EModeLogic,0xf09), (BorrowLogic,0xf10), (ConfiguratorLogic,0xf11)"
+      ]
+    }
+  },
+  "logging": {
+    "level": "info",
+    "logDirectory": "",
+    "noColor": false
+  }
+}