@etherisc/gif-next 0.0.2-fd4931b-974 → 0.0.2-fd5f17a-625

package/contracts/shared/ComponentService.sol

@@ -4,30 +4,27 @@ pragma solidity ^0.8.20;
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
-import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, POLICY_SERVICE_ROLE, PRODUCT_SERVICE_ROLE} from "../type/RoleId.sol";
-import {KEEP_STATE} from "../type/StateId.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IProductComponent} from "../product/IProductComponent.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {InstanceStore} from "../instance/InstanceStore.sol";
-import {TokenHandler} from "./TokenHandler.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {KEEP_STATE} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
+import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 
 contract ComponentService is
     ComponentVerifyingService,
     IComponentService
 {
-
     error ErrorComponentServiceAlreadyRegistered(address component);
     error ErrorComponentServiceNotComponent(address component);
     error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
@@ -56,17 +53,12 @@ contract ComponentService is
         address initialOwner;
         (registryAddress, initialOwner) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, address(0), owner);
+        _initializeService(registryAddress, address(0), owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
 
-        registerInterface(type(IComponentService).interfaceId);
-    }
-
-
-    function getDomain() public pure virtual override returns(ObjectType) {
-        return COMPONENT();
+        _registerInterface(type(IComponentService).interfaceId);
     }
 
     //-------- component ----------------------------------------------------//
@@ -99,6 +91,37 @@ contract ComponentService is
     // TODO implement
     function unlock() external virtual {}
 
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        returns (Amount withdrawnAmount)
+    {
+        (NftId componentNftId,, IInstance instance) = _getAndVerifyActiveComponent(COMPONENT());
+        IComponents.ComponentInfo memory info = instance.getInstanceReader().getComponentInfo(componentNftId);
+        address componentWallet = info.wallet;
+
+        // determine withdrawn amount
+        withdrawnAmount = amount;
+        if (withdrawnAmount.gte(AmountLib.max())) {
+            withdrawnAmount = instance.getInstanceReader().getFeeAmount(componentNftId);
+        } else if (withdrawnAmount.eqz()) {
+            revert ErrorComponentServiceWithdrawAmountIsZero();
+        } else {
+            Amount withdrawLimit = instance.getInstanceReader().getFeeAmount(componentNftId);
+            if (withdrawnAmount.gt(withdrawLimit)) {
+                revert ErrorComponentServiceWithdrawAmountExceedsLimit(withdrawnAmount, withdrawLimit);
+            }
+        }
+
+        // decrease fee counters by withdrawnAmount
+        _changeTargetBalance(DECREASE, instance.getInstanceStore(), componentNftId, AmountLib.zero(), withdrawnAmount);
+        
+        // transfer amount to component owner
+        address componentOwner = getRegistry().ownerOf(componentNftId);
+        emit LogComponentServiceComponentFeesWithdrawn(componentNftId, componentOwner, address(info.token), withdrawnAmount);
+        info.tokenHandler.distributeTokens(componentWallet, componentOwner, withdrawnAmount);
+    }
+
 
     //-------- product ------------------------------------------------------//
 
@@ -107,12 +130,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](1);
-        bytes4[][] memory selectors = new bytes4[][](1);
-
-        // authorizaion for distribution owner
-        roles[0] = PRODUCT_OWNER_ROLE();
-        selectors[0] = _createSelectors(IProductComponent.setFees.selector);
 
         // register/create component setup
         (
@@ -122,10 +139,8 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             PRODUCT(),
-            PRODUCT_OWNER_ROLE(),
-            roles,
-            selectors);
-
+            PRODUCT_OWNER_ROLE());
+        
         // create product info
         IComponents.ProductInfo memory productInfo = IProductComponent(contractAddress).getInitialProductInfo();
         instanceStore.createProduct(productNftId, productInfo);
@@ -198,24 +213,12 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for distribution owner
-        roles[0] = DISTRIBUTION_OWNER_ROLE();
-        selectors[0] = _createSelectors(IDistributionComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = PRODUCT_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IDistributionComponent.processRenewal.selector);
 
         // register/create component info
         _register(
             contractAddress,
             DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE(),
-            roles,
-            selectors);
+            DISTRIBUTION_OWNER_ROLE());
     }
 
 
@@ -280,24 +283,62 @@ contract ComponentService is
         _changeTargetBalance(DECREASE, instanceStore, distributionNftId, amount, feeAmount);
     }
 
-    //-------- pool ---------------------------------------------------------//
+    //-------- distributor -------------------------------------------------------//
 
-    /// @dev registers the sending component as a distribution component
-    function registerPool()
+    function increaseDistributorBalance(
+        InstanceStore instanceStore, 
+        NftId distributorNftId, 
+        Amount amount, 
+        Amount feeAmount
+    )
+        external
+        virtual
+        // TODO re-enable once role granting is stable and fixed
+        // restricted()
+    {
+        _changeTargetBalance(INCREASE, instanceStore, distributorNftId, amount, feeAmount);
+    }
+
+    function decreaseDistributorBalance(
+        InstanceStore instanceStore, 
+        NftId distributorNftId, 
+        Amount amount, 
+        Amount feeAmount
+    )
+        external
+        virtual
+        // TODO re-enable once role granting is stable and fixed
+        // restricted()
+    {
+        _changeTargetBalance(DECREASE, instanceStore, distributorNftId, amount, feeAmount);
+    }
+
+    //-------- oracle -------------------------------------------------------//
+
+    function registerOracle()
         external
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
 
-        // authorizaion for distribution owner
-        roles[0] = POOL_OWNER_ROLE();
-        selectors[0] = _createSelectors(IPoolComponent.setFees.selector);
+        // register/create component setup
+        (
+            , // instance reader
+            InstanceStore instanceStore, 
+            NftId componentNftId
+        ) = _register(
+            contractAddress,
+            ORACLE(),
+            ORACLE_OWNER_ROLE());            
+    }
+
+    //-------- pool ---------------------------------------------------------//
 
-        // authorizaion for product service
-        roles[1] = POLICY_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IPoolComponent.verifyApplication.selector);
+    function registerPool()
+        external
+        virtual
+    {
+        address contractAddress = msg.sender;
 
         // register/create component setup
         (
@@ -307,14 +348,13 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             POOL(),
-            POOL_OWNER_ROLE(),
-            roles,
-            selectors);            
+            POOL_OWNER_ROLE());            
 
         // create info
         instanceStore.createPool(
             componentNftId, 
-            IPoolComponent(contractAddress).getInitialPoolInfo());
+            IPoolComponent(
+                contractAddress).getInitialPoolInfo());
     }
 
 
@@ -444,9 +484,7 @@ contract ComponentService is
     function _register(
         address componentAddress, // address of component to register
         ObjectType requiredType, // required type for component for registration
-        RoleId requiredRole, // role required for comonent owner for registration
-        RoleId[] memory roles, // roles with write access to component
-        bytes4[][] memory selectors // authorized functions per role with write access
+        RoleId requiredRole // role required for comonent owner for registration
     )
         internal
         virtual
@@ -477,17 +515,21 @@ contract ComponentService is
         instanceReader = instance.getInstanceReader();
         instanceStore = instance.getInstanceStore();
 
-        IComponents.ComponentInfo memory componentInfo = component.getComponentInfo();
-        componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
-        instanceStore.createComponent(component.getNftId(), componentInfo);
-
-        // configure instance authorization
-        _instanceService.createComponentTarget(
-            instance.getNftId(), 
-            componentAddress, 
-            component.getName(), 
-            selectors, 
-            roles);
+        IComponents.ComponentInfo memory componentInfo = component.getInitialComponentInfo();
+        componentInfo.tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(
+            address(componentInfo.token), 
+            address(instance.getInstanceAdmin().authority()));
+
+        instanceStore.createComponent(
+            component.getNftId(), 
+            componentInfo);
+
+        // setup initial component authorization
+        _instanceService.initializeAuthorization(
+            instance.getNftId(),
+            component);
+
+        // TODO add logging
     }
 
 
@@ -526,7 +568,7 @@ contract ComponentService is
     }
 
 
-    function _createSelectors(bytes4 selector) internal view returns (bytes4[] memory selectors) {
+    function _createSelectors(bytes4 selector) internal pure returns (bytes4[] memory selectors) {
         selectors = new bytes4[](1);
         selectors[0] = selector;
     }
@@ -560,18 +602,13 @@ contract ComponentService is
         RoleId requiredRole
     )
         internal
-        // view
+        view
         returns (
             IInstance instance,
             IInstanceLinkedComponent component,
             address owner
         )
     {
-        // check component has not already been registered
-        if (getRegistry().getNftId(componentAddress).gtz()) {
-            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
-        }
-
         // check this is a component
         component = IInstanceLinkedComponent(componentAddress);
         if(!component.supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
@@ -584,12 +621,21 @@ contract ComponentService is
             revert ErrorComponentServiceInvalidType(componentAddress, requiredType, info.objectType);
         }
 
+        // check component has not already been registered
+        if (getRegistry().getNftIdForAddress(componentAddress).gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
+        }
+
         // check instance has assigned required role to inital owner
         instance = _getInstance(info.parentNftId);
         owner = info.initialOwner;
 
-        if(!instance.getInstanceAccessManager().hasRole(requiredRole, owner)) {
+        if(!instance.getInstanceAdmin().hasRole(owner, requiredRole)) {
             revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
         }
     }
+
+    function _getDomain() internal pure virtual override returns(ObjectType) {
+        return COMPONENT();
+    }
 }

package/contracts/shared/ComponentServiceManager.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "./IVersionable.sol";
-import {ProxyManager} from "./ProxyManager.sol";
 import {ComponentService} from "./ComponentService.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 
 contract ComponentServiceManager is ProxyManager {
 

package/contracts/shared/ComponentVerifyingService.sol

@@ -32,13 +32,11 @@ abstract contract ComponentVerifyingService is
             IInstance instance
         )
     {
-        componentNftId = getRegistry().getNftId(msg.sender);
-        (componentInfo, instance) = _getAndVerifyComponentInfo(componentNftId, expectedType);
-
-        // ensure component is not locked
-        if (instance.getInstanceAccessManager().isTargetLocked(componentInfo.objectAddress)) {
-            revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-        }
+        componentNftId = getRegistry().getNftIdForAddress(msg.sender);
+        (componentInfo, instance) = _getAndVerifyComponentInfo(
+            componentNftId, 
+            expectedType,
+            true); // only active
     }
 
 
@@ -48,7 +46,8 @@ abstract contract ComponentVerifyingService is
     /// - the component has the wrong object type
     function _getAndVerifyComponentInfo(
         NftId componentNftId,
-        ObjectType expectedType // assume always of `component` type
+        ObjectType expectedType, // assume always of `component` type
+        bool onlyActive
     )
         internal
         virtual
@@ -85,6 +84,13 @@ abstract contract ComponentVerifyingService is
         }
 
         instance = _getInstance(info.parentNftId);
+
+        // ensure component is not locked
+        if (onlyActive) {
+            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
+                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
+            }
+        }
     }
 
 

package/contracts/shared/IComponent.sol

@@ -4,14 +4,10 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IProductService} from "../product/IProductService.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 /// @dev component base class
@@ -27,22 +23,22 @@ interface IComponent is
     error ErrorComponentNameLengthZero();
     error ErrorComponentWalletAddressZero();
     error ErrorComponentWalletAddressIsSameAsCurrent();
-    error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
     error ErrorComponentWalletNotComponent();
 
     event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
-    event LogComponentTokenHandlerApproved(address token, uint256 limit);
+    event LogComponentTokenHandlerApproved(address token, Amount limit);
 
     /// @dev approves token hanlder to spend up to the specified amount of tokens
     /// reverts if component wallet is not component itself
     /// only component owner (nft holder) is authorizes to call this function
-    function approveTokenHandler(uint256 spendingLimitAmount) external;
+    function approveTokenHandler(Amount spendingLimitAmount) external;
 
-    /// @dev sets the wallet address for the component
-    /// if the current wallet has tokens, these will be transferred
+    /// @dev sets the wallet address for the component.
+    /// if the current wallet has tokens, these will be transferred.
     /// if the new wallet address is externally owned, an approval from the 
-    /// owner of the external wallet for the component to move all tokens must exist
+    /// owner of the external wallet to the tokenhandler of the component that 
+    /// covers the current component balance must exist
     function setWallet(address walletAddress) external;
 
     /// @dev returns the name of this component

package/contracts/shared/IComponentService.sol

@@ -1,21 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {Fee} from "../type/Fee.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {IProductService} from "../product/IProductService.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 /// @dev component base class
@@ -27,7 +18,12 @@ interface IComponentService is
     error ErrorComponentServiceWalletAddressZero();
     error ErrorComponentServiceWalletAddressIsSameAsCurrent();
 
+    error ErrorComponentServiceWithdrawAmountIsZero();
+    error ErrorComponentServiceWithdrawAmountExceedsLimit(Amount withdrawnAmount, Amount withdrawLimit);
+    error ErrorComponentServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
+
     event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
+    event LogComponentServiceComponentFeesWithdrawn(NftId componentNftId, address recipient, address token, Amount withdrawnAmount);
     event LogComponentServiceProductFeesUpdated(NftId productNftId);
     event LogComponentServiceDistributionFeesUpdated(NftId distributionNftId);
     event LogComponentServicePoolFeesUpdated(NftId poolNftId);
@@ -51,7 +47,14 @@ interface IComponentService is
     /// @dev unlocks the component associated with the caller
     function unlock() external;
 
+    /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
+    /// @param withdrawAmount the amount to withdraw
+    /// @return withdrawnAmount the amount that was actually withdrawn
+    function withdrawFees(Amount withdrawAmount) external returns (Amount withdrawnAmount);
+
     //-------- product ------------------------------------------------------//
+
+    /// @dev registers the sending component as a product component
     function registerProduct() external;
 
     function setProductFees(
@@ -63,6 +66,8 @@ interface IComponentService is
     function decreaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
 
     //-------- distribution -------------------------------------------------//
+
+    /// @dev registers the sending component as a distribution component
     function registerDistribution() external;
 
     function setDistributionFees(
@@ -73,7 +78,18 @@ interface IComponentService is
     function increaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
     function decreaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
 
+    //-------- distributor --------------------------------------------------//
+    function increaseDistributorBalance(InstanceStore instanceStore, NftId distributorNftId, Amount amount, Amount feeAmount) external;
+    function decreaseDistributorBalance(InstanceStore instanceStore, NftId distributorNftId, Amount amount, Amount feeAmount) external;
+
+    //-------- oracle -------------------------------------------------------//
+
+    /// @dev registers the sending component as an oracle component
+    function registerOracle() external;
+
     //-------- pool ---------------------------------------------------------//
+
+    /// @dev registers the sending component as a pool component
     function registerPool() external;
 
     function setPoolFees(
@@ -88,4 +104,5 @@ interface IComponentService is
     //-------- bundle -------------------------------------------------------//
     function increaseBundleBalance(InstanceStore instanceStore, NftId bundleNftId, Amount amount, Amount feeAmount) external;
     function decreaseBundleBalance(InstanceStore instanceStore, NftId bundleNftId, Amount amount, Amount feeAmount) external;
+
 }

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -4,22 +4,17 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {IComponent} from "../shared/IComponent.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IProductService} from "../product/IProductService.sol";
-import {IRegisterable} from "../shared/IRegisterable.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
 
 /// @dev component base class
 /// component examples are product, distribution, pool and oracle
 interface IInstanceLinkedComponent is 
     IComponent
 {
-    error ErrorComponentNotProductService(address caller);
     error ErrorComponentNotInstance(NftId instanceNftId);
     error ErrorComponentProductNftAlreadySet();
 
@@ -36,9 +31,17 @@ interface IInstanceLinkedComponent is
     /// only component owner (nft holder) is authorizes to call this function
     function unlock() external;
 
+    /// @dev Withdraw fees from the distribution component. Only component owner is allowed to withdraw fees.
+    /// @param amount the amount to withdraw
+    /// @return withdrawnAmount the amount that was actually withdrawn
+    function withdrawFees(Amount amount) external returns (Amount withdrawnAmount);
+
     /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);
 
+    /// @dev returns the initial component authorization specification.
+    function getAuthorization() external view returns (IAuthorization authorization);
+
     /// @dev defines the product to which this component is linked to
     /// this is only relevant for pool and distribution components
     function getProductNftId() external view returns (NftId productNftId);

package/contracts/shared/IKeyValueStore.sol

@@ -13,6 +13,7 @@ interface IKeyValueStore is ILifecycle {
 
     error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
     error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
+    error ErrorKeyValueStoreNoLifecycle(ObjectType objectType);
     error ErrorKeyValueStoreStateZero(Key32 key);
     error ErrorKeyValueStoreNotExisting(Key32 key);
 
@@ -32,7 +33,7 @@ interface IKeyValueStore is ILifecycle {
         // eg account outside gif objects that initiated the tx
         // implies the caller needs to be propagated through all calls up to key values store itself
         // to always have the instance address there doesn't seem to make sense
-        address updatedBy;
+        // address updatedBy;
         Blocknumber updatedIn;
         Blocknumber createdIn;
     }

package/contracts/shared/ILifecycle.sol

@@ -1,13 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {StateId} from "../type/StateId.sol";
 
 interface ILifecycle {
 
-    error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
+    error ErrorNoLifecycle(ObjectType objectType);
     error ErrorInvalidStateTransition(
         ObjectType objectType,
         StateId fromStateId,

package/contracts/shared/INftOwnable.sol

@@ -16,7 +16,7 @@ interface INftOwnable is
     error ErrorNftOwnableAlreadyLinked(NftId nftId);
     error ErrorNftOwnableContractNotRegistered(address contractAddress);
 
-    function linkToRegisteredNftId() external;
+    function linkToRegisteredNftId() external returns (NftId);
 
     function getNftId() external view returns (NftId);
     function getOwner() external view returns (address);

package/contracts/shared/IPolicyHolder.sol

@@ -27,19 +27,10 @@ interface IPolicyHolder is
     /// it is optional for products to notifiy policy holder of expired claims
     function policyExpired(NftId policyNftId) external;
 
-    /// @dev request for a payout by the requesting policy
-    /// the contract implements its use case specific handling for such requests.
-    /// eg. creation of a pending payout, a corresponding claim against one of the policies held by the IPolicyHolder
-    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external;
-
     /// @dev callback function to notify the confirmation of the specified claim
     /// active policies may open claims under the activated policy
     function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external;
 
     /// @dev callback function that will be called after a successful payout
     function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external;
-
-    /// @dev determines policy and claim specific beneficiary address
-    /// returned address will override GIF default where the policy nft holder is treated as beneficiary
-    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external view returns (address beneficiary);
 }

package/contracts/shared/IService.sol

@@ -1,11 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
-import {IVersionable} from "./IVersionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IRegisterable,
@@ -14,5 +15,11 @@ interface IService is
 {
     error ErrorServiceNotImplemented();
 
+    /// @dev returns the domain for this service.
+    /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
+
+    /// @dev returns the GIF release specific role id.
+    /// These role ids are used to authorize service to service communication.
+    function getRoleId() external pure returns(RoleId serviceRoleId);
 }