@etherisc/gif-next 0.0.2-b421459-499 → 0.0.2-b43fece-589

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,7 +17,7 @@ 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";
@@ -36,6 +37,7 @@ 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 {
@@ -46,14 +48,23 @@ abstract contract InstanceLinkedComponent is
         IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
     }
 
-    function getInstance() public view override returns (IInstance instance) {
-        return _getInstanceLinkedComponentStorage()._instance;
+    /// @inheritdoc IInstanceLinkedComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        onlyOwner()
+        restricted()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
     }
 
-    function getProductNftId() public view override returns (NftId productNftId) {
-        return getComponentInfo().productNftId;
+    /// @inheritdoc IInstanceLinkedComponent
+    function getInstance() public view override returns (IInstance instance) {
+        return _getInstanceLinkedComponentStorage()._instance;
     }
 
+    /// @inheritdoc IInstanceLinkedComponent
     function getAuthorization() external view returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
@@ -66,50 +77,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;
+        }
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IInstanceLinkedComponent).interfaceId);
+        // if not product parent is product, and parent of product is instance
+        IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
+        return registry.getObjectInfo(parentNftId).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);
+
+        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 +173,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()) {
@@ -141,11 +196,18 @@ abstract contract InstanceLinkedComponent is
         return _getInstanceLinkedComponentStorage()._instanceReader;
     }
 
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
+    }
+
 
     /// @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);
+        VersionPart release = _getInstanceLinkedComponentStorage()._instance.getRelease();
+        return getRegistry().getServiceAddress(domain, release);
     }
 }

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);
+        _;
+    }
+
+    function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
+        if(!getRegistry().isObjectType(nftId, expectedObjectType)) {
+            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
+        }
+    }
+
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function initializeNftOwnable(
-        address initialOwner,
-        address registryAddress
+    function _initializeNftOwnable(
+        address registry,
+        address initialOwner
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-        initializeERC165();
+        _initializeRegistryLinked(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);
+        _initializeRegistryLinked(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
-        }
-    }
 }

package/contracts/shared/Registerable.sol

@@ -1,11 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
-
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
@@ -14,6 +13,8 @@ contract Registerable is
     NftOwnable,
     IRegisterable
 {
+    uint256 public constant GIF_RELEASE = 3;
+
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
 
@@ -24,21 +25,21 @@ contract Registerable is
         bytes _data;
     }
 
-    function initializeRegisterable(
-        address registryAddress,
+    function _initializeRegisterable(
+        address registry,
         NftId parentNftId,
         ObjectType objectType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+        bytes memory data // writeonly data that will saved in the object info record of the registry
     )
-        public
+        internal
         virtual
-        onlyInitializing
+        onlyInitializing()
     {
-        initializeNftOwnable(
-            initialOwner,
-            registryAddress);
+        _initializeNftOwnable(
+            registry,
+            initialOwner);
 
         RegisterableStorage storage $;
         assembly {
@@ -48,10 +49,17 @@ contract Registerable is
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        $._data = registryData;
+        $._data = data;
+    }
+
+
+    /// @inheritdoc IRegisterable
+    function getRelease() public virtual pure returns (VersionPart release) {
+        return VersionPartLib.toVersionPart(GIF_RELEASE);
     }
 
 
+    /// @inheritdoc IRegisterable
     function getInitialInfo() 
         public 
         view 

package/contracts/shared/RegistryLinked.sol

@@ -10,14 +10,15 @@ contract RegistryLinked is
     IRegistryLinked
 {
 
+    // priorize simplicity and size over using standard upgradeability structs
     IRegistry private _registry;
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function initializeRegistryLinked(
+    function _initializeRegistryLinked(
         address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {

package/contracts/shared/Service.sol

@@ -3,16 +3,16 @@ pragma solidity ^0.8.20;
 
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "./IVersionable.sol";
-import {NftId} from "../type/NftId.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-import {Versionable} from "./Versionable.sol";
+import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 /// @dev service base contract
@@ -20,28 +20,20 @@ abstract contract Service is
     Registerable,
     Versionable,
     AccessManagedUpgradeable,
+    ReentrancyGuardUpgradeable,
     IService
 {
 
-    uint8 private constant GIF_MAJOR_VERSION = 3;
-
-
-    function initializeService(
+    function _initializeService(
         address registry, 
         address authority, // real authority for registry service adress(0) for other services
         address initialOwner
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegisterable(
-            registry, 
-            IRegistry(registry).getNftId(), 
-            SERVICE(), 
-            false, // is interceptor
-            initialOwner, 
-            ""); // data
+        __ReentrancyGuard_init();
 
         // externally provided authority
         if(authority != address(0)) {
@@ -53,8 +45,17 @@ abstract contract Service is
             __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
         }
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IService).interfaceId);
+        _initializeRegisterable(
+            registry, 
+            IRegistry(registry).getNftId(), 
+            SERVICE(), 
+            false, // is interceptor
+            initialOwner, 
+            ""); // data
+
+
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IService).interfaceId);
     }
 
     function getDomain() external virtual pure returns(ObjectType serviceDomain) {
@@ -62,22 +63,22 @@ abstract contract Service is
     }
 
     function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
-        return RoleIdLib.roleForTypeAndVersion(_getDomain(), VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+        return RoleIdLib.roleForTypeAndVersion(_getDomain(), getRelease());
     }
 
-    // from Versionable
+    /// @inheritdoc IVersionable
     function getVersion()
         public 
         pure 
         virtual override (IVersionable, Versionable)
         returns(Version)
     {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+        return VersionLib.toVersion(GIF_RELEASE,0,0);
     }
 
     function _getDomain() internal virtual pure returns (ObjectType);
 
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+        return getRegistry().getServiceAddress(domain, getRelease());
     }
 }