@etherisc/gif-next 0.0.2-78e428e-483 → 0.0.2-791e161-234

package/contracts/instance/BundleSet.sol

@@ -1,20 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IInstance} from "./IInstance.sol";
-import {INSTANCE} from "../type/ObjectType.sol";
-import {InstanceReader} from "./InstanceReader.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
 import {LibNftIdSet} from "../type/NftIdSet.sol";
-import {NftId} from "../type/NftId.sol";
-import {TimestampLib} from "../type/Timestamp.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {Key32} from "../type/Key32.sol";
+import {BUNDLE} from "../type/ObjectType.sol";
 
 import {ObjectSet} from "./base/ObjectSet.sol";
 
 contract BundleSet is 
     ObjectSet
 {
+    using LibNftIdSet for LibNftIdSet.Set;
 
     event LogBundleSetPolicyLinked(NftId bundleNftId, NftId policyNftId);
     event LogBundleSetPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
@@ -34,40 +32,28 @@ contract BundleSet is
     mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
 
     /// @dev links a policy to its bundle
-    // to link a policy it MUST NOT yet have been linked
-    function linkPolicy(NftId policyNftId) external restricted() {
-        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
-        // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+    function linkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
 
         // ensure bundle is unlocked (in active set) and registered with this instance
-        if (!_isActive(poolNftId, bundleNftId)) {
+        if (!_isActive(poolNftId, _toBundleKey32(bundleNftId))) {
             revert ErrorBundleSetBundleLocked(bundleNftId, policyNftId);
         }
 
-        LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
+        _activePolicies[bundleNftId].add(policyNftId);
         emit LogBundleSetPolicyLinked(bundleNftId, policyNftId);
     }
 
 
     /// @dev unlinks a policy from its bundle
-    // to unlink a policy it must closable, ie. meet one of the following criterias
-    // - the policy MUST be past its expiry period and it MUST NOT have any open claims
-    // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
-    function unlinkPolicy(NftId policyNftId) external restricted() {
-        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
-
-        NftId bundleNftId = policyInfo.bundleNftId;
-        // decision will likely depend on the decision what to check here and what in the service
-        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+    function unlinkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
 
         // ensure bundle is registered with this instance
-        if (!_contains(poolNftId, bundleNftId)) {
+        if (!_contains(poolNftId, _toBundleKey32(bundleNftId))) {
             revert ErrorBundleSetBundleUnknown(bundleNftId);
         }
 
-        LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
-        emit LogBundleSetPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+        _activePolicies[bundleNftId].remove(policyNftId);
+        emit LogBundleSetPolicyUnlinked(bundleNftId, policyNftId);
     }
 
 
@@ -81,7 +67,7 @@ contract BundleSet is
             revert ErrorBundleSetBundleNotRegistered(bundleNftId);
         }
 
-        _add(poolNftId, bundleNftId);
+        _add(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleAdded(poolNftId, bundleNftId);
     }
 
@@ -89,38 +75,56 @@ contract BundleSet is
     /// @dev unlocked (active) bundles are available to collateralize new policies
     function unlock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
-        _activate(poolNftId, bundleNftId);
+        _activate(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleUnlocked(poolNftId, bundleNftId);
     }
 
     /// @dev locked (deactivated) bundles may not collateralize any new policies
     function lock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
-        _deactivate(poolNftId, bundleNftId);
+        _deactivate(poolNftId, _toBundleKey32(bundleNftId));
         emit LogBundleSetBundleLocked(poolNftId, bundleNftId);
     }
 
+
+    function checkBundle(NftId productNftId, NftId bundleId)
+        public
+        view 
+        returns (bool exists, bool active)
+    {
+        Key32 bundleKey32 = bundleId.toKey32(BUNDLE());
+        exists = _contains(productNftId, bundleKey32);
+
+        if (exists) {
+            active = _isActive(productNftId, bundleKey32);
+        }
+    }
+
     function bundles(NftId poolNftId) external view returns(uint256) {
         return _objects(poolNftId);
     }
 
-    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
-        return _getObject(poolNftId, idx);
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getObject(poolNftId, idx).toKeyId());
     }
 
     function activeBundles(NftId poolNftId) external view returns(uint256) {
         return _activeObjs(poolNftId);
     }
 
-    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
-        return _getActiveObject(poolNftId, idx);
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getActiveObject(poolNftId, idx).toKeyId());
     }
 
     function activePolicies(NftId bundleNftId) external view returns(uint256) {
-        return LibNftIdSet.size(_activePolicies[bundleNftId]);
+        return _activePolicies[bundleNftId].size();
     }
 
     function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
-        return LibNftIdSet.getElementAt(_activePolicies[bundleNftId], idx);
+        return _activePolicies[bundleNftId].getElementAt(idx);
+    }
+
+    function _toBundleKey32(NftId nftId) private pure returns (Key32) {
+        return nftId.toKey32(BUNDLE());
     }
 }

package/contracts/instance/IInstance.sol

@@ -1,48 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-
 import {Amount} from "../type/Amount.sol";
-import {ClaimId} from "../type/ClaimId.sol";
-import {DistributorType} from "../type/DistributorType.sol";
-import {PayoutId} from "../type/PayoutId.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
 import {NftId} from "../type/NftId.sol";
-import {StateId} from "../type/StateId.sol";
-import {ReferralId} from "../type/Referral.sol";
-import {RiskId} from "../type/RiskId.sol";
-import {VersionPart} from "../type/Version.sol";
-import {Key32} from "../type/Key32.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-
-import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleSet} from "./BundleSet.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {InstanceStore} from "./InstanceStore.sol";
-
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
-
-import {IAccess} from "./module/IAccess.sol";
-
-import {IBundleService} from "../pool/IBundleService.sol";
-import {IDistributionService} from "../distribution/IDistributionService.sol";
-import {IPolicyService} from "../product/IPolicyService.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";
-
 
 interface IInstance is 
-    IRegisterable, 
-    ITransferInterceptor, 
-    IAccessManaged
+    IRegisterable
 {
     error ErrorInstanceInstanceAdminZero();
     error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
@@ -52,6 +25,10 @@ interface IInstance is
     error ErrorInstanceBundleSetInstanceMismatch(address instance);
     error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
+    error ErrorInstanceRiskSetAlreadySet(address instanceRiskSet);
+    error ErrorInstanceRiskSetInstanceMismatch(address instance);
+    error ErrorInstanceRiskSetAuthorityMismatch(address instanceAuthority);
+
     error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
@@ -61,13 +38,16 @@ interface IInstance is
         uint64 requestsCount;
     }
 
+    /// @dev Register a product with the instance.
+    function registerProduct(address product) external returns (NftId productNftId);
+
     function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
     function grantRole(RoleId roleId, address account) external;
     function revokeRole(RoleId roleId, address account) external;
 
     function createTarget(address target, string memory name) external;
     function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
-    function setTargetLocked(address target, bool locked) external;
+    function setLocked(address target, bool locked) external;
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
     function setStakingRewardRate(UFixed rewardRate) external;
@@ -78,9 +58,9 @@ interface IInstance is
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
     // get instance release and supporting contracts
-    function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleSet() external view returns (BundleSet);
+    function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
 }

package/contracts/instance/IInstanceService.sol

@@ -2,13 +2,10 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {BundleSet} from "./BundleSet.sol";
-import {Instance} from "./Instance.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IInstance} from "./IInstance.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
-import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -25,6 +22,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceMasterInstanceAlreadySet();
     error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
     error ErrorInstanceServiceMasterBundleSetAlreadySet();
+    error ErrorInstanceServiceMasterRiskSetAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
     error ErrorInstanceServiceMasterInstanceReaderNotSet();
@@ -36,12 +34,15 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
     error ErrorInstanceServiceBundleSetZero();
+    error ErrorInstanceServiceRiskSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
     error ErrorInstanceServiceBundleSetAuthorityMismatch();
+    error ErrorInstanceServiceRiskSetAuthorityMismatch();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
-    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+    error ErrorInstanceServiceBundleSetInstanceMismatch();
+    error ErrorInstanceServiceRiskSetInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
@@ -55,11 +56,12 @@ interface IInstanceService is IService {
     function createInstance()
         external 
         returns (
-            // TODO check if Instance can be changed to IInstance
-            Instance clonedInstance,
+            IInstance instance,
             NftId instanceNftId
         );
 
+    function upgradeInstanceReader(NftId instanceNftId) external;
+    function upgradeMasterInstanceReader(address instanceReaderAddress) external;
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
     function setStakingRewardRate(UFixed rewardRate) external;
@@ -67,26 +69,4 @@ interface IInstanceService is IService {
 
     /// @dev Defunds the staking reward reserves for the specified target.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
-
-    /// @dev Sets up the component authorization for the specified instance.
-    /// The authorization is based on the authz specification provided by the component via getAuthorization.
-    function initializeAuthorization(NftId instanceNftId, IInstanceLinkedComponent component) external;
-
-    function createComponentTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    ) external;
-
-    function createGifTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    ) external;
-
-    function setComponentLocked(bool locked) external;
 }

package/contracts/instance/Instance.sol

@@ -1,61 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
 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 {RiskSet} from "./RiskSet.sol";
+import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
 import {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleSet} from "./BundleSet.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 {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../type/NftId.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";
 
 contract Instance is
     IInstance,
-    AccessManagedUpgradeable,
     Registerable
 {
-    uint256 public constant GIF_MAJOR_VERSION = 3;
-
     bool private _initialized;
 
+    IComponentService internal _componentService;
     IInstanceService internal _instanceService;
     InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
-    BundleSet internal _bundleManager;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
 
     modifier onlyChainNft() {
@@ -68,7 +42,8 @@ contract Instance is
     function initialize(
         InstanceAdmin instanceAdmin, 
         InstanceStore instanceStore,
-        BundleSet bundleManager,
+        BundleSet bundleSet,
+        RiskSet riskSet,
         InstanceReader instanceReader,
         IRegistry registry, 
         address initialOwner
@@ -76,17 +51,15 @@ contract Instance is
         external 
         initializer()
     {
-        _instanceAdmin = instanceAdmin;
-        if(_instanceAdmin.authority() == address(0)) {
-            // TODO rename error
+        if(address(instanceAdmin) == address(0)) {
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        // set authority to instance admin authority
-        __AccessManaged_init(_instanceAdmin.authority());
+        _instanceAdmin = instanceAdmin;
 
         // setup instance object info
-        initializeRegisterable(
+        __Registerable_init(
+            instanceAdmin.authority(),
             address(registry), 
             registry.getNftId(), 
             INSTANCE(), 
@@ -96,27 +69,42 @@ contract Instance is
 
         // store instance supporting contracts
         _instanceStore = instanceStore;
-        _bundleManager = bundleManager;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
         _instanceReader = instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
-        _bundleManager.initialize();
+        _bundleSet.initialize();
+        _riskSet.initialize();
         _instanceReader.initialize();
 
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                getRelease()));
+
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
                 INSTANCE(), 
-                getMajorVersion()));
+                getRelease()));
 
-        registerInterface(type(IInstance).interfaceId);    
+        _registerInterface(type(IInstance).interfaceId);    
+    }
+
+    //--- ProductRegistration ----------------------------------------------//
+    function registerProduct(address product)
+        external
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        return _componentService.registerProduct(product);
     }
 
     //--- Staking ----------------------------------------------------------//
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
-        // TODO decide if onlyOwner or restricted to instance owner role is better
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -193,23 +181,16 @@ contract Instance is
         // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
     }
 
-    function setTargetLocked(address target, bool locked)
+    function setLocked(address target, bool locked)
         external 
         onlyOwner()
     {
-        // TODO refactor
-        // _instanceAdmin.setTargetLockedByInstance(target, locked);
+        _componentService.setLockedFromInstance(target, locked);
     }
 
     //--- ITransferInterceptor ----------------------------------------------//
 
-    // TODO interception of child components nfts
-    function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        // TODO refactor
-        // _instanceAdmin.transferInstanceOwnerRole(address(0), to);
-    }
-
-    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
         // TODO refactor
         // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
@@ -235,7 +216,11 @@ contract Instance is
     }
 
     function getBundleSet() external view returns (BundleSet) {
-        return _bundleManager;
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
     }
 
     function getInstanceAdmin() external view returns (InstanceAdmin) {
@@ -246,9 +231,5 @@ contract Instance is
         return _instanceStore;
     }
 
-    function getMajorVersion() public pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
-    }
-
     //--- internal view/pure functions --------------------------------------//
 }