Merge pull request #40 from morpho-labs/refactor/remove-bucket-dll-getters

Remove bucket DLL getters

Author: QGarchery

src/BucketDLL.sol

@@ -19,36 +19,15 @@ library BucketDLL {
 
     /* INTERNAL */
 
-    /// @notice Returns the address at the head of the `list`.
-    /// @param list The list from which to get the head.
-    /// @return The address of the head.
-    function getHead(List storage list) internal view returns (address) {
-        return list.accounts[address(0)].next;
-    }
-
-    /// @notice Returns the address at the tail of the `list`.
-    /// @param list The list from which to get the tail.
-    /// @return The address of the tail.
-    function getTail(List storage list) internal view returns (address) {
-        return list.accounts[address(0)].prev;
-    }
-
     /// @notice Returns the next id address from the current `id`.
+    /// @dev Pass the address 0 to get the head of the list.
     /// @param list The list to search in.
     /// @param id The address of the current account.
     /// @return The address of the next account.
     function getNext(List storage list, address id) internal view returns (address) {
         return list.accounts[id].next;
     }
 
-    /// @notice Returns the previous id address from the current `id`.
-    /// @param list The list to search in.
-    /// @param id The address of the current account.
-    /// @return The address of the previous account.
-    function getPrev(List storage list, address id) internal view returns (address) {
-        return list.accounts[id].prev;
-    }
-
     /// @notice Removes an account of the `list`.
     /// @dev This function should not be called with `id` equal to address 0.
     /// @dev This function should not be called with an `_id` that is not in the list.
@@ -70,7 +49,7 @@ library BucketDLL {
 
     /// @notice Inserts an account in the `list`.
     /// @dev This function should not be called with `id` equal to address 0.
-    /// @dev This function should not be called with an `_id` that is already in the list.
+    /// @dev This function should not be called with an `id` that is already in the list.
     /// @param list The list to search in.
     /// @param id The address of the account.
     /// @param atHead Tells whether to insert at the head or at the tail of the list.

src/LogarithmicBuckets.sol

@@ -72,12 +72,12 @@ library LogarithmicBuckets {
         if (bucketsMask == 0) return address(0);
 
         uint256 next = nextBucket(value, bucketsMask);
-        if (next != 0) return buckets.buckets[next].getHead();
+        if (next != 0) return buckets.buckets[next].getNext(address(0));
 
         // `highestSetBit` is used to compute the highest non-empty bucket.
         // Knowing that `next` == 0, it is also the highest previous non-empty bucket.
         uint256 prev = highestSetBit(bucketsMask);
-        return buckets.buckets[prev].getHead();
+        return buckets.buckets[prev].getNext(address(0));
     }
 
     /* PRIVATE */

test/TestBucketDLL.t.sol

@@ -2,10 +2,10 @@
 pragma solidity ^0.8.0;
 
 import "forge-std/Test.sol";
-import "src/BucketDLL.sol";
+import "./mocks/BucketDLLMock.sol";
 
 contract TestBucketDLL is Test {
-    using BucketDLL for BucketDLL.List;
+    using BucketDLLMock for BucketDLL.List;
 
     uint256 internal numberOfAccounts = 50;
     address[] public accounts;

test/TestLogarithmicBuckets.t.sol

@@ -5,7 +5,7 @@ import "forge-std/Test.sol";
 import "./mocks/LogarithmicBucketsMock.sol";
 
 contract TestLogarithmicBuckets is LogarithmicBucketsMock, Test {
-    using BucketDLL for BucketDLL.List;
+    using BucketDLLMock for BucketDLL.List;
     using LogarithmicBuckets for LogarithmicBuckets.Buckets;
 
     uint256 public accountsLength = 50;

test/TestLogarithmicBucketsInvariant.t.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.0;
 
 import "./helpers/Random.sol";
 import "./mocks/LogarithmicBucketsMock.sol";
+import "./mocks/BucketDLLMock.sol";
 import "forge-std/Test.sol";
 
 contract TestLogarithmicBucketsInvariant is Test, Random {
@@ -31,7 +32,7 @@ contract TestLogarithmicBucketsInvariant is Test, Random {
 }
 
 contract LogarithmicBucketsSeenMock is LogarithmicBucketsMock {
-    using BucketDLL for BucketDLL.List;
+    using BucketDLLMock for BucketDLL.List;
     using LogarithmicBuckets for LogarithmicBuckets.Buckets;
 
     address[] public seen;

test/mocks/BucketDLLMock.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity ^0.8.0;
+
+import "src/BucketDLL.sol";
+
+library BucketDLLMock {
+    function remove(BucketDLL.List storage _list, address _id) internal returns (bool) {
+        return BucketDLL.remove(_list, _id);
+    }
+
+    function insert(
+        BucketDLL.List storage _list,
+        address _id,
+        bool _head
+    ) internal returns (bool) {
+        return BucketDLL.insert(_list, _id, _head);
+    }
+
+    function getNext(BucketDLL.List storage _list, address _id) internal view returns (address) {
+        return BucketDLL.getNext(_list, _id);
+    }
+
+    function getHead(BucketDLL.List storage _list) internal view returns (address) {
+        return _list.accounts[address(0)].next;
+    }
+
+    function getPrev(BucketDLL.List storage _list, address _id) internal view returns (address) {
+        return _list.accounts[_id].prev;
+    }
+
+    function getTail(BucketDLL.List storage _list) internal view returns (address) {
+        return _list.accounts[address(0)].prev;
+    }
+}

test/mocks/LogarithmicBucketsMock.sol

@@ -2,9 +2,10 @@
 pragma solidity ^0.8.0;
 
 import "src/LogarithmicBuckets.sol";
+import "./BucketDLLMock.sol";
 
 contract LogarithmicBucketsMock {
-    using BucketDLL for BucketDLL.List;
+    using BucketDLLMock for BucketDLL.List;
     using LogarithmicBuckets for LogarithmicBuckets.Buckets;
 
     LogarithmicBuckets.Buckets public buckets;