@etherisc/gif-next 0.0.2-f634e5c-828 → 0.0.2-f689687-279

package/contracts/instance/InstanceReader.sol

@@ -1,19 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../type/Amount.sol";
-import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
-import {DistributorType} from "../type/DistributorType.sol";
-import {Key32} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.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, UFixedLib} from "../type/UFixed.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
@@ -22,12 +10,28 @@ import {IInstance} from "./IInstance.sol";
 import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
 import {IOracle} from "../oracle/IOracle.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
 import {TimestampLib} from "../type/Timestamp.sol";
 
-import {InstanceStore} from "./InstanceStore.sol";
+import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
+import {BUNDLE, COMPONENT, DISTRIBUTOR, DISTRIBUTION, FEE, PREMIUM, POLICY, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {Key32} from "../type/Key32.sol";
+import {NftId} from "../type/NftId.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 {RiskSet} from "./RiskSet.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {StateId} from "../type/StateId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {UFixed, UFixedLib} from "../type/UFixed.sol";
+
 
 
 contract InstanceReader {
@@ -37,7 +41,9 @@ contract InstanceReader {
 
     bool private _initialized = false;
 
+    IRegistry internal _registry;
     IInstance internal _instance;
+
     InstanceStore internal _store;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
@@ -51,7 +57,6 @@ contract InstanceReader {
         initializeWithInstance(msg.sender);
     }
 
-    /// @dev This initializer needs to be called from the instance itself.
     function initializeWithInstance(address instanceAddress)
         public
     {
@@ -61,12 +66,28 @@ contract InstanceReader {
 
         _initialized = true;
         _instance = IInstance(instanceAddress);
+        _registry = _instance.getRegistry();
+
         _store = _instance.getInstanceStore();
         _bundleSet = _instance.getBundleSet();
         _riskSet = _instance.getRiskSet();
     }
 
 
+    // instance level functions
+
+    function getRegistry() public view returns (IRegistry registry) {
+        return _registry;
+    }
+
+    function getInstanceNftId() public view returns (NftId instanceNftid) {
+        return _registry.getNftIdForAddress(address(_instance));
+    }
+
+    function getInstance() public view returns (IInstance instance) {
+        return _instance;
+    }
+
     // module specific functions
 
     function getPolicyInfo(NftId policyNftId)
@@ -110,7 +131,7 @@ contract InstanceReader {
     function bundles(NftId poolNftId)
         public
         view
-        returns (uint256 bundles)
+        returns (uint256 bundleCount)
     {
         return _bundleSet.bundles(poolNftId);
     }
@@ -118,7 +139,7 @@ contract InstanceReader {
     function activeBundles(NftId poolNftId)
         public
         view
-        returns (uint256 bundles)
+        returns (uint256 bundleCount)
     {
         return _bundleSet.activeBundles(poolNftId);
     }
@@ -166,7 +187,7 @@ contract InstanceReader {
     function claims(NftId policyNftId)
         public
         view
-        returns (uint16 claims)
+        returns (uint16 claimCount)
     {
         return getPolicyInfo(policyNftId).claimsCount;
     }
@@ -204,7 +225,7 @@ contract InstanceReader {
     function payouts(NftId policyNftId, ClaimId claimId)
         public
         view
-        returns (uint24 payouts)
+        returns (uint24 payoutCount)
     {
         return getClaimInfo(policyNftId, claimId).payoutsCount;
     }
@@ -250,7 +271,7 @@ contract InstanceReader {
     function risks(NftId productNftId)
         public
         view
-        returns (uint256 activeRisks)
+        returns (uint256 riskCount)
     {
         return _riskSet.risks(productNftId);
     }
@@ -266,7 +287,7 @@ contract InstanceReader {
     function activeRisks(NftId productNftId)
         public
         view
-        returns (uint256 activeRisks)
+        returns (uint256 activeRiskCount)
     {
         return _riskSet.activeRisks(productNftId);
     }
@@ -315,32 +336,43 @@ contract InstanceReader {
         return _riskSet.getLinkedPolicyNftId(riskId, idx);
     }
 
-    function getWallet(NftId componentNftId)
+
+    function getToken(NftId componentNftId)
         public
         view
-        returns (address tokenHandler)
+        returns (IERC20Metadata token)
     {
-        bytes memory data = _store.getData(toComponentKey(componentNftId));
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.TOKEN();
+        }
+    }
 
-        if (data.length > 0) {
-            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return info.tokenHandler.getWallet();
+
+    function getWallet(NftId componentNftId)
+        public
+        view
+        returns (address wallet)
+    {
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.getWallet();
         }
     }
 
+
     function getTokenHandler(NftId componentNftId)
         public
         view
-        returns (address tokenHandler)
+        returns (TokenHandler tokenHandler)
     {
         bytes memory data = _store.getData(toComponentKey(componentNftId));
-
         if (data.length > 0) {
-            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return address(info.tokenHandler);
+            return abi.decode(data, (IComponents.ComponentInfo)).tokenHandler;
         }
     }
 
+
     function getBundleInfo(NftId bundleNftId)
         public 
         view 
@@ -408,6 +440,17 @@ contract InstanceReader {
         }
     }
 
+    function getFeeInfo(NftId productNftId)
+        public
+        view
+        returns (IComponents.FeeInfo memory feeInfo)
+    {
+        bytes memory data = _store.getData(toFeeKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.FeeInfo));
+        }
+    }
+
     function getPoolInfo(NftId poolNftId)
         public
         view
@@ -518,7 +561,7 @@ contract InstanceReader {
     }
 
 
-    function isTargetLocked(address target) public view returns (bool) {
+    function isLocked(address target) public view returns (bool) {
         return _instance.getInstanceAdmin().isTargetLocked(target);
     }
 
@@ -554,11 +597,12 @@ contract InstanceReader {
         return productNftId.toKey32(PRODUCT());
     }
 
-    // low level function
-    function getInstance() external view returns (IInstance instance) {
-        return _instance;
+    function toFeeKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(FEE());
     }
 
+    // low level function
+
     function getInstanceStore() external view returns (IKeyValueStore store) {
         return _store;
     }

package/contracts/instance/InstanceService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
@@ -80,6 +81,7 @@ contract InstanceService is
         _;
     }
 
+
     // TODO check component - service - instance version match
     modifier onlyComponent() {
         if (! getRegistry().isRegisteredComponent(msg.sender)) {
@@ -90,6 +92,7 @@ contract InstanceService is
 
     function createInstance()
         external 
+        restricted()
         returns (
             IInstance instance,
             NftId instanceNftId
@@ -113,7 +116,11 @@ contract InstanceService is
             TargetManagerLib.getDefaultRewardRate());
 
         // MUST be set after instance is set up and registered
-        instanceAdmin.initializeInstanceAuthorization(address(instance));
+        IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
+        VersionPart release = AccessManagerCloneable(authority()).getRelease();
+        instanceAdmin.completeSetup(
+            address(instance),
+            address(instanceAuthorization));
 
         emit LogInstanceCloned(
             instanceNftId,
@@ -124,6 +131,7 @@ contract InstanceService is
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -136,6 +144,7 @@ contract InstanceService is
     function setStakingRewardRate(UFixed rewardRate)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -148,6 +157,7 @@ contract InstanceService is
     function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -161,6 +171,7 @@ contract InstanceService is
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
         returns (Amount newBalance)
     {
@@ -170,14 +181,26 @@ contract InstanceService is
             dipAmount);
     }
 
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
+    function upgradeInstanceReader(NftId instanceNftId) 
+        external 
+        nonReentrant()
+        restricted()
+        onlyInstanceOwner(instanceNftId) 
+        onlyNftOfType(instanceNftId, INSTANCE())
+    {
+        IRegistry registry = getRegistry();
+        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
+        Instance instance = Instance(instanceInfo.objectAddress);
+        
+        InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
+        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
+        instance.setInstanceReader(upgradedInstanceReaderClone);
     }
 
     function setAndRegisterMasterInstance(address instanceAddress)
-            external 
-            onlyOwner 
-            returns(NftId masterInstanceNftId)
+        external 
+        onlyOwner()
+        returns(NftId masterInstanceNftId)
     {
         if(_masterInstance != address(0)) { revert ErrorInstanceServiceMasterInstanceAlreadySet(); }
         if(_masterInstanceAdmin != address(0)) { revert ErrorInstanceServiceMasterInstanceAdminAlreadySet(); }
@@ -209,8 +232,8 @@ contract InstanceService is
         if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
         if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
         if(instanceStore.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceStoreAuthorityMismatch(); }
-        if(bundleSet.getInstance() != instance) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
-        if(riskSet.getInstance() != instance) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
+        if(bundleSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
+        if(riskSet.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceRiskSetInstanceMismatch(); }
         if(instanceReader.getInstance() != instance) { revert ErrorInstanceServiceInstanceReaderInstanceMismatch2(); }
 
         _masterAccessManager = accessManagerAddress;
@@ -226,7 +249,10 @@ contract InstanceService is
         masterInstanceNftId = info.nftId;
     }
 
-    function upgradeMasterInstanceReader(address instanceReaderAddress) external onlyOwner {
+    function upgradeMasterInstanceReader(address instanceReaderAddress)
+        external
+        onlyOwner
+    {
         if(_masterInstanceReader == address(0)) { revert ErrorInstanceServiceMasterInstanceReaderNotSet(); }
         if(instanceReaderAddress == address(0)) { revert ErrorInstanceServiceInstanceReaderAddressZero(); }
         if(instanceReaderAddress == _masterInstanceReader) { revert ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader(); }
@@ -237,19 +263,8 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
     }
 
-    function upgradeInstanceReader(NftId instanceNftId) 
-        external 
-        nonReentrant()
-        onlyInstanceOwner(instanceNftId) 
-        onlyNftOfType(instanceNftId, INSTANCE())
-    {
-        IRegistry registry = getRegistry();
-        IRegistry.ObjectInfo memory instanceInfo = registry.getObjectInfo(instanceNftId);
-        Instance instance = Instance(instanceInfo.objectAddress);
-        
-        InstanceReader upgradedInstanceReaderClone = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-        upgradedInstanceReaderClone.initializeWithInstance(address(instance));
-        instance.setInstanceReader(upgradedInstanceReaderClone);
+    function getMasterInstanceReader() external view returns (address) {
+        return _masterInstanceReader;
     }
 
     /// @dev create new cloned instance admin
@@ -260,19 +275,16 @@ contract InstanceService is
         returns (InstanceAdmin clonedInstanceAdmin)
     {
         // start with setting up a new OZ access manager
+        // TODO consider _masterInstanceAdmin.authority() instead of _masterAccessManager
         AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
             Clones.clone(_masterAccessManager));
         
         // set up the instance admin
         clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedAccessManager.initialize(
-            address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
-
-        address authorization = address(
-            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
         clonedInstanceAdmin.initialize(
             clonedAccessManager,
-            authorization);
+            getRegistry(),
+            getRelease());
     }
 
 
@@ -344,11 +356,11 @@ contract InstanceService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _stakingService = IStakingService(_getServiceAddress(STAKING()));

package/contracts/instance/InstanceServiceManager.sol

@@ -17,7 +17,7 @@ contract InstanceServiceManager is ProxyManager {
     ) 
     {
         InstanceService svc = new InstanceService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/instance/InstanceStore.sol

@@ -7,10 +7,10 @@ import {Amount} from "../type/Amount.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR, FEE} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {StateId} from "../type/StateId.sol";
+import {StateId, KEEP_STATE} from "../type/StateId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -85,6 +85,17 @@ contract InstanceStore is
         _update(_toNftKey32(productNftId, PRODUCT()), abi.encode(info), newState);
     }
 
+
+    //--- Fee -----------------------------------------------------------//
+    function createFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _create(_toNftKey32(productNftId, FEE()), abi.encode(info));
+    }
+
+    // Fee only has one state, so no change change possible
+    function updateFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _update(_toNftKey32(productNftId, FEE()), abi.encode(info), KEEP_STATE());
+    }
+
     //--- Pool --------------------------------------------------------------//
 
     function createPool(

package/contracts/instance/RiskSet.sol

@@ -1,18 +1,17 @@
 // 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";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+import {RiskIdLib, RiskId} from "../type/RiskId.sol";
 
-contract RiskSet is 
+/// @dev RiskSet manages the risks and its active policies per product.
+contract RiskSet is
     ObjectSet
 {
-    using LibNftIdSet for LibNftIdSet.Set;
 
     event LogRiskSetPolicyLinked(RiskId riskId, NftId policyNftId);
     event LogRiskSetPolicyUnlinked(RiskId riskId, NftId policyNftId);
@@ -36,7 +35,7 @@ contract RiskSet is
             revert ErrorRiskSetRiskLocked(riskId, policyNftId);
         }
 
-        _activePolicies[riskId].add(policyNftId);
+        LibNftIdSet.add(_activePolicies[riskId], policyNftId);
         emit LogRiskSetPolicyLinked(riskId, policyNftId);
     }
 
@@ -48,14 +47,14 @@ contract RiskSet is
             revert ErrorRiskSetRiskUnknown(riskId);
         }
 
-        _activePolicies[riskId].remove(policyNftId);
+        LibNftIdSet.remove(_activePolicies[riskId], 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;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
 
         // ensure product is registered with instance
         if(productNftId.eqz()) {
@@ -68,14 +67,14 @@ contract RiskSet is
 
     /// @dev Applications linked to active risks may be underwritten
     function activate(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _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;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _deactivate(productNftId, riskId.toKey32());
         emit LogRiskSetRiskPaused(productNftId, riskId);
     }
@@ -110,10 +109,10 @@ contract RiskSet is
     }
 
     function linkedPolicies(RiskId riskId) external view returns(uint256) {
-        return _activePolicies[riskId].size();
+        return LibNftIdSet.size(_activePolicies[riskId]);
     }
 
     function getLinkedPolicyNftId(RiskId riskId, uint256 idx) external view returns(NftId policyNftId) {
-        return _activePolicies[riskId].getElementAt(idx);
+        return LibNftIdSet.getElementAt(_activePolicies[riskId], idx);
     }
 }

package/contracts/instance/base/ObjectLifecycle.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PREMIUM, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL} from "../../type/ObjectType.sol";
+import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PREMIUM, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL, FEE} from "../../type/ObjectType.sol";
 import {ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, COLLATERALIZED, REVOKED, SUBMITTED, CONFIRMED, DECLINED, EXPECTED, PAID, FULFILLED, FAILED, CANCELLED} from "../../type/StateId.sol";
 import {Lifecycle} from "../../shared/Lifecycle.sol";
 
@@ -65,6 +65,7 @@ contract ObjectLifecycle is
 
     function _setupClaimLifecycle() private {
         setInitialState(CLAIM(), SUBMITTED());
+        setStateTransition(CLAIM(), SUBMITTED(), REVOKED());
         setStateTransition(CLAIM(), SUBMITTED(), CONFIRMED());
         setStateTransition(CLAIM(), SUBMITTED(), DECLINED());
         setStateTransition(CLAIM(), CONFIRMED(), CLOSED());
@@ -72,8 +73,8 @@ contract ObjectLifecycle is
 
     function _setupPayoutLifecycle() private {
         setInitialState(PAYOUT(), EXPECTED());
-        // TODO: add state cancelled
         setStateTransition(PAYOUT(), EXPECTED(), PAID());
+        setStateTransition(PAYOUT(), EXPECTED(), CANCELLED());
     }
 
     function _setupRiskLifecycle() private {
@@ -99,6 +100,7 @@ contract ObjectLifecycle is
     // dummy lifecycle only
     function _setUpProductLifecycle() private {
         setInitialState(PRODUCT(), ACTIVE());
+        setInitialState(FEE(), ACTIVE());
     }
 
     // dummy lifecycles only

package/contracts/instance/base/ObjectSet.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.20;
 
 import {Cloneable} from "./Cloneable.sol";
 
-import {IInstance} from "../IInstance.sol";
 import {LibKey32Set} from "../../type/Key32Set.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Key32} from "../../type/Key32.sol";
@@ -19,21 +18,21 @@ contract ObjectSet is
 
     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
+    address internal _instanceAddress;
 
     /// @dev This initializer needs to be called from the instance itself.
-    function initialize() 
+    function initialize(address authority, address registry) 
         external
         initializer()
     {
-        _instance = IInstance(msg.sender);
-        __Cloneable_init(_instance.authority(), address(_instance.getRegistry()));
+        _instanceAddress = msg.sender;
+        __Cloneable_init(authority, registry);
         
-        emit LogObjectSetInitialized(address(_instance));
+        emit LogObjectSetInitialized(address(_instanceAddress));
     }
 
-    function getInstance() external view returns (IInstance) {
-        return _instance;
+    function getInstanceAddress() external view returns (address) {
+        return _instanceAddress;
     }
 
     function _add(NftId componentNftId, Key32 key) internal {

package/contracts/instance/base/ObjectSetHelperLib.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IBundle} from "../module/IBundle.sol";
+import {IInstance} from "../IInstance.sol";
+import {IRisk} from "../module/IRisk.sol";
+import {NftId} from "../../type/NftId.sol";
+import {RiskId} from "../../type/RiskId.sol";
+
+
+library ObjectSetHelperLib {
+
+    function getRiskInfo(address instanceAddress, RiskId riskId) public view returns (IRisk.RiskInfo memory) {
+
+        return IInstance(instanceAddress).getInstanceReader().getRiskInfo(riskId);
+    }
+
+    function getProductNftId(address instanceAddress, RiskId riskId) public view returns (NftId) {
+        return getRiskInfo(instanceAddress, riskId).productNftId;
+    }
+
+    function getBundleInfo(address instanceAddress, NftId bundleNftId) public view returns (IBundle.BundleInfo memory) {
+        return IInstance(instanceAddress).getInstanceReader().getBundleInfo(bundleNftId);
+    }
+
+    function getPoolNftId(address instanceAddress, NftId bundleNftId) public view returns (NftId) {
+        return getBundleInfo(instanceAddress, bundleNftId).poolNftId;
+    }
+
+}

package/contracts/instance/module/IComponents.sol

@@ -6,7 +6,6 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 import {Amount} from "../../type/Amount.sol";
 import {Fee} from "../../type/Fee.sol";
 import {NftId} from "../../type/NftId.sol";
-import {RoleId} from "../../type/RoleId.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 import {UFixed} from "../../type/UFixed.sol";
 
@@ -28,6 +27,9 @@ interface IComponents {
         NftId poolNftId; // mandatory
         NftId distributionNftId; // 0..1 (optional)
         NftId [] oracleNftId; // 0..n (optional)
+    }
+
+    struct FeeInfo {
         Fee productFee; // product fee on net premium
         Fee processingFee; // product fee on payout amounts        
         Fee distributionFee; // distribution fee for sales that do not include commissions
@@ -37,7 +39,6 @@ interface IComponents {
         Fee performanceFee; // pool fee on profits from capital investors
     }
 
-
     struct PoolInfo {
         Amount maxBalanceAmount; // max balance amount allowed for pool
         bool isInterceptingBundleTransfers; // custom logic for bundle nft transfers