@etherisc/gif-next 0.0.2-b9366f5-670 → 0.0.2-b98b2b0-875

package/contracts/product/PolicyService.sol

@@ -21,6 +21,7 @@ import {StateId} from "../type/StateId.sol";
 import {VersionPart} from "../type/Version.sol";
 
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IApplicationService} from "./IApplicationService.sol";
 import {IBundleService} from "../pool/IBundleService.sol";
 import {IClaimService} from "./IClaimService.sol";
@@ -28,6 +29,7 @@ import {IComponentService} from "../shared/IComponentService.sol";
 import {IDistributionService} from "../distribution/IDistributionService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
+import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 import {IPricingService} from "./IPricingService.sol";
@@ -56,12 +58,11 @@ contract PolicyService is
         initializer
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         VersionPart majorVersion = getVersion().toMajorPart();
         _applicationService = IApplicationService(getRegistry().getServiceAddress(APPLICATION(), majorVersion));
@@ -72,7 +73,7 @@ contract PolicyService is
         _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), majorVersion));
         _pricingService = IPricingService(getRegistry().getServiceAddress(PRICE(), majorVersion));
 
-        registerInterface(type(IPolicyService).interfaceId);
+        _registerInterface(type(IPolicyService).interfaceId);
     }
 
 
@@ -80,7 +81,8 @@ contract PolicyService is
         NftId applicationNftId // = policyNftId
     )
         external
-        virtual override
+        virtual
+        nonReentrant()
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -115,7 +117,8 @@ contract PolicyService is
         Timestamp activateAt
     )
         external 
-        virtual override
+        virtual
+        nonReentrant()
     {
         // check caller is registered product
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -175,16 +178,21 @@ contract PolicyService is
         // update referral counter 
         {
             IComponents.ProductInfo memory productInfo = instanceReader.getProductInfo(productNftId);
-            _distributionService.processReferral(
-                productInfo.distributionNftId, 
-                applicationInfo.referralId);
+
+            if (! productInfo.distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product    
+                _distributionService.processReferral(
+                    productInfo.distributionNftId, 
+                    applicationInfo.referralId);
+            }
         }
-        
-        // TODO add calling pool contract if it needs to validate application
 
-        // TODO: add logging
+        // log policy creation before interactions with token and policy holder
+        emit LogPolicyServicePolicyCreated(applicationNftId, premium.premiumAmount, activateAt);
+
+        // TODO add calling pool contract if it needs to validate application
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(applicationNftId, activateAt);
     }
 
 
@@ -195,6 +203,7 @@ contract PolicyService is
     )
         external 
         virtual
+        nonReentrant()
     {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
@@ -228,15 +237,18 @@ contract PolicyService is
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
         instance.getInstanceStore().updatePremiumState(policyNftId, PAID());
 
-        // TODO: add logging
+        // log premium collection before interactions with token
+        emit LogPolicyServicePolicyPremiumCollected(policyNftId, premium.premiumAmount);
 
         _transferFunds(instanceReader, policyNftId, policyInfo.productNftId, premium);
-
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
     }
 
     /// @inheritdoc IPolicyService
-    function activate(NftId policyNftId, Timestamp activateAt) public override {
+    function activate(NftId policyNftId, Timestamp activateAt)
+        external
+        virtual
+        nonReentrant()
+    {
         // check caller is registered product
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -246,9 +258,11 @@ contract PolicyService is
 
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        // TODO: add logging
+        // log policy activation before interactions with policy holder
+        emit LogPolicyServicePolicyActivated(policyNftId, activateAt);
 
-        // TODO: add callback IPolicyHolder.policyActivated() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyActivated(policyNftId, activateAt);
     }
 
 
@@ -258,15 +272,14 @@ contract PolicyService is
         Timestamp expireAt
     )
         external
-        override
         virtual
+        nonReentrant()
         returns (Timestamp expiredAt)
     {
         (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
-        InstanceReader instanceReader = instance.getInstanceReader();
-
+        
         // check policy matches with calling product
-        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if(policyInfo.productNftId != productNftId) {
             revert ErrorPolicyServicePolicyProductMismatch(
                 policyNftId, 
@@ -274,8 +287,44 @@ contract PolicyService is
                 productNftId);
         }
 
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    /// @inheritdoc IPolicyService
+    function expirePolicy(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        external
+        virtual
+        nonReentrant()
+        returns (Timestamp expiredAt)
+    {
+        return _expire(
+            instance,
+            policyNftId,
+            expireAt
+        );
+    }
+
+    function _expire(
+        IInstance instance,
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        internal
+        returns (Timestamp expiredAt)
+    {
+        InstanceReader instanceReader = instance.getInstanceReader();
+        
         // check policy is active
         StateId policyState = instanceReader.getPolicyState(policyNftId);
+        IPolicy.PolicyInfo memory policyInfo = instance.getInstanceReader().getPolicyInfo(policyNftId);
         if (!_policyHasBeenActivated(policyState, policyInfo)) {
             revert ErrorPolicyServicePolicyNotActive(policyNftId, policyState);
         }
@@ -297,12 +346,14 @@ contract PolicyService is
         }
 
         // update policyInfo with new expiredAt timestamp
+        Timestamp originalExpiredAt = policyInfo.expiredAt;
         policyInfo.expiredAt = expiredAt;
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
 
-        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, expiredAt);
+        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, originalExpiredAt, expiredAt);
 
-        // TODO: add callback IPolicyHolder.policyExpired() if applicable
+        // callback to policy holder if applicable
+        _policyHolderPolicyExpired(policyNftId, expiredAt);
     }
 
 
@@ -310,7 +361,8 @@ contract PolicyService is
         NftId policyNftId
     )
         external 
-        override
+        virtual
+        nonReentrant()
     {
         (,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
         InstanceReader instanceReader = instance.getInstanceReader();
@@ -351,7 +403,7 @@ contract PolicyService is
         policyInfo.closedAt = TimestampLib.blockTimestamp();
         instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, CLOSED());
 
-        // TODO add logging
+        emit LogPolicyServicePolicyClosed(policyNftId);
     }
 
 
@@ -439,10 +491,12 @@ contract PolicyService is
             premium.productFeeVarAmount + premium.productFeeFixAmount);
 
         // update distribution fees and distributor commission and pool fees 
-        _distributionService.processSale(
-            distributionNftId, 
-            referralId, 
-            premium);
+        if (!distributionNftId.eqz()) { // only call distribution service if a distribution component is connected to the product
+            _distributionService.processSale(
+                distributionNftId, 
+                referralId, 
+                premium);
+        }
 
         // update pool and bundle fees 
         _poolService.processSale(
@@ -525,6 +579,64 @@ contract PolicyService is
     }
 
 
+    function _policyHolderPolicyActivated(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (activateAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyActivated(policyNftId, activateAt);
+        }
+    }
+
+
+    function _policyHolderPolicyExpired(
+        NftId policyNftId,
+        Timestamp expiredAt
+    )
+        internal
+        virtual
+    {
+        // immediately return if policy is not activated
+        if (expiredAt.eqz()) {
+            return;
+        }
+
+        // get policy holder address
+        IPolicyHolder policyHolder = _getPolicyHolder(policyNftId);
+
+        // execute callback if policy holder implements IPolicyHolder
+        if (address(policyHolder) != address(0)) {
+            policyHolder.policyExpired(policyNftId, expiredAt);
+        }
+    }
+
+
+    function _getPolicyHolder(NftId policyNftId)
+        internal 
+        view 
+        returns (IPolicyHolder policyHolder)
+    {
+        address policyHolderAddress = getRegistry().ownerOf(policyNftId);
+        policyHolder = IPolicyHolder(policyHolderAddress);
+
+        if (!ContractLib.isPolicyHolder(policyHolderAddress)) {
+            policyHolder = IPolicyHolder(address(0));
+        }
+    }
+
+
     function _getTokenHandler(
         InstanceReader instanceReader,
         NftId productNftId
@@ -539,6 +651,7 @@ contract PolicyService is
         tokenHandler = instanceReader.getComponentInfo(productNftId).tokenHandler;
     }
 
+
     function _getDistributionNftAndWallets(
         InstanceReader instanceReader,
         NftId productNftId

package/contracts/product/PolicyServiceManager.sol

@@ -12,14 +12,14 @@ contract PolicyServiceManager is ProxyManager {
     /// @dev initializes proxy manager with product service implementation 
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
         PolicyService svc = new PolicyService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);

package/contracts/product/PricingService.sol

@@ -45,13 +45,12 @@ contract PricingService is
         initializer()
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress, 
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
-        registerInterface(type(IPricingService).interfaceId);
+        _initializeService(registryAddress, authority, owner);
+        _registerInterface(type(IPricingService).interfaceId);
 
         _distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION()));
     }

package/contracts/product/PricingServiceManager.sol

@@ -15,11 +15,11 @@ contract PricingServiceManager is ProxyManager {
         address registryAddress,
         bytes32 salt
     )
-        ProxyManager(registryAddress)
     {
         PricingService pricingSrv = new PricingService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registryAddress, authority);
+        IVersionable versionable = initialize(
+            registryAddress,
             address(pricingSrv), 
             data,
             salt);

package/contracts/product/Product.sol

@@ -49,6 +49,29 @@ abstract contract Product is
     }
 
 
+    function register()
+        external
+        virtual
+        onlyOwner()
+    {
+        _getProductStorage()._componentService.registerProduct();
+        _approveTokenHandler(type(uint256).max);
+    }
+
+
+    function processFundedClaim(
+        NftId policyNftId, 
+        ClaimId claimId, 
+        Amount availableAmount
+    )
+        external
+        virtual
+        restricted() // pool service role
+    {
+        // default implementation does nothing
+    }
+
+
     function calculatePremium(
         Amount sumInsuredAmount,
         RiskId riskId,
@@ -91,16 +114,6 @@ abstract contract Product is
     }
 
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getProductStorage()._componentService.registerProduct();
-        _approveTokenHandler(type(uint256).max);
-    }
-
-
     function getInitialProductInfo()
         public 
         virtual 
@@ -112,6 +125,7 @@ abstract contract Product is
         return IComponents.ProductInfo({
             distributionNftId: $._distributionNftId,
             poolNftId: $._poolNftId,
+            isProcessingFundedClaims: false,
             productFee: FeeLib.zero(),
             processingFee: FeeLib.zero(),
             distributionFee: FeeLib.zero(),
@@ -122,13 +136,6 @@ abstract contract Product is
         });
     }
 
-    function getPoolNftId() external view override returns (NftId poolNftId) {
-        return getRegistry().getNftIdForAddress(address(_getProductStorage()._pool));
-    }
-
-    function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return getRegistry().getNftIdForAddress(address(_getProductStorage()._distribution));
-    }
 
     function _initializeProduct(
         address registry,
@@ -174,7 +181,7 @@ abstract contract Product is
         $._poolNftId = getRegistry().getNftIdForAddress(pool);
         $._distributionNftId = getRegistry().getNftIdForAddress(distribution);
 
-        registerInterface(type(IProductComponent).interfaceId);  
+        _registerInterface(type(IProductComponent).interfaceId);  
     }
 
 
@@ -413,7 +420,7 @@ abstract contract Product is
         return RiskIdLib.toRiskId(riskName);
     }
 
-    function _getProductStorage() private pure returns (ProductStorage storage $) {
+    function _getProductStorage() internal pure returns (ProductStorage storage $) {
         assembly {
             $.slot := PRODUCT_STORAGE_LOCATION_V1
         }

package/contracts/product/RiskService.sol

@@ -33,18 +33,17 @@ contract RiskService is
         virtual override
     {
         (
-            address registryAddress,, 
-            //address managerAddress
+            address registryAddress,
             address authority
-        ) = abi.decode(data, (address, address, address));
+        ) = abi.decode(data, (address, address));
 
-        initializeService(registryAddress, authority, owner);
+        _initializeService(registryAddress, authority, owner);
 
         _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
         _poolService = IPoolService(getRegistry().getServiceAddress(POOL(), getVersion().toMajorPart()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
 
-        registerInterface(type(IRiskService).interfaceId);
+        _registerInterface(type(IRiskService).interfaceId);
     }
 
 

package/contracts/product/RiskServiceManager.sol

@@ -12,14 +12,14 @@ contract RiskServiceManager is ProxyManager {
     /// @dev initializes proxy manager with product service implementation 
     constructor(
         address authority, 
-        address registryAddress,
+        address registry,
         bytes32 salt
     ) 
-        ProxyManager(registryAddress)
     {
         RiskService svc = new RiskService{salt: salt}();
-        bytes memory data = abi.encode(registryAddress, address(this), authority);
-        IVersionable versionable = deployDetermenistic(
+        bytes memory data = abi.encode(registry, authority);
+        IVersionable versionable = initialize(
+            registry,
             address(svc), 
             data,
             salt);

package/contracts/registry/ChainNft.sol

@@ -8,6 +8,8 @@ import {ITransferInterceptor} from "./ITransferInterceptor.sol";
 
 contract ChainNft is ERC721Enumerable {
 
+    event LogTokenInterceptorAddress(uint256 tokenId, address interceptor);
+
     // constants
     string public constant NAME = "Dezentralized Insurance Protocol NFT";
     string public constant SYMBOL = "DIPNFT";
@@ -15,12 +17,11 @@ contract ChainNft is ERC721Enumerable {
     uint256 public constant PROTOCOL_NFT_ID = 1101;
     uint256 public constant GLOBAL_REGISTRY_ID = 2101;
 
-    // TODO rename errors to error pattern: CallerNotRegistry -> ErrorCallerNotRegistry etc.
     // custom errors
-    error CallerNotRegistry(address caller);
-    error RegistryAddressZero();
-    error NftUriEmpty();
-    error NftUriAlreadySet();
+    error ErrorChainNftCallerNotRegistry(address caller);
+    error ErrorChainNftRegistryAddressZero();
+    error ErrorChainNftUriEmpty();
+    error ErrorChainNftUriAlreadySet();
 
     // contract state
 
@@ -34,31 +35,25 @@ contract ChainNft is ERC721Enumerable {
     address private _registry;
 
     // only used for _getNextTokenId
-    uint256 internal _chainIdInt;
     uint256 internal _chainIdDigits;
     uint256 internal _chainIdMultiplier;
     uint256 internal _idNext;
     uint256 internal _totalMinted;
 
     modifier onlyRegistry() {
-        if (msg.sender != _registry) { revert CallerNotRegistry(msg.sender); }
+        if (msg.sender != _registry) { revert ErrorChainNftCallerNotRegistry(msg.sender); }
         _;
     }
 
-    constructor(address registry) ERC721(NAME, SYMBOL) {
-        if (registry == address(0)) { revert RegistryAddressZero(); }
+    constructor(address registry)
+        ERC721(NAME, SYMBOL)
+    {
+        if (registry == address(0)) { revert ErrorChainNftRegistryAddressZero(); }
 
+        // NFT contract is deployed by the registry
         _registry = registry;
-        _chainIdInt = block.chainid;
-        _chainIdDigits = 0;
-
-        // count digis
-        uint256 num = _chainIdInt;
-        while (num != 0) {
-            _chainIdDigits++;
-            num /= 10;
-        }
 
+        _chainIdDigits = _calculateChainIdDigits(block.chainid);
         _chainIdMultiplier = 10 ** _chainIdDigits;
 
         // the first object registered through normal registration starts with id 4
@@ -74,12 +69,16 @@ contract ChainNft is ERC721Enumerable {
     * 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 mint(
+        address to, 
+        uint256 tokenId
+    )
+        external
+        onlyRegistry()
+    {
+        _safeMintWithInterceptorAddress(to, tokenId, address(0));
     }
 
-
     /**
     * @dev mints the next token to register new objects
     * non-zero transferInterceptors are recorded and called during nft token transfers.
@@ -89,7 +88,11 @@ contract ChainNft is ERC721Enumerable {
         address to,
         address interceptor,
         string memory uri
-    ) public onlyRegistry returns (uint256 tokenId) {
+    )
+        public
+        onlyRegistry()
+        returns (uint256 tokenId) 
+    {
         tokenId = _getNextTokenId();
 
         if (interceptor != address(0)) {
@@ -100,8 +103,7 @@ contract ChainNft is ERC721Enumerable {
             _uri[tokenId] = uri;
         }
 
-        _totalMinted++;
-        _safeMint(to, tokenId);
+        _safeMintWithInterceptorAddress(to, tokenId, interceptor);
 
         if(interceptor != address(0)) {
             ITransferInterceptor(interceptor).nftMint(to, tokenId);
@@ -132,8 +134,8 @@ contract ChainNft is ERC721Enumerable {
         uint256 tokenId,
         string memory uri
     ) external onlyRegistry {
-        if (bytes(uri).length == 0) { revert NftUriEmpty(); }
-        if (bytes(_uri[tokenId]).length > 0) { revert NftUriAlreadySet(); }
+        if (bytes(uri).length == 0) { revert ErrorChainNftUriEmpty(); }
+        if (bytes(_uri[tokenId]).length > 0) { revert ErrorChainNftUriAlreadySet(); }
 
         _requireOwned(tokenId);
         _uri[tokenId] = uri;
@@ -199,19 +201,50 @@ contract ChainNft is ERC721Enumerable {
     * (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 =
-            (idIndex * _chainIdMultiplier + _chainIdInt) *
-            100 +
-            _chainIdDigits;
+    function calculateTokenId(uint256 idIndex, uint256 chainId) public view returns (uint256 id) {
+        if(chainId == block.chainid) {
+            return 100 * (idIndex * _chainIdMultiplier + chainId) + _chainIdDigits;
+        } else {
+            uint256 chainIdDigits = _calculateChainIdDigits(chainId);
+            return 100 * (idIndex * (10 ** chainIdDigits) + chainId) + chainIdDigits;
+        }
+    }
+
+    function calculateTokenId(uint256 idIndex) public view returns (uint256) {
+        return 100 * (idIndex * _chainIdMultiplier + block.chainid) + _chainIdDigits;
     }
 
     function getNextTokenId() external view returns (uint256) {
         return calculateTokenId(_idNext);
     }
 
+    // ---------------- private functions ----------------- //
+
     function _getNextTokenId() private returns (uint256 id) {
         id = calculateTokenId(_idNext);
         _idNext++;
     }
+
+    function _calculateChainIdDigits(uint256 chainId) private pure returns (uint256) {
+        uint256 num = chainId;
+        uint256 digits = 0;
+        while (num != 0) {
+            digits++;
+            num /= 10;
+        }
+        return digits;
+    }
+
+    function _safeMintWithInterceptorAddress(
+        address to,
+        uint256 tokenId,
+        address interceptor
+    )
+        private
+    {
+        emit LogTokenInterceptorAddress(tokenId, interceptor);
+        
+        _totalMinted++;
+        _safeMint(to, tokenId);
+    }
 }