@etherisc/gif-next 0.0.2-de0a1d3-009 → 0.0.2-e1e92ab-754

package/contracts/instance/base/IInstanceBase.sol

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Key32} from "../../types/Key32.sol";
 import {StateId} from "../../types/StateId.sol";
 
 import {IKeyValueStore} from "./IKeyValueStore.sol";
+
 import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
 import {IDistributionService} from "../service/IDistributionService.sol";
 import {IProductService} from "../service/IProductService.sol";
@@ -15,7 +16,7 @@ interface IInstanceBase {
     function updateState(Key32 key, StateId state) external;
     function getState(Key32 key) external view returns (StateId state);
 
-    function getComponentOwnerService() external view returns(IComponentOwnerService service);
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
     function getDistributionService() external view returns(IDistributionService);
     function getProductService() external view returns(IProductService service);
     function getPoolService() external view returns(IPoolService service);

package/contracts/instance/base/InstanceBase.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {Versionable} from "../../shared/Versionable.sol";
 import {Registerable} from "../../shared/Registerable.sol";
@@ -35,11 +35,13 @@ abstract contract InstanceBase is
 
     constructor(
         address registry,
-        NftId registryNftId
+        NftId registryNftId,
+        address initialOwner
     )
-        Registerable(registry, registryNftId)
         Versionable()
     {
+        bytes memory data = "";
+        _initializeRegisterable(registry, registryNftId, INSTANCE(), true, initialOwner, data);
         _keyValueStore = new KeyValueStore();
 
         _registerInterface(type(IInstance).interfaceId);
@@ -67,10 +69,6 @@ abstract contract InstanceBase is
     }
 
     // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
-
 
     // internal / private functions
     function _linkToServicesInRegistry() internal {
@@ -82,7 +80,7 @@ abstract contract InstanceBase is
     }
 
     function _getAndCheck(string memory serviceName, VersionPart majorVersion) internal view returns (address serviceAddress) {
-        serviceAddress = _registry.getServiceAddress(serviceName, majorVersion);
+        serviceAddress = getRegistry().getServiceAddress(serviceName, majorVersion);
         require(
             serviceAddress != address(0),
             "ERROR:INS-001:NOT_REGISTERED"

package/contracts/instance/base/ServiceBase.sol

@@ -3,9 +3,10 @@ pragma solidity ^0.8.19;
 
 import {NftId, zeroNftId} from "../../types/NftId.sol";
 import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
-import {Version, VersionPart} from "../../types/Version.sol";
+import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
 
 import {Registerable} from "../../shared/Registerable.sol";
+import {IRegistry} from "../../registry/IRegistry.sol";
 import {IVersionable} from "../../shared/IVersionable.sol";
 import {Versionable} from "../../shared/Versionable.sol";
 
@@ -16,22 +17,28 @@ abstract contract ServiceBase is
     Versionable,
     IService
 {
+    function getName() public pure virtual override returns(string memory name);
 
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _registerInterface(type(IService).interfaceId);
+    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
+        return getVersion().toMajorPart(); 
     }
 
-    function getMajorVersion() external view override returns(VersionPart majorVersion) {
-        return this.getVersion().toMajorPart();
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(3,0,0);
     }
 
-    function getType() external pure override returns (ObjectType) {
-        return SERVICE();
+    function _initializeServiceBase(address registry, NftId registryNftId, address initialOwner)
+        internal 
+        //onlyInitializing //TODO uncomment when "fully" upgradeable
+    {// service must provide its name and version upon registration
+        bytes memory data = abi.encode(getName(), getMajorVersion());
+        _initializeRegisterable(registry, registryNftId, SERVICE(), false, initialOwner, data);
+        _registerInterface(type(IService).interfaceId);
     }
 }

package/contracts/instance/module/component/ComponentModule.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
@@ -17,10 +17,11 @@ abstract contract ComponentModule is
 
     NftId[] private _nftIds;
 
-    modifier onlyComponentOwnerService() {
+    // TODO try to keep 1 modifier in 1 place...
+    modifier onlyComponentOwnerService() virtual {
         require(
             msg.sender == address(this.getComponentOwnerService()),
-            "ERROR:CMP-001:NOT_OWNER_SERVICE"
+            "ERROR:CMP-001:NOT_COMPONENT_OWNER_SERVICE"
         );
         _;
     }

package/contracts/instance/module/component/IComponent.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";

package/contracts/instance/module/policy/IPolicy.sol

@@ -56,7 +56,7 @@ interface IPolicyModule is IPolicy {
     ) external view returns (PolicyInfo memory info);
 
     // repeat registry linked signature
-    function getRegistry() external view returns (IRegistry registry);
+    // function getRegistry() external view returns (IRegistry registry);
 
     // repeat service linked signature to avoid linearization issues
     function getProductService() external  returns(IProductService);

package/contracts/instance/module/pool/IPoolModule.sol

@@ -6,6 +6,7 @@ import {NftId} from "../../../types/NftId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
 import {IProductService} from "../../service/IProductService.sol";
 import {IPoolService} from "../../service/IPoolService.sol";
+import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
 
 interface IPool {
     struct PoolInfo {
@@ -17,9 +18,8 @@ interface IPool {
 interface IPoolModule is IPool {
 
     function registerPool(
-        NftId poolNftId, 
-        bool isVerifying, 
-        UFixed collateralizationLevel
+        NftId nftId, 
+        PoolInfo memory info
     ) external;
 
     function addBundleToPool(
@@ -36,5 +36,6 @@ interface IPoolModule is IPool {
     function getBundleNftId(NftId poolNftId, uint256 index) external view returns (NftId bundleNftId);
 
     // repeat service linked signatures to avoid linearization issues
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
     function getPoolService() external returns(IPoolService);
 }

package/contracts/instance/module/pool/PoolModule.sol

@@ -26,6 +26,16 @@ abstract contract PoolModule is
     // mapping(NftId poolNftId => PoolInfo info) private _poolInfo;
     mapping(NftId poolNftId => LibNftIdSet.Set bundles) private _bundlesForPool;
 
+
+    // TODO try to keep 1 modifier in 1 place...
+    modifier onlyComponentOwnerService() virtual {
+        require(
+            msg.sender == address(this.getComponentOwnerService()),
+            "ERROR:CMP-001:NOT_COMPONENT_OWNER_SERVICE"
+        );
+        _;
+    }
+
     modifier poolServiceCallingPool() {
         require(
             msg.sender == address(this.getPoolService()),
@@ -40,17 +50,12 @@ abstract contract PoolModule is
 
     function registerPool(
         NftId nftId, 
-        bool isVerifying,
-        UFixed collateralizationRate
+        PoolInfo memory info
     )
         public
+        onlyComponentOwnerService
         override
     {
-        PoolInfo memory info  = PoolInfo(
-            isVerifying,
-            collateralizationRate
-        );
-
         _create(POOL(), nftId, abi.encode(info));
     }
 

package/contracts/instance/module/treasury/ITreasury.sol

@@ -1,10 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
 import {IPoolComponent} from "../../../components/IPoolComponent.sol";
 import {IProductComponent} from "../../../components/IProductComponent.sol";
+import {IComponentOwnerService} from "../../service/IComponentOwnerService.sol";
 
 import {NftId} from "../../../types/NftId.sol";
 import {UFixed} from "../../../types/UFixed.sol";
@@ -33,9 +34,8 @@ interface ITreasury {
 interface ITreasuryModule is ITreasury {
 
     function registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
+        NftId productNftId,
+        TreasuryInfo memory info
     ) external;
 
     function setTreasuryInfo(
@@ -79,4 +79,6 @@ interface ITreasuryModule is ITreasury {
         uint256 a, 
         int8 exp
     ) external pure returns (UFixed);
+
+    function getComponentOwnerService() external view returns(IComponentOwnerService);
 }

package/contracts/instance/module/treasury/TokenHandler.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 

package/contracts/instance/module/treasury/TreasuryModule.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {IDistributionComponent} from "../../../components/IDistributionComponent.sol";
@@ -9,7 +9,7 @@ import {IProductComponent} from "../../../components/IProductComponent.sol";
 import {NftId} from "../../../types/NftId.sol";
 import {TREASURY} from "../../../types/ObjectType.sol";
 import {Fee, FeeLib} from "../../../types/Fee.sol";
-import {UFixed, UFixedMathLib} from "../../../types/UFixed.sol";
+import {UFixed, UFixedLib} from "../../../types/UFixed.sol";
 import {TokenHandler} from "./TokenHandler.sol";
 import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
 import {ITreasuryModule} from "./ITreasury.sol";
@@ -25,48 +25,41 @@ abstract contract TreasuryModule is
     mapping(NftId componentNftId => TokenHandler tokenHandler) internal _tokenHandler;
     Fee internal _zeroFee;
     
+    modifier onlyComponentOwnerService() virtual {
+        require(
+            msg.sender == address(this.getComponentOwnerService()),
+            "ERROR:CMP-001:NOT_COPONENT_OWNER_SERVICE"
+        );
+        _;
+    }
 
-    function initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+    function _initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        //_initializeModuleBase(keyValueStore);
         _initialize(keyValueStore);
         _zeroFee = FeeLib.zeroFee();
     }
 
     function registerProductSetup(
-        IProductComponent product,
-        IPoolComponent pool,
-        IDistributionComponent distribution
-    ) external override // TODO add authz (only component module)
+        NftId productNftId,
+        TreasuryInfo memory setup
+    ) 
+        external
+        onlyComponentOwnerService
     {
-        NftId productNftId = product.getNftId();
-        NftId poolNftId = pool.getNftId();
-        NftId distributionNftId = distribution.getNftId();
-
-        require(productNftId.gtz(), "ERROR:TRS-010:PRODUCT_UNDEFINED");
-        require(poolNftId.gtz(), "ERROR:TRS-011:POOL_UNDEFINED");
+        NftId poolNftId = setup.poolNftId;
+        NftId distributionNftId = setup.distributionNftId;
 
         require(address(_tokenHandler[productNftId]) == address(0), "ERROR:TRS-012:TOKEN_HANDLER_ALREADY_REGISTERED");
         require(_productNft[poolNftId].eqz(), "ERROR:TRS-013:POOL_ALREADY_LINKED");
         require(_productNft[distributionNftId].eqz(), "ERROR:TRS-014:COMPENSATION_ALREADY_LINKED");
 
+        // TODO deploy TokenHandler with separate contract to save space
         // deploy product specific handler contract
-        IERC20Metadata token = product.getToken();
-        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(token));
+        _tokenHandler[productNftId] = new TokenHandler(productNftId, address(setup.token));
         _productNft[distributionNftId] = productNftId;
         _productNft[poolNftId] = productNftId;
 
-        TreasuryInfo memory info = TreasuryInfo(
-            poolNftId,
-            distributionNftId,
-            token,
-            product.getProductFee(),
-            product.getProcessingFee(),
-            pool.getPoolFee(),
-            pool.getStakingFee(),
-            pool.getPerformanceFee(),
-            distribution.getDistributionFee()
-        );
-
-        _create(TREASURY(), productNftId, abi.encode(info));
+        _create(TREASURY(), productNftId, abi.encode(setup));
     }
 
     function setTreasuryInfo(
@@ -125,7 +118,7 @@ abstract contract TreasuryModule is
     function getUFixed(
         uint256 a
     ) external pure override returns (UFixed) {
-        return UFixedMathLib.toUFixed(a);
+        return UFixedLib.toUFixed(a);
     }
 
     function getUFixed(
@@ -133,6 +126,6 @@ abstract contract TreasuryModule is
         int8 exp
     ) external pure returns (UFixed)
     {
-        return UFixedMathLib.toUFixed(a, exp);
+        return UFixedLib.toUFixed(a, exp);
     }
 }