@etherisc/gif-next 0.0.2-ed4dd55 → 0.0.2-f08d150-296

package/contracts/components/BaseComponent.sol

@@ -0,0 +1,88 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IInstance} from "../instance/IInstance.sol";
+
+import {IInstance} from "../instance/IInstance.sol";
+import {IComponent, IComponentModule} from "../instance/module/component/IComponent.sol";
+import {IComponentOwnerService} from "../instance/service/IComponentOwnerService.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+import {NftId} from "../types/NftId.sol";
+
+abstract contract BaseComponent is
+    Registerable,
+    IBaseComponent
+{
+    IComponentOwnerService internal _componentOwnerService;
+
+    address internal _deployer;
+    address internal _wallet;
+    IERC20Metadata internal _token;
+    IInstance internal _instance;
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        address token
+    )
+        Registerable(registry, instanceNftId)
+    {
+        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
+        _instance = IInstance(instanceInfo.objectAddress);
+        require(
+            _instance.supportsInterface(type(IInstance).interfaceId),
+            ""
+        );
+
+        _componentOwnerService = _instance.getComponentOwnerService();
+        _wallet = address(this);
+        _token = IERC20Metadata(token);
+    }
+
+    // from registerable
+    function register() public override(IRegisterable, Registerable) returns (NftId componentId) {
+        require(msg.sender == getOwner(), "");
+        require(
+            address(_registry) != address(0),
+            "ERROR:COB-001:REGISTRY_ZERO"
+        );
+        require(
+            _registry.isRegistered(address(_instance)),
+            "ERROR:COB:INSTANCE_NOT_REGISTERED"
+        );
+
+        componentId = _componentOwnerService.register(this);
+    }
+
+    // from component contract
+    function lock() external onlyOwner override {
+        _componentOwnerService.lock(this);
+    }
+
+    function unlock() external onlyOwner override {
+        _componentOwnerService.unlock(this);
+    }
+
+    function getWallet()
+        external
+        view
+        override
+        returns (address walletAddress)
+    {
+        return _wallet;
+    }
+
+    function getToken() external view override returns (IERC20Metadata token) {
+        return _token;
+    }
+
+    function getInstance() external view override returns (IInstance instance) {
+        return _instance;
+    }
+}

package/contracts/components/IBaseComponent.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IInstanceLinked} from "../instance/IInstanceLinked.sol";
+
+interface IBaseComponent is IRegisterable, IInstanceLinked {
+
+    function lock() external;
+
+    function unlock() external;
+
+    function getToken() external view returns (IERC20Metadata token);
+
+    function getWallet() external view returns (address walletAddress);
+
+}

package/contracts/components/IPoolComponent.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IPoolComponent is IBaseComponent {
+
+    event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
+
+    /**
+     * @dev creates a new bundle for this pool.
+     */
+    function createBundle(
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    ) external returns(NftId bundleNftId);
+
+    /** 
+     * @dev this is a callback function that is called by the product service when underwriting a policy.
+     * the pool has the option to check the details and object to underwriting by reverting.
+     * the function is only called for "active" pools that ask to be involved/notified
+     * by product related state changes.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    ) external;
+
+    /**
+     * @dev returns true iff the policy application data in policyData matches
+     * with the bundle filter criteria encoded in bundleFilter. 
+     */
+    function policyMatchesBundle(
+        bytes memory policyData,
+        bytes memory bundleFilter
+    )
+        external
+        view
+        returns (bool isMatching);
+
+    function isVerifying() external view returns (bool verifying);
+
+    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
+
+    function getStakingFee() external view returns (Fee memory stakingFee);
+
+    function getPerformanceFee()
+        external
+        view
+        returns (Fee memory performanceFee);
+}

package/contracts/components/IProductComponent.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+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);
+}

package/contracts/components/Pool.sol

@@ -1,29 +1,174 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IPoolComponent} from "./IPool.sol";
-import {Component} from "./Component.sol";
+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 {UFixed} from "../types/UFixed.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
+import {BaseComponent} from "./BaseComponent.sol";
 
+contract Pool is BaseComponent, IPoolComponent {
 
-contract Pool is
-    Component,
-    IPoolComponent
-{
+    bool internal _isVerifying;
+    UFixed internal _collateralizationLevel;
+
+    // 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
+        address registry,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool verifying,
+        UFixed collateralizationLevel
     )
-        Component(registry, instance)
-    { }
+        BaseComponent(registry, instanceNftId, token)
+    {
+        _isVerifying = verifying;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
 
-    // from registerable
-    function getType() public view override returns(uint256) {
-        return _registry.POOL();
+        _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
+    function getStakingFee()
+        external
+        view
+        override
+        returns (Fee memory stakingFee)
+    {
+        return _instance.getPoolSetup(getNftId()).stakingFee;
+    }
+
+    function getPerformanceFee()
+        external
+        view
+        override
+        returns (Fee memory performanceFee)
+    {
+        return _instance.getPoolSetup(getNftId()).performanceFee;
     }
 
     // from registerable
-    function getData() external view override returns(bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function getType() public pure override returns (ObjectType) {
+        return POOL();
     }
-}
+}

package/contracts/components/Product.sol

@@ -1,25 +1,25 @@
 // 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 {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 {BaseComponent} from "./BaseComponent.sol";
 
-
-contract Product is
-    Component,
-    IProductComponent
-{
+contract Product is BaseComponent, IProductComponent {
     IProductService private _productService;
     address private _pool;
 
     constructor(
-        address registry, 
-        address instance, 
+        address registry,
+        NftId instanceNftid,
+        address token,
         address pool
-    )
-        Component(registry, instance)
-    { 
+    ) BaseComponent(registry, instanceNftid, token) {
+        // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
     }
@@ -29,11 +29,8 @@ contract Product is
         uint256 sumInsuredAmount,
         uint256 premiumAmount,
         uint256 lifetime,
-        uint256 bundleNftId
-    )
-        internal
-        returns(uint256 nftId)
-    {
+        NftId bundleNftId
+    ) internal returns (NftId nftId) {
         nftId = _productService.createApplication(
             applicationOwner,
             sumInsuredAmount,
@@ -43,23 +40,78 @@ contract Product is
         );
     }
 
-    function _underwrite(uint256 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 _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
         internal
     {
-        _productService.underwrite(nftId);
+        _productService.activate(
+            policyNftId, 
+            activateAt);
     }
 
-    function getPoolNftId() external view override returns(uint256 poolNftId) {
+    function getPoolNftId() external view override returns (NftId poolNftId) {
         return _registry.getNftId(_pool);
     }
 
-    // from registerable
-    function getType() public view override returns(uint256) {
-        return _registry.PRODUCT();
+    // 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 _instance.getProductSetup(getNftId()).policyFee;
+    }
+
+    function getProcessingFee()
+        external
+        view
+        override
+        returns (Fee memory processingFee)
+    {
+        return _instance.getProductSetup(getNftId()).processingFee;
     }
 
     // from registerable
-    function getData() external view override returns(bytes memory data) {
-        return bytes(abi.encode(getInstance().getNftId()));
+    function getType() public pure override returns (ObjectType) {
+        return PRODUCT();
     }
-}
+}

package/contracts/experiment/errors/Require.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+contract Require {
+    error AsmallerThanB_S();
+    error AsmallerThanB_M(uint a);
+    error AsmallerThanB_L(uint a, uint b);
+
+    uint256 private _b;
+
+    constructor() {
+        _b = 42;
+    }
+
+    function isAlargerThanBRequire_S(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-001");
+
+        return true;
+    }
+
+    function isAlargerThanBRequire_M(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-002:A_IS_SMALLER");
+
+        return true;
+    }
+
+    function isAlargerThanBRequire_L(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-003:A_IS_SMALLER_THAN_B");
+
+        return true;
+    }
+}

package/contracts/experiment/errors/Revert.sol

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+contract Revert {
+    error AsmallerThanB_S();
+    error AsmallerThanB_M(uint a);
+    error AsmallerThanB_L(uint a, uint b);
+
+    uint256 private _b;
+
+    constructor() {
+        _b = 42;
+    }
+
+    function isAlargerThanBRevert_S(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_S();
+        }
+
+        return true;
+    }
+
+    function isAlargerThanBRevert_M(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_M(a);
+        }
+
+        return true;
+    }
+
+    function isAlargerThanBRevert_L(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_L(a, _b);
+        }
+
+        return true;
+    }
+}

package/contracts/experiment/inheritance/A.sol

@@ -35,22 +35,19 @@ a.setC(20);
  */
 
 contract AShared is ISharedA {
-
     uint256 private _x;
 
     constructor() {
         _x = 42;
     }
 
-    function getA() external view override returns(uint256) { return _x; }
-    function setA(uint256 newA) external override { _x = newA; }
-}
-
-contract A is
-    AShared,
-    B,
-    C,
-    IA
-{
+    function getA() external view override returns (uint256) {
+        return _x;
+    }
 
+    function setA(uint256 newA) external override {
+        _x = newA;
+    }
 }
+
+contract A is AShared, B, C, IA {}

package/contracts/experiment/inheritance/B.sol

@@ -5,7 +5,6 @@ import {ISharedA} from "./IA.sol";
 import {IB} from "./IB.sol";
 
 abstract contract B is ISharedA, IB {
-
     // names of private variables can be re-used in inheritance
     uint256 private _x;
 
@@ -14,10 +13,16 @@ abstract contract B is ISharedA, IB {
     }
 
     // access own state
-    function getB() external view override returns(uint256) { return _x; }
-    function setB(uint256 newB) external override { _x = newB; }
+    function getB() external view override returns (uint256) {
+        return _x;
+    }
 
-    // access state from parent contract A
-    function getAfromB() external view override returns(uint256) { return this.getA(); }
+    function setB(uint256 newB) external override {
+        _x = newB;
+    }
 
+    // access state from parent contract A
+    function getAfromB() external view override returns (uint256) {
+        return this.getA();
+    }
 }

package/contracts/experiment/inheritance/C.sol

@@ -6,7 +6,6 @@ import {IB} from "./IB.sol";
 import {IC} from "./IC.sol";
 
 abstract contract C is ISharedA, IC {
-
     uint256 private _x;
 
     constructor() {
@@ -14,14 +13,21 @@ abstract contract C is ISharedA, IC {
     }
 
     // access own state
-    function getC() external view override returns(uint256) { return _x; }
-    function setC(uint256 newC) external override { _x = newC; }
+    function getC() external view override returns (uint256) {
+        return _x;
+    }
+
+    function setC(uint256 newC) external override {
+        _x = newC;
+    }
 
     // access state from parent contract A
-    function getAfromC() external view override returns(uint256) { return this.getA(); }
+    function getAfromC() external view override returns (uint256) {
+        return this.getA();
+    }
 
     // access state from other module B
-    function getBfromC() external view override returns(uint256) {
+    function getBfromC() external view override returns (uint256) {
         IB b = IB(address(this));
         return b.getB();
     }