@etherisc/gif-next 0.0.2-9dd41ff-671 → 0.0.2-9ed3c41-176

package/contracts/product/ProductService.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IProductComponent} from "./IProductComponent.sol";
 import {Product} from "./Product.sol";
-import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
@@ -12,8 +12,7 @@ import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IProductService} from "./IProductService.sol";
-import {ITreasury} from "../instance/module/ITreasury.sol";
-import {ISetup} from "../instance/module/ISetup.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
@@ -23,9 +22,9 @@ import {Versionable} from "../shared/Versionable.sol";
 import {Timestamp, zeroTimestamp} from "../type/Timestamp.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
-import {ObjectType, PRODUCT, POOL, POLICY} from "../type/ObjectType.sol";
+import {ObjectType, INSTANCE, PRODUCT, POOL, POLICY, REGISTRY} from "../type/ObjectType.sol";
 import {APPLIED, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../type/NftId.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {RiskId} from "../type/RiskId.sol";
@@ -35,16 +34,20 @@ import {RoleId, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 
 import {IService} from "../shared/IService.sol";
 import {Service} from "../shared/Service.sol";
-import {ComponentService} from "../shared/ComponentService.sol";
+import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IProductService} from "./IProductService.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IPoolService} from "../pool/PoolService.sol";
 
-// TODO or name this ProtectionService to have Product be something more generic (loan, savings account, ...)
-contract ProductService is ComponentService, IProductService {
-    using NftIdLib for NftId;
-
+contract ProductService is
+    ComponentVerifyingService,
+    IProductService 
+{
+    IInstanceService private _instanceService;
     IPoolService internal _poolService;
+    IRegistryService private _registryService;
 
     event LogProductServiceSender(address sender);
 
@@ -64,112 +67,14 @@ contract ProductService is ComponentService, IProductService {
 
         initializeService(registryAddress, authority, owner);
 
+        _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
+        _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
         registerInterface(type(IProductService).interfaceId);
     }
 
 
-    function register(address productAddress) 
-        external
-        returns(NftId productNftId)
-    {
-        (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        ) = _checkComponentForRegistration(
-            productAddress,
-            PRODUCT(),
-            PRODUCT_OWNER_ROLE());
-
-        IProductComponent product = IProductComponent(productAddress);
-        IRegistry.ObjectInfo memory productInfo = getRegistryService().registerProduct(product, owner);
-        productNftId = productInfo.nftId;
-        _createProductSetup(
-            instance, 
-            product, 
-            productNftId);
-    }
-
-
-    function _createProductSetup(
-        IInstance instance, 
-        IProductComponent product, 
-        NftId productNftId 
-    )
-        internal
-        returns (string memory name)
-    {
-        // wire distribution and pool components to product component
-        ISetup.ProductSetupInfo memory setup = product.getSetupInfo();
-        IComponent distribution = IComponent(getRegistry().getObjectInfo(setup.distributionNftId).objectAddress);
-        IComponent pool = IComponent(getRegistry().getObjectInfo(setup.poolNftId).objectAddress);
-
-        distribution.setProductNftId(productNftId);
-        pool.setProductNftId(productNftId);
-        product.setProductNftId(productNftId);
-        product.linkToRegisteredNftId();
-
-        // create product setup in instance
-        instance.getInstanceStore().createProductSetup(productNftId, product.getSetupInfo());
-
-        bytes4[][] memory selectors = new bytes4[][](1);
-        selectors[0] = new bytes4[](1);
-        selectors[0][0] = IProductComponent.setFees.selector;
-
-        RoleId[] memory roles = new RoleId[](1);
-        roles[0] = PRODUCT_OWNER_ROLE();
-
-        // create target for instane access manager
-        getInstanceService().createGifTarget(
-            getRegistry().getNftId(address(instance)), 
-            address(product), 
-            product.getName(),
-            selectors,
-            roles);
-    }
-
-    function getDomain() public pure override returns(ObjectType) {
-        return PRODUCT();
-    }
-
-
-    function _decodeAndVerifyProductData(bytes memory data) 
-        internal 
-        returns(string memory name, ISetup.ProductSetupInfo memory setup)
-    {
-        (name, setup) = abi.decode(
-            data,
-            (string, ISetup.ProductSetupInfo)
-        );
-
-        // TODO add checks
-        // if(wallet == address(0)) {
-        //     revert WalletIsZero();
-        // }
-    }
-
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    )
-        external
-    {
-        // TODO check args 
-
-        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
-        ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(productNftId);
-
-        productSetupInfo.productFee = productFee;
-        productSetupInfo.processingFee = processingFee;
-        
-        instance.getInstanceStore().updateProductSetup(productNftId, productSetupInfo, KEEP_STATE());
-    }
-
     function createRisk(
         RiskId riskId,
         bytes memory data
@@ -177,7 +82,7 @@ contract ProductService is ComponentService, IProductService {
         external 
         override
     {
-        (NftId productNftId,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
+        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         IRisk.RiskInfo memory riskInfo = IRisk.RiskInfo(productNftId, data);
 
         instance.getInstanceStore().createRisk(
@@ -186,13 +91,14 @@ contract ProductService is ComponentService, IProductService {
         );
     }
 
+
     function updateRisk(
         RiskId riskId,
         bytes memory data
     )
         external
     {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
 
         IRisk.RiskInfo memory riskInfo = instanceReader.getRiskInfo(riskId);
@@ -200,13 +106,19 @@ contract ProductService is ComponentService, IProductService {
         instance.getInstanceStore().updateRisk(riskId, riskInfo, KEEP_STATE());
     }
 
+
     function updateRiskState(
         RiskId riskId,
         StateId state
     )
         external
     {
-        (,, IInstance instance) = _getAndVerifyCallingComponentAndInstance(PRODUCT());
+        (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         instance.getInstanceStore().updateRiskState(riskId, state);
     }
+
+
+    function _getDomain() internal pure override returns(ObjectType) {
+        return PRODUCT();
+    }
 }

package/contracts/registry/ChainNft.sol

@@ -15,6 +15,7 @@ contract ChainNft is ERC721Enumerable {
     uint256 public constant PROTOCOL_NFT_ID = 1101;
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
+    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
     // custom errors
     error CallerNotRegistry(address caller);
     error RegistryAddressZero();
@@ -59,7 +60,13 @@ contract ChainNft is ERC721Enumerable {
         }
 
         _chainIdMultiplier = 10 ** _chainIdDigits;
-        _idNext = 3;
+
+        // the first object registered through normal registration starts with id 4
+        // 1 -> protocol
+        // 2 -> registry
+        // 3 -> staking
+        // >= 4 -> all other objects
+        _idNext = 4;
     }
 
     /**

package/contracts/registry/IRegistry.sol

@@ -7,21 +7,29 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {RoleId} from "../type/RoleId.sol";
 
+/// @title Chain Registry interface.
+/// A chain registry holds all protocol relevant objects with basic metadata.
+/// Registered objects include services, instances, products, pools, policies, bundles, stakes and more.
+/// Registered objects are represented by NFTs.
 interface IRegistry is IERC165 {
 
     event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
     event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
 
+    // register()
+    error ErrorRegistryCallerNotRegistryService();
+    error ErrorRegistryService(address service);
+
     // registerService()
-    error ErrorRegistryCallerNotReleaseManager();
+    error ErrorRegistryCallerNotReleaseRegistry();
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(); 
+    error ErrorRegistryNotService(address service, ObjectType objectType);
+    error ErrorRegistryServiceParentNotRegistry(NftId parentNftId);
     error ErrorRegistryDomainZero(address service);
     error ErrorRegistryDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
 
-    // register()
-    error ErrorRegistryCallerNotRegistryService();
-
     // registerWithCustomTypes()
     error ErrorRegistryCoreTypeRegistration();
 
@@ -40,29 +48,34 @@ interface IRegistry is IERC165 {
         bytes data;
     }
 
-
     struct ReleaseInfo {
         VersionPart version;
+        bytes32 salt;
         address[] addresses;
         string[] names;
-        RoleId[][] serviceRoles;
-        string[][] serviceRoleNames;
-        RoleId[][] functionRoles;
-        string[][] functionRoleNames;
-        bytes4[][][] selectors;
         ObjectType[] domains;
         Timestamp activatedAt;
         Timestamp disabledAt;
     }
 
+    /// @dev Register an object with a known core type.
+    /// The function returns a newly minted object NFT ID.
+    /// May not be used to register services.
+    function register(ObjectInfo memory info) external returns (NftId nftId);
+
+    /// @dev Register a service with using the provided domain and version.
+    /// The function returns a newly minted service NFT ID.
+    /// May only be used to register services.
     function registerService(
         ObjectInfo memory serviceInfo, 
         VersionPart serviceVersion, 
         ObjectType serviceDomain
     ) external returns(NftId nftId);
 
-    function register(ObjectInfo memory info) external returns (NftId nftId);
-
+    /// @dev Register an object with a custom type.
+    /// The function returns a newly minted object NFT ID.
+    /// This function is reserved for GIF releases > 3.
+    /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
     function getInitialVersion() external view returns (VersionPart);
@@ -75,8 +88,6 @@ interface IRegistry is IERC165 {
 
     function getObjectCount() external view returns (uint256);
 
-    function getNftId() external view returns (NftId nftId);
-
     function getNftId(address objectAddress) external view returns (NftId nftId);
 
     function ownerOf(NftId nftId) external view returns (address);
@@ -102,11 +113,22 @@ interface IRegistry is IERC165 {
         VersionPart releaseVersion
     ) external view returns (address serviceAddress);
 
-    function getReleaseManagerAddress() external view returns (address);
+    function getProtocolNftId() external view returns (NftId protocolNftId);
 
-    function getReleaseAccessManagerAddress(VersionPart version) external view returns (address);
+    function getNftId() external view returns (NftId nftId);
+
+    function getOwner() external view returns (address);
 
+    // TODO refactor the address getters below to contract getters
     function getChainNftAddress() external view returns (address);
 
-    function getOwner() external view returns (address);
+    function getReleaseRegistryAddress() external view returns (address);
+
+    function getStakingAddress() external view returns (address);
+
+    function getTokenRegistryAddress() external view returns (address);
+
+    function getRegistryAdminAddress() external view returns (address);
+
+    function getAuthority() external view returns (address);
 }

package/contracts/registry/IRegistryService.sol

@@ -11,6 +11,8 @@ import {IRegistry} from "./IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {IComponent} from "../shared/IComponent.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+
 
 interface IRegistryService is 
      IService
@@ -19,6 +21,7 @@ interface IRegistryService is
 
      error ErrorRegistryServiceNotService(address notService);
      error ErrorRegistryServiceNotInstance(address notInstance);
+     error ErrorRegistryServiceNotComponent(address notComponent);
      error ErrorRegistryServiceNotProduct(address notProduct);
      error ErrorRegistryServiceNotPool(address notPool);
      error ErrorRegistryServiceNotDistribution(address notDistribution);
@@ -38,22 +41,29 @@ interface IRegistryService is
      error ErrorRegistryServiceInvalidInitialOwner(address initialOwner);
      error ErrorRegistryServiceInvalidAddress(address registerableAddress);
 
+     function registerStake(IRegistry.ObjectInfo memory info)
+          external returns(NftId nftId); 
+
      function registerInstance(IRegisterable instance, address owner)
           external returns(IRegistry.ObjectInfo memory info); 
 
-     function registerProduct(IComponent product, address owner)
+     function registerComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerProduct(IComponent product, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerDistribution(IComponent distribution, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerPool(IComponent pool, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
+
+     // function registerDistribution(IComponent distribution, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
      function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerPolicy(IRegistry.ObjectInfo memory info) external returns(NftId nftId);
 
      function registerBundle(IRegistry.ObjectInfo memory info) external returns(NftId nftId); 
+
 }