@etherisc/gif-next 3.0.0-d7939fe-905 → 3.0.0-f90c901-018

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -7,23 +7,20 @@ import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
 
 /// @dev component base class
 /// component examples are product, distribution, pool and oracle
 interface IInstanceLinkedComponent is 
     IComponent
 {
-    error ErrorInstanceLinkedComponentTypeMismatch(ObjectType requiredType, ObjectType objectType);
-    error ErrorInstanceLinkedComponentNotProduct(NftId nftId, ObjectType objectType);
-
-    /// @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);
+    error ErrorInstanceLinkedComponentInstanceInvalid();
+    error ErrorInstanceLinkedComponentInstanceMismatch(VersionPart instanceRelease, VersionPart componentRelease);
 
     /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);
 
+    // TODO consider moving to Registerable -> it works with authority
     /// @dev returns the initial component authorization specification.
     function getAuthorization() external view returns (IAuthorization authorization);
 

package/contracts/shared/INftOwnable.sol

@@ -5,7 +5,6 @@ import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 import {IRegistryLinked} from "./IRegistryLinked.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
 
 interface INftOwnable is
     IERC165,
@@ -15,7 +14,6 @@ interface INftOwnable is
     
     error ErrorNftOwnableInitialOwnerZero();
     error ErrorNftOwnableNotOwner(address account);
-    error ErrorNftOwnableInvalidType(NftId nftId, ObjectType expectedObjectType);
 
     error ErrorNftOwnableAlreadyLinked(NftId nftId);
     error ErrorNftOwnableContractNotRegistered(address contractAddress);

package/contracts/shared/IRegisterable.sol

@@ -4,8 +4,11 @@ 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 {IVersionable} from "./IVersionable.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {NftId} from "../type/NftId.sol";
+import {VersionPart} from "../type/Version.sol";
 
 /// @title IRegisterable
 /// @dev Marks contracts that are intended to be registered in the registry.
@@ -13,7 +16,7 @@ import {IRegistry} from "../registry/IRegistry.sol";
 interface IRegisterable is
     IAccessManaged,
     INftOwnable,
-    IRelease
+    IVersionable
 {
     // __Registerable_init
     error ErrorAuthorityInvalid(address authority);
@@ -21,6 +24,9 @@ interface IRegisterable is
     // onlyActive()
     error ErrorRegisterableNotActive();
 
+    // _checkNftType()
+    error ErrorRegisterableInvalidType(NftId nftId, ObjectType expectedType, VersionPart expectedRelease);
+
     /// @dev Returns true iff this contract managed by its authority is active.
     /// Queries the IAccessManaged.authority().
     function isActive() external view returns (bool active);
@@ -32,5 +38,10 @@ interface IRegisterable is
     function getInitialInfo() 
         external 
         view
-        returns (IRegistry.ObjectInfo memory);
+        returns (IRegistry.ObjectInfo memory info);
+
+    function getInitialData() 
+        external 
+        view
+        returns (bytes memory data);
 }

package/contracts/shared/IRegistryLinked.sol

@@ -5,7 +5,5 @@ import {IRegistry} from "../registry/IRegistry.sol";
 
 interface IRegistryLinked {
 
-    error ErrorNotRegistry(address registryAddress);
-
-    function getRegistry() external view returns (IRegistry);
+    function getRegistry() external pure returns (IRegistry);
 }

package/contracts/shared/IService.sol

@@ -4,14 +4,14 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IAccessManaged,
     IRegisterable,
-    IVersionable
+    IUpgradeable
 {
     /// @dev returns the domain for this service.
     /// In any GIF release only one service for any given domain may be deployed.

package/contracts/shared/IVersionable.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Version, VersionPart} from "../type/Version.sol";
+
+interface IVersionable {
+
+    error ErrorVersionableReleaseInvalid(address target, VersionPart invalidRelease);
+    error ErrorVersionableReleaseMismatch(address target, VersionPart expected, VersionPart actual);
+
+    /**
+     * @dev returns version of this contract
+     * implementation MUST define version in this function
+     * version number MUST increase 
+     */
+    function getVersion() external pure returns(Version);
+
+    function getRelease() external pure returns(VersionPart);
+}

package/contracts/shared/InstanceLinkedComponent.sol

@@ -1,10 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 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 {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";
@@ -12,17 +8,11 @@ import {IComponentService} from "./IComponentService.sol";
 import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
 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, PRODUCT} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
-import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {IAccess} from "../authorization/IAccess.sol";
-import {TokenHandler} from "../shared/TokenHandler.sol";
-import {VersionPart} from "../type/Version.sol";
 
 // then add (Distribution|Pool|Product)Upradeable that also intherit from Versionable
 // same pattern as for Service which is also upgradeable
@@ -35,24 +25,11 @@ abstract contract InstanceLinkedComponent is
 
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance for this component
-        InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
-        IComponentService _componentService;
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function withdrawFees(Amount amount)
-        external
-        virtual
-        restricted()
-        onlyOwner()
-        returns (Amount withdrawnAmount)
-    {
-        return _withdrawFees(amount);
-    }
-
-    /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view virtual override returns (IInstance instance) {
+    function getInstance() public view virtual returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
@@ -61,14 +38,7 @@ abstract contract InstanceLinkedComponent is
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
-    function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
-        assembly {
-            $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
-        }
-    }
-
     function __InstanceLinkedComponent_init(
-        address registry,
         NftId parentNftId,
         string memory name,
         ObjectType componentType,
@@ -76,79 +46,60 @@ abstract contract InstanceLinkedComponent is
         bool isInterceptor,
         address initialOwner
     )
-        internal
+        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).getObjectAddress(instanceNftId));
+        IInstance instance = _checkAndGetInstance(parentNftId, componentType);
 
         // set component specific parameters
         __Component_init(
-            $._instance.authority(), // instance linked components need to point to instance admin
-            registry, 
+            instance.authority(),
             parentNftId, 
             name, 
-            componentType, 
+            componentType,
             isInterceptor, 
             initialOwner, 
             ""); // registry data
 
         // set instance linked specific parameters
-        $._instanceReader = $._instance.getInstanceReader();
+        InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
+        $._instance = instance;
         $._initialAuthorization = authorization;
-        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
         // register interfaces
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
-
-    function _checkAndGetInstanceNftId(
-        address registryAddress,
+    function _checkAndGetInstance(
         NftId parentNftId,
         ObjectType componentType
     )
-        internal
+        private
         view
-        returns (NftId instanceNftId)
+        returns (IInstance instance)
     {
-        // if product, then parent is already instance
-        if (componentType == PRODUCT()) {
-            _checkAndGetRegistry(registryAddress, parentNftId, INSTANCE());
-            return parentNftId;
+        NftId instanceNftId;
+        IRegistry registry = _getRegistry();
+
+        if(componentType == PRODUCT()) {
+            instanceNftId = parentNftId;
+        } else {
+            NftId productNftId = parentNftId;
+            instanceNftId = registry.getParentNftId(productNftId);
         }
 
-        // if not product parent is product, and parent of product is instance
-        IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
-        return registry.getParentNftId(parentNftId);
-    }
+        IRegistry.ObjectInfo memory info = registry.getObjectInfo(instanceNftId);
 
-    /// @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 != INSTANCE()) {
+            revert ErrorInstanceLinkedComponentInstanceInvalid();
+        }
 
-        if (info.objectType != requiredType) {
-            revert ErrorInstanceLinkedComponentTypeMismatch(requiredType, info.objectType);
+        if(info.release != getRelease()) {
+            revert ErrorInstanceLinkedComponentInstanceMismatch(info.release, getRelease());
         }
+
+        instance = IInstance(info.objectAddress); 
     }
 
 
@@ -160,7 +111,7 @@ abstract contract InstanceLinkedComponent is
 
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
-        NftId componentNftId = getRegistry().getNftIdForAddress(address(this));
+        NftId componentNftId = _getRegistry().getNftIdForAddress(address(this));
 
         // if registered, attempt to return component info via instance reader
         if (componentNftId.gtz()) {
@@ -180,13 +131,12 @@ abstract contract InstanceLinkedComponent is
 
     /// @dev returns reader for linked instance
     function _getInstanceReader() internal view returns (InstanceReader reader) {
-        return _getInstanceLinkedComponentStorage()._instanceReader;
+        return _getInstanceLinkedComponentStorage()._instance.getInstanceReader();
     }
 
-    function _withdrawFees(Amount amount)
-        internal
-        returns (Amount withdrawnAmount)
-    {
-        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
+    function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
+        assembly {
+            $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
+        }
     }
 }

package/contracts/shared/NftOwnable.sol

@@ -4,7 +4,6 @@ pragma solidity ^0.8.20;
 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
@@ -29,28 +28,15 @@ contract NftOwnable is
     }
 
     modifier onlyNftOwner(NftId nftId) {
-        if(!getRegistry().isOwnerOf(nftId, msg.sender)) {
+        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(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType)) {
-            revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
-        }
-    }
-
-
     /// @dev Initialization for upgradable contracts.
-    // used in __Registerable_init, ProxyManager._preDeployChecksAndSetup
+    // used in __Registerable_init, ProxyManager.initialize
     function __NftOwnable_init(
-        address registry,
         address initialOwner
     )
         internal
@@ -58,7 +44,6 @@ contract NftOwnable is
         onlyInitializing()
     {
         __ERC165_init();
-        __RegistryLinked_init(registry);
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -88,7 +73,7 @@ contract NftOwnable is
         NftOwnableStorage storage $ = _getNftOwnableStorage();
 
         if ($._nftId.gtz()) {
-            return getRegistry().ownerOf($._nftId);
+            return _getRegistry().ownerOf($._nftId);
         }
 
         return $._initialOwner;
@@ -108,15 +93,17 @@ contract NftOwnable is
             revert ErrorNftOwnableAlreadyLinked($._nftId);
         }
 
-        if (!getRegistry().isRegistered(nftOwnableAddress)) {
+        NftId nftId = _getRegistry().getNftIdForAddress(nftOwnableAddress);
+
+        if (nftId.eqz()) {
             revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
         }
 
-        $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
+        $._nftId = nftId;
 
-        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+        emit LogNftOwnableNftLinkedToAddress(nftId, getOwner());
 
-        return $._nftId;
+        return nftId;
     }
 
 

package/contracts/shared/PolicyHolder.sol

@@ -23,14 +23,12 @@ contract PolicyHolder is
     // 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
 
-    function _initializePolicyHolder(
-        address registryAddress
+    function __PolicyHolder_init(
     )
         internal
         virtual
         onlyInitializing()
     {
-        __RegistryLinked_init(registryAddress);
         _initializeERC165();
         _registerInterface(type(IPolicyHolder).interfaceId);
     }
@@ -47,7 +45,7 @@ contract PolicyHolder is
     /// @dev empty default implementation
     function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external virtual {}
 
-    //--- IERC165 functions ---------------// 
+    //--- IERC721 functions ---------------// 
     function onERC721Received(
         address, // operator
         address, // from

package/contracts/shared/Registerable.sol

@@ -9,15 +9,16 @@ import {ContractLib} from "../shared/ContractLib.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {Versionable} from "../shared/Versionable.sol";
 import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
-import {IRelease} from "../registry/IRelease.sol";
 
 abstract contract Registerable is
     AccessManagedUpgradeable,
     NftOwnable,
+    Versionable,
     IRegisterable
 {
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
@@ -37,14 +38,27 @@ abstract contract Registerable is
         _;
     }
 
+    modifier onlyNftOfType(NftId nftId, ObjectType expectedObjectType) {
+        _checkNftType(nftId, expectedObjectType);
+        _;
+    }
+
+    // TODO move to registerables verification library
+    // TODO and check the owner here?
+    function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
+        VersionPart expectedRelease = getRelease();
+        if(expectedObjectType.eqz() || !_getRegistry().isObjectType(nftId, expectedObjectType, expectedRelease)) {
+            revert ErrorRegisterableInvalidType(nftId, expectedObjectType, expectedRelease);
+        }
+    }
+
     function __Registerable_init(
         address authority,
-        address registry,
         NftId parentNftId,
         ObjectType objectType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory data // writeonly data that will saved in the object info record of the registry
+        bytes memory data
     )
         internal
         virtual
@@ -54,14 +68,19 @@ abstract contract Registerable is
             revert ErrorAuthorityInvalid(authority);
         }
 
+        VersionPart release = AccessManagerCloneable(authority).getRelease();
+
         __AccessManaged_init(authority);
-        __NftOwnable_init(registry, initialOwner);
+        __NftOwnable_init(initialOwner);
+        __Versionable_init(release);
 
         RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        $._data = data;
+        if(data.length > 0) { 
+            $._data = data;
+        }
 
         _registerInterface(type(IAccessManaged).interfaceId);
     }
@@ -72,13 +91,6 @@ abstract contract Registerable is
         return !AccessManagerCloneable(authority()).isTargetClosed(address(this));
     }
 
-
-    /// @inheritdoc IRelease
-    function getRelease() public virtual view returns (VersionPart release) {
-        return AccessManagerCloneable(authority()).getRelease();
-    }
-
-
     /// @inheritdoc IRegisterable
     function getInitialInfo() 
         public 
@@ -87,14 +99,19 @@ abstract contract Registerable is
         returns (IRegistry.ObjectInfo memory info) 
     {
         RegisterableStorage storage $ = _getRegisterableStorage();
-        return IRegistry.ObjectInfo(
-            NftIdLib.zero(),
-            $._parentNftId,
-            $._objectType,
-            $._isInterceptor,
-            address(this), 
-            getOwner(),
-            $._data);
+        return (
+            IRegistry.ObjectInfo(
+                NftIdLib.zero(),
+                $._parentNftId,
+                $._objectType,
+                getRelease(),
+                $._isInterceptor,
+                address(this))
+        );
+    }
+
+    function getInitialData() public view virtual returns (bytes memory data) {
+        return _getRegisterableStorage()._data;
     }
 
 

package/contracts/shared/RegistryLinked.sol

@@ -1,38 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {ContractLib} from "../shared/ContractLib.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "./IRegistryLinked.sol";
 
 contract RegistryLinked is
-    Initializable,
     IRegistryLinked
 {
-
-    // priorize simplicity and size over using standard upgradeability structs
-    IRegistry private _registry;
-
-    /// @dev initialization for upgradable contracts
-    // used in _initializeRegisterable
-    function __RegistryLinked_init(
-        address registry
-    )
-        internal
-        virtual
-        onlyInitializing()
-    {
-        if (!ContractLib.isRegistry(registry)) {
-            revert ErrorNotRegistry(registry);
-        }
-
-        _registry = IRegistry(registry);
+    function getRegistry() external pure returns (IRegistry) {
+        return ContractLib.getRegistry();
     }
 
-
-    function getRegistry() public view returns (IRegistry) {
-        return _registry;
+    function _getRegistry() internal pure returns (IRegistry) {
+        return ContractLib.getRegistry();
     }
 }

package/contracts/shared/Service.sol

@@ -5,25 +5,25 @@ import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/ut
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IVersionable} from "../shared/IVersionable.sol";
 import {ObjectType, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {Versionable} from "../upgradeability/Versionable.sol";
+import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../shared/Versionable.sol";
+import {Upgradeable} from "../upgradeability/Upgradeable.sol";
 
 
 /// @dev service base contract
 abstract contract Service is 
-    Registerable,
-    Versionable,
+    Registerable, 
+    Upgradeable,
     ReentrancyGuardUpgradeable,
     IService
 {
 
     function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
-        address registry, 
         address initialOwner
     )
         internal
@@ -34,8 +34,7 @@ abstract contract Service is
 
         __Registerable_init(
             authority,
-            registry, 
-            IRegistry(registry).getNftId(), 
+            _getRegistry().getNftId(), 
             SERVICE(), 
             false, // is interceptor
             initialOwner, 
@@ -62,6 +61,6 @@ abstract contract Service is
 
 
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, getRelease());
+        return _getRegistry().getServiceAddress(domain, getRelease());
     }
 }