npm - @etherisc/gif-next - Versions diffs - 0.0.2-d5b7b78-706 → 0.0.2-d5fac82-078 - Mend

@etherisc/gif-next 0.0.2-d5b7b78-706 → 0.0.2-d5fac82-078

Files changed (453) hide show

package/contracts/{types → type}/ClaimId.sol RENAMED Viewed

@@ -4,13 +4,18 @@ pragma solidity ^0.8.20;
 // uint16 allows for 65'535 claims per policy
 type ClaimId is uint16;
+import {CLAIM} from "./ObjectType.sol";
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
 // type bindings
 using {
     eqClaimId as ==,
     neClaimId as !=,
     ClaimIdLib.eqz,
     ClaimIdLib.gtz,
-    ClaimIdLib.toInt
+    ClaimIdLib.toInt,
+    ClaimIdLib.toKey32
 } for ClaimId global;
@@ -25,10 +30,14 @@ function neClaimId(ClaimId a, ClaimId b) pure returns (bool isDifferent) {
 // library functions that operate on user defined type
 library ClaimIdLib {
-    /// @dev Converts the ClaimId to a uint.
+    /// @dev claim id min value (0), use only for non-initialized values
     function zero() public pure returns (ClaimId) {
         return ClaimId.wrap(0);
     }
+    /// @dev claim id max value (2**16-1), use only for non-initialized values
+    function max() public pure returns (ClaimId) {
+        return ClaimId.wrap(type(uint16).max);
+    }
     /// @dev Converts an uint into a ClaimId.
     function toClaimId(uint256 a) public pure returns (ClaimId) {
@@ -40,6 +49,20 @@ library ClaimIdLib {
         return uint16(ClaimId.unwrap(a));
     }
+    /// @dev Converts the ClaimId and NftId to a Key32.
+    function toKey32(ClaimId claimId, NftId policyNftId) public pure returns (Key32) {
+        return Key32Lib.toKey32(CLAIM(), toKeyId(claimId, policyNftId));
+    }
+    /// @dev Converts the ClaimId and NftId to a Key32.
+    function toKeyId(ClaimId claimId, NftId policyNftId) public pure returns (KeyId) {
+        return KeyId.wrap(
+            bytes31(
+                bytes14(
+                    uint112(
+                        NftId.unwrap(policyNftId) << 16 + ClaimId.unwrap(claimId)))));
+    }
     /// @dev Returns true if the value is non-zero (> 0).
     function gtz(ClaimId a) public pure returns (bool) {
         return ClaimId.unwrap(a) > 0;

package/contracts/{types → type}/Fee.sol RENAMED Viewed

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
+import {Amount, AmountLib} from "./Amount.sol";
 import {UFixed, UFixedLib} from "./UFixed.sol";
 struct Fee {
@@ -12,19 +13,22 @@ library FeeLib {
     function calculateFee(
         Fee memory fee,
-        uint256 amount
+        Amount amount
     )
         public
         pure
         returns (
-            uint256 feeAmount,
-            uint256 netAmount
+            Amount feeAmount,
+            Amount netAmount
         )
     {
-        UFixed fractionalAmount = UFixedLib.toUFixed(amount) *
-            fee.fractionalFee;
-        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
-        netAmount = amount - feeAmount;
+        netAmount = amount;
+        if(gtz(fee)) {
+            UFixed fractionalAmount =
+                amount.toUFixed() * fee.fractionalFee;
+            feeAmount = AmountLib.toAmount(fractionalAmount.toInt() + fee.fixedFee);
+            netAmount = netAmount - feeAmount;
+        }
     }
     /// @dev Converts the uint256 to a fee struct.
@@ -51,7 +55,11 @@ library FeeLib {
         return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
     }
-    function feeIsZero(Fee memory fee) public pure returns (bool) {
+    function gtz(Fee memory fee) public pure returns (bool) {
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+    }
+    function eqz(Fee memory fee) public pure returns (bool) {
         return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
     }
 }

package/contracts/{types → type}/NftIdSet.sol RENAMED Viewed

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
-import {NftId} from "../types/NftId.sol";
+import {NftId} from "../type/NftId.sol";
 // based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
 library LibNftIdSet {

package/contracts/{types → type}/ObjectType.sol RENAMED Viewed

@@ -8,6 +8,7 @@ using {
     eqObjectType as ==,
     neObjectType as !=,
     ObjectTypeLib.toInt,
+    ObjectTypeLib.eqz,
     ObjectTypeLib.gtz
 } for ObjectType global;
@@ -86,6 +87,10 @@ function POOL() pure returns (ObjectType) {
     return toObjectType(140);
 }
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(220);
+}
 function RISK() pure returns (ObjectType) {
     return toObjectType(200);
 }
@@ -102,12 +107,12 @@ function CLAIM() pure returns (ObjectType) {
     return toObjectType(212);
 }
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
+function PAYOUT() pure returns (ObjectType) {
+    return toObjectType(213);
 }
-function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(212);
+function PRICE() pure returns (ObjectType) {
+    return toObjectType(230);
 }
 /// @dev Converts the uint8 to a ObjectType.
@@ -154,4 +159,4 @@ library ObjectTypeLib {
     function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
         return eqObjectType(a, b);
     }
-}
+}

package/contracts/{types → type}/PayoutId.sol RENAMED Viewed

@@ -4,13 +4,21 @@ pragma solidity ^0.8.20;
 // uint24 allows for 65'535 claims with 255 payouts each per policy
 type PayoutId is uint24;
+import {ClaimId} from "./ClaimId.sol";
+import {PAYOUT} from "./ObjectType.sol";
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
 // type bindings
 using {
     eqPayoutId as ==,
     nePayoutId as !=,
     PayoutIdLib.eqz,
     PayoutIdLib.gtz,
-    PayoutIdLib.toInt
+    PayoutIdLib.toInt,
+    PayoutIdLib.toClaimId,
+    PayoutIdLib.toPayoutNo,
+    PayoutIdLib.toKey32
 } for PayoutId global;
@@ -23,8 +31,6 @@ function nePayoutId(PayoutId a, PayoutId b) pure returns (bool isDifferent) {
     return PayoutId.unwrap(a) != PayoutId.unwrap(b);
 }
-// TODO come up with a way to code claim id into payout id
-// eg payoutId.getClaimId(), payoutId.getPayoutNo()
 // library functions that operate on user defined type
 library PayoutIdLib {
     /// @dev Converts the PayoutId to a uint.
@@ -33,8 +39,16 @@ library PayoutIdLib {
     }
     /// @dev Converts an uint into a PayoutId.
-    function toPayoutId(uint256 a) public pure returns (PayoutId) {
-        return PayoutId.wrap(uint24(a));
+    function toPayoutId(ClaimId claimId, uint8 payoutNo) public pure returns (PayoutId) {
+        return PayoutId.wrap((ClaimId.unwrap(claimId) << 8) + payoutNo);
+    }
+    function toClaimId(PayoutId payoutId) public pure returns (ClaimId) {
+        return ClaimId.wrap(uint16(PayoutId.unwrap(payoutId) >> 8));
+    }
+    function toPayoutNo(PayoutId payoutId) public pure returns (uint8) {
+        return uint8(PayoutId.unwrap(payoutId) & 255);
     }
     /// @dev Converts the PayoutId to a uint.
@@ -51,4 +65,18 @@ library PayoutIdLib {
     function eqz(PayoutId a) public pure returns (bool) {
         return PayoutId.unwrap(a) == 0;
     }
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKey32(PayoutId payoutId, NftId policyNftId) public pure returns (Key32) {
+        return Key32Lib.toKey32(PAYOUT(), toKeyId(payoutId, policyNftId));
+    }
+    /// @dev Converts the PayoutId and NftId to a Key32.
+    function toKeyId(PayoutId payoutId, NftId policyNftId) public pure returns (KeyId) {
+        return KeyId.wrap(
+            bytes31(
+                bytes15(
+                    uint120(
+                        (NftId.unwrap(policyNftId) << 24) + PayoutId.unwrap(payoutId)))));
+    }
 }

package/contracts/{types → type}/RoleId.sol RENAMED Viewed

@@ -24,30 +24,72 @@ function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uin
 function PUBLIC_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(type(uint64).max); }
 // general pure free functions
-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"; }
+/// @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); }
+/// @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); }
+/// @dev instance specific role to register/own a distribution component
 function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2); }
+/// @dev instance specific  role to register/own an oracle component
 function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(3); }
+/// @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 product component
 function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(5); }
+/// @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); }
+/// @dev instance specific role for distribution service
 function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2100); }
+/// @dev instance specific role for pool service
 function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2200); }
+/// @dev instance specific role for product service
 function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2300); }
+/// @dev instance specific role for application service
 function APPLICATION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2400); }
+/// @dev instance specific role for policy service
 function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2410); }
+/// @dev instance specific role for claim service
 function CLAIM_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2420); }
+/// @dev instance specific role for bundle service
 function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2500); }
-function INSTANCE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2600); }
-function GIF_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1500); }
-function GIF_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1600); }
-function RELEASE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); }
+/// @dev instance specific role for pricing service
+function PRICING_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2800); }
+/// @dev instance specific role for staking service
+function STAKING_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(2900); }
 // @dev Returns true iff role ids a and b are identical
 function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {

package/contracts/{types → type}/StateId.sol RENAMED Viewed

@@ -26,14 +26,18 @@ function DECLINED() pure returns (StateId) {
     return toStateId(30);
 }
-function UNDERWRITTEN() pure returns (StateId) {
+function COLLATERALIZED() pure returns (StateId) {
     return toStateId(40);
 }
-function CONFIRMED() pure returns (StateId) {
+function SUBMITTED() pure returns (StateId) {
     return toStateId(50);
 }
+function CONFIRMED() pure returns (StateId) {
+    return toStateId(51);
+}
 function EXPECTED() pure returns (StateId) {
     return toStateId(60);
 }

package/contracts/{types → type}/Timestamp.sol RENAMED Viewed

@@ -60,6 +60,11 @@ function zeroTimestamp() pure returns (Timestamp) {
 }
 library TimestampLib {
+    function zero() public pure returns (Timestamp) {
+        return toTimestamp(0);
+    }
     function blockTimestamp() public view returns (Timestamp) {
         return Timestamp.wrap(uint40(block.timestamp));
     }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-d5b7b78-706",
+  "version": "0.0.2-d5fac82-078",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {