@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd9539f-062

package/contracts/type/RequestId.sol

@@ -0,0 +1,75 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.24;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {REQUEST} from "./ObjectType.sol";
+
+type RequestId is uint64;
+
+// type bindings
+using {
+    eqRequestId as ==, 
+    neRequestId as !=,
+    RequestIdLib.eqz,
+    RequestIdLib.gtz,
+    RequestIdLib.toInt,
+    RequestIdLib.toKey32
+} for RequestId global;
+
+// general pure free functions
+
+function eqRequestId(RequestId a, RequestId b) pure returns (bool isSame) {
+    return RequestIdLib.eq(a, b);
+}
+
+function neRequestId(RequestId a, RequestId b) pure returns (bool isSame) {
+    return RequestIdLib.ne(a, b);
+}
+
+library RequestIdLib {
+
+    // @dev zero element to refer to a non existing/initialized request
+    function zero() public pure returns (RequestId) {
+        return RequestId.wrap(0);
+    }
+
+    // @dev Converts an int id into a request id.
+    function toRequestId(uint256 id) public pure returns (RequestId) {
+        return RequestId.wrap(uint64(id));
+    }
+
+    // @dev Converts a request id back to an int value.
+    function toInt(RequestId requestId) public pure returns (uint256) {
+        return RequestId.unwrap(requestId);
+    }
+
+    // @dev Returns true iff request id a == 0
+    function eqz(RequestId a) public pure returns (bool) {
+        return RequestId.unwrap(a) == 0;
+    }
+
+    // @dev Returns true iff request id a > 0
+    function gtz(RequestId a) public pure returns (bool) {
+        return RequestId.unwrap(a) > 0;
+    }
+
+    // @dev Returns true iff risk ids a and b are identical
+    function eq(RequestId a, RequestId b) public pure returns (bool isSame) {
+        return RequestId.unwrap(a) == RequestId.unwrap(b);
+    }
+
+    // @dev Returns true iff risk ids a and b are different
+    function ne(RequestId a, RequestId b) public pure returns (bool isSame) {
+        return RequestId.unwrap(a) != RequestId.unwrap(b);
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(RequestId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(REQUEST(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(RequestId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(RequestId.unwrap(id))));
+    }
+}

package/contracts/type/RiskId.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.24;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
 import {RISK} from "./ObjectType.sol";

package/contracts/type/RoleId.sol

@@ -1,8 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.24;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
-import {ROLE} from "./ObjectType.sol";
+import {ObjectType, ROLE} from "./ObjectType.sol";
+import {VersionPart} from "./Version.sol";
 
 type RoleId is uint64;
 
@@ -12,58 +13,92 @@ using {
     neRoleId as !=,
     RoleIdLib.eqz,
     RoleIdLib.gtz,
-    RoleIdLib.toInt,
-    RoleIdLib.toKey32
+    RoleIdLib.toInt
+    // RoleIdLib.toKey32
 } for RoleId global;
 
+// general pure free functions
+
+//--- OpenZeppelin provided roles -------------------------------------------//
 
-/// @dev role id needs to match with oz AccessManager.ADMIN_ROLE
+/// @dev Role ID needs to match with oz AccessManager.ADMIN_ROLE
 function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).min); }
 
-/// @dev role id needs to match with oz AccessManager.PUBLIC_ROLE
+/// @dev Role ID needs to match with oz AccessManager.PUBLIC_ROLE
 function PUBLIC_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).max); }
 
-// general pure free functions
+/// @dev Default access admin (registry admin, instance admin) role with rights to manage roles
+function MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1); } 
+
+//--- Core GIF roles (range: 1-99) ------------------------------------------//
 
 /// @dev cental role for gif release management.
 /// this role is necessary to call ReleaseManager.createNextRelease/activateNextRelease
 /// the actual deployment of a release requires the GIF_MANAGER_ROLE.
 /// GIF_ADMIN_ROLE is the admin of the GIF_MANAGER_ROLE.
 /// only a single holder may hold this role at any time
-function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1500); } 
+function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); } 
 
 /// @dev role for token whith/blacklisting, deploying and registering the services for a new major release
 /// registering services for a new major release is only possible after a new initial release has been created by the GIF_ADMIN_ROLE
 /// token white/blacklisting is possible for any active release
-function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1600); } 
+function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); } 
 
-/// @dev instance specific role to register/own a distribution component
-function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); }
+/// @dev role for registering remote staking targets and reporting remote total value locked amounts.
+function GIF_REMOTE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); } 
+
+/// @dev required role to own an instance.
+/// Role is granted by instance service when cloning a new instance.
+/// allows instance specific target, role and access management 
+function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10); }
+
+/// @dev instance specific  role to register/own a product component
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11); }
 
 /// @dev instance specific  role to register/own an oracle component
-function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); }
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(12); }
 
-/// @dev instance specific  role to register/own a pool component
-function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(4); }
+/// @dev instance specific role to register/own a distribution component
+function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(13); }
 
-/// @dev instance specific  role to register/own a product component
-function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(5); }
+/// @dev instance specific  role to register/own a pool component
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(14); }
+
+//--- GIF contract roles (range: 200 - 9900) --------------------------------//
+// created and assigned during initial deployment for registry and staking
+// granting for instances and components in instance service
+// object type * 100 + 0, examples:
+// - registry contract role: 200 
+// - staking contract role: 300 
+// - instance contract role: 1000
+// - product contract role: 1200
+
+//--- GIF service roles (range 201 - 99xx) ----------------------------------//
+// created and assigned by release manager contract
+// object type * 100 + 1/major version, examples:
+// - registry service role (any version): 201
+// - registry service role (version 3): 203
+// - registry service role (any version): 301
+// - staking service role: (version 3): 303
+// - application service role (version 3): 2003
+
+//--- Custom roles (range > 10000) ------------------------------------------//
+
+/// @dev role associated with the staking contract
+/// this role is the admin role for the INSTANCE_OWNER_ROLE
+function STAKING_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1313); }
 
 /// @dev role associated with an instance contract
 /// this role is the admin role for the INSTANCE_OWNER_ROLE
 function INSTANCE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2600); }
 
-/// @dev required role to register/own an instance
-/// allows instance specific target, role and access management 
-function INSTANCE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1900); }
-
 function REGISTRY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1800); }
 
 /// @dev instance specific role for instance service
 function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2000); }
 
 /// @dev role for creating gif target on instance service
-function CAN_CREATE_GIF_TARGET_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); }
+function CAN_CREATE_GIF_TARGET__ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); }
 
 /// @dev role for registering gif components
 function COMPONENT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2001); }
@@ -71,6 +106,9 @@ function COMPONENT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRol
 /// @dev instance specific role for distribution service
 function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2100); }
 
+/// @dev instance specific role for oracle service
+function ORACLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2150); }
+
 /// @dev instance specific role for pool service
 function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2200); }
 
@@ -121,6 +159,26 @@ library RoleIdLib {
         return uint64(RoleId.unwrap(a));
     }
 
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForType(ObjectType objectType) public pure returns (RoleId) {
+        return RoleId.wrap(100 * uint64(objectType.toInt()));
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForTypeAndVersion(ObjectType objectType, VersionPart majorVersion) public pure returns (RoleId) {
+        return RoleId.wrap(
+            uint64(100 * objectType.toInt() + majorVersion.toInt()));
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    /// Used for GIF core contracts.
+    function roleForTypeAndAllVersions(ObjectType objectType) public pure returns (RoleId) {
+        return RoleId.wrap(
+            uint64(100 * objectType.toInt() + 99));
+    }
+
     /// @dev Returns true if the value is non-zero (> 0).
     function gtz(RoleId a) public pure returns (bool) {
         return RoleId.unwrap(a) > 0;

package/contracts/type/Seconds.sol

@@ -1,15 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 type Seconds is uint40;
 
 using {
+    SecondsEq as ==,
     SecondsGt as >,
     SecondsLib.eqz,
     SecondsLib.gtz,
     SecondsLib.toInt
 } for Seconds global;
 
+function SecondsEq(Seconds duration1, Seconds duration2) pure returns (bool) {
+    return SecondsLib.eq(duration1, duration2);
+}
+
 function SecondsGt(Seconds duration1, Seconds duration2) pure returns (bool) {
     return SecondsLib.gt(duration1, duration2);
 }
@@ -26,6 +31,14 @@ library SecondsLib {
         return Seconds.wrap(_max());
     }
 
+    function oneDay() public pure returns (Seconds duration) {
+        return Seconds.wrap(24 * 3600);
+    }
+
+    function oneYear() public pure returns (Seconds duration) {
+        return Seconds.wrap(365 * 24 * 3600);
+    }
+
     /// @dev converts the uint duration into Seconds
     /// function reverts if duration is exceeding max Seconds value
     function toSeconds(uint256 duration) public pure returns (Seconds) {
@@ -47,6 +60,11 @@ library SecondsLib {
         return Seconds.unwrap(duration) > 0;
     }
 
+    /// @dev return true iff duration1 and duration2 are the same
+    function eq(Seconds duration1, Seconds duration2) public pure returns (bool) {
+        return Seconds.unwrap(duration1) == Seconds.unwrap(duration2);
+    }
+
     /// @dev return true if duration1 is larger than duration2
     function gt(Seconds duration1, Seconds duration2) public pure returns (bool) {
         return Seconds.unwrap(duration1) > Seconds.unwrap(duration2);

package/contracts/type/Selector.sol

@@ -0,0 +1,102 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.24;
+
+type Selector is bytes4;
+
+// type bindings
+using {
+    eqSelector as ==, 
+    neSelector as !=, 
+    SelectorLib.toBytes4,
+    SelectorLib.eqz
+} for Selector global;
+
+// pure free functions for operators
+function eqSelector(Selector s1, Selector s2) pure returns (bool isSame) {
+    return SelectorLib.eq(s1, s2);
+}
+
+function neSelector(Selector s1, Selector s2) pure returns (bool isDifferent) {
+    return SelectorLib.ne(s1, s2);
+}
+
+// library functions that operate on user defined type
+library SelectorLib {
+
+    function zero() public pure returns (Selector) {
+        return Selector.wrap("");
+    }
+
+    function eqz(Selector s) public pure returns (bool) {
+        return Selector.unwrap(s) == "";
+    }
+
+    function eq(Selector s1, Selector s2) public pure returns (bool isSame) {
+        return Selector.unwrap(s1) == Selector.unwrap(s2);
+    }
+
+    function ne(Selector s1, Selector s2) public pure returns (bool isDifferent) {
+        return Selector.unwrap(s1) != Selector.unwrap(s2);
+    }
+
+    function toSelector(bytes4 selector) public pure returns (Selector) {
+        return Selector.wrap(selector);
+    }
+
+    function toBytes4(Selector s) public pure returns (bytes4) {
+        return Selector.unwrap(s);
+    }
+}
+
+// selector specific set library
+// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
+library SelectorSetLib {
+
+    struct Set {
+        Selector[] selectors;
+        mapping(Selector selector => uint256 index) at;
+    }
+
+    function add(Set storage set, Selector selector) external {
+        // selector already in set
+        if (set.at[selector] > 0) { return; }
+
+        set.selectors.push(selector);
+        set.at[selector] = set.selectors.length;
+    }
+
+    function remove(Set storage set, Selector selector) external {
+        uint256 selectorIndex = set.at[selector];
+
+        // selector not in set
+        if (selectorIndex == 0) {return; }
+
+        uint256 toDeleteIndex = selectorIndex - 1;
+        uint256 lastIndex = set.selectors.length - 1;
+
+        if (lastIndex != toDeleteIndex) {
+            Selector lastSelector = set.selectors[lastIndex];
+            set.selectors[toDeleteIndex] = lastSelector;
+            set.at[lastSelector] = selectorIndex; // Replace lastValue's index to valueIndex
+        }
+
+        set.selectors.pop();
+        delete set.at[selector];
+    }
+
+    function isEmpty(Set storage set) external view returns(bool empty) {
+        return set.selectors.length == 0;
+    }
+
+    function contains(Set storage set, Selector selector) external view returns(bool inSet) {
+        return set.at[selector] > 0;
+    }
+
+    function size(Set storage set) external view returns(uint256 length) {
+        return set.selectors.length;
+    }
+
+    function at(Set storage set, uint256 index) external view returns(Selector selector) {
+        return set.selectors[index];
+    }
+}

package/contracts/type/StateId.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 // uint96 allows for chain ids up to 13 digits
 type StateId is uint8;
@@ -59,6 +59,18 @@ function EXPECTED() pure returns (StateId) {
     return toStateId(60);
 }
 
+function FULFILLED() pure returns (StateId) {
+    return toStateId(70);
+}
+
+function FAILED() pure returns (StateId) {
+    return toStateId(7);
+}
+
+function CANCELLED() pure returns (StateId) {
+    return toStateId(72);
+}
+
 function PAUSED() pure returns (StateId) {
     return toStateId(110);
 }

package/contracts/type/String.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.24;
+
+import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
+
+type Str is bytes32;
+
+using {
+    StrEq as ==,
+    StrNe as !=,
+    StrLib.toString,
+    StrLib.length
+} for Str global;
+
+function StrEq(Str s1, Str s2) pure returns (bool) {
+    return StrLib.eq(s1, s2);
+}
+
+function StrNe(Str s1, Str s2) pure returns (bool) {
+    return StrLib.ne(s1, s2);
+}
+
+library StrLib {
+
+
+    /// @dev converts the provided string into a short string.
+    /// uses ShortStrings.toShortString
+    function toStr(string memory str) public pure returns (Str) {
+        return Str.wrap(ShortString.unwrap(ShortStrings.toShortString(str)));
+    }
+
+    /// @dev return true iff s1 equals s2
+    function eq(Str s1, Str s2) public pure returns (bool) {
+        return Str.unwrap(s1) == Str.unwrap(s2);
+    }
+
+    /// @dev return true iff s1 differs from s2
+    function ne(Str s1, Str s2) public pure returns (bool) {
+        return Str.unwrap(s1) != Str.unwrap(s2);
+    }
+
+    /// @dev converts the provided short string into a string.
+    /// uses ShortStrings.toString
+    function toString(Str str) public pure returns (string memory) {
+        return ShortStrings.toString(ShortString.wrap(Str.unwrap(str)));
+    }
+
+    /// @dev converts the provided short string into a string.
+    /// uses ShortStrings.byteLength
+    function length(Str str) public pure returns (uint256 byteLength) {
+        return ShortStrings.byteLength(ShortString.wrap(Str.unwrap(str)));
+    }
+}

package/contracts/type/Timestamp.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 import {Seconds} from "./Seconds.sol";
 
@@ -56,13 +56,17 @@ function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
 // TODO move to TimestampLib and rename to zero()
 /// @dev Return the Timestamp zero (0)
 function zeroTimestamp() pure returns (Timestamp) {
-    return toTimestamp(0);
+    return Timestamp.wrap(0);
 }
 
 library TimestampLib {
 
     function zero() public pure returns (Timestamp) {
-        return toTimestamp(0);
+        return Timestamp.wrap(0);
+    }
+
+    function max() public pure returns (Timestamp) {
+        return Timestamp.wrap(type(uint40).max);
     }
     
     function blockTimestamp() public view returns (Timestamp) {

package/contracts/type/UFixed.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.24;
 
 /// @dev UFixed is a fixed point number with 18 decimals precision.
 type UFixed is uint256;

package/contracts/type/Version.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.24;
 
 type VersionPart is uint8;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-fd4931b-974",
+  "version": "0.0.2-fd9539f-062",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -30,10 +30,11 @@
   "homepage": "https://github.com/etherisc/gif-next#readme",
   "devDependencies": {
     "@nomicfoundation/hardhat-foundry": "^1.1.1",
-    "@nomicfoundation/hardhat-toolbox": "^3.0.0",
-    "@nomicfoundation/hardhat-verify": "^1.1.1",
+    "@nomicfoundation/hardhat-toolbox": "^5.0.0",
+    "@nomicfoundation/hardhat-verify": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
+    "antlr4ng-cli": "^2.0.0",
     "dotenv": "^16.3.1",
     "eslint": "^8.50.0",
     "hardhat": "^2.17.2",
@@ -44,7 +45,9 @@
   "dependencies": {
     "@openzeppelin/contracts": "5.0.0",
     "@openzeppelin/contracts-upgradeable": "5.0.0",
+    "@openzeppelin/upgrades-core": "^1.34.1",
     "abi-coder": "^5.0.0",
+    "antlr4ng": "^3.0.4",
     "ethers": "^6.7.1",
     "solidity-docgen": "^0.6.0-beta.36",
     "winston": "^3.10.0"

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

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