@etherisc/gif-next 0.0.2-cc4a5cb-898 → 0.0.2-cdac553-411

package/contracts/instance/service/IComponentOwnerService.sol

@@ -5,13 +5,11 @@ import {NftId} from "../../types/NftId.sol";
 import {ObjectType} from "../../types/ObjectType.sol";
 import {RoleId} from "../../types/RoleId.sol";
 import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 // TODO rename to registry service
 interface IComponentOwnerService is IService {
 
-    function register(IBaseComponent component) external returns(NftId componentNftId);
-
     // TODO move to product/pool services
     function lock(IBaseComponent component) external;
 

package/contracts/instance/service/IDistributionService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 interface IDistributionService is IService {
     function setFees(

package/contracts/instance/service/IPoolService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../types/NftId.sol";
 import {Fee} from "../../types/Fee.sol";
-import {IService} from "../base/IService.sol";
+import {IService} from "../../shared/IService.sol";
 
 interface IPoolService is IService {
     function setFees(

package/contracts/instance/service/IProductService.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRisk} from "../module/risk/IRisk.sol";
-import {IService} from "../base/IService.sol";
+import {IRisk} from "../module/IRisk.sol";
+import {IService} from "../../shared/IService.sol";
 
 import {NftId} from "../../types/NftId.sol";
-import {ReferralId} from "../../types/ReferralId.sol";
+import {ReferralId} from "../../types/Referral.sol";
 import {RiskId} from "../../types/RiskId.sol";
 import {StateId} from "../../types/StateId.sol";
 import {Timestamp} from "../../types/Timestamp.sol";

package/contracts/instance/service/PoolService.sol

@@ -1,47 +1,91 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Pool} from "../../components/Pool.sol";
 import {IRegistry} from "../../registry/IRegistry.sol";
 import {IInstance} from "../../instance/IInstance.sol";
-import {IBundle} from "../../instance/module/bundle/IBundle.sol";
-import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
+import {IBundle} from "../../instance/module/IBundle.sol";
+import {TokenHandler} from "../../instance/module/ITreasury.sol";
+import {ISetup} from "../module/ISetup.sol";
 
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {Versionable} from "../../shared/Versionable.sol";
+import {INftOwnable} from "../../shared/INftOwnable.sol";
 
-import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
 import {POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {Fee} from "../../types/Fee.sol";
+import {POOL_OWNER_ROLE} from "../../types/RoleId.sol";
+import {Fee, FeeLib} from "../../types/Fee.sol";
 import {Version, VersionLib} from "../../types/Version.sol";
+import {KEEP_STATE} from "../../types/StateId.sol";
+import {zeroTimestamp} from "../../types/Timestamp.sol";
 
+import {IService} from "../../shared/IService.sol";
+import {Service} from "../../shared/Service.sol";
 import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
 import {IPoolService} from "./IPoolService.sol";
+import {IRegistryService} from "../../registry/IRegistryService.sol";
+import {InstanceService} from "../InstanceService.sol";
+import {InstanceReader} from "../InstanceReader.sol";
 
 
-contract PoolService is ComponentServiceBase, IPoolService {
+string constant POOL_SERVICE_NAME = "PoolService";
+
+contract PoolService is 
+    ComponentServiceBase, 
+    IPoolService 
+{
     using NftIdLib for NftId;
 
     string public constant NAME = "PoolService";
 
-    constructor(
-        address registry,
-        NftId registryNftId
-    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+    address internal _registryAddress;
+    InstanceService internal _instanceService;
+
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        initializer
+        virtual override
     {
+        address initialOwner = address(0);
+        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
+
+        IRegistry registry = IRegistry(_registryAddress);
+        _instanceService = InstanceService(registry.getServiceAddress("InstanceService", getMajorVersion()));
+
+        _initializeService(_registryAddress, initialOwner);
+
+        _registerInterface(type(IService).interfaceId);
         _registerInterface(type(IPoolService).interfaceId);
     }
 
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
+    function getName() public pure override(Service, IService) returns(string memory name) {
+        return NAME;
     }
 
-    function getName() external pure override returns(string memory name) {
-        return NAME;
+    function register(address poolComponentAddress) 
+        external 
+        returns (NftId poolNftId)
+    {
+        address componentOwner = msg.sender;
+        Pool pool = Pool(poolComponentAddress);
+        IInstance instance = pool.getInstance();
+        INftOwnable nftOwnable = INftOwnable(address(instance));
+        
+        require(_instanceService.hasRole(componentOwner, POOL_OWNER_ROLE(), nftOwnable.getNftId()), "ERROR:POS-001:NOT_POOL_OWNER_ROLE");
+        
+        IRegistryService registryService = getRegistryService();
+        (IRegistry.ObjectInfo memory poolObjInfo, ) = registryService.registerPool(
+            pool,
+            componentOwner
+        );
+        poolNftId = poolObjInfo.nftId;
+
+        ISetup.PoolSetupInfo memory initialSetup = pool.getInitialSetupInfo();
+        instance.createPoolSetup(poolNftId, initialSetup);
     }
 
     function setFees(
@@ -53,13 +97,15 @@ contract PoolService is ComponentServiceBase, IPoolService {
         override
     {
         (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-
-        NftId productNftId = instance.getProductNftId(poolInfo.nftId);
-        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
-        treasuryInfo.poolFee = poolFee;
-        treasuryInfo.stakingFee = stakingFee;
-        treasuryInfo.performanceFee = performanceFee;
-        instance.setTreasuryInfo(productNftId, treasuryInfo);
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId poolNftId = poolInfo.nftId;
+
+        ISetup.PoolSetupInfo memory poolSetupInfo = instanceReader.getPoolSetupInfo(poolNftId);
+        poolSetupInfo.poolFee = poolFee;
+        poolSetupInfo.stakingFee = stakingFee;
+        poolSetupInfo.performanceFee = performanceFee;
+        
+        instance.updatePoolSetup(poolNftId, poolSetupInfo, KEEP_STATE());
     }
 
     function createBundle(
@@ -74,33 +120,43 @@ contract PoolService is ComponentServiceBase, IPoolService {
         returns(NftId bundleNftId)
     {
         (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-
-        // register bundle with registry
+        InstanceReader instanceReader = instance.getInstanceReader();
         NftId poolNftId = info.nftId;
-        bundleNftId = _registry.registerObjectForInstance(
-            poolNftId, 
-            BUNDLE(), 
-            owner,
-            "");
 
-        // create bundle info in instance
-        instance.createBundleInfo(
-            bundleNftId,
+        IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
             poolNftId,
-            fee,
+            FeeLib.zeroFee(),
+            filter,
+            stakingAmount,
+            0,
             stakingAmount,
             lifetime,
-            filter);
+            zeroTimestamp(),
+            zeroTimestamp()
+        );
 
-        // add bundle to pool in instance
-        instance.addBundleToPool(
-            bundleNftId,
-            poolNftId,
-            stakingAmount);
+        // register bundle with registry
+        bundleNftId = getRegistryService().registerBundle(
+            IRegistry.ObjectInfo(
+                zeroNftId(), 
+                poolNftId,
+                BUNDLE(),
+                false, // intercepting property for bundles is defined on pool
+                address(0),
+                owner,
+                abi.encode(bundleInfo)
+            )
+        );
+
+        // create bundle info in instance
+        instance.createBundle(bundleNftId, bundleInfo);
 
+        // TODO add bundle to pool in instance
+        
         // collect capital
         _processStakingByTreasury(
-            instance,
+            instanceReader,
+            zeroNftId(),
             poolNftId,
             bundleNftId,
             stakingAmount);
@@ -115,17 +171,24 @@ contract PoolService is ComponentServiceBase, IPoolService {
         external
         override
     {
-        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        IBundle.BundleInfo memory bundleInfo = instance.getBundleInfo(bundleNftId);
+        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+        InstanceReader instanceReader = instance.getInstanceReader();
+        NftId poolNftId = info.nftId;
+
+        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
         require(bundleInfo.poolNftId.gtz(), "ERROR:PLS-010:BUNDLE_UNKNOWN");
-        require(poolInfo.nftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
+        require(poolNftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
+
         bundleInfo.fee = fee;
-        instance.setBundleInfo(bundleNftId, bundleInfo);
+
+        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
     }
 
 
+
     function _processStakingByTreasury(
-        IInstance instance,
+        InstanceReader instanceReader,
+        NftId productNftId,
         NftId poolNftId,
         NftId bundleNftId,
         uint256 stakingAmount
@@ -134,14 +197,13 @@ contract PoolService is ComponentServiceBase, IPoolService {
     {
         // process token transfer(s)
         if(stakingAmount > 0) {
-            NftId productNftId = instance.getProductNftId(poolNftId);
-            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
-            address bundleOwner = _registry.getOwner(bundleNftId);
-            address poolWallet = instance.getComponentWallet(poolNftId);
-
+            TokenHandler tokenHandler = TokenHandler(instanceReader.getTokenHandler(productNftId));
+            address bundleOwner = getRegistry().ownerOf(bundleNftId);
+            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
+            
             tokenHandler.transfer(
                 bundleOwner,
-                poolWallet,
+                poolInfo.wallet,
                 stakingAmount
             );
         }

package/contracts/instance/service/PoolServiceManager.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {ProxyManager} from "../../shared/ProxyManager.sol";
+import {PoolService} from "./PoolService.sol";
+import {Registry} from "../../registry/Registry.sol";
+import {RegistryService} from "../../registry/RegistryService.sol";
+import {VersionLib} from "../../types/Version.sol";
+
+contract PoolServiceManager is ProxyManager {
+
+    PoolService private _poolService;
+
+    /// @dev initializes proxy manager with pool service implementation 
+    constructor(
+        address registryAddress
+    )
+        ProxyManager()
+    {
+        PoolService poolSrv = new PoolService();
+        bytes memory data = abi.encode(registryAddress, address(this));
+        IVersionable versionable = deploy(
+            address(poolSrv), 
+            data);
+
+        _poolService = PoolService(address(versionable));
+
+        Registry registry = Registry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
+        RegistryService registryService = RegistryService(registryServiceAddress);
+        
+        registryService.registerService(_poolService);
+        
+        // link ownership of instance service manager ot nft owner of instance service
+        _linkToNftOwnable(
+            address(registryAddress),
+            address(_poolService));
+
+        // implies that after this constructor call only upgrade functionality is available
+        _isDeployed = true;
+    }
+
+    //--- view functions ----------------------------------------------------//
+    function getPoolService()
+        external
+        view
+        returns (PoolService poolService)
+    {
+        return _poolService;
+    }
+
+}

package/contracts/registry/ChainNft.sol

@@ -1,16 +1,31 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {ERC721, ERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
-import {IChainNft} from "./IChainNft.sol";
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
-contract ChainNft is ERC721Enumerable, IChainNft {
-    string public constant NAME = "Dezentralized Insurance Protocol Registry";
-    string public constant SYMBOL = "DIPR";
+import {ITransferInterceptor} from "./ITransferInterceptor.sol";
+
+contract ChainNft is ERC721Enumerable {
+
+    // constants
+    string public constant NAME = "Dezentralized Insurance Protocol NFT";
+    string public constant SYMBOL = "DIPNFT";
 
     uint256 public constant PROTOCOL_NFT_ID = 1101;
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
+    // custom errors
+    error CallerNotRegistry(address caller);
+    error RegistryAddressZero();
+    error NftUriEmpty();
+    error NftUriAlreadySet();
+
+    // contract state
+
+    // remember interceptors
+    mapping(uint256 tokenId => address interceptor) private _interceptor;
+
     // remember token uri
     mapping(uint256 tokenId => string uri) private _uri;
 
@@ -25,50 +40,79 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        require(msg.sender == _registry, "ERROR:NFT-001:CALLER_NOT_REGISTRY");
+        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
         _;
     }
 
     constructor(address registry) ERC721(NAME, SYMBOL) {
-        require(registry != address(0), "ERROR:NFT-010:REGISTRY_ZERO");
+        if (registry == address(0)) { revert RegistryAddressZero(); }
 
         _registry = registry;
-
         _chainIdInt = block.chainid;
-        _chainIdDigits = _countDigits(_chainIdInt);
+        _chainIdDigits = 0;
+
+        // count digis
+        uint256 num = _chainIdInt;
+        while (num != 0) {
+            _chainIdDigits++;
+            num /= 10;
+        }
+
         _chainIdMultiplier = 10 ** _chainIdDigits;
-        _idNext = 3;
+        _idNext = 4;
     }
 
+    /**
+    * @dev mints a token for a specified token id
+    * not part of the IRegistry interface only needed for
+    * initial registry setup (protocol and global registry objects)
+    */
+    function mint(address to, uint256 tokenId) external onlyRegistry {
+        _totalMinted++;
+        _safeMint(to, tokenId);
+    }
+
+
     /**
     * @dev mints the next token to register new objects
+    * non-zero transferInterceptors are recorded and called during nft token transfers.
+    * the contract receiving such a notification may decides to revert or record the transfer
     */
     function mint(
         address to,
+        address interceptor,
         string memory uri
-    ) external override onlyRegistry returns (uint256 tokenId) {
+    ) public onlyRegistry returns (uint256 tokenId) {
         tokenId = _getNextTokenId();
 
+        if (interceptor != address(0)) {
+            _interceptor[tokenId] = interceptor;
+        }
+
         if (bytes(uri).length > 0) {
             _uri[tokenId] = uri;
         }
 
-        _safeMint(to, tokenId);
         _totalMinted++;
+        _safeMint(to, tokenId);
     }
 
+
     /**
-    * @dev mints a token for a specified token id
-    * not part of the IRegistry interface only needed for
-    * initial registry setup (protocol and global registry objects)
-    */
-    function mint(address to, uint256 tokenId) external onlyRegistry {
-        _totalMinted++;
-        _safeMint(to, tokenId);
+     * @dev amend the open zeppelin transferFrom function by an interceptor call if such an interceptor is defined for the nft token id
+     * this allows distribution, product and pool components to be notified when distributors, policies and bundles are transferred.
+     */
+    function transferFrom(address from, address to, uint256 tokenId) public override (ERC721, IERC721) {
+        super.transferFrom(from, to, tokenId);
+
+        if (_interceptor[tokenId] != address(0)) {
+            ITransferInterceptor(_interceptor[tokenId]).nftTransferFrom(from, to, tokenId);
+        }
     }
 
-    function burn(uint256 tokenId) external override onlyRegistry {
-        _requireMinted(tokenId);
+
+    function burn(uint256 tokenId) external onlyRegistry {
+        _requireOwned(tokenId);
         _burn(tokenId);
         delete _uri[tokenId];
     }
@@ -76,29 +120,36 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     function setURI(
         uint256 tokenId,
         string memory uri
-    ) external override onlyRegistry {
-        require(bytes(uri).length > 0, "ERROR:CRG-011:URI_EMPTY");
+    ) external onlyRegistry {
+        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
 
-        _requireMinted(tokenId);
+        _requireOwned(tokenId);
         _uri[tokenId] = uri;
     }
 
-    function exists(uint256 tokenId) external view override returns (bool) {
-        return _exists(tokenId);
+    function exists(uint256 tokenId) external view returns (bool) {
+        return _ownerOf(tokenId) != address(0);
     }
 
     function tokenURI(
         uint256 tokenId
     ) public view override returns (string memory) {
-        _requireMinted(tokenId);
+        // gif generally does not revert for view functions
+        // this is an exception to keep the openzeppelin nft semantics
+        _requireOwned(tokenId);
         return _uri[tokenId];
     }
 
-    function getRegistryAddress() external view override returns (address) {
+    function getInterceptor(uint256 tokenId) external view returns (address) {
+        return _interceptor[tokenId];
+    }
+
+    function getRegistryAddress() external view returns (address) {
         return _registry;
     }
 
-    function totalMinted() external view override returns (uint256) {
+    function totalMinted() external view returns (uint256) {
         return _totalMinted;
     }
 
@@ -148,12 +199,4 @@ contract ChainNft is ERC721Enumerable, IChainNft {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
-
-    function _countDigits(uint256 num) private pure returns (uint256 count) {
-        count = 0;
-        while (num != 0) {
-            count++;
-            num /= 10;
-        }
-    }
 }

package/contracts/registry/IRegistry.sol

@@ -1,57 +1,94 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {ChainNft} from "./ChainNft.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 import {VersionPart} from "../types/Version.sol";
-import {IChainNft} from "./IChainNft.sol";
 
 interface IRegistry is IERC165 {
+
+    event LogInitialMajorVersionSet(VersionPart majorVersion);
+    event LogMajorVersionSet(VersionPart majorVersionMax);
+    event LogRegistration(ObjectInfo info);
+    event LogTokenStateSet(address token, VersionPart majorVersion, bool active);
+    event LogServiceNameRegistration(string serviceName, VersionPart majorVersion); 
+
+    // supported versions
+    error MajorVersionMaxIncreaseInvalid(VersionPart newMajorVersionMax, VersionPart existingMaxMajorVersion);
+
+    // token whitelisting
+    error TokenNotRegistered(address token);
+    error NotToken(address token);
+    error TokenMajorVersionInvalid(VersionPart majorVersion);
+
+    // register
+    error NotRegistryService();
+    error ZeroParentAddress();
+    error ContractAlreadyRegistered(address objectAddress);
+    error InvalidServiceVersion(VersionPart majorVersion);
+    error ServiceNameAlreadyRegistered(string name, VersionPart majorVersion);
+            
+    // approve
+    error NotOwner(address account);
+    error NotRegisteredContract(NftId registrarNftId);
+    error NotService(NftId registrarNftId);
+    error InvalidTypesCombination(ObjectType objectType, ObjectType parentType);
+
+
     struct ObjectInfo {
         NftId nftId;
         NftId parentNftId;
         ObjectType objectType;
+        bool isInterceptor;
         address objectAddress;
         address initialOwner;
         bytes data;
-    }
+    }// TODO delete nftId and initialOwner(if not used) from struct
+    // TODO strong disagree, keep nftId there (lets keep get object info return object consistent)
+
+    function setMajorVersion(VersionPart newMajorVersionMax) external;
+
+    function register(ObjectInfo memory info) external returns (NftId nftId);
 
-    function register(address objectAddress) external returns (NftId nftId);
+    function setTokenActive(address token, VersionPart majorVersion, bool active) external;
 
-    function registerObjectForInstance(
-        NftId parentNftid,
-        ObjectType objectType,
-        address initialOwner,
-        bytes memory data
-    ) external returns (NftId nftId);
+    function getMajorVersionMin() external view returns (VersionPart);
 
-    function getServiceAddress(string memory serviceName, VersionPart majorVersion) external view returns (address serviceAddress);
+    function getMajorVersionMax() external view returns (VersionPart);
+
+    function getMajorVersion() external view returns (VersionPart);
 
     function getObjectCount() external view returns (uint256);
 
     function getNftId() external view returns (NftId nftId);
 
-    function getNftId(
-        address objectAddress
-    ) external view returns (NftId nftId);
+    function getNftId(address objectAddress) external view returns (NftId nftId);
 
-    function getObjectInfo(
-        NftId nftId
-    ) external view returns (ObjectInfo memory info);
+    function ownerOf(NftId nftId) external view returns (address);
 
-    function getName(
-        NftId nftId
-    ) external view returns (string memory name);
+    function ownerOf(address contractAddress) external view returns (address);
 
-    function getProtocolOwner() external view returns (address);
+    function getObjectInfo(NftId nftId) external view returns (ObjectInfo memory info);
 
-    function getOwner(NftId nftId) external view returns (address ownerAddress);
+    function getObjectInfo(address object) external view returns (ObjectInfo memory info);
 
     function isRegistered(NftId nftId) external view returns (bool);
 
-    function isRegistered(address objectAddress) external view returns (bool);
+    function isRegistered(address contractAddress) external view returns (bool);
+
+    function isTokenActive(address token, VersionPart majorVersion) external view returns (bool);
+
+    function getServiceName(NftId nftId) external view returns (string memory name);
+
+    function getServiceAddress(
+        string memory serviceName, 
+        VersionPart majorVersion
+    ) external view returns (address serviceAddress);
+
+    function getChainNft() external view returns (ChainNft);
 
-    function getChainNft() external view returns (IChainNft);
-}
+    function getOwner() external view returns (address);
+}