feat: add assertApproxEqAbsDecimal assertions (#191)

* feat: add assertApproxEqAbsDecimal assertions

* feat: add assertApproxEqRelDecimal assertions

Author: aaoferreira

src/StdAssertions.sol

@@ -124,6 +124,31 @@ abstract contract StdAssertions is DSTest {
         }
     }
 
+    function assertApproxEqAbsDecimal(uint256 a, uint256 b, uint256 maxDelta, uint256 decimals) internal virtual {
+        uint256 delta = stdMath.delta(a, b);
+
+        if (delta > maxDelta) {
+            emit log("Error: a ~= b not satisfied [uint]");
+            emit log_named_decimal_uint("  Expected", b, decimals);
+            emit log_named_decimal_uint("    Actual", a, decimals);
+            emit log_named_decimal_uint(" Max Delta", maxDelta, decimals);
+            emit log_named_decimal_uint("     Delta", delta, decimals);
+            fail();
+        }
+    }
+
+    function assertApproxEqAbsDecimal(uint256 a, uint256 b, uint256 maxDelta, uint256 decimals, string memory err)
+        internal
+        virtual
+    {
+        uint256 delta = stdMath.delta(a, b);
+
+        if (delta > maxDelta) {
+            emit log_named_string("Error", err);
+            assertApproxEqAbsDecimal(a, b, maxDelta, decimals);
+        }
+    }
+
     function assertApproxEqAbs(int256 a, int256 b, uint256 maxDelta) internal virtual {
         uint256 delta = stdMath.delta(a, b);
 
@@ -146,6 +171,31 @@ abstract contract StdAssertions is DSTest {
         }
     }
 
+    function assertApproxEqAbsDecimal(int256 a, int256 b, uint256 maxDelta, uint256 decimals) internal virtual {
+        uint256 delta = stdMath.delta(a, b);
+
+        if (delta > maxDelta) {
+            emit log("Error: a ~= b not satisfied [int]");
+            emit log_named_decimal_int("  Expected", b, decimals);
+            emit log_named_decimal_int("    Actual", a, decimals);
+            emit log_named_decimal_uint(" Max Delta", maxDelta, decimals);
+            emit log_named_decimal_uint("     Delta", delta, decimals);
+            fail();
+        }
+    }
+
+    function assertApproxEqAbsDecimal(int256 a, int256 b, uint256 maxDelta, uint256 decimals, string memory err)
+        internal
+        virtual
+    {
+        uint256 delta = stdMath.delta(a, b);
+
+        if (delta > maxDelta) {
+            emit log_named_string("Error", err);
+            assertApproxEqAbsDecimal(a, b, maxDelta, decimals);
+        }
+    }
+
     function assertApproxEqRel(
         uint256 a,
         uint256 b,
@@ -181,6 +231,43 @@ abstract contract StdAssertions is DSTest {
         }
     }
 
+    function assertApproxEqRelDecimal(
+        uint256 a,
+        uint256 b,
+        uint256 maxPercentDelta, // An 18 decimal fixed point number, where 1e18 == 100%
+        uint256 decimals
+    ) internal virtual {
+        if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
+
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        if (percentDelta > maxPercentDelta) {
+            emit log("Error: a ~= b not satisfied [uint]");
+            emit log_named_decimal_uint("    Expected", b, decimals);
+            emit log_named_decimal_uint("      Actual", a, decimals);
+            emit log_named_decimal_uint(" Max % Delta", maxPercentDelta, 18);
+            emit log_named_decimal_uint("     % Delta", percentDelta, 18);
+            fail();
+        }
+    }
+
+    function assertApproxEqRelDecimal(
+        uint256 a,
+        uint256 b,
+        uint256 maxPercentDelta, // An 18 decimal fixed point number, where 1e18 == 100%
+        uint256 decimals,
+        string memory err
+    ) internal virtual {
+        if (b == 0) return assertEq(a, b, err); // If the expected is 0, actual must be too.
+
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        if (percentDelta > maxPercentDelta) {
+            emit log_named_string("Error", err);
+            assertApproxEqRelDecimal(a, b, maxPercentDelta, decimals);
+        }
+    }
+
     function assertApproxEqRel(int256 a, int256 b, uint256 maxPercentDelta) internal virtual {
         if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
 
@@ -206,4 +293,33 @@ abstract contract StdAssertions is DSTest {
             assertApproxEqRel(a, b, maxPercentDelta);
         }
     }
+
+    function assertApproxEqRelDecimal(int256 a, int256 b, uint256 maxPercentDelta, uint256 decimals) internal virtual {
+        if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
+
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        if (percentDelta > maxPercentDelta) {
+            emit log("Error: a ~= b not satisfied [int]");
+            emit log_named_decimal_int("    Expected", b, decimals);
+            emit log_named_decimal_int("      Actual", a, decimals);
+            emit log_named_decimal_uint(" Max % Delta", maxPercentDelta, 18);
+            emit log_named_decimal_uint("     % Delta", percentDelta, 18);
+            fail();
+        }
+    }
+
+    function assertApproxEqRelDecimal(int256 a, int256 b, uint256 maxPercentDelta, uint256 decimals, string memory err)
+        internal
+        virtual
+    {
+        if (b == 0) return assertEq(a, b, err); // If the expected is 0, actual must be too.
+
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        if (percentDelta > maxPercentDelta) {
+            emit log_named_string("Error", err);
+            assertApproxEqRelDecimal(a, b, maxPercentDelta, decimals);
+        }
+    }
 }