@etherisc/gif-next 0.0.2-e79d227-681 → 0.0.2-e7a5428-226

package/contracts/shared/InstanceLinkedComponent.sol

@@ -20,7 +20,7 @@ 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 "../instance/module/IAccess.sol";
+import {IAccess} from "../authorization/IAccess.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPart} from "../type/Version.sol";
 
@@ -40,32 +40,24 @@ abstract contract InstanceLinkedComponent is
         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
-        onlyOwner()
         restricted()
+        onlyOwner()
         returns (Amount withdrawnAmount)
     {
         return _withdrawFees(amount);
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view override returns (IInstance instance) {
+    function getInstance() public view virtual override returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getAuthorization() external view returns (IAuthorization authorization) {
+    function getAuthorization() external view virtual returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
@@ -75,11 +67,10 @@ abstract contract InstanceLinkedComponent is
         }
     }
 
-    function _initializeInstanceLinkedComponent(
+    function __InstanceLinkedComponent_init(
         address registry,
         NftId parentNftId,
         string memory name,
-        address token,
         ObjectType componentType,
         IAuthorization authorization,
         bool isInterceptor,
@@ -102,12 +93,11 @@ abstract contract InstanceLinkedComponent is
             IRegistry(registry).getObjectAddress(instanceNftId));
 
         // set component specific parameters
-        _initializeComponent(
+        __Component_init(
             $._instance.authority(), // instance linked components need to point to instance admin
             registry, 
             parentNftId, 
             name, 
-            token,
             componentType, 
             isInterceptor, 
             initialOwner, 
@@ -120,7 +110,6 @@ abstract contract InstanceLinkedComponent is
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
         // register interfaces
-        _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
@@ -142,7 +131,7 @@ abstract contract InstanceLinkedComponent is
 
         // if not product parent is product, and parent of product is instance
         IRegistry registry = _checkAndGetRegistry(registryAddress, parentNftId, PRODUCT());
-        return registry.getObjectInfo(parentNftId).parentNftId;
+        return registry.getParentNftId(parentNftId);
     }
 
     /// @dev checks the and gets registry.

package/contracts/shared/KeyValueStore.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
+import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
 import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
@@ -38,7 +38,7 @@ abstract contract KeyValueStore is
             revert ErrorKeyValueStoreNoLifecycle(objectType);
         }
 
-        Blocknumber blocknumber = blockBlocknumber();
+        Blocknumber blocknumber = BlocknumberLib.current();
         StateId initialState = getInitialState(objectType);
 
         // set metadata
@@ -102,7 +102,7 @@ abstract contract KeyValueStore is
         }
 
         // update metadata
-        metadata.updatedIn = blockBlocknumber();
+        metadata.updatedIn = BlocknumberLib.current();
     }
 
     function exists(Key32 key32) public view returns (bool) {

package/contracts/shared/NftOwnable.sol

@@ -41,15 +41,15 @@ contract NftOwnable is
     }
 
     function _checkNftType(NftId nftId, ObjectType expectedObjectType) internal view {
-        if(!getRegistry().isObjectType(nftId, expectedObjectType)) {
+        if(expectedObjectType.eqz() || !getRegistry().isObjectType(nftId, expectedObjectType)) {
             revert ErrorNftOwnableInvalidType(nftId, expectedObjectType);
         }
     }
 
 
-    /// @dev initialization for upgradable contracts
-    // used in _initializeRegisterable
-    function _initializeNftOwnable(
+    /// @dev Initialization for upgradable contracts.
+    // used in __Registerable_init, ProxyManager._preDeployChecksAndSetup
+    function __NftOwnable_init(
         address registry,
         address initialOwner
     )
@@ -57,8 +57,8 @@ contract NftOwnable is
         virtual
         onlyInitializing()
     {
-        _initializeRegistryLinked(registry);
-        _initializeERC165();
+        __ERC165_init();
+        __RegistryLinked_init(registry);
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -114,6 +114,8 @@ contract NftOwnable is
 
         $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
+        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+
         return $._nftId;
     }
 

package/contracts/shared/PolicyHolder.sol

@@ -3,12 +3,13 @@ pragma solidity ^0.8.20;
 
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
+import {IPolicyHolder} from "./IPolicyHolder.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.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 {PayoutId} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 
@@ -29,7 +30,7 @@ contract PolicyHolder is
         virtual
         onlyInitializing()
     {
-        _initializeRegistryLinked(registryAddress);
+        __RegistryLinked_init(registryAddress);
         _initializeERC165();
         _registerInterface(type(IPolicyHolder).interfaceId);
     }

package/contracts/shared/Registerable.sol

@@ -1,6 +1,11 @@
 // 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 {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+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";
@@ -8,13 +13,13 @@ import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
+import {IRelease} from "../registry/IRelease.sol";
 
-contract Registerable is
+abstract contract Registerable is
+    AccessManagedUpgradeable,
     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;
 
@@ -25,7 +30,15 @@ contract Registerable is
         bytes _data;
     }
 
-    function _initializeRegisterable(
+    modifier onlyActive() {
+        if (!isActive()) {
+            revert ErrorRegisterableNotActive();
+        }
+        _;
+    }
+
+    function __Registerable_init(
+        address authority,
         address registry,
         NftId parentNftId,
         ObjectType objectType,
@@ -37,25 +50,32 @@ contract Registerable is
         virtual
         onlyInitializing()
     {
-        _initializeNftOwnable(
-            registry,
-            initialOwner);
-
-        RegisterableStorage storage $;
-        assembly {
-            $.slot := REGISTERABLE_LOCATION_V1
+        if (!ContractLib.isAuthority(authority)) {
+            revert ErrorAuthorityInvalid(authority);
         }
 
+        __AccessManaged_init(authority);
+        __NftOwnable_init(registry, initialOwner);
+
+        RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
         $._data = data;
+
+        _registerInterface(type(IAccessManaged).interfaceId);
     }
 
 
     /// @inheritdoc IRegisterable
-    function getRelease() public virtual pure returns (VersionPart release) {
-        return VersionPartLib.toVersionPart(GIF_RELEASE);
+    function isActive() public virtual view returns (bool active) {
+        return !AccessManagerCloneable(authority()).isTargetClosed(address(this));
+    }
+
+
+    /// @inheritdoc IRelease
+    function getRelease() public virtual view returns (VersionPart release) {
+        return AccessManagerCloneable(authority()).getRelease();
     }
 
 
@@ -66,12 +86,8 @@ contract Registerable is
         virtual 
         returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage storage $;
-        assembly {
-            $.slot := REGISTERABLE_LOCATION_V1
-        }
-
-        info = IRegistry.ObjectInfo(
+        RegisterableStorage storage $ = _getRegisterableStorage();
+        return IRegistry.ObjectInfo(
             NftIdLib.zero(),
             $._parentNftId,
             $._objectType,
@@ -80,4 +96,11 @@ contract Registerable is
             getOwner(),
             $._data);
     }
+
+
+    function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
+    }
 }

package/contracts/shared/RegistryLinked.sol

@@ -17,7 +17,7 @@ contract RegistryLinked is
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function _initializeRegistryLinked(
+    function __RegistryLinked_init(
         address registry
     )
         internal

package/contracts/shared/Service.sol

@@ -1,17 +1,15 @@
 // 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 {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
 import {IVersionable} from "../upgradeability/IVersionable.sol";
-import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.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 {Version, VersionLib} from "../type/Version.sol";
 import {Versionable} from "../upgradeability/Versionable.sol";
 
 
@@ -19,14 +17,13 @@ import {Versionable} from "../upgradeability/Versionable.sol";
 abstract contract Service is 
     Registerable,
     Versionable,
-    AccessManagedUpgradeable,
     ReentrancyGuardUpgradeable,
     IService
 {
 
-    function _initializeService(
-        address registry, 
+    function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
+        address registry, 
         address initialOwner
     )
         internal
@@ -35,17 +32,8 @@ abstract contract Service is
     {
         __ReentrancyGuard_init();
 
-        // externally provided authority
-        if(authority != address(0)) {
-            __AccessManaged_init(authority);
-        } else {
-            address registryServiceAddress = _getServiceAddress(REGISTRY());
-
-            // copy authority from already registered registry services
-            __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
-        }
-
-        _initializeRegisterable(
+        __Registerable_init(
+            authority,
             registry, 
             IRegistry(registry).getNftId(), 
             SERVICE(), 
@@ -53,8 +41,6 @@ abstract contract Service is
             initialOwner, 
             ""); // data
 
-
-        _registerInterface(type(IAccessManaged).interfaceId);
         _registerInterface(type(IService).interfaceId);
     }
 
@@ -62,22 +48,19 @@ abstract contract Service is
         return _getDomain();
     }
 
-    function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
-        return RoleIdLib.roleForTypeAndVersion(_getDomain(), getRelease());
+    function getVersion() public pure virtual override (IVersionable, Versionable) returns(Version) {
+        return VersionLib.toVersion(3, 0, 0);
     }
 
-    /// @inheritdoc IVersionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_RELEASE,0,0);
+
+    function getRoleId() external virtual view returns(RoleId serviceRoleId) {
+        return RoleIdLib.toServiceRoleId(_getDomain(), getRelease());
     }
 
+    //--- internal functions --------------------------------------------------------//
     function _getDomain() internal virtual pure returns (ObjectType);
 
+
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
         return getRegistry().getServiceAddress(domain, getRelease());
     }

package/contracts/shared/TokenHandler.sol

@@ -12,6 +12,10 @@ import {NftId} from "../type/NftId.sol";
 import {SERVICE} from "../type/ObjectType.sol";
 
 
+/// @dev Token specific transfer helper base contract.
+/// A default token contract is provided via contract constructor.
+/// Relies internally on OpenZeppelin SafeERC20.safeTransferFrom.
+/// This base contract simplifies writing tests.
 contract TokenHandlerBase {
 
     // _setWallet
@@ -36,10 +40,6 @@ contract TokenHandlerBase {
     // _approveTokenHandler
     error ErrorTokenHandlerNotWallet(NftId nftId, address tokenHandler, address wallet);
 
-    // _pullAndPullToken
-    error ErrorTokenHandlerWalletsNotDistinct(address from, address to1, address to2);
-    error ErrorTokenHandlerPushAmountsTooLarge(Amount pushAmount, Amount pullAmount);
-
     // _checkPreconditions
     error ErrorTokenHandlerBalanceTooLow(address token, address from, uint256 balance, uint256 expectedBalance);
     error ErrorTokenHandlerAllowanceTooSmall(address token, address from, address spender, uint256 allowance, uint256 expectedAllowance);
@@ -75,6 +75,23 @@ contract TokenHandlerBase {
         }
 
         TOKEN = IERC20Metadata(token);
+
+        // self approval of token handler to max amount
+        _approve(TOKEN, AmountLib.max());
+    }
+
+
+    /// @dev Checks the balance and allowance for the from address and amount.
+    /// When requiring amount > 0 set checkAmount to true.
+    function checkBalanceAndAllowance(
+        address from,
+        Amount amount,
+        bool checkAmount
+    )
+        external
+        view
+    {
+        _checkBalanceAndAllowance(from, amount, checkAmount);
     }
 
 
@@ -159,33 +176,6 @@ contract TokenHandlerBase {
     }
 
 
-    function _pullAndPushToken(
-        address from, 
-        Amount pullAmount,
-        address to1,
-        Amount amount1,
-        address to2,
-        Amount amount2
-    )
-        internal
-    {
-        address wallet = getWallet();
-
-        if (wallet == to1 || wallet == to2 || to1 == to2) {
-            revert ErrorTokenHandlerWalletsNotDistinct(wallet, to1, to2);
-        }
-
-        if (amount1 + amount2 > pullAmount) {
-            revert ErrorTokenHandlerPushAmountsTooLarge(amount1 + amount2, pullAmount);
-        }
-
-        _pullToken(from, pullAmount);
-
-        if (amount1.gtz()) { _pushToken(to1, amount1); }
-        if (amount2.gtz()) { _pushToken(to2, amount2); }
-    }
-
-
     function _pullToken(address from, Amount amount)
         internal
     {
@@ -209,8 +199,8 @@ contract TokenHandlerBase {
         internal
     {
         if (checkPreconditions) {
-            // check amount > 0, balance >= amount and allowance >= amount
-            _checkPreconditions(from, amount);
+            bool checkAmount = true;
+            _checkBalanceAndAllowance(from, amount, checkAmount);
         }
 
         // transfer the tokens
@@ -224,15 +214,16 @@ contract TokenHandlerBase {
     }
 
 
-    function _checkPreconditions(
+    function _checkBalanceAndAllowance(
         address from,
-        Amount amount
+        Amount amount,
+        bool checkAmount
     ) 
         internal
         view
     {
         // amount must be greater than zero
-        if (amount.eqz()) {
+        if (checkAmount && amount.eqz()) {
             revert ErrorTokenHandlerAmountIsZero();
         }
 
@@ -251,9 +242,9 @@ contract TokenHandlerBase {
 }
 
 
-/// @dev Token specific transfer helper
-/// a default token contract is provided via contract constructor
-/// relies internally on oz SafeERC20.safeTransferFrom
+/// @dev Token specific transfer helper.
+/// Contract is derived from TokenHandlerBase and adds 
+/// authorization based on OpenZeppelin AccessManaged.
 contract TokenHandler is
     AccessManaged,
     TokenHandlerBase
@@ -262,9 +253,6 @@ contract TokenHandler is
     // onlyService
     error ErrorTokenHandlerNotService(address service);
 
-    // TODO delete
-    error ErrorTokenHandlerRecipientWalletsMustBeDistinct(address to, address to2, address to3);
-
     modifier onlyService() {
         if (!REGISTRY.isObjectType(msg.sender, SERVICE())) {
             revert ErrorTokenHandlerNotService(msg.sender);
@@ -282,14 +270,15 @@ contract TokenHandler is
         AccessManaged(authority)
     { }
 
-    /// @dev sets the wallet address for the component.
-    /// if the current wallet has tokens, these will be transferred.
-    /// if the new wallet address is externally owned, an approval from the 
+    /// @dev Sets the wallet address for the component.
+    /// Seeting the new wallet address to address(0) will set the wallet to the tokenHandler contract itself.
+    /// If the current wallet has tokens, these will be transferred.
+    /// If the new wallet address is externally owned, an approval from the 
     /// owner of the external wallet to the tokenhandler of the component that 
-    /// covers the current component balance must exist
+    /// covers the current component balance must exist.
     function setWallet(address newWallet)
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _setWallet(newWallet);
@@ -305,7 +294,7 @@ contract TokenHandler is
         Amount amount
     )
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _approve(token, amount);
@@ -313,69 +302,34 @@ contract TokenHandler is
 
     /// @dev Collect tokens from outside of GIF and transfer them to the wallet.
     /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function collectTokens(
+    function pullToken(
         address from,
         Amount amount
     )
         external
-        // restricted() // TODO re-activate
+        restricted()
         onlyService()
     {
         _pullToken(from, amount);
     }
 
 
-    /// @dev Collect tokens from outside of GIF and transfer them to the wallet.
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
+    /// @dev Distribute tokens from a wallet within the scope of gif to some address.
     function pushToken(
-        address from,
-        Amount amount
-    )
-        external
-        // restricted() // TODO re-activate
-        onlyService()
-    {
-        _pushToken(from, amount);
-    }
-
-
-    /// @dev collect tokens from outside of the gif and transfer them to three distinct wallets within the scope of gif
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function collectTokensToThreeRecipients( 
-        address from,
         address to,
-        Amount amount,
-        address to2,
-        Amount amount2,
-        address to3,
-        Amount amount3
+        Amount amount
     )
         external
         restricted()
         onlyService()
     {
-        if (to == to2 || to == to3 || to2 == to3) {
-            revert ErrorTokenHandlerRecipientWalletsMustBeDistinct(to, to2, to3);
-        }
-
-        _checkPreconditions(from, amount + amount2 + amount3);
-
-        if (amount.gtz()) {
-            _transfer(from, to, amount, false);
-        }
-        if (amount2.gtz()) {
-            _transfer(from, to2, amount2, false);
-        }
-        if (amount3.gtz()) {
-            _transfer(from, to3, amount3, false);
-        }
+        _pushToken(to, amount);
     }
 
 
-    /// @dev distribute tokens from a wallet within the scope of gif to an external address.
-    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
-    function distributeTokens(
-        address from,
+    /// @dev Distribute fee tokens from a wallet within the scope of gif to some address.
+    /// Separate push function for component service.
+    function pushFeeToken(
         address to,
         Amount amount
     )
@@ -383,7 +337,6 @@ contract TokenHandler is
         restricted()
         onlyService()
     {
-        // _transfer(from, to, amount, true);
         _pushToken(to, amount);
     }
 }