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

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

@@ -0,0 +1,96 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {NftId} from "../../../types/NftId.sol";
+import {UFixed} from "../../../types/UFixed.sol";
+import {Fee} from "../../../types/Fee.sol";
+
+import {TokenHandler} from "./TokenHandler.sol";
+
+interface ITreasury {
+    // TODO add events
+    // TODO add errors
+
+    // treasury info is linked to product nft id
+    struct TreasuryInfo {
+        NftId compensationNftId;
+        NftId poolNftId;
+        IERC20Metadata token;
+        Fee commissionFee;
+        Fee policyFee;
+        Fee processingFee;
+        Fee stakingFee;
+        Fee performanceFee;
+    }
+}
+
+interface ITreasuryModule is ITreasury {
+
+    function registerProductSetup(
+        NftId productNftId,
+        NftId distributorNftId,
+        NftId poolNftId,
+        IERC20Metadata token,
+        Fee memory policyFee,
+        Fee memory processingFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    function setTreasuryInfo(
+        NftId productNftId,
+        TreasuryInfo memory info
+    ) external;
+
+    function getTreasuryInfo(
+        NftId productNftId
+    ) external view returns (TreasuryInfo memory info);
+
+    // function setProductFees(
+    //     NftId productNftId,
+    //     Fee memory policyFee,
+    //     Fee memory processingFee
+    // ) external;
+
+    // function setCompensationFees(
+    //     NftId poolNftId,
+    //     Fee memory distributionFee
+    // ) external;
+
+    // function setPoolFees(
+    //     NftId poolNftId,
+    //     Fee memory stakingFee,
+    //     Fee memory performanceFee
+    // ) external;
+
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId);
+
+    function getTokenHandler(
+        NftId componentNftId
+    ) external view returns (TokenHandler tokenHandler);
+
+    function calculateFeeAmount(
+        uint256 amount,
+        Fee memory fee
+    ) external pure returns (uint256 feeAmount, uint256 netAmount);
+
+    function getFee(
+        UFixed fractionalFee, 
+        uint256 fixedFee
+    ) external pure returns (Fee memory fee);
+
+    function getZeroFee() external view returns (Fee memory fee);
+
+    function getUFixed(
+        uint256 a
+    ) external pure returns (UFixed);
+
+    function getUFixed(
+        uint256 a, 
+        int8 exp
+    ) external pure returns (UFixed);
+}

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

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {NftId} from "../../../types/NftId.sol";
+
+contract TokenHandler {
+    NftId private _productNftId;
+    IERC20Metadata private _token;
+
+    constructor(
+        NftId productNftId,
+        address token
+    )
+    {
+        _productNftId = productNftId;
+        _token = IERC20Metadata(token);
+    }
+
+    // TODO add logging
+    function transfer(
+        address from,
+        address to,
+        uint256 amount
+    )
+        external // TODO add authz (only treasury/instance/product/pool/ service)
+    {
+        // TODO switch to oz safeTransferFrom
+        _token.transferFrom(from, to, amount);
+    }
+
+    function getProductNftId()
+        external
+        view
+        returns(NftId)
+    {
+        return _productNftId;
+    }
+
+    function getToken()
+        external
+        view
+        returns(IERC20Metadata)
+    {
+        return _token;
+    }
+}

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

@@ -0,0 +1,171 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.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 {TokenHandler} from "./TokenHandler.sol";
+import {IKeyValueStore} from "../../base/IKeyValueStore.sol";
+import {ITreasuryModule} from "./ITreasury.sol";
+import {ModuleBase} from "../../base/ModuleBase.sol";
+
+abstract contract TreasuryModule is
+    ModuleBase,
+    ITreasuryModule
+{
+    // relation of distributor and pool nft map to product nft
+    mapping(NftId componentNftId => NftId productNftId) internal _productNft;
+    // relation of component nft to token hanlder
+    mapping(NftId componentNftId => TokenHandler tokenHandler) internal _tokenHandler;
+    Fee internal _zeroFee;
+    
+
+    function initializeTreasuryModule(IKeyValueStore keyValueStore) internal {
+        _initialize(keyValueStore);
+        _zeroFee = FeeLib.zeroFee();
+    }
+
+    function registerProductSetup(
+        NftId productNftId,
+        NftId compensationNftId,
+        NftId poolNftId,
+        IERC20Metadata token,
+        Fee memory policyFee,
+        Fee memory processingFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external override // TODO add authz (only component module)
+    {
+        require(address(_tokenHandler[productNftId]) == address(0), "ERROR:TRS-010:TOKEN_HANDLER_ALREADY_REGISTERED");
+        require(_productNft[compensationNftId].eqz(), "ERROR:TRS-011:COMPENSATION_ALREADY_LINKED");
+        require(_productNft[poolNftId].eqz(), "ERROR:TRS-012:POOL_ALREADY_LINKED");
+
+        // deploy product specific handler contract
+        TokenHandler tokenHandler = new TokenHandler(productNftId, address(token));
+        _tokenHandler[productNftId] = tokenHandler;
+        _productNft[compensationNftId] = productNftId;
+        _productNft[poolNftId] = productNftId;
+
+        TreasuryInfo memory info = TreasuryInfo(
+            compensationNftId,
+            poolNftId,
+            token,
+            _zeroFee,
+            policyFee,
+            processingFee,
+            stakingFee,
+            performanceFee
+        );
+
+        _create(TREASURY(), productNftId, abi.encode(info));
+    }
+
+    function setTreasuryInfo(
+        NftId productNftId,
+        TreasuryInfo memory info
+    )
+        external
+        // TODO add authz (only component module)
+        override
+    {
+        _updateData(TREASURY(), productNftId, abi.encode(info));
+    }
+
+    // function setProductFees(
+    //     NftId productNftId,
+    //     Fee memory policyFee,
+    //     Fee memory processingFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-020:NOT_FOUND");
+
+    //     info.policyFee = policyFee;
+    //     info.processingFee = processingFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    // function setCompensationFees(
+    //     NftId compensationNftId,
+    //     Fee memory distributionFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     NftId productNftId = _productNft[compensationNftId];
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-030:NOT_FOUND");
+
+    //     info.commissionFee = distributionFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    // function setPoolFees(
+    //     NftId poolNftId,
+    //     Fee memory stakingFee,
+    //     Fee memory performanceFee
+    // ) external override // TODO add authz (only component owner service)
+    // {
+    //     NftId productNftId = _productNft[poolNftId];
+    //     TreasuryInfo memory info = getTreasuryInfo(productNftId);
+    //     require(address(info.token) != address(0), "ERROR:TRS-040:NOT_FOUND");
+
+    //     info.stakingFee = stakingFee;
+    //     info.performanceFee = performanceFee;
+
+    //     _updateData(TREASURY(), productNftId, abi.encode(info));
+    // }
+
+    function getProductNftId(
+        NftId componentNftId
+    ) external view returns (NftId productNftId) {
+        return _productNft[componentNftId];
+    }
+
+    function getTokenHandler(
+        NftId componentNftId
+    ) external view override returns (TokenHandler tokenHandler) {
+        return _tokenHandler[componentNftId];
+    }
+
+    function getTreasuryInfo(
+        NftId productNftId
+    ) public view override returns (TreasuryInfo memory info) {
+        return abi.decode(_getData(TREASURY(), productNftId), (TreasuryInfo));
+    }
+
+    function calculateFeeAmount(
+        uint256 amount,
+        Fee memory fee
+    ) public pure override returns (uint256 feeAmount, uint256 netAmount) {
+        return FeeLib.calculateFee(amount, fee);
+    }
+
+    function getFee(
+        UFixed fractionalFee, 
+        uint256 fixedFee
+    ) external pure override returns (Fee memory fee) {
+        return FeeLib.toFee(fractionalFee, fixedFee);
+    }
+
+    function getZeroFee() external view override returns (Fee memory fee) {
+        return _zeroFee;
+    }
+
+    function getUFixed(
+        uint256 a
+    ) external pure override returns (UFixed) {
+        return UFixedMathLib.toUFixed(a);
+    }
+
+    function getUFixed(
+        uint256 a, 
+        int8 exp
+    ) external pure returns (UFixed)
+    {
+        return UFixedMathLib.toUFixed(a, exp);
+    }
+}

package/contracts/instance/service/ComponentOwnerService.sol

@@ -0,0 +1,155 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IInstance} from "../IInstance.sol";
+
+import {ITreasuryModule} from "../module/treasury/ITreasury.sol";
+import {TreasuryModule} from "../module/treasury/TreasuryModule.sol";
+import {IComponent, IComponentModule} from "../module/component/IComponent.sol";
+import {IBaseComponent} from "../../components/IBaseComponent.sol";
+import {IPoolComponent} from "../../components/IPoolComponent.sol";
+import {IKeyValueStore} from "../../instance/base/IKeyValueStore.sol";
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+
+import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
+import {ObjectType, COMPONENT, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
+import {Key32} from "../../types/Key32.sol";
+import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {Version, VersionLib} from "../../types/Version.sol";
+
+import {IProductComponent} from "../../components/IProductComponent.sol";
+import {ServiceBase} from "../base/ServiceBase.sol";
+import {IComponentOwnerService} from "./IComponentOwnerService.sol";
+
+contract ComponentOwnerService is
+    ServiceBase,
+    IComponentOwnerService
+{
+    using NftIdLib for NftId;
+
+    string public constant NAME = "ComponentOwnerService";
+
+    modifier onlyRegisteredComponent(IBaseComponent component) {
+        NftId nftId = _registry.getNftId(address(component));
+        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
+        _;
+    }
+
+    constructor(
+        address registry,
+        NftId registryNftId
+    ) ServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
+
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(3,0,0);
+    }
+
+    function getName() external pure override returns(string memory name) {
+        return NAME;
+    }
+
+    function getRoleForType(
+        ObjectType cType
+    ) public pure override returns (RoleId role) {
+        if (cType == PRODUCT()) {
+            return PRODUCT_OWNER_ROLE();
+        }
+        if (cType == POOL()) {
+            return POOL_OWNER_ROLE();
+        }
+        if (cType == ORACLE()) {
+            return ORACLE_OWNER_ROLE();
+        }
+    }
+
+    function register(
+        IBaseComponent component
+    ) external override returns (NftId nftId) {
+        address initialOwner = component.getOwner();
+        require(
+            msg.sender == address(component),
+            "ERROR:COS-003:NOT_COMPONENT"
+        );
+
+        IInstance instance = component.getInstance();
+        ObjectType objectType = component.getType();
+        RoleId typeRole = getRoleForType(objectType);
+        require(
+            instance.hasRole(typeRole, initialOwner),
+            "ERROR:CMP-004:TYPE_ROLE_MISSING"
+        );
+
+        nftId = _registry.register(address(component));
+        IERC20Metadata token = component.getToken();
+
+        instance.registerComponent(
+            nftId,
+            token,
+            component.getWallet()); 
+
+        // component type specific registration actions
+        if (component.getType() == PRODUCT()) {
+            IProductComponent product = IProductComponent(address(component));
+            NftId poolNftId = product.getPoolNftId();
+            require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
+            IPoolComponent pool = IPoolComponent(_registry.getObjectInfo(poolNftId).objectAddress);
+
+            // register with tresury
+            // implement and add validation
+            NftId distributorNftId = zeroNftId();
+            instance.registerProductSetup(
+                nftId,
+                distributorNftId,
+                poolNftId,
+                token,
+                product.getPolicyFee(),
+                product.getProcessingFee(),
+                pool.getStakingFee(),
+                pool.getPerformanceFee()
+            );
+        } else if (component.getType() == POOL()) {
+            IPoolComponent pool = IPoolComponent(address(component));
+
+            // register with pool
+            instance.registerPool(
+                nftId,
+                pool.isVerifying(),
+                pool.getCollateralizationLevel());
+        }
+        // TODO add compensation
+    }
+
+    function lock(
+        IBaseComponent component
+    ) external override onlyRegisteredComponent(component) {
+        // TODO use msg.sender to get component and get instance via registered parent nft id
+        IInstance instance = component.getInstance();
+        NftId nftId = component.getNftId();
+        Key32 key = nftId.toKey32(COMPONENT());
+        instance.updateState(key, PAUSED());
+    }
+
+    function unlock(
+        IBaseComponent component
+    ) external override onlyRegisteredComponent(component) {
+        // TODO use msg.sender to get component and get instance via registered parent nft id
+        IInstance instance = component.getInstance();
+        NftId nftId = component.getNftId();
+        Key32 key = nftId.toKey32(COMPONENT());
+        instance.updateState(key, ACTIVE());
+    }
+}

package/contracts/instance/service/IComponentOwnerService.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {RoleId} from "../../types/RoleId.sol";
+import {IBaseComponent} from "../../components/IBaseComponent.sol";
+import {IService} from "../base/IService.sol";
+
+// TODO rename to registry service
+interface IComponentOwnerService is IService {
+
+    function register(IBaseComponent component) external returns(NftId componentNftId);
+
+    // TODO move to product/pool services
+    function lock(IBaseComponent component) external;
+
+    // TODO move to product/pool services
+    function unlock(IBaseComponent component) external;
+
+    function getRoleForType(ObjectType cType) external pure returns (RoleId role);
+}

package/contracts/instance/service/IPoolService.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {IService} from "../base/IService.sol";
+
+interface IPoolService is IService {
+    function setFees(
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    function createBundle(
+        address owner,
+        uint256 amount,
+        uint256 lifetime, 
+        bytes calldata filter
+    ) external returns(NftId bundleNftId);
+
+    // function fundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    // function defundBundle(NftId bundleNftId, uint256 amount) external returns(uint256 netAmount);
+
+    // function lockBundle(NftId bundleNftId) external;
+
+    // function unlockBundle(NftId bundleNftId) external;
+
+    // function closeBundle(NftId bundleNftId) external;
+}

package/contracts/instance/service/IProductService.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../../types/NftId.sol";
+import {Timestamp} from "../../types/Timestamp.sol";
+import {UFixed} from "../../types/UFixed.sol";
+import {Fee} from "../../types/Fee.sol";
+import {IService} from "../base/IService.sol";
+
+interface IProductService is IService {
+    function setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
+
+    function createApplication(
+        address applicationOwner,
+        uint256 sumInsuredAmount,
+        uint256 premiumAmount,
+        uint256 lifetime,
+        NftId bundleNftId
+    ) external returns (NftId nftId);
+
+    // function revoke(unit256 nftId) external;
+
+    /**
+     * @dev underwrites the policy represented by {policyNftId}.
+     * optionally collects premiums and activates the policy.
+     * - premium payment is only attempted if requirePremiumPayment is set to true
+     * - activation is only done if activateAt is a non-zero timestamp
+     */
+    function underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    ) external;
+
+    // function decline(uint256 nftId) external;
+    // function expire(uint256 nftId) external;
+
+    function collectPremium(NftId nftId, Timestamp activateAt) external;
+
+    function activate(NftId nftId, Timestamp activateAt) external;
+
+
+    function close(NftId nftId) external;
+
+    // function createClaim(uint256 nftId, uint256 claimAmount) external;
+    // function confirmClaim(uint256 nftId, uint256 claimId, uint256 claimAmount) external;
+    // function declineClaim(uint256 nftId, uint256 claimId) external;
+    // function closeClaim(uint256 nftId, uint256 claimId) external;
+
+    function calculateRequiredCollateral(
+        UFixed collateralizationLevel, 
+        uint256 sumInsuredAmount
+    ) external pure returns(uint256 collateralAmount);
+
+}