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

package/contracts/instance/service/PoolService.sol

@@ -0,0 +1,129 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {POOL, BUNDLE} from "../../types/ObjectType.sol";
+import {Fee} from "../../types/Fee.sol";
+import {Version, VersionLib} from "../../types/Version.sol";
+
+import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {IPoolService} from "./IPoolService.sol";
+
+
+contract PoolService is ComponentServiceBase, IPoolService {
+    using NftIdLib for NftId;
+
+    string public constant NAME = "PoolService";
+
+    constructor(
+        address registry,
+        NftId registryNftId
+    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+    {
+        _registerInterface(type(IPoolService).interfaceId);
+    }
+
+    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 setFees(
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+
+        NftId productNftId = instance.getProductNftId(poolInfo.nftId);
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
+        treasuryInfo.stakingFee = stakingFee;
+        treasuryInfo.performanceFee = performanceFee;
+        instance.setTreasuryInfo(productNftId, treasuryInfo);
+    }
+
+    function createBundle(
+        address owner, 
+        uint256 stakingAmount, 
+        uint256 lifetime, 
+        bytes calldata filter
+    )
+        external
+        override
+        returns(NftId bundleNftId)
+    {
+        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
+
+        // register bundle with registry
+        NftId poolNftId = info.nftId;
+        bundleNftId = _registry.registerObjectForInstance(
+            poolNftId, 
+            BUNDLE(), 
+            owner,
+            "");
+
+        // create bundle info in instance
+        instance.createBundleInfo(
+            bundleNftId,
+            poolNftId,
+            stakingAmount,
+            lifetime,
+            filter);
+
+        // add bundle to pool in instance
+        instance.addBundleToPool(
+            bundleNftId,
+            poolNftId,
+            stakingAmount);
+
+        // collect capital
+        _processStakingByTreasury(
+            instance,
+            poolNftId,
+            bundleNftId,
+            stakingAmount);
+
+        // TODO add logging
+    }
+
+
+    function _processStakingByTreasury(
+        IInstance instance,
+        NftId poolNftId,
+        NftId bundleNftId,
+        uint256 stakingAmount
+    )
+        internal
+    {
+        // process token transfer(s)
+        if(stakingAmount > 0) {
+            NftId productNftId = instance.getProductNftId(poolNftId);
+            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
+            address bundleOwner = _registry.getOwner(bundleNftId);
+            address poolWallet = instance.getComponentWallet(poolNftId);
+
+            tokenHandler.transfer(
+                bundleOwner,
+                poolWallet,
+                stakingAmount
+            );
+        }
+    }
+}

package/contracts/instance/service/ProductService.sol

@@ -0,0 +1,366 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+import {IPoolComponent} from "../../components/IPoolComponent.sol";
+import {IInstance} from "../../instance/IInstance.sol";
+import {IPolicy, IPolicyModule} from "../module/policy/IPolicy.sol";
+import {IPool} from "../module/pool/IPoolModule.sol";
+import {IBundle} from "../module/bundle/IBundle.sol";
+import {IProductService} from "./IProductService.sol";
+import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
+
+import {IVersionable} from "../../shared/IVersionable.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+
+import {Timestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+import {UFixed, UFixedMathLib} from "../../types/UFixed.sol";
+import {ObjectType, INSTANCE, PRODUCT, POLICY} from "../../types/ObjectType.sol";
+import {APPLIED, UNDERWRITTEN, ACTIVE} from "../../types/StateId.sol";
+import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
+import {Fee, FeeLib} from "../../types/Fee.sol";
+import {Version, VersionLib} from "../../types/Version.sol";
+
+import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
+import {IProductService} from "./IProductService.sol";
+
+// TODO or name this ProtectionService to have Product be something more generic (loan, savings account, ...)
+contract ProductService is ComponentServiceBase, IProductService {
+    using NftIdLib for NftId;
+
+    string public constant NAME = "ProductService";
+
+    event LogProductServiceSender(address sender);
+
+    constructor(
+        address registry,
+        NftId registryNftId
+    ) ComponentServiceBase(registry, registryNftId) // solhint-disable-next-line no-empty-blocks
+    {
+        _registerInterface(type(IProductService).interfaceId);
+    }
+
+    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 setFees(
+        Fee memory policyFee,
+        Fee memory processingFee
+    )
+        external
+        override
+    {
+        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        NftId productNftId = productInfo.nftId;
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productNftId);
+        treasuryInfo.policyFee = policyFee;
+        treasuryInfo.processingFee = processingFee;
+        instance.setTreasuryInfo(productNftId, treasuryInfo);
+    }
+
+    function createApplication(
+        address applicationOwner,
+        uint256 sumInsuredAmount,
+        uint256 premiumAmount,
+        uint256 lifetime,
+        NftId bundleNftId
+    ) external override returns (NftId policyNftId) {
+        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+        NftId productNftId = productInfo.nftId;
+        // TODO add validations (see create bundle in pool service)
+
+        policyNftId = this.getRegistry().registerObjectForInstance(
+            productNftId,
+            POLICY(),
+            applicationOwner,
+            ""
+        );
+
+        instance.createPolicyInfo(
+            policyNftId,
+            productNftId,
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            bundleNftId
+        );
+
+        // TODO add logging
+    }
+
+    function _getAndVerifyUnderwritingSetup(
+        IInstance instance,
+        IPolicy.PolicyInfo memory policyInfo
+    )
+        internal
+        view
+        returns (
+            ITreasury.TreasuryInfo memory treasuryInfo,
+            NftId bundleNftId,
+            IBundle.BundleInfo memory bundleInfo,
+            uint256 collateralAmount
+        )
+    {
+        // check match between policy and bundle (via pool)
+        treasuryInfo = instance.getTreasuryInfo(policyInfo.productNftId);
+        bundleNftId = policyInfo.bundleNftId;
+        bundleInfo = instance.getBundleInfo(bundleNftId);
+        require(bundleInfo.poolNftId == treasuryInfo.poolNftId, "POLICY_BUNDLE_MISMATCH");
+
+        // calculate required collateral
+        NftId poolNftId = treasuryInfo.poolNftId;
+        IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
+
+        // obtain remaining return values
+        collateralAmount = calculateRequiredCollateral(poolInfo.collateralizationLevel, policyInfo.sumInsuredAmount);
+    }
+
+    function _lockCollateralInBundle(
+        IInstance instance,
+        NftId bundleNftId, 
+        IBundle.BundleInfo memory bundleInfo,
+        NftId policyNftId, 
+        uint256 collateralAmount
+    )
+        internal
+        returns (IBundle.BundleInfo memory)
+    {
+        bundleInfo.lockedAmount += collateralAmount;
+        instance.collateralizePolicy(bundleNftId, policyNftId, collateralAmount);
+        return bundleInfo;
+    }
+
+    function _underwriteByPool(
+        ITreasury.TreasuryInfo memory treasuryInfo,
+        NftId policyNftId,
+        IPolicy.PolicyInfo memory policyInfo,
+        bytes memory bundleFilter,
+        uint256 collateralAmount
+    )
+        internal
+    {
+        address poolAddress = _registry.getObjectInfo(treasuryInfo.poolNftId).objectAddress;
+        IPoolComponent pool = IPoolComponent(poolAddress);
+        pool.underwrite(
+            policyNftId, 
+            policyInfo.applicationData, 
+            bundleFilter,
+            collateralAmount);
+    }
+
+
+    function underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        external 
+        override
+    {
+        // check caller is registered product
+        (
+            IRegistry.ObjectInfo memory productInfo, 
+            IInstance instance
+        ) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+
+        // check match between policy and calling product
+        NftId productNftId = productInfo.nftId;
+        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
+        require(policyInfo.productNftId == productNftId, "POLICY_PRODUCT_MISMATCH");
+        require(instance.getPolicyState(policyNftId) == APPLIED(), "ERROR:PRS-021:STATE_NOT_APPLIED");
+
+        ITreasury.TreasuryInfo memory treasuryInfo;
+        NftId bundleNftId;
+        IBundle.BundleInfo memory bundleInfo;
+        uint256 collateralAmount;
+
+        (
+            treasuryInfo,
+            bundleNftId,
+            bundleInfo,
+            collateralAmount
+        ) = _getAndVerifyUnderwritingSetup(
+            instance,
+            policyInfo
+        );
+
+        // lock bundle collateral
+        bundleInfo = _lockCollateralInBundle(
+            instance,
+            bundleNftId,
+            bundleInfo,
+            policyNftId, 
+            collateralAmount);
+
+        // set policy state to underwritten
+        instance.updatePolicyState(policyNftId, UNDERWRITTEN());
+
+        // optional activation of policy
+        if(activateAt > zeroTimestamp()) {
+            policyInfo.activatedAt = activateAt;
+            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+
+            instance.updatePolicyState(policyNftId, ACTIVE());
+        }
+
+        // optional collection of premium
+        if(requirePremiumPayment) {
+            uint256 netPremiumAmount = _processPremiumByTreasury(
+                instance, 
+                productInfo.nftId,
+                treasuryInfo, 
+                policyNftId, 
+                policyInfo.premiumAmount);
+
+            policyInfo.premiumPaidAmount += policyInfo.premiumAmount;
+            bundleInfo.balanceAmount += netPremiumAmount;
+        }
+
+        instance.setPolicyInfo(policyNftId, policyInfo);
+        instance.setBundleInfo(bundleNftId, bundleInfo);
+
+        // involve pool if necessary
+        {
+            NftId poolNftId = treasuryInfo.poolNftId;
+            IPool.PoolInfo memory poolInfo = instance.getPoolInfo(poolNftId);
+
+            if(poolInfo.isVerifying) {
+                _underwriteByPool(
+                    treasuryInfo,
+                    policyNftId,
+                    policyInfo,
+                    bundleInfo.filter,
+                    collateralAmount
+                );
+            }
+        }
+
+        // TODO add logging
+    }
+
+    function calculateRequiredCollateral(UFixed collateralizationLevel, uint256 sumInsuredAmount) public pure override returns(uint256 collateralAmount) {
+        UFixed sumInsuredUFixed = UFixedMathLib.toUFixed(sumInsuredAmount);
+        UFixed collateralUFixed =  collateralizationLevel * sumInsuredUFixed;
+        return collateralUFixed.toInt();
+    } 
+
+    function collectPremium(NftId policyNftId, Timestamp activateAt) external override {
+        // check caller is registered product
+        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+
+        // perform actual token transfers
+        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
+        ITreasury.TreasuryInfo memory treasuryInfo = instance.getTreasuryInfo(productInfo.nftId);
+
+        uint256 premiumAmount = policyInfo.premiumAmount;
+        _processPremiumByTreasury(instance, productInfo.nftId, treasuryInfo, policyNftId, premiumAmount);
+
+        // policy level book keeping for premium paid
+        policyInfo.premiumPaidAmount += premiumAmount;
+
+        // optional activation of policy
+        if(activateAt > zeroTimestamp()) {
+            require(
+                policyInfo.activatedAt.eqz(),
+                "ERROR:PRS-030:ALREADY_ACTIVATED");
+
+            policyInfo.activatedAt = activateAt;
+            policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+
+            instance.updatePolicyState(policyNftId, ACTIVE());
+        }
+
+        instance.setPolicyInfo(policyNftId, policyInfo);
+
+        // TODO add logging
+    }
+
+    function activate(NftId policyNftId, Timestamp activateAt) external override {
+        // check caller is registered product
+        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
+
+        IPolicy.PolicyInfo memory policyInfo = instance.getPolicyInfo(policyNftId);
+
+        require(
+            policyInfo.activatedAt.eqz(),
+            "ERROR:PRS-020:ALREADY_ACTIVATED");
+
+        policyInfo.activatedAt = activateAt;
+        policyInfo.expiredAt = activateAt.addSeconds(policyInfo.lifetime);
+
+        instance.setPolicyInfo(policyNftId, policyInfo);
+        instance.updatePolicyState(policyNftId, ACTIVE());
+
+        // TODO add logging
+    }
+
+    function close(
+        NftId policyNftId
+    ) external override // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
+
+    function _getPoolNftId(
+        IInstance instance,
+        NftId productNftId
+    )
+        internal
+        view
+        returns (NftId poolNftid)
+    {
+        return instance.getTreasuryInfo(productNftId).poolNftId;
+    }
+
+
+    function _processPremiumByTreasury(
+        IInstance instance,
+        NftId productNftId,
+        ITreasury.TreasuryInfo memory treasuryInfo,
+        NftId policyNftId,
+        uint256 premiumAmount
+    )
+        internal
+        returns (uint256 netPremiumAmount)
+    {
+        // process token transfer(s)
+        if(premiumAmount > 0) {
+            TokenHandler tokenHandler = instance.getTokenHandler(productNftId);
+            address policyOwner = _registry.getOwner(policyNftId);
+            address poolWallet = instance.getComponentWallet(treasuryInfo.poolNftId);
+            netPremiumAmount = premiumAmount;
+            Fee memory policyFee = treasuryInfo.policyFee;
+
+            if (FeeLib.feeIsZero(policyFee)) {
+                tokenHandler.transfer(
+                    policyOwner,
+                    poolWallet,
+                    premiumAmount
+                );
+            } else {
+                (uint256 feeAmount, uint256 netAmount) = instance.calculateFeeAmount(
+                    premiumAmount,
+                    policyFee
+                );
+
+                address productWallet = instance.getComponentWallet(productNftId);
+                tokenHandler.transfer(policyOwner, productWallet, feeAmount);
+                tokenHandler.transfer(policyOwner, poolWallet, netAmount);
+                netPremiumAmount = netAmount;
+            }
+        }
+
+        // TODO add logging
+    }
+}

package/contracts/registry/ChainNft.sol

@@ -8,6 +8,9 @@ contract ChainNft is ERC721Enumerable, IChainNft {
     string public constant NAME = "Dezentralized Insurance Protocol Registry";
     string public constant SYMBOL = "DIPR";
 
+    uint256 public constant PROTOCOL_NFT_ID = 1101;
+    uint256 public constant GLOBAL_REGISTRY_ID = 2101;
+
     // remember token uri
     mapping(uint256 tokenId => string uri) private _uri;
 
@@ -34,27 +37,34 @@ contract ChainNft is ERC721Enumerable, IChainNft {
         _chainIdInt = block.chainid;
         _chainIdDigits = _countDigits(_chainIdInt);
         _chainIdMultiplier = 10 ** _chainIdDigits;
-
-        // on mainnet/goerli start /1 (reserved for protocol nft) on other chains with 2
-        if (block.chainid == 1 || block.chainid == 5) {
-            _idNext = 1;
-        } else {
-            _idNext = 2;
-        }
+        _idNext = 3;
     }
 
+    /**
+    * @dev mints the next token to register new objects
+    */
     function mint(
         address to,
         string memory uri
     ) external override onlyRegistry returns (uint256 tokenId) {
         tokenId = _getNextTokenId();
-        _totalMinted++;
-
-        _safeMint(to, tokenId);
 
         if (bytes(uri).length > 0) {
             _uri[tokenId] = uri;
         }
+
+        _safeMint(to, tokenId);
+        _totalMinted++;
+    }
+
+    /**
+    * @dev mints a token for a specified token id
+    * not part of the IRegistry interface only needed for
+    * initial registry setup (protocol and global registry objects)
+    */
+    function mint(address to, uint256 tokenId) external onlyRegistry {
+        _totalMinted++;
+        _safeMint(to, tokenId);
     }
 
     function burn(uint256 tokenId) external override onlyRegistry {
@@ -92,36 +102,50 @@ contract ChainNft is ERC721Enumerable, IChainNft {
         return _totalMinted;
     }
 
-    // requirement: each chain registry produces token ids that
-    // are guaranteed to not collide with any token id genereated
-    // on a different chain
-    //
-    // format concat(counter,chainid,2 digits for len-of-chain-id)
-    // restriction chainid up to 99 digits
-    // decode: from right to left:
-    // - 2 right most digits encode length of chainid
-    // - move number of digits to left as determined above (-> chainid)
-    // - the reminder to the left is the counter
-    // examples
-    // 1101
-    // ^^ ^
-    // || +- 1-digit chain id
-    // |+-- chain id = 1 (mainnet)
-    // +-- 1st token id on mainnet
-    // (1 * 10 ** 1 + 1) * 100 + 1
-    // 42987654321010
-    // ^ ^          ^
-    // | |          +- 10-digit chain id
-    // | +-- chain id = 9876543210 (hypothetical chainid)
-    // +-- 42nd token id on this chain
-    // (42 * 10 ** 10 + 9876543210) * 100 + 10
-    // (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
-
-    function _getNextTokenId() private returns (uint256 id) {
+    /**
+    * @dev token id calculation based on an index value that is supposed
+    * to increase with every minted token
+    *
+    * requirement: each chain registry produces token ids that
+    * are guaranteed to not collide with any token id genereated
+    * on a different chain
+    *
+    * format concat(counter,chainid,2 digits for len-of-chain-id)
+    * restriction chainid up to 99 digits
+    * decode: from right to left:
+    * - 2 right most digits encode length of chainid
+    * - move number of digits to left as determined above (-> chainid)
+    * - the reminder to the left is the counter
+    *
+    * special cases
+    * 1101 -> decentralized insurance protocol
+    * 2102 -> global registry
+    * 2xxxxx -> chain registry, where xxxxx = <chain-part> 
+    *
+    * examples
+    * 1101
+    * ^^ ^
+    * || +- 1-digit chain id
+    * |+-- chain id = 1 (mainnet)
+    * +-- 1st token id on mainnet
+    * (1 * 10 ** 1 + 1) * 100 + 1
+    * 42987654321010
+    * ^ ^          ^
+    * | |          +- 10-digit chain id
+    * | +-- chain id = 9876543210 (hypothetical chainid)
+    * +-- 42nd token id on this chain
+    * (42 * 10 ** 10 + 9876543210) * 100 + 10
+    * (index * 10 ** digits + chainid) * 100 + digits (1 < digits < 100)
+    */
+    function calculateTokenId(uint256 idIndex) public view returns (uint256 id) {
         id =
-            (_idNext * _chainIdMultiplier + _chainIdInt) *
+            (idIndex * _chainIdMultiplier + _chainIdInt) *
             100 +
             _chainIdDigits;
+    }
+
+    function _getNextTokenId() private returns (uint256 id) {
+        id = calculateTokenId(_idNext);
         _idNext++;
     }