@etherisc/gif-next 0.0.2-7f39e38-904 → 0.0.2-804cdbf-724

package/contracts/registry/TokenRegistry.sol

@@ -5,12 +5,16 @@ import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManage
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
 
+import {REGISTRY} from "../type/ObjectType.sol";
+import {VersionPart} from "../type/Version.sol";
+
 import {IRegisterable} from "../shared/IRegisterable.sol";
+
 import {IRegistry} from "./IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
-import {ReleaseManager} from "./ReleaseManager.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
+import {ReleaseRegistry} from "./ReleaseRegistry.sol";
+import {RegistryAdmin} from "./RegistryAdmin.sol";
+
 
 /// @title contract to register token per GIF major release.
 contract TokenRegistry is
@@ -45,7 +49,7 @@ contract TokenRegistry is
     TokenInfo [] internal _token;
 
     IRegistry internal _registry;
-    ReleaseManager internal _releaseManager;
+    ReleaseRegistry internal _releaseRegistry;
     IERC20Metadata internal _dipToken;
 
     /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
@@ -56,16 +60,15 @@ contract TokenRegistry is
         _;
     }
 
-    constructor(
-        address initialAuthority,
-        address registry,
-        address dipToken
-    )
-        AccessManaged(initialAuthority)
-    { 
-        // set dip token
-        _registry = IRegistry(registry);
-        _dipToken = IERC20Metadata(dipToken);
+    constructor(IRegistry registry, IERC20Metadata dipToken)
+        AccessManaged(msg.sender)
+    {
+        // set authority
+        address authority = RegistryAdmin(registry.getRegistryAdminAddress()).authority();
+        setAuthority(authority);
+        
+        _registry = registry;
+        _dipToken = dipToken;
 
         // register dip token
         uint256 chainId = block.chainid;
@@ -76,52 +79,6 @@ contract TokenRegistry is
             _dipToken.symbol());
     }
 
-    // TODO cleanup
-    // function initialize(
-    //     address initialOwner
-    // )
-    //     public
-    //     initializer()
-    // {
-    //     initializeNftOwnable(initialOwner, _registryAddress);
-
-    //     // initialize release manager
-    //     _releaseManager = ReleaseManager(msg.sender);
-
-
-    //     // register dip token
-    //     uint256 chainId = block.chainid;
-    //     _registerToken(
-    //         chainId, 
-    //         address(_dipToken), 
-    //         _dipToken.decimals(), 
-    //         _dipToken.symbol());
-    // }
-
-
-    // /// @dev link token registry ownership to nft owner of registry service and register dip token.
-    // function linkToRegistryService() 
-    //     external
-    // {
-    //     // link token registry ownership to registry service
-    //     address registryService = getRegistry().getServiceAddress(
-    //             REGISTRY(), 
-    //             _releaseManager.getInitialVersion());
-
-    //     _linkToNftOwnable(registryService);
-
-    //     // activate dip for initial gif version
-    //     // as token registry is created in constructor of release manager
-    //     // release manager can not yet be called in constructor of token registry
-    //     uint256 chainId = block.chainid;
-    //     address dipToken = address(_dipToken);
-    //     VersionPart majorVersion = _releaseManager.getInitialVersion();
-    //     bool active = true;
-    //     _active[chainId][dipToken][majorVersion] = active;
-
-    //     emit LogTokenRegistryTokenStateSet(chainId, dipToken, majorVersion, active);
-    // }
-
 
     /// @dev register an onchain token.
     /// this function verifies that the provided token address is a contract that implements
@@ -220,7 +177,7 @@ contract TokenRegistry is
         // verify valid major version
         if(enforceVersionCheck) {
             uint256 version = majorVersion.toInt();
-            if (!getRegistry().isValidRelease(majorVersion)) {
+            if (!getRegistry().isActiveRelease(majorVersion)) {
                 revert ErrorTokenRegistryMajorVersionInvalid(majorVersion);
             }
         }
@@ -264,6 +221,10 @@ contract TokenRegistry is
         return _active[chainId][token][majorVersion];
     }
 
+    function getDipTokenAddress() external view returns (address) {
+        return address(_dipToken);
+    }
+
     //--- IRegistryLinked --------------------------------------------------//
 
     /// @dev returns the dip token for this chain

package/contracts/shared/Component.sol

@@ -6,21 +6,14 @@ 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 {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PRODUCT} from "../type/ObjectType.sol";
-import {VersionPart} from "../type/Version.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {Registerable} from "../shared/Registerable.sol";
-import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {IAccess} from "../instance/module/IAccess.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
-import {VersionPart} from "../type/Version.sol";
+import {VersionPartLib} from "../type/Version.sol";
 
 abstract contract Component is
     AccessManagedUpgradeable,
@@ -95,7 +88,7 @@ abstract contract Component is
     }
 
 
-    function approveTokenHandler(uint256 spendingLimitAmount)
+    function approveTokenHandler(Amount spendingLimitAmount)
         external
         virtual
         onlyOwner
@@ -103,7 +96,7 @@ abstract contract Component is
         approveTokenHandler(address(getToken()), spendingLimitAmount);
     }
 
-    function approveTokenHandler(address token, uint256 spendingLimitAmount)
+    function approveTokenHandler(address token, Amount spendingLimitAmount)
         public
         virtual
         onlyOwner
@@ -114,7 +107,7 @@ abstract contract Component is
 
         IERC20Metadata(token).approve(
             address(getTokenHandler()),
-            spendingLimitAmount);
+            spendingLimitAmount.toInt());
 
         emit LogComponentTokenHandlerApproved(address(getTokenHandler()), spendingLimitAmount);
     }
@@ -259,6 +252,7 @@ abstract contract Component is
 
     }
 
+
     /// @dev for component contracts that hold its own component information 
     /// this function creates and sets a token hanlder for the components tokens
     function _createAndSetTokenHandler()
@@ -268,6 +262,7 @@ abstract contract Component is
         $._tokenHandler = new TokenHandler(address($._token));
     }
 
+
     /// @dev depending on the source of the component information this function needs to be overwritten. 
     /// eg for instance linked components that externally store this information with the instance store contract
     function _getComponentInfo() internal virtual view returns (IComponents.ComponentInfo memory info) {

package/contracts/shared/ComponentService.sol

@@ -10,8 +10,8 @@ import {IRegistryService} from "../registry/IRegistryService.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IAccess} from "../instance/module/IAccess.sol";
 import {NftId} from "../type/NftId.sol";
-import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, POLICY_SERVICE_ROLE, PRODUCT_SERVICE_ROLE} from "../type/RoleId.sol";
+import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
@@ -64,11 +64,6 @@ contract ComponentService is
         registerInterface(type(IComponentService).interfaceId);
     }
 
-
-    function getDomain() public pure virtual override returns(ObjectType) {
-        return COMPONENT();
-    }
-
     //-------- component ----------------------------------------------------//
 
     function setWallet(address newWallet) external virtual {
@@ -107,12 +102,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](1);
-        bytes4[][] memory selectors = new bytes4[][](1);
-
-        // authorizaion for distribution owner
-        roles[0] = PRODUCT_OWNER_ROLE();
-        selectors[0] = _createSelectors(IProductComponent.setFees.selector);
 
         // register/create component setup
         (
@@ -122,9 +111,7 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             PRODUCT(),
-            PRODUCT_OWNER_ROLE(),
-            roles,
-            selectors);
+            PRODUCT_OWNER_ROLE());
 
         // create product info
         IComponents.ProductInfo memory productInfo = IProductComponent(contractAddress).getInitialProductInfo();
@@ -198,24 +185,12 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for distribution owner
-        roles[0] = DISTRIBUTION_OWNER_ROLE();
-        selectors[0] = _createSelectors(IDistributionComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = PRODUCT_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IDistributionComponent.processRenewal.selector);
 
         // register/create component info
         _register(
             contractAddress,
             DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE(),
-            roles,
-            selectors);
+            DISTRIBUTION_OWNER_ROLE());
     }
 
 
@@ -280,24 +255,32 @@ contract ComponentService is
         _changeTargetBalance(DECREASE, instanceStore, distributionNftId, amount, feeAmount);
     }
 
-    //-------- pool ---------------------------------------------------------//
+    //-------- oracle -------------------------------------------------------//
 
-    /// @dev registers the sending component as a distribution component
-    function registerPool()
+    function registerOracle()
         external
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
 
-        // authorizaion for distribution owner
-        roles[0] = POOL_OWNER_ROLE();
-        selectors[0] = _createSelectors(IPoolComponent.setFees.selector);
+        // register/create component setup
+        (
+            , // instance reader
+            InstanceStore instanceStore, 
+            NftId componentNftId
+        ) = _register(
+            contractAddress,
+            ORACLE(),
+            ORACLE_OWNER_ROLE());            
+    }
 
-        // authorizaion for product service
-        roles[1] = POLICY_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IPoolComponent.verifyApplication.selector);
+    //-------- pool ---------------------------------------------------------//
+
+    function registerPool()
+        external
+        virtual
+    {
+        address contractAddress = msg.sender;
 
         // register/create component setup
         (
@@ -307,14 +290,13 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             POOL(),
-            POOL_OWNER_ROLE(),
-            roles,
-            selectors);            
+            POOL_OWNER_ROLE());            
 
         // create info
         instanceStore.createPool(
             componentNftId, 
-            IPoolComponent(contractAddress).getInitialPoolInfo());
+            IPoolComponent(
+                contractAddress).getInitialPoolInfo());
     }
 
 
@@ -444,9 +426,7 @@ contract ComponentService is
     function _register(
         address componentAddress, // address of component to register
         ObjectType requiredType, // required type for component for registration
-        RoleId requiredRole, // role required for comonent owner for registration
-        RoleId[] memory roles, // roles with write access to component
-        bytes4[][] memory selectors // authorized functions per role with write access
+        RoleId requiredRole // role required for comonent owner for registration
     )
         internal
         virtual
@@ -473,21 +453,23 @@ contract ComponentService is
 
         component.linkToRegisteredNftId();
 
+        // setup initial component authorization
+        _instanceService.initializeAuthorization(
+            instance.getNftId(),
+            component);
+
         // save amended component info with instance
         instanceReader = instance.getInstanceReader();
         instanceStore = instance.getInstanceStore();
 
         IComponents.ComponentInfo memory componentInfo = component.getComponentInfo();
         componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
-        instanceStore.createComponent(component.getNftId(), componentInfo);
-
-        // configure instance authorization
-        _instanceService.createComponentTarget(
-            instance.getNftId(), 
-            componentAddress, 
-            component.getName(), 
-            selectors, 
-            roles);
+
+        instanceStore.createComponent(
+            component.getNftId(), 
+            componentInfo);
+
+        // TODO add logging
     }
 
 
@@ -526,7 +508,7 @@ contract ComponentService is
     }
 
 
-    function _createSelectors(bytes4 selector) internal view returns (bytes4[] memory selectors) {
+    function _createSelectors(bytes4 selector) internal pure returns (bytes4[] memory selectors) {
         selectors = new bytes4[](1);
         selectors[0] = selector;
     }
@@ -560,18 +542,13 @@ contract ComponentService is
         RoleId requiredRole
     )
         internal
-        // view
+        view
         returns (
             IInstance instance,
             IInstanceLinkedComponent component,
             address owner
         )
     {
-        // check component has not already been registered
-        if (getRegistry().getNftId(componentAddress).gtz()) {
-            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
-        }
-
         // check this is a component
         component = IInstanceLinkedComponent(componentAddress);
         if(!component.supportsInterface(type(IInstanceLinkedComponent).interfaceId)) {
@@ -584,12 +561,21 @@ contract ComponentService is
             revert ErrorComponentServiceInvalidType(componentAddress, requiredType, info.objectType);
         }
 
+        // check component has not already been registered
+        if (getRegistry().getNftId(componentAddress).gtz()) {
+            revert ErrorComponentServiceAlreadyRegistered(componentAddress);
+        }
+
         // check instance has assigned required role to inital owner
         instance = _getInstance(info.parentNftId);
         owner = info.initialOwner;
 
-        if(!instance.getInstanceAccessManager().hasRole(requiredRole, owner)) {
+        if(!instance.getInstanceAdmin().hasRole(owner, requiredRole)) {
             revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
         }
     }
+
+    function _getDomain() internal pure virtual override returns(ObjectType) {
+        return COMPONENT();
+    }
 }

package/contracts/shared/ComponentVerifyingService.sol

@@ -33,12 +33,10 @@ abstract contract ComponentVerifyingService is
         )
     {
         componentNftId = getRegistry().getNftId(msg.sender);
-        (componentInfo, instance) = _getAndVerifyComponentInfo(componentNftId, expectedType);
-
-        // ensure component is not locked
-        if (instance.getInstanceAccessManager().isTargetLocked(componentInfo.objectAddress)) {
-            revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-        }
+        (componentInfo, instance) = _getAndVerifyComponentInfo(
+            componentNftId, 
+            expectedType,
+            true); // only active
     }
 
 
@@ -48,7 +46,8 @@ abstract contract ComponentVerifyingService is
     /// - the component has the wrong object type
     function _getAndVerifyComponentInfo(
         NftId componentNftId,
-        ObjectType expectedType // assume always of `component` type
+        ObjectType expectedType, // assume always of `component` type
+        bool onlyActive
     )
         internal
         virtual
@@ -85,6 +84,13 @@ abstract contract ComponentVerifyingService is
         }
 
         instance = _getInstance(info.parentNftId);
+
+        // ensure component is not locked
+        if (onlyActive) {
+            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
+                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
+            }
+        }
     }
 
 

package/contracts/shared/IComponent.sol

@@ -4,14 +4,10 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IInstance} from "../instance/IInstance.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IProductService} from "../product/IProductService.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 /// @dev component base class
@@ -32,12 +28,12 @@ interface IComponent is
 
     event LogComponentWalletAddressChanged(address oldWallet, address newWallet);
     event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
-    event LogComponentTokenHandlerApproved(address token, uint256 limit);
+    event LogComponentTokenHandlerApproved(address token, Amount limit);
 
     /// @dev approves token hanlder to spend up to the specified amount of tokens
     /// reverts if component wallet is not component itself
     /// only component owner (nft holder) is authorizes to call this function
-    function approveTokenHandler(uint256 spendingLimitAmount) external;
+    function approveTokenHandler(Amount spendingLimitAmount) external;
 
     /// @dev sets the wallet address for the component
     /// if the current wallet has tokens, these will be transferred

package/contracts/shared/IComponentService.sol

@@ -52,6 +52,8 @@ interface IComponentService is
     function unlock() external;
 
     //-------- product ------------------------------------------------------//
+
+    /// @dev registers the sending component as a product component
     function registerProduct() external;
 
     function setProductFees(
@@ -63,6 +65,8 @@ interface IComponentService is
     function decreaseProductFees(InstanceStore instanceStore, NftId productNftId, Amount feeAmount) external;
 
     //-------- distribution -------------------------------------------------//
+
+    /// @dev registers the sending component as a distribution component
     function registerDistribution() external;
 
     function setDistributionFees(
@@ -73,7 +77,14 @@ interface IComponentService is
     function increaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
     function decreaseDistributionBalance(InstanceStore instanceStore, NftId distributionNftId, Amount amount, Amount feeAmount) external;
 
+    //-------- oracle -------------------------------------------------------//
+
+    /// @dev registers the sending component as an oracle component
+    function registerOracle() external;
+
     //-------- pool ---------------------------------------------------------//
+
+    /// @dev registers the sending component as a pool component
     function registerPool() external;
 
     function setPoolFees(

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -5,6 +5,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponent} from "../shared/IComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
@@ -43,4 +44,7 @@ interface IInstanceLinkedComponent is
     /// this is only relevant for pool and distribution components
     function getProductNftId() external view returns (NftId productNftId);
 
+    /// @dev returns the initial component authorization specification.
+    function getAuthorization() external view returns (IAuthorization authorization);
+
 }

package/contracts/shared/IKeyValueStore.sol

@@ -13,6 +13,7 @@ interface IKeyValueStore is ILifecycle {
 
     error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
     error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
+    error ErrorKeyValueStoreNoLifecycle(ObjectType objectType);
     error ErrorKeyValueStoreStateZero(Key32 key);
     error ErrorKeyValueStoreNotExisting(Key32 key);
 
@@ -32,7 +33,7 @@ interface IKeyValueStore is ILifecycle {
         // eg account outside gif objects that initiated the tx
         // implies the caller needs to be propagated through all calls up to key values store itself
         // to always have the instance address there doesn't seem to make sense
-        address updatedBy;
+        // address updatedBy;
         Blocknumber updatedIn;
         Blocknumber createdIn;
     }

package/contracts/shared/ILifecycle.sol

@@ -1,13 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {StateId} from "../type/StateId.sol";
 
 interface ILifecycle {
 
-    error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
+    error ErrorNoLifecycle(ObjectType objectType);
     error ErrorInvalidStateTransition(
         ObjectType objectType,
         StateId fromStateId,

package/contracts/shared/INftOwnable.sol

@@ -16,7 +16,7 @@ interface INftOwnable is
     error ErrorNftOwnableAlreadyLinked(NftId nftId);
     error ErrorNftOwnableContractNotRegistered(address contractAddress);
 
-    function linkToRegisteredNftId() external;
+    function linkToRegisteredNftId() external returns (NftId);
 
     function getNftId() external view returns (NftId);
     function getOwner() external view returns (address);

package/contracts/shared/IService.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
 
 interface IService is 
     IRegisterable,
@@ -14,5 +15,11 @@ interface IService is
 {
     error ErrorServiceNotImplemented();
 
+    /// @dev returns the domain for this service.
+    /// In any GIF release only one service for any given domain may be deployed.
     function getDomain() external pure returns(ObjectType serviceDomain);
+
+    /// @dev returns the GIF release specific role id.
+    /// These role ids are used to authorize service to service communication.
+    function getRoleId() external pure returns(RoleId serviceRoleId);
 }