@etherisc/gif-next 0.0.2-b72409c-493 → 0.0.2-b7f4834-822

package/contracts/shared/ComponentVerifyingService.sol

@@ -0,0 +1,117 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "../instance/IInstance.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {Service} from "../shared/Service.sol";
+
+
+abstract contract ComponentVerifyingService is 
+    Service
+{
+
+    error ErrorComponentVerifyingServiceComponentTypeInvalid(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
+    error ErrorComponentVerifyingServiceComponentIsLocked(NftId componentNftId);
+
+    /// @dev based on the sender address returns the corresponding components nft id, info and instance.
+    /// the function reverts iff:
+    /// - there is no such component
+    /// - the component has the wrong object type
+    /// - the component is locked
+    function _getAndVerifyActiveComponent(
+        ObjectType expectedType // assume always of `component` type
+    )
+        internal
+        view
+        returns(
+            NftId componentNftId,
+            IRegistry.ObjectInfo memory componentInfo, 
+            IInstance instance
+        )
+    {
+        componentNftId = getRegistry().getNftId(msg.sender);
+        (componentInfo, instance) = _getAndVerifyComponentInfo(
+            componentNftId, 
+            expectedType,
+            true); // only active
+    }
+
+
+    /// @dev returns the component info and instance contract reference given a component nft id
+    /// the function reverts iff:
+    /// - there is no such component
+    /// - the component has the wrong object type
+    function _getAndVerifyComponentInfo(
+        NftId componentNftId,
+        ObjectType expectedType, // assume always of `component` type
+        bool onlyActive
+    )
+        internal
+        virtual
+        view
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            IInstance instance
+        )
+    {
+        IRegistry registry = getRegistry();
+        info = registry.getObjectInfo(componentNftId);
+
+        // if not COMPONENT require exact match
+        if(expectedType != COMPONENT()) {
+            // ensure component is of expected type
+            if(info.objectType != expectedType) {
+                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
+                    componentNftId,
+                    expectedType,
+                    info.objectType);
+            }
+        } else {
+            if(!(info.objectType == PRODUCT()
+                || info.objectType == POOL()
+                || info.objectType == DISTRIBUTION()
+                || info.objectType == ORACLE()
+            ))
+            {
+                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
+                    componentNftId,
+                    expectedType,
+                    info.objectType);
+            }
+        }
+
+        instance = _getInstance(info.parentNftId);
+
+        // ensure component is not locked
+        if (onlyActive) {
+            if (instance.getInstanceAccessManager().isTargetClosed(info.objectAddress)) {
+                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
+            }
+        }
+    }
+
+
+    /// @dev returns the linked product nft id for the specified component
+    function _getProductNftId(
+        InstanceReader instanceReader,
+        NftId componentNftId
+    )
+        internal
+        virtual
+        view
+        returns (NftId productNftId)
+    {
+        return instanceReader.getComponentInfo(componentNftId).productNftId;
+    }
+
+
+    /// @dev returns an IInstance contract reference for the specified instance nft id
+    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
+        return IInstance(
+            getRegistry().getObjectInfo(
+                instanceNftId).objectAddress);
+    }
+}

package/contracts/shared/ERC165.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 

package/contracts/shared/IAccessManagerExtended.sol

@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: MIT
+// OpenZeppelin Contracts (last updated v5.0.0) (access/manager/IAccessManager.sol)
+
+pragma solidity ^0.8.20;
+
+import {IAccessManager} from "@openzeppelin/contracts/access/manager/IAccessManager.sol";
+
+import {Timestamp} from "../type/Timestamp.sol";
+
+interface IAccessManagerExtended is IAccessManager {
+    // Structure that stores the details for a target contract.
+    struct TargetInfo {
+        address taddress;
+        //IAccess.Type ttype;
+        string name;
+        Timestamp createdAt;
+        //Timestamp updatedAt;
+    }
+
+    // Structure that stores the details of a role.
+    struct RoleInfo {
+        uint64 id;
+        //IAccess.Type rtype;
+        string name;
+        Timestamp createdAt;
+    }
+
+    event LogRoleCreation(uint64 roleId, string name);// IAccess.Type rtype);
+    event LogTargetCreation(address target, string name);// IAccess.Type ttype);
+
+    error AccessManagerRoleIdNotExists(uint64 roleId);
+    error AccessManagerRoleIdAlreadyExists(uint64 roleId);
+    error AccessManagerRoleNameAlreadyExists(uint64 newRoleId, uint64 existingRoleId, string duplicateName);
+    error AccessManagerRoleIdZero();
+    error AccessManagerRoleNameEmpty(uint64 roleId);
+    error AccessManagerRoleIdTooBig(uint64 roleId);
+
+    error AccessManagerTargetAlreadyExists(address target);
+    error AccessManagerTargetNotExists(address target);
+    error AccessManagerTargetNameAlreadyExists(address newTarget, address existingTarget, string duplicateName);
+    error AccessManagerTargetAddressZero();
+    error AccessManagerTargetNameEmpty(address target);
+    error AccessManagerTargetAuthorityInvalid(address target, address targetAuthority);
+
+    function getRoleMembers(uint64 roleId) external view returns (uint256 numberOfMembers);
+
+    function getRoleMember(uint64 roleId, uint256 idx) external view returns (address member);
+
+    function getRoleId(uint256 idx) external view returns (uint64 roleId);
+
+    // TODO returns ADMIN_ROLE id for non existent name
+    function getRoleId(string memory name) external view returns (uint64 roleId);
+
+    function getRoles() external view returns (uint256 numberOfRoles);
+
+    function isRoleExists(uint64 roleId) external view returns (bool exists);
+
+    function getRoleInfo(uint64 roleId) external view returns (RoleInfo memory);
+
+    function isRoleNameExists(string memory name) external view returns (bool);
+
+    function isTargetExists(address target) external view returns (bool);
+
+    function isTargetNameExists(string memory name) external view returns (bool);
+    
+    function getTargetAddress(string memory name) external view returns(address targetAddress);
+
+    function getTargetInfo(address target) external view returns (TargetInfo memory);
+
+
+    function createRole(uint64 roleId, string memory roleName/*, IAccess.Type rtype*/) external;
+
+    function createTarget(address target, string memory name/*, IAccess.Type.Custom*/) external;
+}

package/contracts/shared/IAccessManagerExtendedWithDisable.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.20;
+
+import {IAccessManagerExtended} from "./IAccessManagerExtended.sol";
+
+import {Timestamp} from "../type/Timestamp.sol";
+import {VersionPart} from "../type/Version.sol";
+import {Seconds} from "../type/Seconds.sol";
+
+interface IAccessManagerExtendedWithDisable is IAccessManagerExtended {
+
+    error AccessManagerDisabled();
+
+    function disable(Seconds delay) external;
+    function enable() external;
+    function getVersion() external view returns (VersionPart version);
+}

package/contracts/{components → shared}/IComponent.sol

@@ -1,42 +1,39 @@
 // 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 {IComponents} from "../instance/module/IComponents.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 
 /// @dev component base class
-/// component examples are product, distribution, pool and oracle
+/// component examples are staking, product, distribution, pool and oracle
 interface IComponent is 
+    IAccessManaged,
     IRegisterable,
     ITransferInterceptor
 {
     error ErrorComponentNotChainNft(address caller);
-    error ErrorComponentNotProductService(address caller);
-    error ErrorComponentNotInstance(NftId instanceNftId);
-    error ErrorComponentProductNftAlreadySet();
 
+    error ErrorComponentTokenAddressZero();
+    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, Amount limit);
 
-    /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
+    /// @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 lock() external;
-
-    /// @dev unlocks component to (re-)enable functions that may change state related to this component
-    /// only component owner (nft holder) is authorizes to call this function
-    function unlock() external;
+    function approveTokenHandler(Amount spendingLimitAmount) external;
 
     /// @dev sets the wallet address for the component
     /// if the current wallet has tokens, these will be transferred
@@ -44,9 +41,6 @@ interface IComponent is
     /// owner of the external wallet for the component to move all tokens must exist
     function setWallet(address walletAddress) external;
 
-    /// @dev only product service may set product nft id during registration of product setup
-    function setProductNftId(NftId productNftId) external;
-
     /// @dev returns the name of this component
     /// to successfully register the component with an instance the name MUST be unique in the linked instance
     function getName() external view returns (string memory name);
@@ -54,21 +48,23 @@ interface IComponent is
     /// @dev defines which ERC20 token is used by this component
     function getToken() external view returns (IERC20Metadata token);
 
-    /// @dev defines the instance to which this component is linked to
-    function getInstance() external view returns (IInstance instance);
+    /// @dev returns token handler for this component
+    function getTokenHandler() external view returns (TokenHandler tokenHandler);
 
     /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
     /// the default address is the component token address
     function getWallet() external view returns (address walletAddress);
 
-    /// @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);
-
+    /// @dev returns true iff this compoent intercepts nft minting and transfers for objects registered by this component
     function isNftInterceptor() external view returns(bool isInterceptor);
 
-    /// @dev returns component infos for this pool
-    /// when registered with an instance the info is obtained from the data stored in the instance
-    /// when not registered the function returns the info from the component contract
+    /// @dev returns true iff this component is registered with the registry
+    function isRegistered() external view returns (bool);
+
+    /// @dev returns the component infos for this component
+    /// for a non registered component the function returns getInitialComponentInfo()
     function getComponentInfo() external view returns (IComponents.ComponentInfo memory info);
+
+    /// @dev returns the iniital component infos for this component
+    function getInitialComponentInfo() external view returns (IComponents.ComponentInfo memory info);
 }

package/contracts/shared/IComponentService.sol

@@ -0,0 +1,102 @@
+// 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
+/// component examples are staking, product, distribution, pool and oracle
+interface IComponentService is 
+    IService
+{
+    error ErrorComponentServiceNewWalletAddressZero();
+    error ErrorComponentServiceWalletAddressZero();
+    error ErrorComponentServiceWalletAddressIsSameAsCurrent();
+
+    event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
+    event LogComponentServiceProductFeesUpdated(NftId productNftId);
+    event LogComponentServiceDistributionFeesUpdated(NftId distributionNftId);
+    event LogComponentServicePoolFeesUpdated(NftId poolNftId);
+    event LogComponentServiceUpdateFee(
+        NftId nftId, 
+        string feeName, 
+        UFixed previousFractionalFee, 
+        uint256 previousFixedFee,
+        UFixed newFractionalFee, 
+        uint256 newFixedFee
+    );
+
+    //-------- component ----------------------------------------------------//
+
+    /// @dev sets the components associated wallet address
+    function setWallet(address newWallet) external;
+
+    /// @dev locks the component associated with the caller
+    function lock() external;
+
+    /// @dev unlocks the component associated with the caller
+    function unlock() external;
+
+    //-------- product ------------------------------------------------------//
+
+    /// @dev registers the sending component as a product component
+    function registerProduct() external;
+
+    function setProductFees(
+        Fee memory productFee, // product fee on net premium
+        Fee memory processingFee // product fee on payout amounts        
+    ) external;
+
+    function increaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
+    function decreaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
+
+    //-------- distribution -------------------------------------------------//
+
+    /// @dev registers the sending component as a distribution component
+    function registerDistribution() external;
+
+    function setDistributionFees(
+        Fee memory distributionFee, // distribution fee for sales that do not include commissions
+        Fee memory minDistributionOwnerFee // min fee required by distribution owner (not including commissions for distributors)
+    ) external;
+
+    function increaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
+    function decreaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, 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(
+        Fee memory poolFee, // pool fee on net premium
+        Fee memory stakingFee, // pool fee on staked capital from investor
+        Fee memory performanceFee // pool fee on profits from capital investors
+    ) external;
+
+    function increasePoolBalance(InstanceStore instanceStore, NftId poolNftId, Amount amount, Amount feeAmount) external;
+    function decreasePoolBalance(InstanceStore instanceStore, NftId poolNftId, Amount amount, Amount feeAmount) external;
+
+    //-------- 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

@@ -0,0 +1,46 @@
+// 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 {IComponent} from "../shared/IComponent.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 {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();
+
+    /// @dev registers this component with the registry and instance.
+    /// a component may only be linked once
+    /// only initial component owner (nft holder) is authorizes to call this function
+    function register() external;
+
+    /// @dev locks component to disable functions that may change state related to this component, the only exception is function "unlock"
+    /// only component owner (nft holder) is authorizes to call this function
+    function lock() external;
+
+    /// @dev unlocks component to (re-)enable functions that may change state related to this component
+    /// only component owner (nft holder) is authorizes to call this function
+    function unlock() external;
+
+    /// @dev defines the instance to which this component is linked to
+    function getInstance() external view returns (IInstance instance);
+
+    /// @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/{instance/base → shared}/IKeyValueStore.sol

@@ -1,17 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
-import {Key32, KeyId} from "../../types/Key32.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId} from "../../types/StateId.sol";
+import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
+import {Key32, KeyId} from "../type/Key32.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {StateId} from "../type/StateId.sol";
 
 import {ILifecycle} from "./ILifecycle.sol";
 
-// TODO remove - internal only?
 interface IKeyValueStore is ILifecycle {
 
+    error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
+    error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
+    error ErrorKeyValueStoreStateZero(Key32 key);
+    error ErrorKeyValueStoreNotExisting(Key32 key);
+
+    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
+    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+
     struct Value {
         Metadata metadata;
         bytes data;
@@ -24,15 +32,11 @@ 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;
     }
 
-    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-
     // generic state changing functions
     // function create(Key32 key, bytes memory data) external;
     // function update(Key32 key, bytes memory data, StateId state) external;

package/contracts/{instance/base → shared}/ILifecycle.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId} from "../../types/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {StateId} from "../type/StateId.sol";
 
 interface ILifecycle {
 

package/contracts/shared/INftOwnable.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 import {IRegistryLinked} from "./IRegistryLinked.sol";
-import {NftId} from "../types/NftId.sol";
+import {NftId} from "../type/NftId.sol";
 
 interface INftOwnable is
     IERC165,
@@ -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

@@ -4,23 +4,42 @@ pragma solidity ^0.8.20;
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../types/NftId.sol";
-import {NumberId} from "../types/NumberId.sol";
+import {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
+import {NftId} from "../type/NftId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
 
 /// @dev generic interface for contracts that need to hold policies and receive payouts
 /// GIF will notify policy holder contracts for policy creation and payout execution
-/// 
+interface IPolicyHolder is
+    IERC165,
+    IERC721Receiver,
+    IRegistryLinked
+{
 
-interface IPolicyHolder is IERC165, IERC721Receiver {
+    /// @dev callback function that will be called after successful policy activation
+    /// active policies may open claims under the activated policy
+    function policyActivated(NftId policyNftId) external;
 
-    /// @dev callback function that will be called after successful policy creation
-    function policyCreatedCallback(NftId policyNftId) external;
+    /// @dev callback function to indicate the specified policy has expired
+    /// expired policies may no longer open claims
+    /// 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 payoutExecutedCallback(NftId policyNftId, NumberId payoutId, address beneficiary, uint256 amount) external;
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external;
 
-    /// @dev determines beneficiary address that will be used in payouts targeting this contract
+    /// @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 policyId, NumberId claimId) external view returns (address beneficiary);
+    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external view returns (address beneficiary);
 }

package/contracts/shared/IRegistryLinked.sol

@@ -8,5 +8,4 @@ interface IRegistryLinked {
     error ErrorNotRegistry(address registryAddress);
 
     function getRegistry() external view returns (IRegistry);
-    function getRegistryAddress() external view returns (address);
 }

package/contracts/shared/IService.sol

@@ -1,18 +1,18 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {VersionPart} from "../types/Version.sol";
-import {ObjectType} from "../types/ObjectType.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 
 interface IService is 
     IRegisterable,
-    IVersionable
+    IVersionable,
+    IAccessManaged
 {
-    error ErrorIServiceCallerUnknown(address caller);
-    
+    error ErrorServiceNotImplemented();
+
     function getDomain() external pure returns(ObjectType serviceDomain);
-    function getMajorVersion() external view returns(VersionPart majorVersion);
 }

package/contracts/shared/IVersionable.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Version} from "../types/Version.sol";
+import {Version} from "../type/Version.sol";
 
 /// IMPORTANT
 // Upgradeable contract MUST: