@etherisc/gif-next 0.0.2-c40f9a5 → 0.0.2-c630f3f-038

package/contracts/types/Timestamp.sol

@@ -13,43 +13,90 @@ using {
 } for Timestamp global;
 
 /// @dev return true if Timestamp a is after Timestamp b
-function gtTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) > Timestamp.unwrap(b); }
+function gtTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) > Timestamp.unwrap(b);
+}
+
 /// @dev return true if Timestamp a is after or equal to Timestamp b
-function gteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) >= Timestamp.unwrap(b); }
+function gteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) >= Timestamp.unwrap(b);
+}
 
 /// @dev return true if Timestamp a is before Timestamp b
-function ltTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) < Timestamp.unwrap(b); }
+function ltTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) < Timestamp.unwrap(b);
+}
+
 /// @dev return true if Timestamp a is before or equal to Timestamp b
-function lteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) <= Timestamp.unwrap(b); }
+function lteTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) <= Timestamp.unwrap(b);
+}
 
 /// @dev return true if Timestamp a is equal to Timestamp b
-function eqTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) == Timestamp.unwrap(b); }
+function eqTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) == Timestamp.unwrap(b);
+}
+
 /// @dev return true if Timestamp a is not equal to Timestamp b
-function neTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) != Timestamp.unwrap(b); }
+function neTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
+    return Timestamp.unwrap(a) != Timestamp.unwrap(b);
+}
 
 /// @dev Converts the uint256 to a Timestamp.
-function toTimestamp(uint256 timestamp) pure returns(Timestamp) { return Timestamp.wrap(uint40(timestamp));}
+function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
+    return Timestamp.wrap(uint40(timestamp));
+}
 
-function blockTimestamp() view returns(Timestamp) { return toTimestamp(block.timestamp); }
+function blockTimestamp() view returns (Timestamp) {
+    return toTimestamp(block.timestamp);
+}
 
 /// @dev Return the Timestamp zero (0)
-function zeroTimestamp() pure returns(Timestamp) { return toTimestamp(0); }
+function zeroTimestamp() pure returns (Timestamp) {
+    return toTimestamp(0);
+}
 
 library TimestampLib {
     /// @dev return true if Timestamp a is after Timestamp b
-    function gt(Timestamp a, Timestamp b) public pure returns(bool isAfter) { return gtTimestamp(a, b); }
+    function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {
+        return gtTimestamp(a, b);
+    }
+
     /// @dev return true if Timestamp a is after or the same than Timestamp b
-    function gte(Timestamp a, Timestamp b) public pure returns(bool isAfterOrSame) { return gteTimestamp(a, b); }
+    function gte(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isAfterOrSame) {
+        return gteTimestamp(a, b);
+    }
 
     /// @dev return true if Timestamp a is before Timestamp b
-    function lt(Timestamp a, Timestamp b) public pure returns(bool isBefore) { return ltTimestamp(a, b); }
+    function lt(Timestamp a, Timestamp b) public pure returns (bool isBefore) {
+        return ltTimestamp(a, b);
+    }
+
     /// @dev return true if Timestamp a is before or the same than Timestamp b
-    function lte(Timestamp a, Timestamp b) public pure returns(bool isBeforeOrSame) { return lteTimestamp(a, b); }
+    function lte(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isBeforeOrSame) {
+        return lteTimestamp(a, b);
+    }
 
     /// @dev return true if Timestamp a is equal to Timestamp b
-    function eq(Timestamp a, Timestamp b) public pure returns(bool isSame) { return eqTimestamp(a, b); }
+    function eq(Timestamp a, Timestamp b) public pure returns (bool isSame) {
+        return eqTimestamp(a, b);
+    }
+
     /// @dev return true if Timestamp a is not equal to Timestamp b
-    function ne(Timestamp a, Timestamp b) public pure returns(bool isDifferent) { return neTimestamp(a, b); }
+    function ne(
+        Timestamp a,
+        Timestamp b
+    ) public pure returns (bool isDifferent) {
+        return neTimestamp(a, b);
+    }
 
-    function toInt(Timestamp timestamp) public pure returns(uint256) { return uint256(uint40(Timestamp.unwrap(timestamp))); }
+    function toInt(Timestamp timestamp) public pure returns (uint256) {
+        return uint256(uint40(Timestamp.unwrap(timestamp)));
+    }
 }

package/contracts/types/UFixed.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import { Math } from "@openzeppelin/contracts/utils/math/Math.sol";
+import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 
 /// @dev UFixed is a fixed point number with 18 decimals precision.
 type UFixed is uint256;
@@ -18,59 +18,57 @@ using {
     eqUFixed as ==
 } for UFixed global;
 
-function addUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
 }
 
-function subUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
     return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
 }
 
-function mulUFixed(UFixed a, UFixed b) pure returns(UFixed) {
-    return UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
+function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
+    return
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
 }
 
-function divUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
     require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
 
-    return UFixed.wrap(
-        Math.mulDiv(
-            UFixed.unwrap(a), 
-            10 ** 18,
-            UFixed.unwrap(b)));
+    return
+        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
 }
 
-function gtUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
     return UFixed.unwrap(a) > UFixed.unwrap(b);
 }
 
-function gteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+function gteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
     return UFixed.unwrap(a) >= UFixed.unwrap(b);
 }
 
-function ltUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+function ltUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
     return UFixed.unwrap(a) < UFixed.unwrap(b);
 }
 
-function lteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+function lteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
     return UFixed.unwrap(a) <= UFixed.unwrap(b);
 }
 
-function eqUFixed(UFixed a, UFixed b) pure returns(bool isEqual) {
+function eqUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
     return UFixed.unwrap(a) == UFixed.unwrap(b);
 }
 
-function gtzUFixed(UFixed a) pure returns(bool isZero) {
+function gtzUFixed(UFixed a) pure returns (bool isZero) {
     return UFixed.unwrap(a) > 0;
 }
 
-function eqzUFixed(UFixed a) pure returns(bool isZero) {
+function eqzUFixed(UFixed a) pure returns (bool isZero) {
     return UFixed.unwrap(a) == 0;
 }
 
-function deltaUFixed(UFixed a, UFixed b) pure returns(UFixed) {
-    if(a > b) {
+function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
+    if (a > b) {
         return a - b;
     }
 
@@ -79,42 +77,38 @@ function deltaUFixed(UFixed a, UFixed b) pure returns(UFixed) {
 
 library UFixedMathLib {
 
-    enum Rounding {
-        /// @dev Round down - floor(value)
-        Down, 
-        /// @dev Round up - ceil(value)
-        Up, 
-        /// @dev Round half up - round(value)
-        HalfUp 
-    }
-
     int8 public constant EXP = 18;
     uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
     uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
-    
-    /// @dev Default rounding mode used by ftoi is HalfUp
-    Rounding public constant ROUNDING_DEFAULT = Rounding.HalfUp;
+
+    /// @dev returns the rounding mode DOWN - 0.4 becomes 0, 0.5 becomes 0, 0.6 becomes 0
+    function ROUNDING_DOWN() public pure returns (uint8) {
+        return uint8(0);
+    }
+
+    /// @dev returns the rounding mode UP - 0.4 becomes 1, 0.5 becomes 1, 0.6 becomes 1
+    function ROUNDING_UP() public pure returns (uint8) {
+        return uint8(1);
+    }
+
+    /// @dev returns the rounding mode HALF_UP - 0.4 becomes 0, 0.5 becomes 1, 0.6 becomes 1
+    function ROUNDING_HALF_UP() public pure returns (uint8) {
+        return uint8(2);
+    }
 
     /// @dev returns the decimals precision of the UFixed type
-    function decimals() public pure returns(uint256) {
+    function decimals() public pure returns (uint256) {
         return uint8(EXP);
     }
 
     /// @dev Converts the uint256 to a UFixed.
-    function itof(uint256 a)
-        public
-        pure
-        returns(UFixed)
-    {
+    function itof(uint256 a) public pure returns (UFixed) {
         return UFixed.wrap(a * MULTIPLIER);
     }
 
+    // TODO rename to toUFixed
     /// @dev Converts the uint256 to a UFixed with given exponent.
-    function itof(uint256 a, int8 exp)
-        public
-        pure
-        returns(UFixed)
-    {
+    function itof(uint256 a, int8 exp) public pure returns (UFixed) {
         require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
         require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
 
@@ -122,90 +116,95 @@ library UFixedMathLib {
     }
 
     /// @dev Converts a UFixed to a uint256.
-    function ftoi(UFixed a)
-        public
-        pure
-        returns(uint256)
-    {
-        return ftoi(a, ROUNDING_DEFAULT);
+    function ftoi(UFixed a) public pure returns (uint256) {
+        return ftoi(a, ROUNDING_HALF_UP());
     }
 
     /// @dev Converts a UFixed to a uint256 with given rounding mode.
-    function ftoi(UFixed a, Rounding rounding)
-        public
-        pure
-        returns(uint256)
-    {
-        if(rounding == Rounding.HalfUp) {
-            return Math.mulDiv(UFixed.unwrap(a) + MULTIPLIER_HALF, 1, MULTIPLIER, Math.Rounding.Down);
-        } else if(rounding == Rounding.Down) {
-            return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Down);
+    function ftoi(UFixed a, uint8 rounding) public pure returns (uint256) {
+        if (rounding == ROUNDING_HALF_UP()) {
+            return
+                Math.mulDiv(
+                    UFixed.unwrap(a) + MULTIPLIER_HALF,
+                    1,
+                    MULTIPLIER,
+                    Math.Rounding.Down
+                );
+        } else if (rounding == ROUNDING_DOWN()) {
+            return
+                Math.mulDiv(
+                    UFixed.unwrap(a),
+                    1,
+                    MULTIPLIER,
+                    Math.Rounding.Down
+                );
         } else {
-            return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
+            return
+                Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
         }
     }
 
     /// @dev adds two UFixed numbers
-    function add(UFixed a, UFixed b) public pure returns(UFixed) {
+    function add(UFixed a, UFixed b) public pure returns (UFixed) {
         return addUFixed(a, b);
     }
 
     /// @dev subtracts two UFixed numbers
-    function sub(UFixed a, UFixed b) public pure returns(UFixed) {
+    function sub(UFixed a, UFixed b) public pure returns (UFixed) {
         return subUFixed(a, b);
     }
 
     /// @dev multiplies two UFixed numbers
-    function mul(UFixed a, UFixed b) public pure returns(UFixed) {
+    function mul(UFixed a, UFixed b) public pure returns (UFixed) {
         return mulUFixed(a, b);
     }
 
     /// @dev divides two UFixed numbers
-    function div(UFixed a, UFixed b) public pure returns(UFixed) {
+    function div(UFixed a, UFixed b) public pure returns (UFixed) {
         return divUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is greater than UFixed b
-    function gt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+    function gt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
         return gtUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is greater than or equal to UFixed b
-    function gte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+    function gte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
         return gteUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is less than UFixed b
-    function lt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+    function lt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
         return ltUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is less than or equal to UFixed b
-    function lte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+    function lte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
         return lteUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is equal to UFixed b
-    function eq(UFixed a, UFixed b) public pure returns(bool isEqual) {
+    function eq(UFixed a, UFixed b) public pure returns (bool isEqual) {
         return eqUFixed(a, b);
     }
 
     /// @dev return true if UFixed a is not zero
-    function gtz(UFixed a) public pure returns(bool isZero) {
+    function gtz(UFixed a) public pure returns (bool isZero) {
         return gtzUFixed(a);
     }
 
     /// @dev return true if UFixed a is zero
-    function eqz(UFixed a) public pure returns(bool isZero) {
+    function eqz(UFixed a) public pure returns (bool isZero) {
         return eqzUFixed(a);
     }
 
-    function zero() public pure returns(UFixed) {
+    function zero() public pure returns (UFixed) {
         return UFixed.wrap(0);
     }
 
     /// @dev return the absolute delta between two UFixed numbers
-    function delta(UFixed a, UFixed b) public pure returns(UFixed) {
+    function delta(UFixed a, UFixed b) public pure returns (UFixed) {
         return deltaUFixed(a, b);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-c40f9a5",
+  "version": "0.0.2-c630f3f-038",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,10 @@
     "test": "hh test",
     "ptest": "hh test --parallel",
     "test-with-gas": "REPORT_GAS=true hh test",
-    "coverage": "hh coverage"
+    "coverage": "hh coverage",
+    "styleFix": "prettier --write --plugin=prettier-plugin-solidity 'contracts/**/*.sol' 'test_forge/**/*.t.sol'",
+    "styleCheck": "prettier --check --plugin=prettier-plugin-solidity 'contracts/**/*.sol' 'test_forge/**/*.t.sol'",
+    "lint": "solhint 'contracts/**/*.sol' 'test_forge/**/*.t.sol'"
   },
   "repository": {
     "type": "git",
@@ -25,14 +28,18 @@
   ],
   "homepage": "https://github.com/etherisc/gif-next#readme",
   "devDependencies": {
-    "@nomicfoundation/hardhat-foundry": "^1.0.3",
+    "@nomicfoundation/hardhat-foundry": "^1.1.1",
     "@nomicfoundation/hardhat-toolbox": "^3.0.0",
     "@nomicfoundation/hardhat-verify": "^1.1.1",
     "dotenv": "^16.3.1",
-    "hardhat": "^2.17.1"
+    "hardhat": "^2.17.2",
+    "prettier": "^3.0.3",
+    "prettier-plugin-solidity": "^1.1.3"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.9.3",
-    "@openzeppelin/contracts-upgradeable": "^4.9.3"
+    "@openzeppelin/contracts-upgradeable": "^4.9.3",
+    "ethers": "^6.7.1",
+    "winston": "^3.10.0"
   }
 }