@etherisc/gif-next 0.0.2-eb7c077-523 → 0.0.2-eba4d8b-925

package/contracts/shared/IPolicyHolder.sol

@@ -9,37 +9,27 @@ import {ClaimId} from "../type/ClaimId.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {NftId} from "../type/NftId.sol";
 import {PayoutId} from "../type/PayoutId.sol";
+import {Timestamp} from "../type/Timestamp.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
+/// @dev Generic interface for contracts that need to hold policies and receive payouts.
+/// The framework notifies policy holder contracts for policy creation/expiry, claim confirmation and payout execution
 interface IPolicyHolder is
     IERC165,
     IERC721Receiver,
     IRegistryLinked
 {
 
-    /// @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 activation.
+    /// Active policies may open claims under the activated policy.
+    function policyActivated(NftId policyNftId, Timestamp activatedAt) 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 Callback function to indicate the specified policy has expired.
+    /// expired policies no longer accept new claims.
+    function policyExpired(NftId policyNftId, Timestamp expiredAt) 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
+    /// @dev Callback function to notify the confirmation of the specified claim.
     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);
+    /// @dev Callback function to notify the successful payout.
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external;
 }

package/contracts/shared/IRegisterable.sol

@@ -1,13 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
 import {INftOwnable} from "./INftOwnable.sol";
+import {IRelease} from "../registry/IRelease.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
+import {VersionPart} from "../type/Version.sol";
 
+/// @title IRegisterable
+/// @dev Marks contracts that are intended to be registered in the registry.
+/// 
 interface IRegisterable is
-    INftOwnable
+    IAccessManaged,
+    INftOwnable,
+    IRelease
 {
+    // __Registerable_init
+    error ErrorAuthorityInvalid(address authority);
+
+    // onlyActive()
+    error ErrorRegisterableNotActive();
+
+    /// @dev Returns true iff this contract managed by its authority is active.
+    /// Queries the IAccessManaged.authority().
+    function isActive() external view returns (bool active);
 
+    /// @dev retuns the object info relevant for registering for this contract 
+    /// IMPORTANT information returned by this function may only be used
+    /// before the contract is registered in the registry.
+    /// Once registered this information MUST only be accessed via the registry.
     function getInitialInfo() 
         external 
         view

package/contracts/shared/IService.sol

@@ -9,17 +9,15 @@ import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
+    IAccessManaged,
     IRegisterable,
-    IVersionable,
-    IAccessManaged
+    IVersionable
 {
-    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);
+    function getRoleId() external view returns(RoleId serviceRoleId);
 }

package/contracts/shared/{ERC165.sol → InitializableERC165.sol}

@@ -4,20 +4,20 @@ pragma solidity ^0.8.20;
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-contract ERC165 is
+contract InitializableERC165 is
     Initializable,
     IERC165
 {
     mapping(bytes4 => bool) private _isSupported;
 
     // @dev initializes with support for ERC165
-    function initializeERC165() public onlyInitializing() {
+    function _initializeERC165() internal onlyInitializing() {
         _isSupported[type(IERC165).interfaceId] = true;
     }
 
     // @dev register support for provided interfaceId
     // includes initialization for ERC165_ID if not yet done
-    function registerInterface(bytes4 interfaceId) public onlyInitializing() {
+    function _registerInterface(bytes4 interfaceId) internal onlyInitializing() {
         _isSupported[interfaceId] = true;
     }
 

package/contracts/shared/InstanceLinkedComponent.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {Component} from "./Component.sol";
 import {IComponentService} from "./IComponentService.sol";
 import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
@@ -16,10 +17,10 @@ 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, INSTANCE} from "../type/ObjectType.sol";
+import {ObjectType, COMPONENT, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPart} from "../type/Version.sol";
 
@@ -36,24 +37,26 @@ abstract contract InstanceLinkedComponent is
         IInstance _instance; // instance for this component
         InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
+        IComponentService _componentService;
     }
 
-    function lock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
-    }
-    
-    function unlock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
+    /// @inheritdoc IInstanceLinkedComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
     }
 
+    /// @inheritdoc IInstanceLinkedComponent
     function getInstance() public view override returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
-    function getProductNftId() public view override returns (NftId productNftId) {
-        return getComponentInfo().productNftId;
-    }
-
+    /// @inheritdoc IInstanceLinkedComponent
     function getAuthorization() external view returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
@@ -66,50 +69,94 @@ abstract contract InstanceLinkedComponent is
 
     function _initializeInstanceLinkedComponent(
         address registry,
-        NftId instanceNftId,
+        NftId parentNftId,
         string memory name,
         address token,
         ObjectType componentType,
         IAuthorization authorization,
         bool isInterceptor,
         address initialOwner,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // data that will saved with the component info in the instance store
     )
         internal
         virtual
         onlyInitializing()
     {
+        // validate registry, nft ids and get parent nft id
+        NftId instanceNftId = _checkAndGetInstanceNftId(
+            registry, 
+            parentNftId, 
+            componentType);
+
         // set and check linked instance
         InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
         $._instance = IInstance(
-            IRegistry(registry).getObjectInfo(
-                instanceNftId).objectAddress);
+            IRegistry(registry).getObjectAddress(instanceNftId));
 
-        if(!$._instance.supportsInterface(type(IInstance).interfaceId)) {
-            revert ErrorComponentNotInstance(instanceNftId);
-        }
-
-        initializeComponent(
-            $._instance.authority(), 
+        // set component specific parameters
+        _initializeComponent(
+            $._instance.authority(), // instance linked components need to point to instance admin
             registry, 
-            instanceNftId, 
+            parentNftId, 
             name, 
             token,
             componentType, 
             isInterceptor, 
             initialOwner, 
-            registryData,
+            "", // registry data
             componentData);
 
-        // set component state
+        // set instance linked specific parameters
         $._instanceReader = $._instance.getInstanceReader();
         $._initialAuthorization = authorization;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+
+        // register interfaces
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IInstanceLinkedComponent).interfaceId);
+    }
+
+
+    function _checkAndGetInstanceNftId(
+        address registryAddress,
+        NftId parentNftId,
+        ObjectType componentType
+    )
+        internal
+        view
+        returns (NftId instanceNftId)
+    {
+        // if product, then parent is already instance
+        if (componentType == PRODUCT()) {
+            _checkAndGetRegistry(registryAddress, parentNftId, INSTANCE());
+            return parentNftId;
+        }
+
+        // if not product parent is product, and parent of product is instance
+        IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
+        return registry.getParentNftId(parentNftId);
+    }
+
+    /// @dev checks the and gets registry.
+    /// validates registry using a provided nft id and expected object type.
+    function _checkAndGetRegistry(
+        address registryAddress,
+        NftId objectNftId,
+        ObjectType requiredType
+    )
+        internal
+        view
+        returns (IRegistry registry)
+    {
+        registry = IRegistry(registryAddress);
+        IRegistry.ObjectInfo memory info = registry.getObjectInfo(objectNftId);
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IInstanceLinkedComponent).interfaceId);
+        if (info.objectType != requiredType) {
+            revert ErrorInstanceLinkedComponentTypeMismatch(requiredType, info.objectType);
+        }
     }
 
+
     /// @dev for instance linked components the wallet address stored in the instance store.
     /// updating needs to go throug component service
     function _setWallet(address newWallet) internal virtual override onlyOwner {
@@ -118,7 +165,7 @@ abstract contract InstanceLinkedComponent is
 
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
-        NftId componentNftId = getRegistry().getNftId(address(this));
+        NftId componentNftId = getRegistry().getNftIdForAddress(address(this));
 
         // if registered, attempt to return component info via instance reader
         if (componentNftId.gtz()) {
@@ -126,7 +173,7 @@ abstract contract InstanceLinkedComponent is
             info = _getInstanceReader().getComponentInfo(getNftId());
 
             // check if also registered with instance
-            if (info.wallet != address(0)) {
+            if (address(info.tokenHandler) != address(0)) {
                 return info;
             }
         }
@@ -141,11 +188,10 @@ abstract contract InstanceLinkedComponent is
         return _getInstanceLinkedComponentStorage()._instanceReader;
     }
 
-
-    /// @dev returns the service address for the specified domain
-    /// gets address via lookup from registry using the major version form the linked instance
-    function _getServiceAddress(ObjectType domain) internal view returns (address service) {
-        VersionPart majorVersion = _getInstanceLinkedComponentStorage()._instance.getMajorVersion();
-        return getRegistry().getServiceAddress(domain, majorVersion);
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
     }
 }

package/contracts/shared/KeyValueStore.sol

@@ -94,7 +94,7 @@ abstract contract KeyValueStore is
 
         // update state 
         if(state != KEEP_STATE()) {
-            checkTransition(metadata.objectType, stateOld, state);
+            checkTransition(stateOld, metadata.objectType, stateOld, state);
             metadata.state = state;
 
             // solhint-disable-next-line avoid-tx-origin

package/contracts/shared/Lifecycle.sol

@@ -49,8 +49,9 @@ abstract contract Lifecycle is
     }
 
     function checkTransition(
+        StateId stateId,
         ObjectType objectType,
-        StateId fromId,
+        StateId expectedFromId,
         StateId toId
     )
         public
@@ -58,12 +59,22 @@ abstract contract Lifecycle is
     {
         // revert if no life cycle support
         if (_initialState[objectType].eqz()) {
-            revert ErrorNoLifecycle(objectType);
+            revert ErrorNoLifecycle(address(this), objectType);
+        }
+
+        // revert if current state is not expected `from` state
+        if(stateId != expectedFromId) {
+            revert ErrorFromStateMissmatch(address(this), objectType, stateId, expectedFromId);
         }
 
         // enforce valid state transition
-        if (!_isValidTransition[objectType][fromId][toId]) {
-            revert ErrorInvalidStateTransition(objectType, fromId, toId);
+        if (!_isValidTransition[objectType][stateId][toId]) {
+            revert ErrorInvalidStateTransition(
+                address(this),
+                objectType, 
+                stateId, 
+                toId
+            );
         }
     }
 

package/contracts/shared/NftOwnable.sol

@@ -1,13 +1,14 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ERC165} from "./ERC165.sol";
+import {InitializableERC165} from "./InitializableERC165.sol";
 import {INftOwnable} from "./INftOwnable.sol";
 import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 
 contract NftOwnable is
-    ERC165,
+    InitializableERC165,
     RegistryLinked,
     INftOwnable
 {
@@ -27,19 +28,37 @@ contract NftOwnable is
         _;
     }
 
+    modifier onlyNftOwner(NftId nftId) {
+        if(!getRegistry().isOwnerOf(nftId, msg.sender)) {
+            revert ErrorNftOwnableNotOwner(msg.sender);
+        }
+        _;
+    }
+
+    modifier onlyNftOfType(NftId nftId, ObjectType expectedObjectType) {
+        _checkNftType(nftId, expectedObjectType);
+        _;
+    }
 
-    /// @dev initialization for upgradable contracts
-    // used in _initializeRegisterable
-    function initializeNftOwnable(
-        address initialOwner,
-        address registryAddress
+    function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
+        if(!getRegistry().isObjectType(nftId, expectedObjectType)) {
+            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
+        }
+    }
+
+
+    /// @dev Initialization for upgradable contracts.
+    // used in __Registerable_init, ProxyManager._preDeployChecksAndSetup
+    function __NftOwnable_init(
+        address registry,
+        address initialOwner
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-        initializeERC165();
+        __RegistryLinked_init(registry);
+        _initializeERC165();
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -93,13 +112,14 @@ contract NftOwnable is
             revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
         }
 
-        $._nftId = getRegistry().getNftId(nftOwnableAddress);
+        $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
         return $._nftId;
     }
 
 
     function _getNftOwnableStorage() private pure returns (NftOwnableStorage storage $) {
+        // solhint-disable-next-line no-inline-assembly
         assembly {
             $.slot := NFT_OWNABLE_STORAGE_LOCATION_V1
         }

package/contracts/shared/PolicyHolder.sol

@@ -1,74 +1,50 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ERC165} from "./ERC165.sol";
+import {InitializableERC165} from "./InitializableERC165.sol";
 import {IPolicyHolder} from "./IPolicyHolder.sol";
 import {NftId} from "../type/NftId.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 /// @dev template implementation for IPolicyHolder
 contract PolicyHolder is
-    ERC165,
-    RegistryLinked, // TODO need upgradeable version
+    InitializableERC165,
+    RegistryLinked,
     IPolicyHolder
 {
-    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.PolicyHolder")) - 1)) & ~bytes32(uint256(0xff));
-    // TODO fix address
-    bytes32 public constant POLICY_HOLDER_STORAGE_LOCATION_V1 = 0x07ebcf49758b6ed3af50fa146bec0abe157c0218fe65dc0874c286e9d5da4f00;
+    // TODO add modifier to protect callback functions from unauthorized access
+    // callbacks must only be allowed from the policy and claim services
+    // will need a release parameter to fetch the right service addresses for the modifiers
 
-    struct PolicyHolderStorage {
-        mapping(NftId policyId => mapping(PayoutId payoutId => address beneficiary)) _beneficiary;
-        address _beneficiaryDefault;
-    }
-
-    function initializePolicyHolder(
-        address registryAddress,
-        address beneficiaryDefault
+    function _initializePolicyHolder(
+        address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-
-        _getPolicyHolderStorage()._beneficiaryDefault = beneficiaryDefault;
-
-        registerInterface(type(IPolicyHolder).interfaceId);
+        __RegistryLinked_init(registryAddress);
+        _initializeERC165();
+        _registerInterface(type(IPolicyHolder).interfaceId);
     }
 
     /// @dev empty default implementation
-    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external { }
+    function policyActivated(NftId policyNftId, Timestamp activatedAt) external virtual {}
 
     /// @dev empty default implementation
-    function policyActivated(NftId policyNftId) external {}
+    function policyExpired(NftId policyNftId, Timestamp expiredAt) external virtual {}
 
     /// @dev empty default implementation
-    function policyExpired(NftId policyNftId) external {}
+    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external virtual {}
 
     /// @dev empty default implementation
-    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external {}
-
-    /// @dev empty default implementation
-    function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external {}
-
-    /// @dev returns payout specific beneficiary
-    /// when no such beneficiary is defined the policy specific beneficiary is returned
-    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external virtual view returns (address beneficiary) {
-        beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId];
-
-        // fallback to claim independent beneficiary
-        if(beneficiary == address(0) && payoutId.gtz()) {
-            beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][PayoutIdLib.zero()];
-        }
-    }
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external virtual {}
 
     //--- IERC165 functions ---------------// 
     function onERC721Received(
@@ -83,20 +59,4 @@ contract PolicyHolder is
     {
         return IERC721Receiver.onERC721Received.selector;
     }
-
-    /// @dev sets policy specific beneficiary (used when no payout specific beneficiary is defined)
-    function _setBeneficiary(NftId policyNftId, address beneficiary) internal {
-        _setBeneficiary(policyNftId, PayoutIdLib.zero(), beneficiary);
-    }
-
-    /// @dev sets policy and claim specific beneficiary
-    function _setBeneficiary(NftId policyNftId, PayoutId payoutId, address beneficiary) internal {
-        _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId] = beneficiary;
-    }
-
-    function _getPolicyHolderStorage() private pure returns (PolicyHolderStorage storage $) {
-        assembly {
-            $.slot := POLICY_HOLDER_STORAGE_LOCATION_V1
-        }
-    }
 }