@etherisc/gif-next 0.0.2-f99f1d2-109 → 0.0.2-f9bc4c7-556

package/contracts/types/Fee.sol

@@ -1,32 +1,51 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {UFixed} from "./UFixed.sol";
+import {UFixed, UFixedMathLib} from "./UFixed.sol";
 
 struct Fee {
     UFixed fractionalFee;
     uint256 fixedFee;
 }
 
-// general pure free functions
-/// @dev Converts the uint256 to a NftId.
-function toFee(
-    UFixed fractionalFee,
-    uint256 fixedFee
-) pure returns (Fee memory fee) {
-    return Fee(fractionalFee, fixedFee);
-}
+library FeeLib {
 
-/// @dev Return the NftId zero (0)
-function zeroFee() pure returns (Fee memory fee) {
-    return Fee(UFixed.wrap(0), 0);
-}
+    function calculateFee(
+        uint256 amount,
+        Fee memory fee
+    )
+        public
+        pure
+        returns (
+            uint256 feeAmount, 
+            uint256 netAmount
+        )
+    {
+        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
+            fee.fractionalFee;
+        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
+        netAmount = amount - feeAmount;
+    }
 
-// pure free functions for operators
-function feeIsSame(Fee memory a, Fee memory b) pure returns (bool isSame) {
-    return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
-}
+    /// @dev Converts the uint256 to a fee struct.
+    function toFee(
+        UFixed fractionalFee,
+        uint256 fixedFee
+    ) public pure returns (Fee memory fee) {
+        return Fee(fractionalFee, fixedFee);
+    }
 
-function feeIsZero(Fee memory fee) pure returns (bool) {
-    return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
-}
+    /// @dev Return the zero fee struct (0, 0)
+    function zeroFee() public pure returns (Fee memory fee) {
+        return Fee(UFixed.wrap(0), 0);
+    }
+
+    // pure free functions for operators
+    function feeIsSame(Fee memory a, Fee memory b) public pure returns (bool isSame) {
+        return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
+    }
+
+    function feeIsZero(Fee memory fee) public pure returns (bool) {
+        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+    }
+}

package/contracts/types/Key32.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "./ObjectType.sol";
+
+type Key32 is bytes32;
+type KeyId is bytes31;
+
+// type bindings
+using {
+    eqKey32 as ==, 
+    neKey32 as !=,
+    Key32Lib.toKey
+} for Key32 global;
+
+// @dev Returns true iff keys are identical
+function eqKey32(Key32 a, Key32 b) pure returns (bool isSame) {
+    return Key32.unwrap(a) == Key32.unwrap(b);
+}
+
+// @dev Returns true iff keys are different
+function neKey32(Key32 a, Key32 b) pure returns (bool isDifferent) {
+    return Key32.unwrap(a) != Key32.unwrap(b);
+}
+
+library Key32Lib {
+
+    uint8 public constant TYPE_SHIFT = 31 * 8;
+    uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+
+    function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
+        uint256 uintObjectType = ObjectType.unwrap(objectType);
+        uint256 uintId = uint248(KeyId.unwrap(id));
+        uint256 uintKey = (uintObjectType << TYPE_SHIFT) + uintId;
+        return Key32.wrap(bytes32(uintKey));
+    }
+
+    function toKey(Key32 key) public pure returns (ObjectType objectType, KeyId id) {
+        bytes32 key32 = Key32.unwrap(key);
+        objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
+        id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
+    }
+}

package/contracts/types/NftId.sol

@@ -1,11 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ObjectType} from "./ObjectType.sol";
+
 // uint96 allows for chain ids up to 13 digits
 type NftId is uint96;
 
 // type bindings
-using {eqNftId as ==, neNftId as !=, NftIdLib.toInt} for NftId global;
+using {
+    eqNftId as ==, 
+    neNftId as !=, 
+    NftIdLib.toInt,
+    NftIdLib.gtz,
+    NftIdLib.eqz,
+    NftIdLib.toKeyId,
+    NftIdLib.toKey32
+} for NftId global;
 
 // general pure free functions
 /// @dev Converts the uint256 to a NftId.
@@ -48,4 +59,14 @@ library NftIdLib {
     function eq(NftId a, NftId b) public pure returns (bool isSame) {
         return eqNftId(a, b);
     }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(NftId id, ObjectType objectType) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(objectType, toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(NftId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
+    }
 }

package/contracts/types/NftIdSet.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library LibNftIdSet {
+
+    struct Set {
+        NftId[] ids;
+        mapping(NftId nftid => uint256 index) at;
+    }
+
+    function add(Set storage set, NftId nftId) external returns(bool added) {
+        if (set.at[nftId] == 0) {
+            set.ids.push(nftId);
+            set.at[nftId] = set.ids.length;
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function remove(Set storage set, NftId nftId) external returns(bool removed) {
+        uint256 nftIdIndex = set.at[nftId];
+
+        if (nftIdIndex > 0) {
+            uint256 toDeleteIndex = nftIdIndex - 1;
+            uint256 lastIndex = set.ids.length - 1;
+
+            if (lastIndex != toDeleteIndex) {
+                NftId lastId = set.ids[lastIndex];
+                set.ids[toDeleteIndex] = lastId;
+                set.at[lastId] = nftIdIndex; // Replace lastValue's index to valueIndex
+            }
+
+            set.ids.pop();
+            delete set.at[nftId];
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.ids.length == 0;
+    }
+
+    function contains(Set storage set, NftId nftId) external view returns(bool inSet) {
+        return set.at[nftId] > 0;
+    }
+
+    function getLength(Set storage set) external view returns(uint256 length) {
+        return set.ids.length;
+    }
+
+    function getElementAt(Set storage set, uint256 index) external view returns(NftId nftId) {
+        return set.ids[index];
+    }
+}

package/contracts/types/ObjectType.sol

@@ -1,14 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-// uint96 allows for chain ids up to 13 digits
 type ObjectType is uint8;
 
 // type bindings
 using {
     eqObjectType as ==,
     neObjectType as !=,
-    ObjectTypeLib.toInt
+    ObjectTypeLib.toInt,
+    ObjectTypeLib.gtz
 } for ObjectType global;
 
 // general pure free functions
@@ -17,15 +17,15 @@ function PROTOCOL() pure returns (ObjectType) {
     return toObjectType(10);
 }
 
-function CHAIN() pure returns (ObjectType) {
+function REGISTRY() pure returns (ObjectType) {
     return toObjectType(20);
 }
 
-function REGISTRY() pure returns (ObjectType) {
+function TOKEN() pure returns (ObjectType) {
     return toObjectType(30);
 }
 
-function TOKEN() pure returns (ObjectType) {
+function SERVICE() pure returns (ObjectType) {
     return toObjectType(40);
 }
 
@@ -33,32 +33,40 @@ function INSTANCE() pure returns (ObjectType) {
     return toObjectType(50);
 }
 
-function PRODUCT() pure returns (ObjectType) {
+function STAKE() pure returns (ObjectType) {
     return toObjectType(60);
 }
 
+function PRODUCT() pure returns (ObjectType) {
+    return toObjectType(100);
+}
+
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return toObjectType(110);
+}
+
 function ORACLE() pure returns (ObjectType) {
-    return toObjectType(70);
+    return toObjectType(120);
 }
 
 function POOL() pure returns (ObjectType) {
-    return toObjectType(80);
+    return toObjectType(130);
 }
 
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(81);
+function POLICY() pure returns (ObjectType) {
+    return toObjectType(200);
 }
 
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(90);
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(210);
 }
 
 function CLAIM() pure returns (ObjectType) {
-    return toObjectType(91);
+    return toObjectType(201);
 }
 
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(92);
+    return toObjectType(202);
 }
 
 /// @dev Converts the uint8 to a ObjectType.

package/contracts/types/RoleId.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type RoleId is bytes8;
+
+// type bindings
+using {
+    eqRoleId as ==, 
+    neRoleId as !=
+} for RoleId global;
+
+// general pure free functions
+function DISTRIBUTOR_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributorOwnerRole"; }
+function ORACLE_OWNER_ROLE_NAME() pure returns (string memory) { return "OracleOwnerRole"; }
+function POOL_OWNER_ROLE_NAME() pure returns (string memory) { return "PoolOwnerRole"; }
+function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "ProductOwnerRole"; }
+
+function DISTRIBUTOR_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("DistributorOwnerRole"); }
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("OracleOwnerRole"); }
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("PoolOwnerRole"); }
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("ProductOwnerRole"); }
+
+// @dev Returns true iff role ids a and b are identical
+function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
+    return RoleId.unwrap(a) == RoleId.unwrap(b);
+}
+
+// @dev Returns true iff role ids a and b are different
+function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
+    return RoleId.unwrap(a) != RoleId.unwrap(b);
+}
+
+library RoleIdLib {
+    // @dev Converts a role string into a role id.
+    function toRoleId(string memory role) public pure returns (RoleId) {
+        return RoleId.wrap(bytes8(keccak256(abi.encode(role))));
+    }
+}

package/contracts/types/StateId.sol

@@ -5,7 +5,13 @@ pragma solidity ^0.8.19;
 type StateId is uint8;
 
 // type bindings
-using {eqStateId as ==, neStateId as !=, StateIdLib.toInt} for StateId global;
+using {
+    eqStateId as ==, 
+    neStateId as !=, 
+    StateIdLib.eqz,
+    StateIdLib.gtz,
+    StateIdLib.toInt
+} for StateId global;
 
 // general pure free functions
 function APPLIED() pure returns (StateId) {
@@ -20,14 +26,18 @@ function DECLINED() pure returns (StateId) {
     return toStateId(30);
 }
 
-function CONFIRMED() pure returns (StateId) {
+function UNDERWRITTEN() pure returns (StateId) {
     return toStateId(40);
 }
 
-function EXPECTED() pure returns (StateId) {
+function CONFIRMED() pure returns (StateId) {
     return toStateId(50);
 }
 
+function EXPECTED() pure returns (StateId) {
+    return toStateId(60);
+}
+
 function ACTIVE() pure returns (StateId) {
     return toStateId(100);
 }

package/contracts/types/Timestamp.sol

@@ -9,7 +9,10 @@ using {
     ltTimestamp as <,
     lteTimestamp as <=,
     eqTimestamp as ==,
-    neTimestamp as !=
+    neTimestamp as !=,
+    TimestampLib.gtz,
+    TimestampLib.eqz,
+    TimestampLib.addSeconds
 } for Timestamp global;
 
 /// @dev return true if Timestamp a is after Timestamp b
@@ -96,6 +99,24 @@ library TimestampLib {
         return neTimestamp(a, b);
     }
 
+    /// @dev return true if Timestamp is larger than 0
+    function gtz(Timestamp timestamp) public pure returns (bool) {
+        return Timestamp.unwrap(timestamp) > 0;
+    }
+
+    /// @dev return true if Timestamp equals 0
+    function eqz(Timestamp timestamp) public pure returns (bool) {
+        return Timestamp.unwrap(timestamp) == 0;
+    }
+
+    /// @dev return true if Timestamp a is not equal to Timestamp b
+    function addSeconds(
+        Timestamp timestamp,
+        uint256 timeDelta
+    ) public pure returns (Timestamp) {
+        return toTimestamp(Timestamp.unwrap(timestamp) + uint40(timeDelta));
+    }
+
     function toInt(Timestamp timestamp) public pure returns (uint256) {
         return uint256(uint40(Timestamp.unwrap(timestamp)));
     }

package/contracts/types/UFixed.sol

@@ -15,7 +15,8 @@ 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) {
@@ -76,49 +77,51 @@ 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 decimals precision of the UFixed type
-    function decimals() public pure returns (uint256) {
-        return uint8(EXP);
+    /// @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 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);
     }
 
-    // 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 toUFixed(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");
 
         return UFixed.wrap(a * 10 ** uint8(EXP + exp));
     }
 
+    /// @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_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) {
+    function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
+        if (rounding == ROUNDING_HALF_UP()) {
             return
                 Math.mulDiv(
                     UFixed.unwrap(a) + MULTIPLIER_HALF,
@@ -126,7 +129,7 @@ library UFixedMathLib {
                     MULTIPLIER,
                     Math.Rounding.Down
                 );
-        } else if (rounding == Rounding.Down) {
+        } else if (rounding == ROUNDING_DOWN()) {
             return
                 Math.mulDiv(
                     UFixed.unwrap(a),

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-f99f1d2-109",
+  "version": "0.0.2-f9bc4c7-556",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -11,7 +11,8 @@
     "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'"
+    "lint": "solhint 'contracts/**/*.sol' 'test_forge/**/*.t.sol'",
+    "eslint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -31,14 +32,19 @@
     "@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",
+    "eslint": "^8.50.0",
     "hardhat": "^2.17.2",
     "prettier": "^3.0.3",
-    "prettier-plugin-solidity": "^1.1.3"
+    "prettier-plugin-solidity": "^1.1.3",
+    "typescript": "^5"
   },
   "dependencies": {
     "@openzeppelin/contracts": "^4.9.3",
     "@openzeppelin/contracts-upgradeable": "^4.9.3",
+    "abi-coder": "^5.0.0",
     "ethers": "^6.7.1",
     "winston": "^3.10.0"
   }

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

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

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

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