feat: remediations

src/SentinelList.sol

@@ -39,6 +39,13 @@
         self.entries[SENTINEL] = newEntry;
     }
 
+    function safePush(SentinelList storage self, address newEntry) internal {
+        if (!alreadyInitialized({ self: self })) {
+            init({ self: self });
+        }
+        push({ self: self, newEntry: newEntry });
+    }
+
     function pop(SentinelList storage self, address prevEntry, address popEntry) internal {
         if (popEntry == ZERO_ADDRESS || popEntry == SENTINEL) {
             revert LinkedList_InvalidEntry(prevEntry);
@@ -55,7 +62,6 @@
             next = self.entries[next];
             self.entries[current] = ZERO_ADDRESS;
         }
-        self.entries[SENTINEL] = ZERO_ADDRESS;
     }
 
     function contains(SentinelList storage self, address entry) internal view returns (bool) {
@@ -104,7 +110,7 @@
         // Set correct size of returned array
         // solhint-disable-next-line no-inline-assembly
         /// @solidity memory-safe-assembly
         assembly {
             mstore(array, entryCount)
         }
     }

src/SentinelList4337.sol

@@ -61,6 +61,13 @@
         self.entries[SENTINEL][account] = newEntry;
     }
 
+    function safePush(SentinelList storage self, address account, address newEntry) internal {
+        if (!alreadyInitialized(self, account)) {
+            init({ self: self, account: account });
+        }
+        push({ self: self, account: account, newEntry: newEntry });
+    }
+
     function pop(
         SentinelList storage self,
         address account,
@@ -86,7 +93,6 @@
             next = self.entries[next][account];
             self.entries[current][account] = ZERO_ADDRESS;
         }
-        self.entries[SENTINEL][account] = ZERO_ADDRESS;
     }
 
     function contains(
@@ -146,7 +152,7 @@
         // Set correct size of returned array
         // solhint-disable-next-line no-inline-assembly
         /// @solidity memory-safe-assembly
         assembly {
             mstore(array, entryCount)
         }
     }

src/SentinelListBytes32.sol

@@ -39,6 +39,13 @@
         self.entries[SENTINEL] = newEntry;
     }
 
+    function safePush(LinkedBytes32 storage self, bytes32 newEntry) internal {
+        if (!alreadyInitialized({ self: self })) {
+            init({ self: self });
+        }
+        push({ self: self, newEntry: newEntry });
+    }
+
     function pop(LinkedBytes32 storage self, bytes32 prevEntry, bytes32 popEntry) internal {
         if (popEntry == ZERO || popEntry == SENTINEL) {
             revert LinkedList_InvalidEntry(prevEntry);
@@ -55,7 +62,6 @@
             next = self.entries[next];
             self.entries[current] = ZERO;
         }
-        self.entries[SENTINEL] = ZERO;
     }
 
     function contains(LinkedBytes32 storage self, bytes32 entry) internal view returns (bool) {
@@ -71,7 +77,7 @@
         view
         returns (bytes32[] memory array, bytes32 next)
     {
-        if (start != SENTINEL && contains(self, start)) revert LinkedList_InvalidEntry(start);
+        if (start != SENTINEL && !contains(self, start)) revert LinkedList_InvalidEntry(start);
         if (pageSize == 0) revert LinkedList_InvalidPage();
         // Init array with max page size
         array = new bytes32[](pageSize);
@@ -98,13 +104,13 @@
          *       incSENTINELrent page, nor will it be included in the next one if you pass it as a
          * start.
          */
-        if (next != SENTINEL) {
+        if (next != SENTINEL && entryCount > 0) {
             next = array[entryCount - 1];
         }
         // Set correct size of returned array
         // solhint-disable-next-line no-inline-assembly
         /// @solidity memory-safe-assembly
         assembly {
             mstore(array, entryCount)
         }
     }

test/concrete/SentinelList.tree

@@ -31,6 +31,21 @@ SentinelListLib::push
         └── it should add the entry to the list
 
 
+SentinelListLib::safePush
+├── when list is not initialized
+│   └── it should initialize list
+└── when list is initialized
+    ├── when entry is zero
+    │   └── it should revert
+    ├── when entry is sentinel
+    │   └── it should revert
+    └── when entry is not sentinel
+        ├── when entry is already added
+        │   └── it should revert
+        └── when entry is not added
+            └── it should add the entry to the list
+
+
 SentinelListLib::pop
 ├── when entry is zero
 │   └── it should revert

test/concrete/SentinelList4337Test.t.sol

@@ -116,6 +116,52 @@ contract SentinelList4337Test is Test {
         list.push(account, address(newEntry));
     }
 
+    function test_SafePushWhenListIsNotInitialized() external {
+        // it should initialize list
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(account, newEntry);
+
+        assertTrue(newList.alreadyInitialized(account));
+    }
+
+    function test_SafePushRevertWhen_EntryIsZero() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(account, ZERO_ADDRESS);
+    }
+
+    function test_SafePushRevertWhen_EntryIsSentinel() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(account, SENTINEL);
+    }
+
+    function test_SafePushRevertWhen_EntryIsAlreadyAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should revert
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(account, address(newEntry));
+
+        address next = newList.getNext(account, SENTINEL);
+        assertEq(next, newEntry);
+
+        vm.expectRevert();
+        newList.safePush(account, address(newEntry));
+    }
+
+    function test_SafePushWhenEntryIsNotAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should add the entry to the list
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(account, address(newEntry));
+    }
+
     function test_PopRevertWhen_EntryIsZero() external {
         // it should revert
         vm.expectRevert();
@@ -232,4 +278,8 @@ contract SentinelList4337Test is Test {
     modifier whenEntryIsContainedOrSentinel() {
         _;
     }
+
+    modifier whenListIsInitialized() {
+        _;
+    }
 }

test/concrete/SentinelListBytes32Test.t.sol

@@ -113,6 +113,52 @@ contract SentinelListBytes32Test is Test {
         list.push(bytes32(newEntry));
     }
 
+    function test_SafePushWhenListIsNotInitialized() external {
+        // it should initialize list
+        bytes32 newEntry = keccak256("newEntry");
+        newList.safePush(newEntry);
+
+        assertTrue(newList.alreadyInitialized());
+    }
+
+    function test_SafePushRevertWhen_EntryIsZero() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(ZERO);
+    }
+
+    function test_SafePushRevertWhen_EntryIsSentinel() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(SENTINEL);
+    }
+
+    function test_SafePushRevertWhen_EntryIsAlreadyAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should revert
+        bytes32 newEntry = keccak256("newEntry");
+        newList.safePush(newEntry);
+
+        bytes32 next = newList.getNext(SENTINEL);
+        assertEq(next, newEntry);
+
+        vm.expectRevert();
+        newList.safePush(newEntry);
+    }
+
+    function test_SafePushWhenEntryIsNotAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should add the entry to the list
+        bytes32 newEntry = keccak256("newEntry");
+        newList.safePush(newEntry);
+    }
+
     function test_PopRevertWhen_EntryIsZero() external {
         // it should revert
         vm.expectRevert();
@@ -229,4 +275,8 @@ contract SentinelListBytes32Test is Test {
     modifier whenEntryIsContainedOrSentinel() {
         _;
     }
+
+    modifier whenListIsInitialized() {
+        _;
+    }
 }

test/concrete/SentinelListTest.t.sol

@@ -113,6 +113,52 @@ contract SentinelListTest is Test {
         list.push(address(newEntry));
     }
 
+    function test_SafePushWhenListIsNotInitialized() external {
+        // it should initialize list
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(newEntry);
+
+        assertTrue(newList.alreadyInitialized());
+    }
+
+    function test_SafePushRevertWhen_EntryIsZero() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(ZERO_ADDRESS);
+    }
+
+    function test_SafePushRevertWhen_EntryIsSentinel() external whenListIsInitialized {
+        // it should revert
+        vm.expectRevert();
+        newList.safePush(SENTINEL);
+    }
+
+    function test_SafePushRevertWhen_EntryIsAlreadyAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should revert
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(address(newEntry));
+
+        address next = newList.getNext(SENTINEL);
+        assertEq(next, newEntry);
+
+        vm.expectRevert();
+        newList.safePush(address(newEntry));
+    }
+
+    function test_SafePushWhenEntryIsNotAdded()
+        external
+        whenListIsInitialized
+        whenEntryIsNotSentinel
+    {
+        // it should add the entry to the list
+        address newEntry = makeAddr("newEntry");
+        newList.safePush(address(newEntry));
+    }
+
     function test_PopRevertWhen_EntryIsZero() external {
         // it should revert
         vm.expectRevert();
@@ -229,4 +275,8 @@ contract SentinelListTest is Test {
     modifier whenEntryIsContainedOrSentinel() {
         _;
     }
+
+    modifier whenListIsInitialized() {
+        _;
+    }
 }