@etherisc/gif-next 0.0.2-71cf987-554 → 0.0.2-7202758-806

package/contracts/instance/InstanceService.sol

@@ -2,33 +2,26 @@
 pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
-import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
 
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 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";
-import {SecondsLib} from "../type/Seconds.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {ADMIN_ROLE} from "../type/RoleId.sol";
-import {ObjectType, INSTANCE, BUNDLE, APPLICATION, CLAIM, DISTRIBUTION, INSTANCE, POLICY, POOL, PRODUCT, REGISTRY, STAKING} from "../type/ObjectType.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {ObjectType, INSTANCE, COMPONENT, INSTANCE, REGISTRY, STAKING} from "../type/ObjectType.sol";
 
 import {Service} from "../shared/Service.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
-import {IService} from "../shared/IService.sol";
-
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IProductComponent} from "../product/IProductComponent.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IStakingService} from "../staking/IStakingService.sol";
 import {TargetManagerLib} from "../staking/TargetManagerLib.sol";
 
+import {IComponentService} from "../shared/IComponentService.sol";
 import {Instance} from "./Instance.sol";
 import {IInstance} from "./IInstance.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
@@ -36,7 +29,7 @@ import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {Seconds} from "../type/Seconds.sol";
-import {VersionPart, VersionPartLib} from "../type/Version.sol";
+import {VersionPart} from "../type/Version.sol";
 
 
 contract InstanceService is
@@ -49,12 +42,14 @@ contract InstanceService is
 
     IRegistryService internal _registryService;
     IStakingService internal _stakingService;
+    IComponentService internal _componentService;
 
     address internal _masterAccessManager;
     address internal _masterInstanceAdmin;
     address internal _masterInstance;
     address internal _masterInstanceReader;
     address internal _masterInstanceBundleSet;
+    address internal _masterInstanceRiskSet;
     address internal _masterInstanceStore;
 
 
@@ -86,6 +81,7 @@ contract InstanceService is
         _;
     }
 
+
     // TODO check component - service - instance version match
     modifier onlyComponent() {
         if (! getRegistry().isRegisteredComponent(msg.sender)) {
@@ -96,9 +92,10 @@ contract InstanceService is
 
     function createInstance()
         external 
+        restricted()
         returns (
-            Instance clonedInstance,
-            NftId clonedInstanceNftId
+            IInstance instance,
+            NftId instanceNftId
         )
     {
         // tx sender will become instance owner
@@ -106,34 +103,35 @@ 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
         IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
+        VersionPart release = AccessManagerCloneable(authority()).getRelease();
         instanceAdmin.completeSetup(
-            address(clonedInstance),
-            address(instanceAuthorization),
-            getVersion().toMajorPart());
+            address(instance),
+            address(instanceAuthorization));
 
         emit LogInstanceCloned(
-            clonedInstanceNftId,
-            address(clonedInstance));
+            instanceNftId,
+            address(instance));
     }
 
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -146,6 +144,7 @@ contract InstanceService is
     function setStakingRewardRate(UFixed rewardRate)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -158,6 +157,7 @@ contract InstanceService is
     function refillStakingRewardReserves(address rewardProvider, Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
@@ -171,6 +171,7 @@ contract InstanceService is
     function withdrawStakingRewardReserves(Amount dipAmount)
         external
         virtual
+        restricted()
         onlyInstance()
         returns (Amount newBalance)
     {
@@ -180,46 +181,31 @@ contract InstanceService is
             dipAmount);
     }
 
-
-    function setComponentLocked(bool locked)
-        external
-        virtual
-        onlyComponent()
+    function upgradeInstanceReader(NftId instanceNftId) 
+        external 
+        nonReentrant()
+        restricted()
+        onlyInstanceOwner(instanceNftId) 
+        onlyNftOfType(instanceNftId, INSTANCE())
     {
-        // checks
-        address componentAddress = msg.sender;
-
-        if (!IInstanceLinkedComponent(componentAddress).supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
-            revert ErrorInstanceServiceComponentNotInstanceLinked(componentAddress);
-        }
-
         IRegistry registry = getRegistry();
-        NftId instanceNftId = registry.getObjectInfo(componentAddress).parentNftId;
-
-        IInstance instance = IInstance(
-            registry.getObjectAddress(instanceNftId));
-
-        // no revert in case already locked
-        // TODO refactor/implement
-        // instance.getInstanceAdmin().setTargetLockedByService(
-        //     componentAddress, 
-        //     locked);
-    }
-
-
-    function getMasterInstanceReader() external view returns (address) {
-        return _masterInstanceReader;
+        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(); }
         if(_masterInstanceBundleSet != address(0)) { revert ErrorInstanceServiceMasterBundleSetAlreadySet(); }
-
+        if(_masterInstanceRiskSet != address(0)) { revert ErrorInstanceServiceMasterRiskSetAlreadySet(); }
         if(instanceAddress == address(0)) { revert ErrorInstanceServiceInstanceAddressZero(); }
 
         IInstance instance = IInstance(instanceAddress);
@@ -228,28 +214,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.getInstanceAddress() != address(instance)) { revert ErrorInstanceServiceBundleSetInstanceMismatch(); }
+        if(riskSet.getInstanceAddress() != address(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);
@@ -257,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(); }
@@ -268,18 +263,8 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
     }
 
-    function upgradeInstanceReader(NftId instanceNftId) 
-        external 
-        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
@@ -296,7 +281,10 @@ contract InstanceService is
         
         // set up the instance admin
         clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedInstanceAdmin.initialize(clonedAccessManager);
+        clonedInstanceAdmin.initialize(
+            clonedAccessManager,
+            getRegistry(),
+            getRelease());
     }
 
 
@@ -308,21 +296,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;
     }
 
 
@@ -365,14 +356,15 @@ 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()));
+        _componentService = IComponentService(_getServiceAddress(COMPONENT()));
 
         _registerInterface(type(IInstanceService).interfaceId);
     }

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

@@ -0,0 +1,118 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32} from "../type/Key32.sol";
+import {LibNftIdSet} from "../type/NftIdSet.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+import {RiskIdLib, RiskId} from "../type/RiskId.sol";
+
+/// @dev RiskSet manages the risks and its active policies per product.
+contract RiskSet is
+    ObjectSet
+{
+
+    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);
+        }
+
+        LibNftIdSet.add(_activePolicies[riskId], 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);
+        }
+
+        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 = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
+
+        // 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 = 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 = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
+        _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 LibNftIdSet.size(_activePolicies[riskId]);
+    }
+
+    function getLinkedPolicyNftId(RiskId riskId, uint256 idx) external view returns(NftId policyNftId) {
+        return LibNftIdSet.getElementAt(_activePolicies[riskId], idx);
+    }
+}

package/contracts/instance/base/ObjectCounter.sol

@@ -11,9 +11,8 @@ contract ObjectCounter {
     // TODO refactor risk id
     // mapping(NftId productNftId => uint64 risks) private _riskCounter;
 
-    uint256 private _requestCounter;
+    uint256 private _requestCounter = 0;
 
-    // TODO introduce RequestId (uint64)
     function _createNextRequestId() internal returns (RequestId requestId) {
         _requestCounter++;
         requestId = RequestIdLib.toRequestId(_requestCounter);

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,77 +3,75 @@ 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;
-    IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectSet initialization
+    mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _activeObjects;
+    mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _allObjects;
+    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, 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);
     }
 }