@etherisc/gif-next 0.0.2-ebbe63d → 0.0.2-ecbd488-936

package/contracts/components/Pool.sol

@@ -0,0 +1,242 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ObjectType, POOL} from "../types/ObjectType.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IPoolService} from "../instance/service/IPoolService.sol";
+import {NftId, zeroNftId, NftIdLib} 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";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+// import {IPool} from "../instance/module/pool/IPoolModule.sol";
+import {ITreasury} from "../instance/module/ITreasury.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+contract Pool is BaseComponent, IPoolComponent {
+    using NftIdLib for NftId;
+
+    bool internal _isVerifying;
+    UFixed internal _collateralizationLevel;
+
+    Fee internal _initialPoolFee;
+    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,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool isInterceptor,
+        bool verifying,
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee,
+        address initialOwner
+    )
+        BaseComponent(registry, instanceNftId, token, POOL(), isInterceptor, initialOwner)
+    {
+        _isVerifying = verifying;
+        // TODO add validation
+        _collateralizationLevel = collateralizationLevel;
+        _initialPoolFee = poolFee;
+        _initialStakingFee = stakingFee;
+        _initialPerformanceFee = performanceFee;
+
+        _poolService = _instance.getPoolService();
+        _productService = _instance.getProductService();
+
+        _registerInterface(type(IPoolComponent).interfaceId);
+    }
+
+    function createBundle(
+        Fee memory fee,
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    )
+        external
+        virtual override
+        returns(NftId bundleNftId)
+    {
+        address owner = msg.sender;
+        bundleNftId = _poolService.createBundle(
+            owner,
+            fee,
+            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 setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _poolService.setFees(poolFee, stakingFee, performanceFee);
+    }
+
+    function setBundleFee(
+        NftId bundleNftId, 
+        Fee memory fee
+    )
+        external
+        override
+        // TODO add onlyBundleOwner
+    {
+        _poolService.setBundleFee(bundleNftId, fee);
+    }
+
+    function getSetupInfo() public view returns (ISetup.PoolSetupInfo memory setupInfo) {
+        InstanceReader reader = _instance.getInstanceReader();
+        return reader.getPoolSetupInfo(getNftId());
+    }
+
+    // from IRegisterable
+
+    // TODO used only once, occupies space
+    // TODO do not use super
+    function getInitialInfo() 
+        public
+        view
+        override (IRegisterable, Registerable)
+        returns (IRegistry.ObjectInfo memory, bytes memory)
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+        ) = super.getInitialInfo();
+
+        return (
+            info,
+            abi.encode(
+                ISetup.PoolSetupInfo(
+                    _productNftId,
+                    TokenHandler(address(_token)),
+                    _collateralizationLevel,
+                    _initialPoolFee,
+                    _initialStakingFee,
+                    _initialPerformanceFee,
+                    _isVerifying,
+                    _wallet
+                )
+            )
+        );
+    }
+
+    // Internals
+
+    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,
+        Fee memory fee,
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        internal
+        returns(NftId bundleNftId)
+    {
+        bundleNftId = _poolService.createBundle(
+            bundleOwner,
+            fee,
+            amount,
+            lifetime,
+            filter
+        );
+    }
+}

package/contracts/components/Product.sol

@@ -0,0 +1,284 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRisk} from "../instance/module/IRisk.sol";
+import {ITreasury} from "../instance/module/ITreasury.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
+import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
+import {ReferralId} from "../types/Referral.sol";
+import {RiskId, RiskIdLib} from "../types/RiskId.sol";
+import {StateId} from "../types/StateId.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {Pool} from "../components/Pool.sol";
+import {Distribution} from "../components/Distribution.sol";
+
+import {zeroNftId} from "../types/NftId.sol";
+
+contract Product is BaseComponent, IProductComponent {
+    using NftIdLib for NftId;
+
+    IProductService internal _productService;
+    Pool internal _pool;
+    Distribution internal _distribution;
+    Fee internal _initialProductFee;
+    Fee internal _initialProcessingFee;
+
+    NftId internal _poolNftId;
+    NftId internal _distributionNftId;
+
+    constructor(
+        address registry,
+        NftId instanceNftid,
+        address token,
+        bool isInterceptor,
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee,
+        address initialOwner
+    ) BaseComponent(registry, instanceNftid, token, PRODUCT(), isInterceptor, initialOwner) {
+        // TODO add validation
+        _productService = _instance.getProductService();
+        _pool = Pool(pool);
+        _distribution = Distribution(distribution);
+        _initialProductFee = productFee;
+        _initialProcessingFee = processingFee;  
+
+        _poolNftId = getRegistry().getNftId(address(_pool));
+        _distributionNftId = getRegistry().getNftId(address(_distribution));
+
+        _registerInterface(type(IProductComponent).interfaceId);  
+    }
+
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    )
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        (premiumAmount,,,,) = _productService.calculatePremium(
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+    }
+
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    )
+        external
+        view
+        virtual override
+        returns (uint256 netPremiumAmount)
+    {
+        // default 10% of sum insured
+        return sumInsuredAmount / 10;
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function _createRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _productService.createRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _productService.updateRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRiskState(
+        RiskId id,
+        StateId state
+    ) internal {
+        _productService.updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
+        return _instance.getInstanceReader().getRiskInfo(id);
+    }
+
+    function _createApplication(
+        address applicationOwner,
+        RiskId riskId,
+        uint256 sumInsuredAmount,
+        uint256 lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    ) internal returns (NftId nftId) {
+        nftId = _productService.createApplication(
+            applicationOwner,
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+    }
+
+    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.activate(
+            policyNftId, 
+            activateAt);
+    }
+
+    function getPoolNftId() external view override returns (NftId poolNftId) {
+        return getRegistry().getNftId(address(_pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(address(_distribution));
+    }
+
+    // from product component
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        override
+    {
+        _productService.setFees(productFee, processingFee);
+    }
+
+    function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        InstanceReader reader = _instance.getInstanceReader();
+        return reader.getProductSetupInfo(getNftId());
+    }
+
+    // from IRegisterable
+
+    function getInitialInfo() 
+        public
+        view 
+        override (IRegisterable, Registerable)
+        returns (IRegistry.ObjectInfo memory, bytes memory)
+    {
+        // from Registerable
+        (
+            IRegistry.ObjectInfo memory productInfo, 
+            bytes memory data
+        ) = super.getInitialInfo();
+        
+        // TODO read pool & distribution fees
+        // 1) from pool -> the only option -> pool must be registered first?
+        // 2) from instance -> all fees are set into instance at product registration which is ongoing here
+        // checks are done in registryProduct() where THIS function is called
+        //require(getRegistry().getObjectInfo(_poolNftId).objectType == POOL(), "POOL_NOT_REGISTERED");
+        //require(getRegistry().getObjectInfo(_distributionNftId).objectType == DISTRIBUTION(), "DISTRIBUTION_NOT_REGISTERED");
+        
+        // from PoolComponent
+        (
+            , 
+            bytes memory poolData
+        ) = _pool.getInitialInfo();
+        
+        (
+            ISetup.PoolSetupInfo memory poolSetupInfo
+        )  = abi.decode(poolData, (ISetup.PoolSetupInfo));
+
+        // from DistributionComponent
+        (
+            , 
+            bytes memory distributionData
+        ) = _distribution.getInitialInfo();
+
+        (
+            ISetup.DistributionSetupInfo memory distributionSetupInfo
+        )  = abi.decode(distributionData, (ISetup.DistributionSetupInfo));
+
+        return (
+            productInfo,
+            abi.encode(
+                ISetup.ProductSetupInfo(
+                    _token,
+                    TokenHandler(address(_token)),
+                    _distributionNftId,
+                    _poolNftId,
+                    distributionSetupInfo.distributionFee, 
+                    _initialProductFee,
+                    _initialProcessingFee,
+                    poolSetupInfo.poolFee, 
+                    poolSetupInfo.stakingFee, 
+                    poolSetupInfo.performanceFee 
+                )
+            )
+        );
+    }
+}

package/contracts/experiment/cloning/Cloner.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
+
+
+contract Cloner {
+
+    Mock1 public mock1;
+    Mock2 public mock2;
+
+    constructor() {
+        mock1 = new Mock1();
+        mock2 = new Mock2();
+    }
+
+    function createClone(address master)
+        external 
+        returns (address cloned)
+    {
+        cloned = Clones.clone(master);
+    }
+}
+
+
+contract Mock1 {
+    function getValue() external virtual view returns (uint256) {
+        return 42;
+    }
+}
+
+contract Mock2 is Mock1 {
+    uint256 internal _value;
+
+    constructor() {
+        _value = 42;
+    }
+
+    function setValue(uint256 value) external virtual {
+        _value = value;
+    }
+
+    function getValue() external virtual override view returns (uint256) {
+        return _value;
+    }
+}
+

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

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IA, ISharedA} from "./IA.sol";
+import {B} from "./B.sol";
+import {C} from "./C.sol";
+
+/* 
+
+# dependency graph
+
+   B <...+
+   ^     |
+   |     |
+   A --> C
+
+   - A is the main contract
+   - A provides functionality implemented by modules B and C
+   - B and C rely on functionality shared by A
+   - C accesses functionality of module B
+
+# chisel session
+
+import {A} from "./contracts/experiment/A.sol";
+A a = new A();
+uint(a.getA())
+uint(a.getB()))
+uint(a.getC())
+uint(a.getAfromB())
+uint(a.getAfromC())
+uint(a.getBfromC())
+a.setA(100);
+a.setB(10);
+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 {}