@etherisc/gif-next 3.0.0-ab0fcb2-112 → 3.0.0-b216819-597

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -7,15 +7,19 @@ 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 
     IAuthorizedComponent
 {
-    error ErrorInstanceLinkedComponentInstanceInvalid();
-    error ErrorInstanceLinkedComponentInstanceMismatch(VersionPart instanceRelease, VersionPart componentRelease);
+    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);
 
     /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);

package/contracts/shared/INftOwnable.sol

@@ -5,6 +5,7 @@ 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,
@@ -14,6 +15,7 @@ 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,11 +4,8 @@ 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.
@@ -16,7 +13,7 @@ import {VersionPart} from "../type/Version.sol";
 interface IRegisterable is
     IAccessManaged,
     INftOwnable,
-    IVersionable
+    IRelease
 {
     // __Registerable_init
     error ErrorAuthorityInvalid(address authority);
@@ -24,9 +21,6 @@ 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);
@@ -38,10 +32,5 @@ interface IRegisterable is
     function getInitialInfo() 
         external 
         view
-        returns (IRegistry.ObjectInfo memory info);
-
-    function getInitialData() 
-        external 
-        view
-        returns (bytes memory data);
+        returns (IRegistry.ObjectInfo memory);
 }

package/contracts/shared/IRegistryLinked.sol

@@ -5,5 +5,7 @@ import {IRegistry} from "../registry/IRegistry.sol";
 
 interface IRegistryLinked {
 
-    function getRegistry() external pure returns (IRegistry);
+    error ErrorNotRegistry(address registryAddress);
+
+    function getRegistry() external view 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 {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IAccessManaged,
     IRegisterable,
-    IUpgradeable
+    IVersionable
 {
     /// @dev returns the domain for this service.
     /// In any GIF release only one service for any given domain may be deployed.

package/contracts/shared/InstanceLinkedComponent.sol

@@ -33,6 +33,7 @@ abstract contract InstanceLinkedComponent is
 
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance for this component
+        InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
         IComponentService _componentService;
         IOracleService _oracleService;
@@ -52,7 +53,16 @@ abstract contract InstanceLinkedComponent is
     }
 
 
-    //function setInstanceReader(address readerAddress);
+    /// @inheritdoc IInstanceLinkedComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        restricted()
+        onlyOwner()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
+    }
 
     //--- internal functions ------------------------------------------------//
 
@@ -74,7 +84,6 @@ abstract contract InstanceLinkedComponent is
     }
 
 
-
     function _cancelRequest(RequestId requestId)
         internal
         virtual
@@ -99,6 +108,7 @@ abstract contract InstanceLinkedComponent is
 
 
     function __InstanceLinkedComponent_init(
+        address registry,
         NftId parentNftId,
         string memory name,
         ObjectType componentType,
@@ -106,25 +116,34 @@ abstract contract InstanceLinkedComponent is
         bool isInterceptor,
         address initialOwner
     )
-        internal 
+        internal
         virtual
         onlyInitializing()
     {
-        IInstance instance = _checkAndGetInstance(parentNftId, componentType);
+        // 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));
 
         // set component specific parameters
         __Component_init(
-            instance.authority(),
+            $._instance.authority(), // instance linked components need to point to instance admin
+            registry, 
             parentNftId, 
             name, 
-            componentType,
+            componentType, 
             isInterceptor, 
             initialOwner, 
             ""); // registry data
 
         // set instance linked specific parameters
-        InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
-        $._instance = instance;
+        $._instanceReader = $._instance.getInstanceReader();
         $._initialAuthorization = authorization;
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
         $._oracleService = IOracleService(_getServiceAddress(ORACLE()));
@@ -133,35 +152,44 @@ abstract contract InstanceLinkedComponent is
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
-    function _checkAndGetInstance(
+
+    function _checkAndGetInstanceNftId(
+        address registryAddress,
         NftId parentNftId,
         ObjectType componentType
     )
-        private
+        internal
         view
-        returns (IInstance instance)
+        returns (NftId instanceNftId)
     {
-        NftId instanceNftId;
-        IRegistry registry = _getRegistry();
-
-        if(componentType == PRODUCT()) {
-            instanceNftId = parentNftId;
-        } else {
-            NftId productNftId = parentNftId;
-            instanceNftId = registry.getParentNftId(productNftId);
+        // if product, then parent is already instance
+        if (componentType == PRODUCT()) {
+            _checkAndGetRegistry(registryAddress, parentNftId, INSTANCE());
+            return parentNftId;
         }
 
-        IRegistry.ObjectInfo memory info = registry.getObjectInfo(instanceNftId);
+        // if not product parent is product, and parent of product is instance
+        IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
+        return registry.getParentNftId(parentNftId);
+    }
 
-        if (info.objectType != INSTANCE()) {
-            revert ErrorInstanceLinkedComponentInstanceInvalid();
-        }
+    /// @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.release != getRelease()) {
-            revert ErrorInstanceLinkedComponentInstanceMismatch(info.release, getRelease());
+        if (info.objectType != requiredType) {
+            revert ErrorInstanceLinkedComponentTypeMismatch(requiredType, info.objectType);
         }
-
-        instance = IInstance(info.objectAddress); 
     }
 
 
@@ -173,7 +201,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()) {
@@ -193,6 +221,13 @@ abstract contract InstanceLinkedComponent is
 
     /// @dev returns reader for linked instance
     function _getInstanceReader() internal view returns (InstanceReader reader) {
-        return _getInstanceLinkedComponentStorage()._instance.getInstanceReader();
+        return _getInstanceLinkedComponentStorage()._instanceReader;
+    }
+
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
     }
 }

package/contracts/shared/NftOwnable.sol

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

package/contracts/shared/PolicyHolder.sol

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

package/contracts/shared/Registerable.sol

@@ -9,16 +9,15 @@ 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));
@@ -38,27 +37,14 @@ 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
+        bytes memory data // writeonly data that will saved in the object info record of the registry
     )
         internal
         virtual
@@ -68,19 +54,14 @@ abstract contract Registerable is
             revert ErrorAuthorityInvalid(authority);
         }
 
-        VersionPart release = AccessManagerCloneable(authority).getRelease();
-
         __AccessManaged_init(authority);
-        __NftOwnable_init(initialOwner);
-        __Versionable_init(release);
+        __NftOwnable_init(registry, initialOwner);
 
         RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        if(data.length > 0) { 
-            $._data = data;
-        }
+        $._data = data;
 
         _registerInterface(type(IAccessManaged).interfaceId);
     }
@@ -91,6 +72,13 @@ 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 
@@ -99,19 +87,14 @@ abstract contract Registerable is
         returns (IRegistry.ObjectInfo memory info) 
     {
         RegisterableStorage storage $ = _getRegisterableStorage();
-        return (
-            IRegistry.ObjectInfo(
-                NftIdLib.zero(),
-                $._parentNftId,
-                $._objectType,
-                getRelease(),
-                $._isInterceptor,
-                address(this))
-        );
-    }
-
-    function getInitialData() public view virtual returns (bytes memory data) {
-        return _getRegisterableStorage()._data;
+        return IRegistry.ObjectInfo(
+            NftIdLib.zero(),
+            $._parentNftId,
+            $._objectType,
+            $._isInterceptor,
+            address(this), 
+            getOwner(),
+            $._data);
     }
 
 

package/contracts/shared/RegistryLinked.sol

@@ -1,19 +1,38 @@
 // 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
 {
-    function getRegistry() external pure returns (IRegistry) {
-        return ContractLib.getRegistry();
+
+    // 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() internal pure returns (IRegistry) {
-        return ContractLib.getRegistry();
+
+    function getRegistry() public view returns (IRegistry) {
+        return _registry;
     }
 }

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

package/contracts/shared/TokenHandler.sol

@@ -10,7 +10,6 @@ import {ContractLib} from "../shared/ContractLib.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
 import {SERVICE} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
 
 
 /// @dev Token specific transfer helper base contract.
@@ -50,7 +49,6 @@ contract TokenHandlerBase {
     IERC20Metadata public immutable TOKEN;
     address public immutable COMPONENT;
     NftId public immutable NFT_ID;
-    VersionPart public immutable RELEASE;
 
     address internal _wallet;
 
@@ -71,7 +69,6 @@ contract TokenHandlerBase {
         REGISTRY = IRegistry(registry);
         COMPONENT = component;
         NFT_ID = REGISTRY.getNftIdForAddress(component);
-        RELEASE = REGISTRY.getObjectRelease(NFT_ID);
 
         if (NFT_ID.eqz()) {
             revert ErrorTokenHandlerComponentNotRegistered(component);
@@ -257,7 +254,7 @@ contract TokenHandler is
     error ErrorTokenHandlerNotService(address service);
 
     modifier onlyService() {
-        if (!REGISTRY.isObjectType(msg.sender, SERVICE(), RELEASE)) {
+        if (!REGISTRY.isObjectType(msg.sender, SERVICE())) {
             revert ErrorTokenHandlerNotService(msg.sender);
         }
         _;

package/contracts/staking/IStaking.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponent} from "../shared/IComponent.sol";
-import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {Blocknumber} from "../type/Blocknumber.sol";
@@ -22,9 +22,11 @@ import {VersionPart} from "../type/Version.sol";
 
 interface IStaking is 
     IComponent,
-    IUpgradeable
+    IVersionable
 {
 
+    event LogStakingTokenHandlerDeployed(NftId componentNftId, address tokenHandler, address token);
+    
     // owner functions
     event LogStakingStakingRateSet(ChainId chainId, address token, UFixed newStakingRate, UFixed oldStakingRate, Blocknumber lastUpdateIn);
     event LogStakingStakingServiceSet(address stakingService, VersionPart release, address oldStakingService);