@etherisc/gif-next 0.0.2-cc253b3 → 0.0.2-cd89a0b-062

package/artifacts/contracts/types/Version.sol/VersionPartLib.json

@@ -0,0 +1,30 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "VersionPartLib",
+  "sourceName": "contracts/types/Version.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "VersionPart",
+          "name": "x",
+          "type": "uint8"
+        }
+      ],
+      "name": "toInt",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x60b9610039600b82828239805160001a60731461002c57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe730000000000000000000000000000000000000000301460806040526004361060335760003560e01c8063ac43d834146038575b600080fd5b60496043366004605b565b60ff1690565b60405190815260200160405180910390f35b600060208284031215606c57600080fd5b813560ff81168114607c57600080fd5b939250505056fea264697066735822122028c6578af7cf354c26921be53c7bafd817914c3fa380a53d5f0e3935a1b47c8b64736f6c63430008140033",
+  "deployedBytecode": "0x730000000000000000000000000000000000000000301460806040526004361060335760003560e01c8063ac43d834146038575b600080fd5b60496043366004605b565b60ff1690565b60405190815260200160405180910390f35b600060208284031215606c57600080fd5b813560ff81168114607c57600080fd5b939250505056fea264697066735822122028c6578af7cf354c26921be53c7bafd817914c3fa380a53d5f0e3935a1b47c8b64736f6c63430008140033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/contracts/components/BaseComponent.sol

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.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 {IComponentOwnerService} from "../instance/service/IComponentOwnerService.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.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,
+        ObjectType componentType,
+        bool isInterceptor,
+        address initialOwner
+    )
+    {
+        bytes memory data = "";
+        _initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
+
+        IRegistry.ObjectInfo memory instanceInfo = getRegistry().getObjectInfo(instanceNftId);
+        _instance = IInstance(instanceInfo.objectAddress);
+        require(
+            _instance.supportsInterface(type(IInstance).interfaceId),
+            ""
+        );
+
+        _componentOwnerService = _instance.getComponentOwnerService();
+        _wallet = address(this);
+        _token = IERC20Metadata(token);
+
+        _registerInterface(type(IBaseComponent).interfaceId);
+    }
+
+    // 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/Distribution.sol

@@ -0,0 +1,155 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {DISTRIBUTION} from "../types/ObjectType.sol";
+import {IDistributionService} from "../instance/service/IDistributionService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+import {IDistributionComponent} from "./IDistributionComponent.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+contract Distribution is
+    BaseComponent,
+    IDistributionComponent
+{
+
+    Fee internal _initialDistributionFee;
+    bool internal _isVerifying;
+
+    IDistributionService private _distributionService;
+    IProductService private _productService;
+
+    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 verifying,
+        Fee memory distributionFee,
+        address initialOwner
+    )
+        BaseComponent(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
+    {
+        _isVerifying = verifying;
+        _initialDistributionFee = distributionFee;
+
+        _distributionService = _instance.getDistributionService();
+        _productService = _instance.getProductService();
+
+        _registerInterface(type(IDistributionComponent).interfaceId);
+    }
+
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        _distributionService.setFees(distributionFee);
+    }
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        Fee memory fee = getDistributionFee();
+        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
+    }
+
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        // default is no fees
+        return 0 * netPremiumAmount;
+    }
+
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
+        // default is invalid
+        return false;
+    }
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    function getDistributionFee() public view returns (Fee memory distributionFee) {
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).distributionFee;
+        } else {
+            return _initialDistributionFee;
+        }
+    }
+
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    // from IRegisterable
+
+    function getInitialInfo() 
+        public 
+        view
+        override (IRegisterable, Registerable)
+        returns(IRegistry.ObjectInfo memory, bytes memory)
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+            bytes memory data
+        ) = super.getInitialInfo();
+
+        return (
+            info,
+            abi.encode(
+                _initialDistributionFee,
+                _isVerifying
+            )
+        );
+    }
+}

package/contracts/components/IBaseComponent.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin5/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/IDistributionComponent.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../types/Fee.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {NftId} from "../types/NftId.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IDistributionComponent is IBaseComponent {
+
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    /// @dev callback from product service when selling a policy for a specific referralId
+    /// the used referral id and the collected fee are provided as parameters
+    /// the component implementation can then process this information accordingly
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev callback from product service when a policy is renews for a specific referralId
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev returns true iff the referral id is valid
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid);
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    function getDistributionFee() external view returns (Fee memory distributionFee);
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying);
+}

package/contracts/components/IPoolComponent.sol

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+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);
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    /**
+     * @dev creates a new bundle for this pool.
+     */
+    function createBundle(
+        Fee memory fee,
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    ) external returns(NftId bundleNftId);
+
+    function setBundleFee(
+        NftId policyNftId, 
+        Fee memory fee
+    ) external;
+
+    /** 
+     * @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 getFees() external view returns (Fee memory poolFee, Fee memory stakingFee, Fee memory performanceFee);
+
+}

package/contracts/components/IProductComponent.sol

@@ -0,0 +1,39 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Fee} from "../types/Fee.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId} from "../types/RiskId.sol";
+
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IProductComponent is IBaseComponent {
+
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    ) external;
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    ) external view returns (uint256 premiumAmount);
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external view returns (uint256 netPremiumAmount);    
+
+    function getProductFee() external view returns (Fee memory productFee);
+    function getProcessingFee() external view returns (Fee memory processingFee);
+
+    function getPoolNftId() external view returns (NftId poolNftId);
+    function getDistributionNftId() external view returns (NftId distributionNftId);
+}

package/contracts/components/Pool.sol

@@ -1,29 +1,246 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-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";
 
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IPool} from "../instance/module/pool/IPoolModule.sol";
+import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
 
-contract Pool is
-    Component,
-    IPoolComponent
-{
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+contract Pool is BaseComponent, IPoolComponent {
+
+    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, 
-        address instance
+        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
     )
-        Component(registry, instance)
-    { }
+        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;
+    }
 
-    // from registerable
-    function getType() public view override returns(uint256) {
-        return _registry.POOL();
+    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);
+    }
+    // TODO delete, call instance instead
+    function getFees()
+        external
+        view
+        override
+        returns (Fee memory, Fee memory, Fee memory)
+    {
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        //if (_instance.hasTreasuryInfo(productNftId)) {
+            ITreasury.TreasuryInfo memory info = _instance.getTreasuryInfo(productNftId);
+            return (info.poolFee, info.stakingFee, info.performanceFee);
+        //} else {
+        //    return (_initialPoolFee, _initialStakingFee, _initialPerformanceFee);
+        //}
     }
 
-    // from registerable
-    function getData() external view override returns(bytes memory data) {
-        return bytes(abi.encode(getInstance().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, 
+            bytes memory data
+        ) = super.getInitialInfo();
+
+        return (
+            info,
+            abi.encode(
+                IPool.PoolInfo(
+                    _isVerifying,
+                    _collateralizationLevel
+                ),
+                _wallet,
+                _token,
+                _initialPoolFee,
+                _initialStakingFee,
+                _initialPerformanceFee
+            )
+        );
+    }
+
+    // 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
+        );
     }
-}
+}