From 3aeaa3f770489e0b1919d7e235d5c545e6d60ab6 Mon Sep 17 00:00:00 2001
From: JaredBorders <jaredborders@pm.me>
Date: Fri, 5 Apr 2024 12:33:23 -0400
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20refactor=20invariant=20testing?=
 =?UTF-8?q?=20setup=20example?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 test/invariant/README.md | 40 +++++++++++++++++++++++++++++++---------
 1 file changed, 31 insertions(+), 9 deletions(-)

diff --git a/test/invariant/README.md b/test/invariant/README.md
index d3630f7..fadf32b 100644
--- a/test/invariant/README.md
+++ b/test/invariant/README.md
@@ -1,4 +1,4 @@
-example
+example of testing invariant(s) related to overflow and underflow
 
 ```solidity
 // SPDX-License-Identifier: GPL-3.0-or-later
@@ -34,27 +34,49 @@ contract ExampleHandler is Test {
 
 contract ExampleInvariantOverflow is Test {
     ExampleHandler public exampleHandler;
+    ExampleTypeHandler public exampleTypeHandler;
+
+    function setUp() public {
+        exampleTypeHandler = new ExampleTypeHandler();
+        exampleHandler = new ExampleHandler(exampleTypeHandler);
+
+        // only add selectors that can result in overflow
+        bytes4[] memory selectors = new bytes4[](1);
+        selectors[0] = ExampleHandler.ghost_overflow.selector;
+
+        targetSelector(
+            FuzzSelector({addr: address(handler), selectors: selectors})
+        );
 
-    constructor(ExampleHandler _exampleHandler) {
-        exampleHandler = _exampleHandler;
+        targetContract(address(exampleHandler));
     }
 
     function invariant_overflow() public view {
-        bytes memory x;
-        exampleHandler.ghost_overflow(x);
+        // invariant assertion happens here
     }
 }
 
 contract ExampleInvariantUnderflow is Test {
     ExampleHandler public exampleHandler;
+    ExampleTypeHandler public exampleTypeHandler;
+
+    function setUp() public {
+        exampleTypeHandler = new ExampleTypeHandler();
+        exampleHandler = new ExampleHandler(exampleTypeHandler);
+
+        // only add selectors that can result in underflow
+        bytes4[] memory selectors = new bytes4[](1);
+        selectors[0] = ExampleHandler.ghost_underflow.selector;
+
+        targetSelector(
+            FuzzSelector({addr: address(handler), selectors: selectors})
+        );
 
-    constructor(ExampleHandler _exampleHandler) {
-        exampleHandler = _exampleHandler;
+        targetContract(address(exampleHandler));
     }
 
     function invariant_underflow() public view {
-        bytes memory x;
-        exampleHandler.ghost_underflow(x);
+        // invariant assertion happens here
     }
 }
 ```
\ No newline at end of file