@etherisc/gif-next 0.0.2-f18fb8b-243 → 0.0.2-f1f3b2c-994

package/contracts/instance/Instance.sol

@@ -4,44 +4,19 @@ pragma solidity ^0.8.20;
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
 import {Amount} from "../type/Amount.sol";
-import {Key32} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {RiskId} from "../type/RiskId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../type/ObjectType.sol";
-import {RoleId} from "../type/RoleId.sol";
-import {ClaimId} from "../type/ClaimId.sol";
-import {ReferralId} from "../type/Referral.sol";
-import {PayoutId} from "../type/PayoutId.sol";
-import {DistributorType} from "../type/DistributorType.sol";
-import {Seconds} from "../type/Seconds.sol";
-import {UFixed} from "../type/UFixed.sol";
-import {VersionPart, VersionPartLib} from "../type/Version.sol";
-
-import {Registerable} from "../shared/Registerable.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
-
+import {BundleSet} from "./BundleSet.sol";
 import {IInstance} from "./IInstance.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleManager} from "./BundleManager.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-
-import {KeyValueStore} from "../shared/KeyValueStore.sol";
-
-import {IBundle} from "./module/IBundle.sol";
-import {IComponents} from "./module/IComponents.sol";
-import {IDistribution} from "./module/IDistribution.sol";
-import {IPolicy} from "./module/IPolicy.sol";
-import {IRisk} from "./module/IRisk.sol";
-
-import {IDistributionService} from "../distribution/IDistributionService.sol";
-import {IPoolService} from "../pool/IPoolService.sol";
-import {IProductService} from "../product/IProductService.sol";
-import {IPolicyService} from "../product/IPolicyService.sol";
-import {IBundleService} from "../pool/IBundleService.sol";
+import {INSTANCE} from "../type/ObjectType.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 contract Instance is
     IInstance,
@@ -55,7 +30,7 @@ contract Instance is
     IInstanceService internal _instanceService;
     InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
-    BundleManager internal _bundleManager;
+    BundleSet internal _bundleManager;
     InstanceStore internal _instanceStore;
 
     modifier onlyChainNft() {
@@ -68,7 +43,7 @@ contract Instance is
     function initialize(
         InstanceAdmin instanceAdmin, 
         InstanceStore instanceStore,
-        BundleManager bundleManager,
+        BundleSet bundleManager,
         InstanceReader instanceReader,
         IRegistry registry, 
         address initialOwner
@@ -86,7 +61,7 @@ contract Instance is
         __AccessManaged_init(_instanceAdmin.authority());
 
         // setup instance object info
-        initializeRegisterable(
+        _initializeRegisterable(
             address(registry), 
             registry.getNftId(), 
             INSTANCE(), 
@@ -109,7 +84,7 @@ contract Instance is
                 INSTANCE(), 
                 getMajorVersion()));
 
-        registerInterface(type(IInstance).interfaceId);    
+        _registerInterface(type(IInstance).interfaceId);    
     }
 
     //--- Staking ----------------------------------------------------------//
@@ -234,7 +209,7 @@ contract Instance is
         return _instanceReader;
     }
 
-    function getBundleManager() external view returns (BundleManager) {
+    function getBundleSet() external view returns (BundleSet) {
         return _bundleManager;
     }
 

package/contracts/instance/InstanceAdmin.sol

@@ -7,6 +7,7 @@ import {AccessAdmin} from "../authorization/AccessAdmin.sol";
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {IAccessAdmin} from "../authorization/IAccessAdmin.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
+import {IComponent} from "../shared/IComponent.sol";
 import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "./IInstance.sol";
@@ -14,6 +15,7 @@ import {IService} from "../shared/IService.sol";
 import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
 import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 import {Str, StrLib} from "../type/String.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPart} from "../type/Version.sol";
 
 
@@ -23,7 +25,7 @@ contract InstanceAdmin is
     string public constant INSTANCE_TARGET_NAME = "Instance";
     string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
     string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
-    string public constant BUNDLE_MANAGER_TARGET_NAME = "BundleManager";
+    string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
 
     uint64 public constant CUSTOM_ROLE_ID_MIN = 10000; // MUST be even
 
@@ -111,26 +113,43 @@ contract InstanceAdmin is
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
-        address componentAddress,
+        IComponent component,
         IAuthorization authorization
     )
         external
     {
-        _checkTargetIsReadyForAuthorization(componentAddress);
+        _checkTargetIsReadyForAuthorization(address(component));
 
         _createRoles(authorization);
 
         // create component target
         _createTarget(
-            componentAddress, 
+            address(component), 
             authorization.getTargetName(), 
             true, // checkAuthority
             false); // custom
 
+        _createTarget(
+            address(component.getTokenHandler()), 
+            string(abi.encodePacked(authorization.getTargetName(), "TH")), 
+            true, 
+            false);
+        
+        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
+        FunctionInfo[] memory functions = new FunctionInfo[](3);
+        functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
+        functions[1] = toFunction(TokenHandler.collectTokensToThreeRecipients.selector, "collectTokensToThreeRecipients");
+        functions[2] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
+
+        _authorizeTargetFunctions(
+            address(component.getTokenHandler()),
+            getPublicRole(),
+            functions);
+
         _grantRoleToAccount(
             authorization.getTargetRole(
                 authorization.getTarget()), 
-            componentAddress);
+            address(component));
         
         _createTargetAuthorizations(authorization);
     }
@@ -184,9 +203,12 @@ contract InstanceAdmin is
 
         for(uint256 i = 0; i < roles.length; i++) {
             roleId = roles[i];
-            _createRole(
-                roleId,
-                authorization.getRoleInfo(roleId));
+
+            if (!roleExists(roleId)) {
+                _createRole(
+                    roleId,
+                    authorization.getRoleInfo(roleId));
+            }
         }
     }
 
@@ -248,7 +270,7 @@ contract InstanceAdmin is
         _checkAndCreateTargetWithRole(address(_instance), INSTANCE_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getInstanceStore()), INSTANCE_STORE_TARGET_NAME);
         _checkAndCreateTargetWithRole(address(_instance.getInstanceAdmin()), INSTANCE_ADMIN_TARGET_NAME);
-        _checkAndCreateTargetWithRole(address(_instance.getBundleManager()), BUNDLE_MANAGER_TARGET_NAME);
+        _checkAndCreateTargetWithRole(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME);
 
         // create targets for services that need to access the module targets
         ObjectType[] memory serviceDomains = _instanceAuthorization.getServiceDomains();

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -6,17 +6,15 @@ import {
 } from "../../contracts/type/ObjectType.sol";
 
 import {
-     ADMIN_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE
+     DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE
 } from "../../contracts/type/RoleId.sol";
 
-import {BundleManager} from "../instance/BundleManager.sol"; 
+import {BundleSet} from "../instance/BundleSet.sol"; 
 import {IAccess} from "../authorization/IAccess.sol";
 import {Instance} from "../instance/Instance.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {ModuleAuthorization} from "../authorization/ModuleAuthorization.sol";
-import {RoleId} from "../type/RoleId.sol";
-import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 
 contract InstanceAuthorizationV3
@@ -26,7 +24,7 @@ contract InstanceAuthorizationV3
      string public constant INSTANCE_TARGET_NAME = "Instance";
      string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
      string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
-     string public constant BUNDLE_MANAGER_TARGET_NAME = "BundleManager";
+     string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
 
      string public constant INSTANCE_ROLE_NAME = "InstanceRole";
      string public constant DISTRIBUTION_OWNER_ROLE_NAME = "DistributionOwnerRole";
@@ -61,7 +59,7 @@ contract InstanceAuthorizationV3
           // instance supporting targets
           _addTarget(INSTANCE_STORE_TARGET_NAME);
           _addTarget(INSTANCE_ADMIN_TARGET_NAME);
-          _addTarget(BUNDLE_MANAGER_TARGET_NAME);
+          _addTarget(BUNDLE_SET_TARGET_NAME);
 
           // service targets relevant to instance
           _addServiceTargetWithRole(INSTANCE());
@@ -84,22 +82,22 @@ contract InstanceAuthorizationV3
           _setupInstanceAuthorization();
           _setupInstanceAdminAuthorization();
           _setupInstanceStoreAuthorization();
-          _setupBundleManagerAuthorization();
+          _setupBundleSetAuthorization();
      }
 
 
-     function _setupBundleManagerAuthorization()
+     function _setupBundleSetAuthorization()
           internal
      {
           IAccess.FunctionInfo[] storage functions;
 
           // authorize bundle service role
-          functions = _authorizeForTarget(BUNDLE_MANAGER_TARGET_NAME, getServiceRole(BUNDLE()));
-          _authorize(functions, BundleManager.linkPolicy.selector, "linkPolicy");
-          _authorize(functions, BundleManager.unlinkPolicy.selector, "unlinkPolicy");
-          _authorize(functions, BundleManager.add.selector, "add");
-          _authorize(functions, BundleManager.lock.selector, "lock");
-          _authorize(functions, BundleManager.unlock.selector, "unlock");
+          functions = _authorizeForTarget(BUNDLE_SET_TARGET_NAME, getServiceRole(BUNDLE()));
+          _authorize(functions, BundleSet.linkPolicy.selector, "linkPolicy");
+          _authorize(functions, BundleSet.unlinkPolicy.selector, "unlinkPolicy");
+          _authorize(functions, BundleSet.add.selector, "add");
+          _authorize(functions, BundleSet.lock.selector, "lock");
+          _authorize(functions, BundleSet.unlock.selector, "unlock");
      }
 
 
@@ -141,7 +139,9 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.createProduct.selector, "createProduct");
           _authorize(functions, InstanceStore.updateProduct.selector, "updateProduct");
           _authorize(functions, InstanceStore.increaseBalance.selector, "increaseBalance");
+          _authorize(functions, InstanceStore.decreaseBalance.selector, "decreaseBalance");
           _authorize(functions, InstanceStore.increaseFees.selector, "increaseFees");
+          _authorize(functions, InstanceStore.decreaseFees.selector, "decreaseFees");
 
           // authorize distribution service role
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(DISTRIBUTION()));
@@ -189,6 +189,8 @@ contract InstanceAuthorizationV3
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(POLICY()));
           _authorize(functions, InstanceStore.updatePolicy.selector, "updatePolicy");
           _authorize(functions, InstanceStore.updatePolicyState.selector, "updatePolicyState");
+          _authorize(functions, InstanceStore.createPremium.selector, "createPremium");
+          _authorize(functions, InstanceStore.updatePremiumState.selector, "updatePremiumState");
 
           // authorize claim service role
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(CLAIM()));

package/contracts/instance/InstanceReader.sol

@@ -1,25 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
 import {Amount} from "../type/Amount.sol";
-import {ClaimId} from "../type/ClaimId.sol";
+import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 import {DistributorType} from "../type/DistributorType.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, BUNDLE} from "../type/ObjectType.sol";
-import {PayoutId} from "../type/PayoutId.sol";
+import {COMPONENT, DISTRIBUTOR, DISTRIBUTION, PREMIUM, PRODUCT, POLICY, POOL, BUNDLE} from "../type/ObjectType.sol";
+import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {StateId} from "../type/StateId.sol";
-import {UFixed, MathLib, UFixedLib} from "../type/UFixed.sol";
-import {Version} from "../type/Version.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
@@ -31,6 +26,7 @@ import {IRisk} from "../instance/module/IRisk.sol";
 import {TimestampLib} from "../type/Timestamp.sol";
 
 import {InstanceStore} from "./InstanceStore.sol";
+import {BundleSet} from "./BundleSet.sol";
 
 
 contract InstanceReader {
@@ -42,6 +38,7 @@ contract InstanceReader {
 
     IInstance internal _instance;
     InstanceStore internal _store;
+    BundleSet internal _bundleSet;
 
     /// @dev This initializer needs to be called from the instance itself.
     function initialize() public {
@@ -61,6 +58,7 @@ contract InstanceReader {
         _initialized = true;
         _instance = IInstance(instanceAddress);
         _store = _instance.getInstanceStore();
+        _bundleSet = _instance.getBundleSet();
     }
 
 
@@ -85,14 +83,51 @@ contract InstanceReader {
         return _store.getState(toPolicyKey(policyNftId));
     }
 
-    /// @dev returns true iff policy may be closed
-    /// a policy can be closed all conditions below are met
-    /// - policy exists
-    /// - has been activated
-    /// - is not yet closed
-    /// - has no open claims
-    /// - claim amount matches sum insured amount or is expired
-    function policyIsCloseable(NftId policyNftId)
+    function getPremiumInfo(NftId policyNftId) 
+        public
+        view
+        returns (IPolicy.PremiumInfo memory info)
+    {
+        bytes memory data = _store.getData(toPremiumKey(policyNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IPolicy.PremiumInfo));
+        }
+    }
+
+    function getPremiumInfoState(NftId policyNftId) 
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toPremiumKey(policyNftId));
+    }
+
+    function activeBundles(NftId poolNftId)
+        public
+        view
+        returns (uint256 bundles)
+    {
+        return _bundleSet.activeBundles(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx)
+        public
+        view
+        returns (NftId bundleNftId)
+    {
+        return _bundleSet.getActiveBundleNftId(poolNftId, idx);
+    }
+
+    function getBundleState(NftId bundleNftId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _store.getState(toBundleKey(bundleNftId));
+    }
+
+    /// @dev Returns true iff policy is active.
+    function policyIsActive(NftId policyNftId)
         public
         view
         returns (bool isCloseable)
@@ -101,17 +136,27 @@ contract InstanceReader {
 
         if (info.productNftId.eqz()) { return false; } // not closeable: policy does not exist (or does not belong to this instance)
         if (info.activatedAt.eqz()) { return false; } // not closeable: not yet activated
-        if (info.closedAt.gtz()) { return false; } // not closeable: already closed
-        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
+        if (info.activatedAt > TimestampLib.blockTimestamp()) { return false; } // not yet active
+        if (info.expiredAt <= TimestampLib.blockTimestamp()) { return false; } // already expired
+
+        return true;
+    }
 
-        // closeable: if sum of claims matches sum insured a policy may be closed prior to the expiry date
-        if (info.claimAmount == info.sumInsuredAmount) { return true; }
+    function claims(NftId policyNftId)
+        public
+        view
+        returns (uint16 claims)
+    {
+        return getPolicyInfo(policyNftId).claimsCount;
+    }
 
-        // not closeable: not yet expired
-        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
 
-        // all conditionsl to close the policy are met
-        return true; 
+    function getClaimId(uint idx)
+        public
+        view
+        returns (ClaimId claimId)
+    {
+        return ClaimIdLib.toClaimId(idx + 1);
     }
 
     function getClaimInfo(NftId policyNftId, ClaimId claimId)
@@ -125,6 +170,7 @@ contract InstanceReader {
         }
     }
 
+
     function getClaimState(NftId policyNftId, ClaimId claimId)
         public
         view
@@ -133,6 +179,34 @@ contract InstanceReader {
         return _store.getState(claimId.toKey32(policyNftId));
     }
 
+
+    function payouts(NftId policyNftId, ClaimId claimId)
+        public
+        view
+        returns (uint24 payouts)
+    {
+        return getClaimInfo(policyNftId, claimId).payoutsCount;
+    }
+
+
+    function getPayoutId(ClaimId claimId, uint24 idx)
+        public
+        view
+        returns (PayoutId payoutId)
+    {
+        return PayoutIdLib.toPayoutId(claimId, idx + 1);
+    }
+
+
+    function getRemainingClaimableAmount(NftId policyNftId)
+        public
+        view
+        returns (Amount remainingClaimableAmount)
+    {
+        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
+        return info.sumInsuredAmount - info.claimAmount;
+    }
+
     function getPayoutInfo(NftId policyNftId, PayoutId payoutId)
         public
         view
@@ -163,6 +237,19 @@ contract InstanceReader {
         }
     }
 
+    function getWallet(NftId componentNftId)
+        public
+        view
+        returns (address tokenHandler)
+    {
+        bytes memory data = _store.getData(toComponentKey(componentNftId));
+
+        if (data.length > 0) {
+            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
+            return info.wallet;
+        }
+    }
+
     function getTokenHandler(NftId componentNftId)
         public
         view
@@ -361,6 +448,9 @@ contract InstanceReader {
         return policyNftId.toKey32(POLICY());
     }
 
+    function toPremiumKey(NftId policyNftId) public pure returns (Key32) { 
+        return policyNftId.toKey32(PREMIUM());
+    }
 
     function toDistributorKey(NftId distributorNftId) public pure returns (Key32) { 
         return distributorNftId.toKey32(DISTRIBUTOR());