@etherisc/gif-next 0.0.2-efdb520-159 → 0.0.2-efef0ea-320

package/contracts/types/RiskId.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {RISK} from "./ObjectType.sol";
+
+type RiskId is bytes8;
+
+// type bindings
+using {
+    eqRiskId as ==, 
+    neRiskId as !=,
+    RiskIdLib.toKey32
+} for RiskId global;
+
+// general pure free functions
+
+// @dev Returns true iff risk ids a and b are identical
+function eqRiskId(RiskId a, RiskId b) pure returns (bool isSame) {
+    return RiskId.unwrap(a) == RiskId.unwrap(b);
+}
+
+// @dev Returns true iff risk ids a and b are different
+function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
+    return RiskId.unwrap(a) != RiskId.unwrap(b);
+}
+
+library RiskIdLib {
+    // @dev Converts a role string into a role id.
+    function toRiskId(string memory risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(RiskId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(RISK(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(RiskId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(RiskId.unwrap(id)));
+    }
+}

package/contracts/types/RoleId.sol

@@ -10,20 +10,15 @@ using {
 } for RoleId global;
 
 // general pure free functions
-function DISTRIBUTOR_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributorOwnerRole"; }
+function DISTRIBUTION_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributionOwnerRole"; }
 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 toRoleId("DistributorOwnerRole"); }
-function ORACLE_OWNER_ROLE() pure returns (RoleId) { return toRoleId("OracleOwnerRole"); }
-function POOL_OWNER_ROLE() pure returns (RoleId) { return toRoleId("PoolOwnerRole"); }
-function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return toRoleId("ProductOwnerRole"); }
-
-// @dev Converts a role string into a role id.
-function toRoleId(string memory role) pure returns (RoleId) {
-    return RoleId.wrap(bytes8(keccak256(abi.encode(role))));
-}
+function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("DistributionOwnerRole"); }
+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) {
@@ -34,3 +29,10 @@ function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
 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) {

package/contracts/types/UFixed.sol

@@ -77,19 +77,25 @@ 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 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 Converts the uint256 to a UFixed.
     function toUFixed(uint256 a) public pure returns (UFixed) {
         return UFixed.wrap(a * MULTIPLIER);
@@ -103,9 +109,6 @@ library UFixedMathLib {
         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);
@@ -113,12 +116,12 @@ library UFixedMathLib {
 
     /// @dev Converts a UFixed to a uint256.
     function toInt(UFixed a) public pure returns (uint256) {
-        return toIntWithRounding(a, ROUNDING_DEFAULT);
+        return toIntWithRounding(a, ROUNDING_HALF_UP());
     }
 
     /// @dev Converts a UFixed to a uint256 with given rounding mode.
-    function toIntWithRounding(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

@@ -12,7 +12,6 @@ using {
 
 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); }
-function toVersionPart(uint8 versionPart) pure returns(VersionPart) { return VersionPart.wrap(versionPart); }
 
 library VersionPartLib {
     function toInt(VersionPart x) external pure returns(uint) { return VersionPart.unwrap(x); }
@@ -24,6 +23,7 @@ using {
     versionGt as >,
     versionEq as ==,
     VersionLib.toInt,
+    VersionLib.toUint64,
     VersionLib.toMajorPart,
     VersionLib.toVersionParts
 }
@@ -32,30 +32,11 @@ using {
 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); }
 
-function toVersion(
-    VersionPart major,
-    VersionPart minor,
-    VersionPart patch
-)
-    pure
-    returns(Version)
-{
-    uint majorInt = major.toInt();
-    uint minorInt = minor.toInt();
-    uint patchInt = patch.toInt();
-
-    return Version.wrap(
-        uint24(
-            (majorInt << 16) + (minorInt << 8) + patchInt));
-}
-
-function zeroVersion() pure returns(Version) {
-    return toVersion(toVersionPart(0), toVersionPart(0), toVersionPart(0));
-}
-
 library VersionLib {
     function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
+    function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
+
     function toMajorPart(Version version)
         external    
         pure 
@@ -83,9 +64,40 @@ library VersionLib {
         uint8 patchInt = uint8(versionInt - (minorInt << 8));
 
         return (
-            toVersionPart(majorInt),
-            toVersionPart(minorInt),
-            toVersionPart(patchInt)
+            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));
+    }
+
+    // TODO check for overflow?
+    function toVersion(uint64 versionNumber) external pure returns(Version) {
+        return Version.wrap(uint24(versionNumber));
+    }
+
+    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-efdb520-159",
+  "version": "0.0.2-efef0ea-320",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/instance/IServiceLinked.sol/IServiceLinked.dbg.json

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

package/artifacts/contracts/instance/IServiceLinked.sol/IServiceLinked.json

@@ -1,50 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "IServiceLinked",
-  "sourceName": "contracts/instance/IServiceLinked.sol",
-  "abi": [
-    {
-      "inputs": [],
-      "name": "getComponentOwnerService",
-      "outputs": [
-        {
-          "internalType": "contract IComponentOwnerService",
-          "name": "service",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getPoolService",
-      "outputs": [
-        {
-          "internalType": "contract IPoolService",
-          "name": "service",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "getProductService",
-      "outputs": [
-        {
-          "internalType": "contract IProductService",
-          "name": "service",
-          "type": "address"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/instance/InstanceBase.sol/InstanceBase.dbg.json

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

package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.dbg.json

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

package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycle.json

@@ -1,134 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "ILifecycle",
-  "sourceName": "contracts/instance/module/lifecycle/ILifecycle.sol",
-  "abi": [
-    {
-      "inputs": [
-        {
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "fromStateId",
-          "type": "uint8"
-        },
-        {
-          "internalType": "StateId",
-          "name": "toStateId",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorInvalidStateTransition",
-      "type": "error"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        },
-        {
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        }
-      ],
-      "name": "ErrorNoLifecycle",
-      "type": "error"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": false,
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "fromStateId",
-          "type": "uint8"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "toStateId",
-          "type": "uint8"
-        }
-      ],
-      "name": "LogBundleStateChanged",
-      "type": "event"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": false,
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        },
-        {
-          "indexed": false,
-          "internalType": "ObjectType",
-          "name": "objectType",
-          "type": "uint8"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "fromStateId",
-          "type": "uint8"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "toStateId",
-          "type": "uint8"
-        }
-      ],
-      "name": "LogComponentStateChanged",
-      "type": "event"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": false,
-          "internalType": "NftId",
-          "name": "nftId",
-          "type": "uint96"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "fromStateId",
-          "type": "uint8"
-        },
-        {
-          "indexed": false,
-          "internalType": "StateId",
-          "name": "toStateId",
-          "type": "uint8"
-        }
-      ],
-      "name": "LogPolicyStateChanged",
-      "type": "event"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/instance/module/lifecycle/ILifecycle.sol/ILifecycleModule.dbg.json

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

package/artifacts/contracts/instance/module/lifecycle/LifecycleModule.sol/LifecycleModule.dbg.json

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