Expose binary lookup functions in Checkpoint

.changeset/three-banks-sing.md

@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': patch
+---
+
+Rollback previous commit & added wrapper functions instead

.changeset/tidy-birds-happen.md

@@ -0,0 +1,5 @@
+---
+'openzeppelin-solidity': minor
+---
+
+Expose binary lookup functions in Checkpoint

contracts/utils/structs/Checkpoints.sol

@@ -54,6 +54,22 @@ library Checkpoints {
         return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function lowerBinaryLookup(
+        Trace224 storage self,
+        uint32 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _lowerBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
      * if there is none.
@@ -91,6 +107,22 @@ library Checkpoints {
         return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function upperBinaryLookup(
+        Trace224 storage self,
+        uint32 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _upperBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
      */
@@ -257,6 +289,22 @@ library Checkpoints {
         return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function lowerBinaryLookup(
+        Trace208 storage self,
+        uint48 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _lowerBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
      * if there is none.
@@ -294,6 +342,22 @@ library Checkpoints {
         return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function upperBinaryLookup(
+        Trace208 storage self,
+        uint48 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _upperBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
      */
@@ -460,6 +524,22 @@ library Checkpoints {
         return pos == len ? 0 : _unsafeAccess(self._checkpoints, pos)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function lowerBinaryLookup(
+        Trace160 storage self,
+        uint96 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _lowerBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
      * if there is none.
@@ -497,6 +577,22 @@ library Checkpoints {
         return pos == 0 ? 0 : _unsafeAccess(self._checkpoints, pos - 1)._value;
     }
 
+    /**
+     * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or `high`
+     * if there is none. `low` and `high` define a section where to do the search, with inclusive `low` and exclusive
+     * `high`.
+     *
+     * WARNING: `high` should not be greater than the array's length.
+     */
+    function upperBinaryLookup(
+        Trace160 storage self,
+        uint96 key,
+        uint256 low,
+        uint256 high
+    ) internal view returns (uint256) {
+        return _upperBinaryLookup(self._checkpoints, key, low, high);
+    }
+
     /**
      * @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
      */

scripts/generate/templates/Checkpoints.js

@@ -59,6 +59,22 @@ function lowerLookup(${opts.historyTypeName} storage self, ${opts.keyTypeName} k
     return pos == len ? 0 : _unsafeAccess(self.${opts.checkpointFieldName}, pos).${opts.valueFieldName};
 }
 
+/**
+ * @dev Return the index of the first (oldest) checkpoint with key greater or equal than the search key, or \`high\`
+ * if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and exclusive
+ * \`high\`.
+ *
+ * WARNING: \`high\` should not be greater than the array's length.
+ */
+function lowerBinaryLookup(
+    ${opts.historyTypeName} storage self,
+    ${opts.keyTypeName} key,
+    uint256 low,
+    uint256 high
+) internal view returns (uint256) {
+    return _lowerBinaryLookup(self.${opts.checkpointFieldName}, key, low, high);
+}
+
 /**
  * @dev Returns the value in the last (most recent) checkpoint with key lower or equal than the search key, or zero
  * if there is none.
@@ -96,6 +112,22 @@ function upperLookupRecent(${opts.historyTypeName} storage self, ${opts.keyTypeN
     return pos == 0 ? 0 : _unsafeAccess(self.${opts.checkpointFieldName}, pos - 1).${opts.valueFieldName};
 }
 
+/**
+ * @dev Return the index of the first (oldest) checkpoint with key strictly bigger than the search key, or \`high\`
+ * if there is none. \`low\` and \`high\` define a section where to do the search, with inclusive \`low\` and exclusive
+ * \`high\`.
+ *
+ * WARNING: \`high\` should not be greater than the array's length.
+ */
+function upperBinaryLookup(
+    ${opts.historyTypeName} storage self,
+    ${opts.keyTypeName} key,
+    uint256 low,
+    uint256 high
+) internal view returns (uint256) {
+    return _upperBinaryLookup(self.${opts.checkpointFieldName}, key, low, high);
+}
+
 /**
  * @dev Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
  */