@etherisc/gif-next 0.0.2-d911522 → 0.0.2-d96b9e1-825

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;
@@ -15,62 +15,61 @@ using {
     gteUFixed as >=,
     ltUFixed as <,
     lteUFixed as <=,
-    eqUFixed as ==
+    eqUFixed as ==,
+    UFixedMathLib.toInt
 } 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;
     }
 
@@ -78,130 +77,130 @@ function deltaUFixed(UFixed a, UFixed b) pure returns(UFixed) {
 }
 
 library UFixedMathLib {
-
     enum Rounding {
         /// @dev Round down - floor(value)
-        Down, 
+        Down,
         /// @dev Round up - ceil(value)
-        Up, 
+        Up,
         /// @dev Round half up - round(value)
-        HalfUp 
+        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 decimals precision of the UFixed type
-    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 toUFixed(uint256 a) public pure returns (UFixed) {
         return UFixed.wrap(a * MULTIPLIER);
     }
 
     /// @dev Converts the uint256 to a UFixed with given exponent.
-    function itof(uint256 a, int8 exp)
-        public
-        pure
-        returns(UFixed)
-    {
+    function toUFixed(uint256 a, int8 exp) public pure returns (UFixed) {
         require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
-        require(EXP + exp <= 2 * EXP, "ERROR:FM-011:EXPONENT_TOO_LARGE");
+        require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
 
         return UFixed.wrap(a * 10 ** uint8(EXP + exp));
     }
 
+    /// @dev Default rounding mode used by ftoi is HalfUp
+    Rounding public constant ROUNDING_DEFAULT = Rounding.HalfUp;
+
+    /// @dev returns the decimals precision of the UFixed type
+    function decimals() public pure returns (uint256) {
+        return uint8(EXP);
+    }
+
     /// @dev Converts a UFixed to a uint256.
-    function ftoi(UFixed a)
-        public
-        pure
-        returns(uint256)
-    {
-        return ftoi(a, ROUNDING_DEFAULT);
+    function toInt(UFixed a) public pure returns (uint256) {
+        return toIntWithRounding(a, ROUNDING_DEFAULT);
     }
 
     /// @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 toIntWithRounding(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
+                );
         } 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) {
+        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/contracts/types/Version.sol

@@ -0,0 +1,95 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type VersionPart is uint8;
+
+using {
+    versionPartGt as >,
+    versionPartEq as ==,
+    VersionPartLib.toInt
+}
+    for VersionPart global;
+
+function versionPartGt(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) > VersionPart.unwrap(b); }
+function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) == VersionPart.unwrap(b); }
+
+library VersionPartLib {
+    function toInt(VersionPart x) external pure returns(uint) { return VersionPart.unwrap(x); }
+}
+
+type Version is uint24; // contains major,minor,patch version parts
+
+using {
+    versionGt as >,
+    versionEq as ==,
+    VersionLib.toInt,
+    VersionLib.toMajorPart,
+    VersionLib.toVersionParts
+}
+    for Version global;
+
+function versionGt(Version a, Version b) pure returns(bool isGreaterThan) { return Version.unwrap(a) > Version.unwrap(b); }
+function versionEq(Version a, Version b) pure returns(bool isSame) { return Version.unwrap(a) == Version.unwrap(b); }
+
+library VersionLib {
+    function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
+
+    function toMajorPart(Version version)
+        external    
+        pure 
+        returns(VersionPart major)
+    { 
+        uint24 versionInt = Version.unwrap(version);
+        uint8 majorInt = uint8(versionInt >> 16);
+        return VersionPart.wrap(majorInt);
+    }
+
+    function toVersionParts(Version version)
+        external
+        pure
+        returns(
+            VersionPart major,
+            VersionPart minor,
+            VersionPart patch
+        )
+    {
+        uint24 versionInt = Version.unwrap(version);
+        uint8 majorInt = uint8(versionInt >> 16);
+
+        versionInt -= majorInt << 16;
+        uint8 minorInt = uint8(versionInt >> 8);
+        uint8 patchInt = uint8(versionInt - (minorInt << 8));
+
+        return (
+            VersionPart.wrap(majorInt),
+            VersionPart.wrap(minorInt),
+            VersionPart.wrap(patchInt)
+        );
+    }
+
+    function toVersionPart(uint256 versionPart) external pure returns(VersionPart) { 
+        return VersionPart.wrap(uint8(versionPart)); 
+    }
+
+    function toVersion(
+        uint256 major,
+        uint256 minor,
+        uint256 patch
+    )
+        external
+        pure
+        returns(Version)
+    {
+        require(
+            major < 256 && minor < 256 && patch < 256,
+            "ERROR:VRS-010:VERSION_PART_TOO_BIG");
+
+        return Version.wrap(
+            uint24(
+                (major << 16) + (minor << 8) + patch));
+    }
+
+    function zeroVersion() external pure returns(Version) {
+        return Version.wrap(0);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-d911522",
+  "version": "0.0.2-d96b9e1-825",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,11 @@
     "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'",
+    "eslint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -25,10 +29,17 @@
   ],
   "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",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
     "dotenv": "^16.3.1",
-    "hardhat": "^2.17.1"
+    "eslint": "^8.50.0",
+    "hardhat": "^2.17.2",
+    "prettier": "^3.0.3",
+    "prettier-plugin-solidity": "^1.1.3",
+    "typescript": "^5"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.9.3",

package/artifacts/contracts/components/Component.sol/Component.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/components/Component.sol/InstanceLinked.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/components/Component.sol/InstanceLinked.json

@@ -1,35 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "InstanceLinked",
-  "sourceName": "contracts/components/Component.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "instance",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "constructor"
-    },
-    {
-      "inputs": [],
-      "name": "getInstance",
-      "outputs": [
-        {
-          "internalType": "contract IInstance",
-          "name": "instance",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x608060405234801561001057600080fd5b50604051610249380380610249833981810160405281019061003291906100db565b806000806101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff16021790555050610108565b600080fd5b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b60006100a88261007d565b9050919050565b6100b88161009d565b81146100c357600080fd5b50565b6000815190506100d5816100af565b92915050565b6000602082840312156100f1576100f0610078565b5b60006100ff848285016100c6565b91505092915050565b610132806101176000396000f3fe6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220e78278246c3e44db4b709006b118bd00a9bc3a08e56a0bb4d74c0cc55c10b23c64736f6c63430008140033",
-  "deployedBytecode": "0x6080604052348015600f57600080fd5b506004361060285760003560e01c8063de7b5d1414602d575b600080fd5b60336047565b604051603e919060e3565b60405180910390f35b60008060009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b600073ffffffffffffffffffffffffffffffffffffffff82169050919050565b6000819050919050565b600060af60ab60a7846070565b6090565b6070565b9050919050565b600060bf82609a565b9050919050565b600060cf8260b6565b9050919050565b60dd8160c6565b82525050565b600060208201905060f6600083018460d6565b9291505056fea2646970667358221220e78278246c3e44db4b709006b118bd00a9bc3a08e56a0bb4d74c0cc55c10b23c64736f6c63430008140033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/components/IPool.sol/IPoolComponent.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/components/IProduct.sol/IProductComponent.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/access/Access.sol/AccessModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccess.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccessCheckRole.json

@@ -1,35 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IAccessCheckRole",
-  "sourceName": "contracts/instance/access/IAccess.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "address",
-          "name": "member",
-          "type": "address"
-        }
-      ],
-      "name": "hasRole",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccessComponentTypeRoles.json

@@ -1,50 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IAccessComponentTypeRoles",
-  "sourceName": "contracts/instance/access/IAccess.sol",
-  "abi": [
-    {
-      "inputs": [],
-      "name": "ORACLE_OWNER_ROLE",
-      "outputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "POOL_OWNER_ROLE",
-      "outputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "PRODUCT_OWNER_ROLE",
-      "outputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/instance/access/IAccess.sol/IAccessModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}

package/artifacts/contracts/instance/component/ComponentModule.sol/ComponentOwnerService.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/5d58518916abd285d6742c7724f5c203.json"
-}