@etherisc/gif-next 0.0.2-e6ad61d-739 → 0.0.2-e875d61-189

package/contracts/components/{IProduct.sol → IProductComponent.sol}

@@ -3,14 +3,17 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
 
-interface IProductComponent {
-    function getPoolNftId() external view returns (NftId poolNftId);
+interface IProductComponent is IBaseComponent {
+    function setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
 
+    function getPoolNftId() external view returns (NftId poolNftId);
+    
     function getPolicyFee() external view returns (Fee memory policyFee);
 
-    function getProcessingFee()
-        external
-        view
-        returns (Fee memory processingFee);
+    function getProcessingFee() external view returns (Fee memory processingFee);
 }

package/contracts/components/Pool.sol

@@ -2,23 +2,157 @@
 pragma solidity ^0.8.19;
 
 import {ObjectType, POOL} from "../types/ObjectType.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {NftId} from "../types/NftId.sol";
 import {Fee} from "../types/Fee.sol";
-import {IPoolComponent} from "./IPool.sol";
-import {Component} from "./Component.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {BaseComponent} from "./BaseComponent.sol";
 
-contract Pool is Component, IPoolComponent {
-    Fee private _stakingFee;
-    Fee private _performanceFee;
+contract Pool is BaseComponent, IPoolComponent {
+
+    bool internal _isVerifying;
+    UFixed internal _collateralizationLevel;
+
+    Fee internal _initialStakingFee;
+    Fee internal _initialPerformanceFee;
+
+    // may be used to interact with instance by derived contracts
+    IPoolService internal _poolService;
+
+    // only relevant to protect callback functions for "active" pools
+    IProductService private _productService;
+
+    modifier onlyPoolService() {
+        require(
+            msg.sender == address(_poolService), 
+            "ERROR:POL-001:NOT_POOL_SERVICE");
+        _;
+    }
+
+    modifier onlyProductService() {
+        require(
+            msg.sender == address(_productService), 
+            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+        _;
+    }
 
     constructor(
         address registry,
-        address instance,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
         address token,
+        bool verifying,
+        UFixed collateralizationLevel,
         Fee memory stakingFee,
         Fee memory performanceFee
-    ) Component(registry, instance, token) {
-        _stakingFee = stakingFee;
-        _performanceFee = performanceFee;
+    )
+        BaseComponent(registry, instanceNftId, token)
+    {
+        _isVerifying = verifying;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
+
+        _poolService = _instance.getPoolService();
+        _productService = _instance.getProductService();
+    }
+
+    function createBundle(
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    )
+        external
+        virtual override
+        returns(NftId bundleNftId)
+    {
+        address owner = msg.sender;
+        bundleNftId = _poolService.createBundle(
+            owner,
+            initialAmount,
+            lifetime,
+            filter
+        );
+
+        // TODO add logging
+    }
+
+    /**
+     * @dev see {IPool.underwrite}. 
+     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        external
+        onlyProductService
+        virtual override 
+    {
+        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
+    }
+
+    /**
+     * @dev see {IPoolComponent.policyMatchesBundle}. 
+     * Default implementation always returns true
+     */
+    function policyMatchesBundle(
+        bytes memory, // policyData
+        bytes memory // bundleFilter
+    )
+        public
+        view
+        virtual override
+        returns (bool isMatching)
+    {
+        return true;
+    }
+
+
+    function isVerifying() external view override returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
+        return _collateralizationLevel;
+    }
+
+    function _underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    )
+        internal 
+    {
+        require(
+            policyMatchesBundle(policyData, bundleFilter),
+            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
+        );
+
+        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
+    }
+
+    function _createBundle(
+        address bundleOwner,
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        internal
+        returns(NftId bundleNftId)
+    {
+        bundleNftId = _poolService.createBundle(
+            bundleOwner,
+            amount,
+            lifetime,
+            filter
+        );
     }
 
     // from pool component
@@ -28,7 +162,12 @@ contract Pool is Component, IPoolComponent {
         override
         returns (Fee memory stakingFee)
     {
-        return _stakingFee;
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (productNftId.gtz()) {
+            return _instance.getTreasuryInfo(productNftId).stakingFee;
+        } else {
+            return _initialStakingFee;
+        }
     }
 
     function getPerformanceFee()
@@ -37,16 +176,16 @@ contract Pool is Component, IPoolComponent {
         override
         returns (Fee memory performanceFee)
     {
-        return _performanceFee;
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (productNftId.gtz()) {
+            return _instance.getTreasuryInfo(productNftId).performanceFee;
+        } else {
+            return _initialPerformanceFee;
+        }
     }
 
     // from registerable
     function getType() public pure override returns (ObjectType) {
         return POOL();
     }
-
-    // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
-    }
 }

package/contracts/components/Product.sol

@@ -1,33 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IProductService} from "../instance/product/IProductService.sol";
-import {Component} from "./Component.sol";
-import {IProductComponent} from "./IProduct.sol";
+import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {Timestamp} from "../types/Timestamp.sol";
 import {Fee} from "../types/Fee.sol";
-import {Component} from "./Component.sol";
+import {BaseComponent} from "./BaseComponent.sol";
 
-contract Product is Component, IProductComponent {
-    IProductService private _productService;
-    address private _pool;
-    Fee private _policyFee;
-    Fee private _processingFee;
+contract Product is BaseComponent, IProductComponent {
+    IProductService internal _productService;
+    address internal _pool;
+    Fee internal _initialPolicyFee;
+    Fee internal _initialProcessingFee;
 
     constructor(
         address registry,
-        address instance,
+        NftId instanceNftid,
         address token,
         address pool,
         Fee memory policyFee,
         Fee memory processingFee
-    ) Component(registry, instance, token) {
+    ) BaseComponent(registry, instanceNftid, token) {
         // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
-        _policyFee = policyFee;
-        _processingFee = processingFee;
+        _initialPolicyFee = policyFee;
+        _initialProcessingFee = processingFee;        
     }
 
     function _createApplication(
@@ -46,12 +47,39 @@ contract Product is Component, IProductComponent {
         );
     }
 
-    function _underwrite(NftId nftId) internal {
-        _productService.underwrite(nftId);
+    function _underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.underwrite(
+            policyNftId, 
+            requirePremiumPayment, 
+            activateAt);
+    }
+
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.collectPremium(
+            policyNftId, 
+            activateAt);
     }
 
-    function _collectPremium(NftId nftId) internal {
-        _productService.collectPremium(nftId);
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _productService.activate(
+            policyNftId, 
+            activateAt);
     }
 
     function getPoolNftId() external view override returns (NftId poolNftId) {
@@ -59,13 +87,30 @@ contract Product is Component, IProductComponent {
     }
 
     // from product component
+    function setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _productService.setFees(policyFee, processingFee);
+    }
+
+
     function getPolicyFee()
         external
         view
         override
         returns (Fee memory policyFee)
     {
-        return _policyFee;
+        NftId productNftId = getNftId();
+        if (address(_instance.getTokenHandler(productNftId)) != address(0)) {
+            return _instance.getTreasuryInfo(productNftId).policyFee;
+        } else {
+            return _initialPolicyFee;
+        }
     }
 
     function getProcessingFee()
@@ -74,16 +119,16 @@ contract Product is Component, IProductComponent {
         override
         returns (Fee memory processingFee)
     {
-        return _processingFee;
+        NftId productNftId = getNftId();
+        if (address(_instance.getTokenHandler(productNftId)) != address(0)) {
+            return _instance.getTreasuryInfo(productNftId).processingFee;
+        } else {
+            return _initialProcessingFee;
+        }
     }
 
     // from registerable
     function getType() public pure override returns (ObjectType) {
         return PRODUCT();
     }
-
-    // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
-    }
 }

package/contracts/instance/IInstance.sol

@@ -1,25 +1,50 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRegisterable} from "../registry/IRegistry.sol";
-import {IAccessModule} from "./access/IAccess.sol";
-import {ILifecycleModule} from "./lifecycle/ILifecycle.sol";
-import {IComponentModule} from "./component/IComponent.sol";
-import {IProductModule} from "./product/IProductService.sol";
-import {IPolicyModule} from "./policy/IPolicy.sol";
-import {IPoolModule} from "./pool/IPoolModule.sol";
-import {ITreasuryModule} from "./treasury/ITreasury.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+import {IVersionable} from "../shared/IVersionable.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IOwnable} from "../shared/IOwnable.sol";
+import {RoleId} from "../types/RoleId.sol";
+
+import {IAccessModule} from "./module/access/IAccess.sol";
+import {IBundleModule} from "./module/bundle/IBundle.sol";
+import {ICompensationModule} from "./module/compensation/ICompensation.sol";
+import {IComponentModule} from "./module/component/IComponent.sol";
+import {IPolicyModule} from "./module/policy/IPolicy.sol";
+import {IPoolModule} from "./module/pool/IPoolModule.sol";
+import {IRiskModule} from "./module/risk/IRisk.sol";
+import {ITreasuryModule} from "./module/treasury/ITreasury.sol";
+
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {IRegistry, IRegistryLinked} from "../registry/IRegistryLinked.sol";
+
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+import {IInstanceBase} from "./base/IInstanceBase.sol";
 
 // solhint-disable-next-line no-empty-blocks
 interface IInstance is
+    IERC165,
+    IVersionable,
     IRegisterable,
     IAccessModule,
-    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
+    IBundleModule,
     IComponentModule,
-    IProductModule,
-    ITreasuryModule
+    ITreasuryModule,
+    ICompensationModule,
+    IInstanceBase
 {
+    function getRegistry() external view override (IPolicyModule, IRegisterable) returns (IRegistry registry);
+    function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
+
+    function getKeyValueStore() external view override (IInstanceBase) returns (IKeyValueStore keyValueStore);
+    function getComponentOwnerService() external view override (IInstanceBase, IComponentModule) returns(IComponentOwnerService);
+    function getProductService() external view override (IInstanceBase, IBundleModule, IPolicyModule) returns(IProductService);
+    function getPoolService() external view override (IInstanceBase, IBundleModule, IPoolModule) returns(IPoolService);
 
 }

package/contracts/instance/IInstanceLinked.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IInstance} from "./IInstance.sol";
+
+interface IInstanceLinked {
+    function getInstance() external view returns (IInstance instance);
+}

package/contracts/instance/Instance.sol

@@ -1,72 +1,71 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Registerable} from "../registry/Registry.sol";
+import {NftId} from "../types/NftId.sol";
+import {RoleId} from "../types/RoleId.sol";
+
+import {InstanceBase} from "./base/InstanceBase.sol";
+import {AccessModule} from "./module/access/Access.sol";
+import {CompensationModule} from "./module/compensation/CompensationModule.sol";
+import {ComponentModule} from "./module/component/ComponentModule.sol";
+import {PolicyModule} from "./module/policy/PolicyModule.sol";
+import {PoolModule} from "./module/pool/PoolModule.sol";
+import {RiskModule} from "./module/risk/RiskModule.sol";
+import {BundleModule} from "./module/bundle/BundleModule.sol";
+import {TreasuryModule} from "./module/treasury/TreasuryModule.sol";
+
 import {IRegistry} from "../registry/IRegistry.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {IAccessModule} from "./module/access/IAccess.sol";
+import {IBundleModule} from "./module/bundle/IBundle.sol";
+import {IComponentModule} from "./module/component/IComponent.sol";
+import {IPoolModule} from "./module/pool/IPoolModule.sol";
+import {IPolicyModule} from "./module/policy/IPolicy.sol";
+import {IInstanceBase} from "./base/IInstanceBase.sol";
 
-import {IAccessModule, AccessModule} from "./access/Access.sol";
-import {LifecycleModule} from "./lifecycle/LifecycleModule.sol";
-import {ComponentModule} from "./component/ComponentModule.sol";
-import {ProductModule} from "./product/ProductService.sol";
-import {PolicyModule} from "./policy/PolicyModule.sol";
-import {PoolModule} from "./pool/PoolModule.sol";
-import {TreasuryModule} from "./treasury/TreasuryModule.sol";
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
 
-import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
-import {NftId, toNftId} from "../types/NftId.sol";
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
 
 contract Instance is
-    Registerable,
+    InstanceBase,
     AccessModule,
-    LifecycleModule,
+    BundleModule,
     ComponentModule,
+    CompensationModule,
     PolicyModule,
     PoolModule,
-    ProductModule,
-    TreasuryModule,
-    IInstance
+    RiskModule,
+    TreasuryModule
 {
     constructor(
         address registry,
-        address componentOwnerService,
-        address productService
+        NftId registryNftId
     )
-        Registerable(registry)
+        InstanceBase(registry, registryNftId)
         AccessModule()
-        ComponentModule(componentOwnerService)
-        PolicyModule(productService)
-        ProductModule(productService)
-        PoolModule(productService)
-    // solhint-disable-next-line no-empty-blocks
+        BundleModule()
+        ComponentModule()
+        PolicyModule()
+        PoolModule()
+        TreasuryModule()
     {
-
-    }
-
-    // from registerable
-    function register() external override returns (NftId nftId) {
-        require(
-            address(_registry) != address(0),
-            "ERROR:PRD-001:REGISTRY_ZERO"
-        );
-        return _registry.register(address(this));
+        initializeBundleModule(_keyValueStore);
+        initializeCompensationModule(_keyValueStore);
+        initializeComponentModule(_keyValueStore);
+        initializePolicyModule(_keyValueStore);
+        initializePoolModule(_keyValueStore);
+        initializeRiskModule(_keyValueStore);
     }
 
-    // from registerable
-    function getParentNftId() public pure override returns (NftId) {
-        // TODO  add self registry and exchange 0 for_registry.getNftId();
-        // define parent tree for all registerables
-        // eg 0 <- chain(mainnet) <- global registry <- chain registry <- instance <- component <- policy/bundle
-        return toNftId(0);
-    }
+    function getRegistry() public view override (Registerable, IPolicyModule) returns (IRegistry registry) { return super.getRegistry(); }
+    function getKeyValueStore() public view override (InstanceBase) returns (IKeyValueStore keyValueStore) { return super.getKeyValueStore(); }
 
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
+    function getComponentOwnerService() external view override (IComponentModule, IInstanceBase) returns(IComponentOwnerService service) { return _componentOwnerService; }
+    function getProductService() external view override (IBundleModule, IPolicyModule, IInstanceBase) returns(IProductService service) { return _productService; }
+    function getPoolService() external view override (IBundleModule, IPoolModule, IInstanceBase) returns(IPoolService service) { return _poolService; }
 
-    // from registerable
-    function getData() external pure override returns (bytes memory data) {
-        return bytes(abi.encode(0));
-    }
+    function getOwner() public view override (IAccessModule, Registerable) returns(address owner) { return super.getOwner(); }
 }

package/contracts/instance/base/ComponentServiceBase.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+
+import {ServiceBase} from "./ServiceBase.sol";
+
+abstract contract ComponentServiceBase is ServiceBase {
+
+    constructor(
+        address registry,
+        NftId registryNftId
+    )
+        ServiceBase(registry, registryNftId)
+    // solhint-disable-next-line no-empty-blocks
+    {
+    }
+
+
+    function _getAndVerifyComponentInfoAndInstance(
+        ObjectType objectType
+    )
+        internal
+        view
+        returns(
+            IRegistry.ObjectInfo memory info, 
+            IInstance instance
+        )
+    {
+        NftId componentNftId = _registry.getNftId(msg.sender);
+        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
+
+        info = _registry.getObjectInfo(componentNftId);
+        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
+
+        address instanceAddress = _registry.getObjectInfo(info.parentNftId).objectAddress;
+        instance = IInstance(instanceAddress);
+    }
+}

package/contracts/instance/base/IInstanceBase.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32} from "../../types/Key32.sol";
+import {StateId} from "../../types/StateId.sol";
+
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
+import {IProductService} from "../service/IProductService.sol";
+import {IPoolService} from "../service/IPoolService.sol";
+
+interface IInstanceBase {
+    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
+    function updateState(Key32 key, StateId state) external;
+
+    function getComponentOwnerService() external view returns(IComponentOwnerService service);
+    function getProductService() external view returns(IProductService service);
+    function getPoolService() external view returns(IPoolService service);
+}

package/contracts/instance/base/IKeyValueStore.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
+import {Key32, KeyId} from "../../types/Key32.sol";
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {StateId} from "../../types/StateId.sol";
+
+import {ILifecycle} from "./ILifecycle.sol";
+
+interface IKeyValueStore is ILifecycle {
+
+    struct Key {
+        ObjectType objectType;
+        KeyId id;
+    }
+
+    struct Value {
+        Metadata metadata;
+        bytes data;
+    }
+
+    struct Metadata {
+        ObjectType objectType;
+        StateId state;
+        address updatedBy;
+        Blocknumber updatedIn;
+        Blocknumber createdIn;
+    }
+
+    event LogInfoCreated(Key key, StateId state, address createdBy, address txOrigin);
+    event LogInfoUpdated(Key key, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+    event LogStateUpdated(Key key, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
+
+    // generic state changing functions
+    function create(Key32 key, ObjectType objectType, bytes memory data) external;
+    function update(Key32 key, StateId state, bytes memory data) external;
+    function updateData(Key32 key, bytes memory data) external;
+    function updateState(Key32 key, StateId state) external;
+
+    function exists(Key32 key) external view returns (bool);
+    function get(Key32 key) external view returns (Value memory value);
+    function getData(Key32 key) external view returns (bytes memory data);
+    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
+    function getState(Key32 key) external view returns (StateId state);
+
+    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
+    function toKey(Key32 key32) external pure returns(Key memory key);
+}