From 9e338421dae536c253209094a3d28428bc8d0ec7 Mon Sep 17 00:00:00 2001
From: Sujith <somraajsujith@gmail.com>
Date: Tue, 17 Oct 2023 20:24:19 -0400
Subject: [PATCH] feat: invariants for adapter add

---
 .../invariant-tests/AdapterList.Invariant.sol | 61 +++++++++++++++++++
 .../handlers/SenderAdapterAdd.handler.sol     | 47 ++++++++++++++
 2 files changed, 108 insertions(+)
 create mode 100644 test/invariant-tests/AdapterList.Invariant.sol
 create mode 100644 test/invariant-tests/handlers/SenderAdapterAdd.handler.sol

diff --git a/test/invariant-tests/AdapterList.Invariant.sol b/test/invariant-tests/AdapterList.Invariant.sol
new file mode 100644
index 0000000..aa214ed
--- /dev/null
+++ b/test/invariant-tests/AdapterList.Invariant.sol
@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity >=0.8.9;
+
+/// library imports
+import {Vm, Test} from "forge-std/Test.sol";
+
+/// local imports
+import "test/Setup.t.sol";
+import "test/contracts-mock/MockUniswapReceiver.sol";
+
+/// handler import
+import {SenderAdapterAddHandler} from "test/invariant-tests/handlers/SenderAdapterAdd.handler.sol";
+
+/// @notice invariants for adding adapters to multi bridge sender
+contract AdapterListInvariant is Setup {
+    SenderAdapterAddHandler public handler;
+
+    /// @notice initializes the setup
+    function setUp() public override {
+        /// @dev calls setup to spin up test contracts
+        super.setUp();
+
+        /// @dev selects fork and deploy the handlers
+        vm.selectFork(fork[SRC_CHAIN_ID]);
+        handler = new SenderAdapterAddHandler(
+            contractAddress[SRC_CHAIN_ID]["GAC"],
+            contractAddress[SRC_CHAIN_ID]["MMA_SENDER"]
+        );
+        targetContract(address(handler));
+    }
+
+    /// @notice invariant-1: adding an adapter should always increase the length of the adapter list
+    /// @notice invariant-2: once a trusted executor is added, its entry should exist in the adapter list
+    /// @notice invariant-3:  the adapter list should never contain duplicates
+    /// @notice invariant-4:  the adapter list should always be in orde
+    function invariant_test_adapter_additions() public {
+        MultiBridgeMessageSender targetContract = MultiBridgeMessageSender(contractAddress[SRC_CHAIN_ID]["MMA_SENDER"]);
+        if (handler.success()) {
+            uint256 currAdds = handler.currAdds();
+
+            address newAddition = targetContract.senderAdapters(currAdds - 1);
+            /// @dev if this asset passes then invariant-2 holds
+            assertTrue(newAddition != address(0));
+
+            /// @dev if this revert then the final index is currAdds - 1 and the invariant-1 holds
+            try targetContract.senderAdapters(currAdds) {
+                assertFalse(1 == 2);
+            } catch {}
+
+            /// @dev assertions for invariant-3 and invariant-4
+            if (currAdds > 1) {
+                for (uint256 i = currAdds; i > 0; i--) {
+                    assertTrue(
+                        targetContract.senderAdapters(i)
+                            > targetContract.senderAdapters(i - 1)
+                    );
+                }
+            }
+        }
+    }
+}
diff --git a/test/invariant-tests/handlers/SenderAdapterAdd.handler.sol b/test/invariant-tests/handlers/SenderAdapterAdd.handler.sol
new file mode 100644
index 0000000..05024ae
--- /dev/null
+++ b/test/invariant-tests/handlers/SenderAdapterAdd.handler.sol
@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity >=0.8.9;
+
+/// library imports
+import "forge-std/Test.sol";
+
+/// library imports
+import {MessageSenderGAC} from "src/controllers/MessageSenderGAC.sol";
+import {MultiBridgeMessageSender} from "src/MultiBridgeMessageSender.sol";
+
+/// @notice handler for testing adding adapters to multi message sender
+/// @dev simulates the ideal criteria for a successful adapter addition
+contract SenderAdapterAddHandler is Test {
+    /// @notice local state
+    MultiBridgeMessageSender public multiBridgeMessageSender;
+    MessageSenderGAC public gac;
+
+    bool public success;
+    uint256 public currAdds;
+
+    /// @notice modifier to prank the add sender adapter call
+    modifier prank(address _prankster) {
+        vm.startPrank(_prankster);
+        _;
+        vm.stopPrank();
+    }
+
+    /// @notice initial setup contracts
+    constructor(address _gac, address _multiBridge) {
+        gac = MessageSenderGAC(_gac);
+        multiBridgeMessageSender = MultiBridgeMessageSender(_multiBridge);
+    }
+
+    /// @notice helper for adding new adapters
+    function addSenderAdapters(address _newSenderAdapter) external prank(gac.getGlobalOwner()) {
+        success = false;
+        vm.assume(_newSenderAdapter != address(0));
+
+        address[] memory _additions = new address[](1);
+        _additions[0] = _newSenderAdapter;
+
+        try multiBridgeMessageSender.addSenderAdapters(_additions) {
+            success = true;
+            currAdds++;
+        } catch {}
+    }
+}