@etherisc/gif-next 0.0.2-e5a6af8-639 → 0.0.2-e5bdc7a-937

package/contracts/instance/InstanceReader.sol

@@ -27,6 +27,7 @@ import {TimestampLib} from "../type/Timestamp.sol";
 
 import {InstanceStore} from "./InstanceStore.sol";
 import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
 
 
 contract InstanceReader {
@@ -39,6 +40,7 @@ contract InstanceReader {
     IInstance internal _instance;
     InstanceStore internal _store;
     BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
 
     /// @dev This initializer needs to be called from the instance itself.
     function initialize() public {
@@ -59,6 +61,7 @@ contract InstanceReader {
         _instance = IInstance(instanceAddress);
         _store = _instance.getInstanceStore();
         _bundleSet = _instance.getBundleSet();
+        _riskSet = _instance.getRiskSet();
     }
 
 
@@ -102,6 +105,14 @@ contract InstanceReader {
         return _store.getState(toPremiumKey(policyNftId));
     }
 
+    function bundles(NftId poolNftId)
+        public
+        view
+        returns (uint256 bundles)
+    {
+        return _bundleSet.bundles(poolNftId);
+    }
+
     function activeBundles(NftId poolNftId)
         public
         view
@@ -118,6 +129,14 @@ contract InstanceReader {
         return _bundleSet.getActiveBundleNftId(poolNftId, idx);
     }
 
+    function getBundleNftId(NftId poolNftId, uint256 idx)
+        public
+        view
+        returns (NftId bundleNftId)
+    {
+        return _bundleSet.getBundleNftId(poolNftId, idx);
+    }
+
     function getBundleState(NftId bundleNftId)
         public
         view
@@ -226,6 +245,38 @@ contract InstanceReader {
         return _store.getState(payoutId.toKey32(policyNftId));
     }
 
+    function risks(NftId productNftId)
+        public
+        view
+        returns (uint256 activeRisks)
+    {
+        return _riskSet.risks(productNftId);
+    }
+
+    function getRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getRiskId(productNftId, idx);
+    }
+
+    function activeRisks(NftId productNftId)
+        public
+        view
+        returns (uint256 activeRisks)
+    {
+        return _riskSet.activeRisks(productNftId);
+    }
+
+    function getActiveRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getActiveRiskId(productNftId, idx);
+    }
+
     function getRiskInfo(RiskId riskId)
         public 
         view 
@@ -237,6 +288,31 @@ contract InstanceReader {
         }
     }
 
+    function getRiskState(RiskId riskId)
+        public 
+        view 
+        returns (StateId stateId)
+    {
+        bytes memory data = _store.getData(riskId.toKey32());
+        return _store.getState(riskId.toKey32());
+    }
+
+    function policiesForRisk(RiskId riskId)
+        public
+        view
+        returns (uint256 linkedPolicies)
+    {
+        return _riskSet.linkedPolicies(riskId);
+    }
+
+    function getPolicyNftIdForRisk(RiskId riskId, uint256 idx)
+        public
+        view
+        returns (NftId linkedPolicyNftId)
+    {
+        return _riskSet.getLinkedPolicyNftId(riskId, idx);
+    }
+
     function getWallet(NftId componentNftId)
         public
         view
@@ -246,7 +322,7 @@ contract InstanceReader {
 
         if (data.length > 0) {
             IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return info.wallet;
+            return info.tokenHandler.getWallet();
         }
     }
 
@@ -485,6 +561,14 @@ contract InstanceReader {
         return _store;
     }
 
+    function getBundleSet() external view returns (BundleSet bundleSet) {
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet riskSet) {
+        return _riskSet;
+    }
+
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
         return UFixedLib.toUFixed(value, exp);
     }

package/contracts/instance/InstanceService.sol

@@ -7,6 +7,7 @@ import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStri
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
 import {ChainNft} from "../registry/ChainNft.sol";
 import {NftId} from "../type/NftId.sol";
 import {RoleId} from "../type/RoleId.sol";
@@ -54,6 +55,7 @@ contract InstanceService is
     address internal _masterInstance;
     address internal _masterInstanceReader;
     address internal _masterInstanceBundleSet;
+    address internal _masterInstanceRiskSet;
     address internal _masterInstanceStore;
 
 
@@ -96,8 +98,8 @@ contract InstanceService is
     function createInstance()
         external 
         returns (
-            Instance clonedInstance,
-            NftId clonedInstanceNftId
+            IInstance instance,
+            NftId instanceNftId
         )
     {
         // tx sender will become instance owner
@@ -105,24 +107,24 @@ contract InstanceService is
 
         // create instance admin and instance
         InstanceAdmin instanceAdmin = _createInstanceAdmin();
-        clonedInstance = _createInstance(instanceAdmin, instanceOwner);
+        instance = _createInstance(instanceAdmin, instanceOwner);
 
         // register cloned instance with registry
-        clonedInstanceNftId = _registryService.registerInstance(
-            clonedInstance, instanceOwner).nftId;
+        instanceNftId = _registryService.registerInstance(
+            instance, instanceOwner).nftId;
 
         // register cloned instance as staking target
         _stakingService.createInstanceTarget(
-            clonedInstanceNftId,
+            instanceNftId,
             TargetManagerLib.getDefaultLockingPeriod(),
             TargetManagerLib.getDefaultRewardRate());
 
         // MUST be set after instance is set up and registered
-        instanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
+        instanceAdmin.initializeInstanceAuthorization(address(instance));
 
         emit LogInstanceCloned(
-            clonedInstanceNftId,
-            address(clonedInstance));
+            instanceNftId,
+            address(instance));
     }
 
 
@@ -214,7 +216,7 @@ contract InstanceService is
         if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
         if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
-
+        if(_masterInstanceRiskSet != address(0)) { revert ErrorInstanceServiceMasterRiskSetAlreadySet(); }
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         IInstance instance = IInstance(instanceAddress);
@@ -223,28 +225,34 @@ contract InstanceService is
         address instanceAdminAddress = address(instanceAdmin);
         InstanceReader instanceReader = instance.getInstanceReader();
         address instanceReaderAddress = address(instanceReader);
-        BundleSet bundleManager = instance.getBundleSet();
-        address bundleManagerAddress = address(bundleManager);
+        BundleSet bundleSet = instance.getBundleSet();
+        address bundleSetAddress = address(bundleSet);
+        RiskSet riskSet = instance.getRiskSet();
+        address riskSetAddress = address(riskSet);
         InstanceStore instanceStore = instance.getInstanceStore();
         address instanceStoreAddress = address(instanceStore);
 
         if(accessManagerAddress == address(0)) { revert ErrorInstanceServiceAccessManagerZero(); }
         if(instanceAdminAddress == address(0)) { revert ErrorInstanceServiceInstanceAdminZero(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderZero(); }
-        if(bundleManagerAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+        if(bundleSetAddress == address(0)) { revert ErrorInstanceServiceBundleSetZero(); }
+        if(riskSetAddress == address(0)) { revert ErrorInstanceServiceRiskSetZero(); }
         if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
         
         if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
-        if(bundleManager.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+        if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
+        if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
         if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
-        if(bundleManager.getInstance() != instance) { revert ErrorInstanceServiceBundleMangerInstanceMismatch(); }
+        if(bundleSet.getInstance() != instance) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
+        if(riskSet.getInstance() != instance) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
         if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
 
         _masterAccessManager = accessManagerAddress;
         _masterInstanceAdmin = instanceAdminAddress;
         _masterInstance = instanceAddress;
         _masterInstanceReader = instanceReaderAddress;
-        _masterInstanceBundleSet = bundleManagerAddress;
+        _masterInstanceBundleSet = bundleSetAddress;
+        _masterInstanceRiskSet = riskSetAddress;
         _masterInstanceStore = instanceStoreAddress;
         
         IInstance masterInstance = IInstance(_masterInstance);
@@ -293,9 +301,11 @@ contract InstanceService is
         clonedAccessManager.initialize(
             address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
 
+        address authorization = address(
+            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
         clonedInstanceAdmin.initialize(
             clonedAccessManager,
-            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
+            authorization);
     }
 
 
@@ -307,21 +317,24 @@ contract InstanceService is
     )
         internal
         virtual
-        returns (Instance clonedInstance)
+        returns (IInstance)
     {
         InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
         BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
+        RiskSet clonedRiskSet = RiskSet(Clones.clone(_masterInstanceRiskSet));
         InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
 
         // clone instance
-        clonedInstance = Instance(Clones.clone(_masterInstance));
+        Instance clonedInstance = Instance(Clones.clone(_masterInstance));
         clonedInstance.initialize(
             instanceAdmin,
             clonedInstanceStore,
             clonedBundleSet,
+            clonedRiskSet,
             clonedInstanceReader,
             getRegistry(),
             instanceOwner);
+        return clonedInstance;
     }
 
 

package/contracts/instance/RiskSet.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {Key32} from "../type/Key32.sol";
+import {LibNftIdSet} from "../type/NftIdSet.sol";
+import {NftId} from "../type/NftId.sol";
+import {RiskIdLib, RiskId} from "../type/RiskId.sol";
+
+import {ObjectSet} from "./base/ObjectSet.sol";
+
+contract RiskSet is 
+    ObjectSet
+{
+    using LibNftIdSet for LibNftIdSet.Set;
+
+    event LogRiskSetPolicyLinked(RiskId riskId, NftId policyNftId);
+    event LogRiskSetPolicyUnlinked(RiskId riskId, NftId policyNftId);
+
+    event LogRiskSetRiskAdded(NftId productNftId, RiskId riskId);
+    event LogRiskSetRiskActive(NftId poolNftId,  RiskId riskId);
+    event LogRiskSetRiskPaused(NftId poolNftId,  RiskId riskId);
+    event LogRiskSetRiskArchived(NftId poolNftId,  RiskId riskId);
+
+    error ErrorRiskSetRiskLocked(RiskId riskId, NftId policyNftId); 
+    error ErrorRiskSetRiskUnknown(RiskId riskId);
+    error ErrorRiskSetRiskNotRegistered(RiskId riskId);
+
+    mapping(RiskId riskId => LibNftIdSet.Set policies) internal _activePolicies;
+
+    /// @dev links a policy to its bundle
+    function linkPolicy(NftId productNftId, RiskId riskId, NftId policyNftId) external restricted() {
+
+        // ensure risk is active (in active set) and registered with this instance
+        if (!_isActive(productNftId, riskId.toKey32())) {
+            revert ErrorRiskSetRiskLocked(riskId, policyNftId);
+        }
+
+        _activePolicies[riskId].add(policyNftId);
+        emit LogRiskSetPolicyLinked(riskId, policyNftId);
+    }
+
+    /// @dev Unlinks a policy from its risk.
+    function unlinkPolicy(NftId productNftId, RiskId riskId, NftId policyNftId) external restricted() {
+
+        // ensure risk is registered with this instance
+        if (!_contains(productNftId, riskId.toKey32())) {
+            revert ErrorRiskSetRiskUnknown(riskId);
+        }
+
+        _activePolicies[riskId].remove(policyNftId);
+        emit LogRiskSetPolicyUnlinked(riskId, policyNftId);
+    }
+
+    /// @dev add a new risk to a product registered with this instance
+    // the corresponding product is fetched via instance reader
+    function add(RiskId riskId) external restricted() {
+        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+
+        // ensure product is registered with instance
+        if(productNftId.eqz()) {
+            revert ErrorRiskSetRiskNotRegistered(riskId);
+        }
+
+        _add(productNftId, riskId.toKey32());
+        emit LogRiskSetRiskAdded(productNftId, riskId);
+    }
+
+    /// @dev Applications linked to active risks may be underwritten
+    function activate(RiskId riskId) external restricted() {
+        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        _activate(productNftId, riskId.toKey32());
+        emit LogRiskSetRiskActive(productNftId, riskId);
+    }
+
+    /// @dev Applications linked to paused/archived risks may not be underwritten
+    function pause(RiskId riskId) external restricted() {
+        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        _deactivate(productNftId, riskId.toKey32());
+        emit LogRiskSetRiskPaused(productNftId, riskId);
+    }
+
+    function checkRisk(NftId productNftId, RiskId riskId)
+        public
+        view 
+        returns (bool exists, bool active)
+    {
+        Key32 riskKey32 = riskId.toKey32();
+        exists = _contains(productNftId, riskKey32);
+
+        if (exists) {
+            active = _isActive(productNftId, riskKey32);
+        }
+    }
+
+    function risks(NftId productNftId) external view returns(uint256) {
+        return _objects(productNftId);
+    }
+
+    function getRiskId(NftId productNftId, uint256 idx) external view returns(RiskId riskId) {
+        return RiskIdLib.toRiskId(_getObject(productNftId, idx).toKeyId());
+    }
+    
+    function activeRisks(NftId productNftId) external view returns(uint256) {
+        return _activeObjs(productNftId);
+    }
+
+    function getActiveRiskId(NftId productNftId, uint256 idx) external view returns(RiskId riskId) {
+        return RiskIdLib.toRiskId(_getActiveObject(productNftId, idx).toKeyId());
+    }
+
+    function linkedPolicies(RiskId riskId) external view returns(uint256) {
+        return _activePolicies[riskId].size();
+    }
+
+    function getLinkedPolicyNftId(RiskId riskId, uint256 idx) external view returns(NftId policyNftId) {
+        return _activePolicies[riskId].getElementAt(idx);
+    }
+}

package/contracts/instance/base/ObjectSet.sol

@@ -4,22 +4,21 @@ pragma solidity ^0.8.20;
 import {Cloneable} from "./Cloneable.sol";
 
 import {IInstance} from "../IInstance.sol";
-import {INSTANCE} from "../../type/ObjectType.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {LibNftIdSet} from "../../type/NftIdSet.sol";
+import {LibKey32Set} from "../../type/Key32Set.sol";
 import {NftId} from "../../type/NftId.sol";
+import {Key32} from "../../type/Key32.sol";
 
 contract ObjectSet is
     Cloneable
 {
+    using LibKey32Set for LibKey32Set.Set;
 
     event LogObjectSetInitialized(address instance);
 
     error ErrorObjectSetNftIdInvalid(NftId instanceNftId);
 
-    mapping(NftId compnentNftId => LibNftIdSet.Set objects) internal _activeObjects;
-    mapping(NftId compnentNftId => LibNftIdSet.Set objects) internal _allObjects;
+    mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _activeObjects;
+    mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _allObjects;
     IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectSet initialization
 
     /// @dev This initializer needs to be called from the instance itself.
@@ -37,43 +36,43 @@ contract ObjectSet is
         return _instance;
     }
 
-    function _add(NftId componentNftId, NftId objectNftId) internal {
-        LibNftIdSet.Set storage allSet = _allObjects[componentNftId];
-        LibNftIdSet.Set storage activeSet = _activeObjects[componentNftId];
+    function _add(NftId componentNftId, Key32 key) internal {
+        LibKey32Set.Set storage allSet = _allObjects[componentNftId];
+        LibKey32Set.Set storage activeSet = _activeObjects[componentNftId];
 
-        LibNftIdSet.add(allSet, objectNftId);
-        LibNftIdSet.add(activeSet, objectNftId);
+        allSet.add(key);
+        activeSet.add(key);
     }
 
-    function _activate(NftId componentNftId, NftId objectNftId) internal {
-        LibNftIdSet.add(_activeObjects[componentNftId], objectNftId);
+    function _activate(NftId componentNftId, Key32 key) internal {
+        _activeObjects[componentNftId].add(key);
     }
 
-    function _deactivate(NftId componentNftId, NftId objectNftId) internal {
-        LibNftIdSet.remove(_activeObjects[componentNftId], objectNftId);
+    function _deactivate(NftId componentNftId, Key32 key) internal {
+        _activeObjects[componentNftId].remove(key);
     }
 
     function _objects(NftId componentNftId) internal view returns (uint256) {
-        return LibNftIdSet.size(_allObjects[componentNftId]);
+        return _allObjects[componentNftId].size();
     }
 
-    function _contains(NftId componentNftId, NftId objectNftId) internal view returns (bool) {
-        return LibNftIdSet.contains(_allObjects[componentNftId], objectNftId);
+    function _contains(NftId componentNftId, Key32 key) internal view returns (bool) {
+        return _allObjects[componentNftId].contains(key);
     }
 
-    function _getObject(NftId componentNftId, uint256 idx) internal view returns (NftId) {
-        return LibNftIdSet.getElementAt(_allObjects[componentNftId], idx);
+    function _getObject(NftId componentNftId, uint256 idx) internal view returns (Key32) {
+        return _allObjects[componentNftId].getElementAt(idx);
     }
 
     function _activeObjs(NftId componentNftId) internal view returns (uint256)  {
-        return LibNftIdSet.size(_activeObjects[componentNftId]);
+        return _activeObjects[componentNftId].size();
     }
 
-    function _isActive(NftId componentNftId, NftId objectNftId) internal view returns (bool) {
-        return LibNftIdSet.contains(_activeObjects[componentNftId], objectNftId);
+    function _isActive(NftId componentNftId, Key32 key) internal view returns (bool) {
+        return _activeObjects[componentNftId].contains(key);
     }
 
-    function _getActiveObject(NftId componentNftId, uint256 idx) internal view returns (NftId) {
-        return LibNftIdSet.getElementAt(_activeObjects[componentNftId], idx);
+    function _getActiveObject(NftId componentNftId, uint256 idx) internal view returns (Key32) {
+        return _activeObjects[componentNftId].getElementAt(idx);
     }
 }

package/contracts/instance/module/IComponents.sol

@@ -16,12 +16,12 @@ interface IComponents {
         string name; // component name (needs to be unique per instance)
         IERC20Metadata token;
         TokenHandler tokenHandler;
-        address wallet;
         bytes data; // will hold component type specific additional info (eg encoded pool info)
     }
 
     struct ProductInfo {
         bool isProcessingFundedClaims; // custom logic to react to pool events for funded claims
+        bool isInterceptingPolicyTransfers; // custom logic for policy nft transfers
         bool hasDistribution; // flag to indicate if distribution is enabled
         uint8 expectedNumberOfOracles; // expected number of oracles
         uint8 numberOfOracles; // actual number of oracles
@@ -40,7 +40,6 @@ interface IComponents {
 
     struct PoolInfo {
         Amount maxBalanceAmount; // max balance amount allowed for pool
-        RoleId bundleOwnerRole; // the required role for bundle owners
         bool isInterceptingBundleTransfers; // custom logic for bundle nft transfers
         bool isProcessingConfirmedClaims; // custom logic for claims confirmation
         bool isExternallyManaged; // funding bundles is restricted to book keeping, actual funds may be provided as needed to support payouts

package/contracts/instance/module/IPolicy.sol

@@ -43,6 +43,7 @@ interface IPolicy {
 
     /// @dev policy data for the full policy lifecycle
     struct PolicyInfo {
+        // application data, no changes after applying for a policy
         NftId productNftId;
         NftId bundleNftId;
         ReferralId referralId;
@@ -50,8 +51,8 @@ interface IPolicy {
         Amount sumInsuredAmount;
         Amount premiumAmount; // expected premium at application time
         Seconds lifetime;
-        // policy application data, no changes after applying for a policy
         bytes applicationData;
+        // policy data that may change during the lifecycle
         bytes processData;
         uint16 claimsCount;
         uint16 openClaimsCount;

package/contracts/instance/module/IRisk.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {NftId} from "../../type/NftId.sol";
 
 interface IRisk {
+
     struct RiskInfo {
         NftId productNftId;
         bytes data;