feat: introduce safecast safeguards

reservoir-labs · Mar 4, 2024 · 63fda06 · 63fda06
1 parent ccb3390
commit 63fda06
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/src/curve/constant-product/ConstantProductPair.sol b/src/curve/constant-product/ConstantProductPair.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity ^0.8.0;
 
+import { SafeCastLib } from "solady/utils/SafeCastLib.sol";
+
 import { Math } from "@openzeppelin/utils/math/Math.sol";
 import { FixedPointMathLib } from "solady/utils/FixedPointMathLib.sol";
 
@@ -245,9 +247,10 @@ contract ConstantProductPair is ReservoirPair {
                 previous.logAccClampedPrice + int56(logInstantClampedPrice) * int56(int256(uint256(aTimeElapsed)));
             _slot0.index += 1;
             _observations[_slot0.index] = Observation(
-                logInstantRawPrice,
-                logInstantClampedPrice,
-                logAccRawPrice,
+                // TODO: prove that these values are guaranteed <=int56 to remove these safe casts
+                SafeCastLib.toInt56(logInstantRawPrice),
+                SafeCastLib.toInt56(logInstantClampedPrice),
+                SafeCastLib.toInt56(logAccRawPrice),
                 logAccClampedPrice,
                 aCurrentTimestamp
             );

diff --git a/src/curve/stable/StablePair.sol b/src/curve/stable/StablePair.sol
@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 pragma solidity ^0.8.0;
 
+import { SafeCastLib } from "solady/utils/SafeCastLib.sol";
+
 import { IReservoirCallee } from "src/interfaces/IReservoirCallee.sol";
 import { IGenericFactory } from "src/interfaces/IGenericFactory.sol";
 
@@ -300,9 +302,10 @@ contract StablePair is ReservoirPair {
                 previous.logAccClampedPrice + int56(logInstantClampedPrice) * int56(int256(uint256(aTimeElapsed)));
             _slot0.index += 1;
             _observations[_slot0.index] = Observation(
-                logInstantRawPrice,
-                logInstantClampedPrice,
-                logAccRawPrice,
+                // TODO: prove that these values are guaranteed <=int56 to remove these safe casts
+                SafeCastLib.toInt56(logInstantRawPrice),
+                SafeCastLib.toInt56(logInstantClampedPrice),
+                SafeCastLib.toInt56(logAccRawPrice),
                 logAccClampedPrice,
                 aCurrentTimestamp
             );

diff --git a/src/libraries/StableOracleMath.sol b/src/libraries/StableOracleMath.sol
@@ -28,9 +28,9 @@ library StableOracleMath {
 
     /// @notice Calculates the spot price of token1 in token0
     /// @param amplificationParameter in precise form (see StableMath.A_PRECISION)
-    /// @param reserve0 token0 reserves normalized to 18 decimals
-    /// @param reserve1 token1 reserves normalized to 18 decimals
-    /// @return spotPrice price where 1e18 == 1
+    /// @param reserve0 normalized to 18 decimals
+    /// @param reserve1 normalized to 18 decimals
+    /// @return spotPrice 18 decimal fixed point number. Minimum price is 1e-18 (1 wei)
     function calcSpotPrice(uint256 amplificationParameter, uint256 reserve0, uint256 reserve1)
         internal
         pure