@etherisc/gif-next 0.0.2-85cbb88-630 → 0.0.2-860ef47-116

package/contracts/product/ClaimService.sol

@@ -1,48 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IRisk} from "../instance/module/IRisk.sol";
-import {IService} from "./IApplicationService.sol";
-
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IProductComponent} from "./IProductComponent.sol";
-import {Product} from "./Product.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
-import {IProductService} from "./IProductService.sol";
-
-import {TokenHandler} from "../shared/TokenHandler.sol";
-
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Versionable} from "../shared/Versionable.sol";
-
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL, APPLICATION, POLICY, CLAIM, BUNDLE} from "../type/ObjectType.sol";
-import {SUBMITTED, ACTIVE, KEEP_STATE, DECLINED, CONFIRMED, CLOSED, PAID} from "../type/StateId.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {ReferralId} from "../type/Referral.sol";
-import {RiskId} from "../type/RiskId.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+import {ObjectType, CLAIM, PRODUCT, POOL} from "../type/ObjectType.sol";
+import {SUBMITTED, KEEP_STATE, DECLINED, CONFIRMED, CLOSED, PAID} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
+import {FeeLib} from "../type/Fee.sol";
 import {StateId} from "../type/StateId.sol";
 import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IBundleService} from "../pool/IBundleService.sol";
 import {IClaimService} from "./IClaimService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
 
 
 contract ClaimService is 
@@ -362,7 +336,8 @@ contract ClaimService is
                 // TODO transfer processing fees to product wallet
                 // TODO inform product to update fee book keeping
             }
-
+            
+            // TODO: centralize token handling (issue #471)
             poolInfo.tokenHandler.transfer(
                 poolInfo.wallet,
                 beneficiary,

package/contracts/product/ClaimServiceManager.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {ClaimService} from "./ClaimService.sol";
 
 contract ClaimServiceManager is ProxyManager {

package/contracts/product/IPolicyService.sol

@@ -34,10 +34,15 @@ interface IPolicyService is IService {
     error ErrorPolicyServicePremiumNotFullyPaid(NftId policyNftId, Amount premiumAmount, Amount premiumPaidAmount);
     error ErrorIPolicyServiceOpenClaims(NftId policyNftId, uint16 openClaimsCount);
     error ErrorIPolicyServicePolicyHasNotExpired(NftId policyNftId, Timestamp expiredAt);
+    error ErrorIPolicyServicePolicyExpirationTooLate(NftId policyNftId, Timestamp upperLimit, Timestamp expiredAt);
+    error ErrorIPolicyServicePolicyExpirationTooEarly(NftId policyNftId, Timestamp lowerLimit, Timestamp expiredAt);
 
     error ErrorPolicyServicePremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount recalculatedPremiumAmount);
     error ErrorPolicyServiceTransferredPremiumMismatch(NftId policyNftId, Amount expectedPremiumAmount, Amount transferredPremiumAmount);
 
+    event LogPolicyServicePolicyDeclined(NftId policyNftId);
+    event LogPolicyServicePolicyExpirationUpdated(NftId policyNftId, Timestamp expiredAt);
+
     /// @dev collateralizes the policy represented by {policyNftId}
     /// sets the policy state to collateralized
     /// may set the policy state to activated and set the activation date
@@ -64,11 +69,12 @@ interface IPolicyService is IService {
     /// to activate a policy it needs to be in underwritten state
     function activate(NftId policyNftId, Timestamp activateAt) external;
 
-    /// @dev expires the specified policy and sets the expiry date in the policy metadata
+    /// @dev expires the specified policy and sets the expiry date in the policy metadata. If expiry date is set to 0, then the earliest possible expiry date (current blocktime) is set
     /// to expire a policy it must be in active state, policies may be expired even when the predefined expiry date is still in the future
     /// a policy can only be closed when it has been expired. in addition, it must not have any open claims
     /// this function can only be called by a product. the policy needs to match with the calling product
-    function expire(NftId policyNftId) external;
+    /// @return expiredAt the effective expiry date
+    function expire(NftId policyNftId, Timestamp expireAt) external returns (Timestamp expiredAt);
 
     /// @dev closes the specified policy and sets the closed data in the policy metadata
     /// a policy can only be closed when it has been expired. in addition, it must not have any open claims

package/contracts/product/IProductComponent.sol

@@ -36,4 +36,5 @@ interface IProductComponent is
 
     /// @dev returns initial pool specific infos for this pool
     function getInitialProductInfo() external view returns (IComponents.ProductInfo memory info);
+    
 }

package/contracts/product/PolicyService.sol

@@ -4,23 +4,16 @@ pragma solidity ^0.8.20;
 import {IRegistry} from "../registry/IRegistry.sol";
 import {Product} from "./Product.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
 
 import {TokenHandler} from "../shared/TokenHandler.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
-import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
 import {ObjectType, APPLICATION, COMPONENT, DISTRIBUTION, PRODUCT, POOL, POLICY, BUNDLE, CLAIM, PRICE} from "../type/ObjectType.sol";
-import {APPLIED, COLLATERALIZED, ACTIVE, KEEP_STATE, CLOSED, DECLINED, CONFIRMED} from "../type/StateId.sol";
+import {APPLIED, COLLATERALIZED, ACTIVE, KEEP_STATE, CLOSED, DECLINED} from "../type/StateId.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {StateId} from "../type/StateId.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -36,8 +29,6 @@ import {InstanceStore} from "../instance/InstanceStore.sol";
 import {IPolicyService} from "./IPolicyService.sol";
 import {IPoolService} from "../pool/IPoolService.sol";
 import {IPricingService} from "./IPricingService.sol";
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
 
 contract PolicyService is
     ComponentVerifyingService, 
@@ -90,15 +81,38 @@ contract PolicyService is
         (, productInfo,) = _getAndVerifyActiveComponent(PRODUCT());
         product = Product(productInfo.objectAddress);
     }
-
+    
 
     function decline(
-        NftId policyNftId
+        NftId applicationNftId // = policyNftId
     )
         external
-        override
+        virtual override
     {
-        revert();
+        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        InstanceReader instanceReader = instance.getInstanceReader();
+
+        // check policy is in state applied
+        if (instanceReader.getPolicyState(applicationNftId) != APPLIED()) {
+            revert ErrorPolicyServicePolicyStateNotApplied(applicationNftId);
+        }
+
+        // check policy matches with calling product
+        IPolicy.PolicyInfo memory applicationInfo = instanceReader.getPolicyInfo(applicationNftId);
+        if(applicationInfo.productNftId != productNftId) {
+            revert ErrorPolicyServicePolicyProductMismatch(
+                applicationNftId, 
+                applicationInfo.productNftId, 
+                productNftId);
+        }
+        
+
+        // store updated policy info
+        instance.getInstanceStore().updatePolicyState(
+            applicationNftId, 
+            DECLINED());
+
+        emit LogPolicyServicePolicyDeclined(applicationNftId);
     }
 
     event LogDebug(uint idx, string message);
@@ -230,15 +244,54 @@ contract PolicyService is
         // TODO: add logging
     }
 
-
+    /// @inheritdoc IPolicyService
     function expire(
-        NftId policyNftId
+        NftId policyNftId,
+        Timestamp expireAt
     )
         external
         override
-        // solhint-disable-next-line no-empty-blocks
+        virtual
+        returns (Timestamp)
     {
-        
+        (NftId productNftId,, IInstance instance) = _getAndVerifyActiveComponent(PRODUCT());
+        InstanceReader instanceReader = instance.getInstanceReader();
+
+        // check policy is in state applied
+        if (instanceReader.getPolicyState(policyNftId) != ACTIVE()) {
+            revert ErrorIPolicyServicePolicyNotActive(policyNftId, instanceReader.getPolicyState(policyNftId));
+        }
+
+        // check policy matches with calling product
+        IPolicy.PolicyInfo memory policyInfo = instanceReader.getPolicyInfo(policyNftId);
+        if(policyInfo.productNftId != productNftId) {
+            revert ErrorPolicyServicePolicyProductMismatch(
+                policyNftId, 
+                policyInfo.productNftId, 
+                productNftId);
+        }
+
+        if (expireAt.eqz()) {
+            expireAt = TimestampLib.blockTimestamp();
+        }
+
+        // check preconditions
+        if (expireAt >= policyInfo.expiredAt) {
+            revert ErrorIPolicyServicePolicyExpirationTooLate(policyNftId, policyInfo.expiredAt, expireAt);
+        }
+        if (expireAt < TimestampLib.blockTimestamp()) {
+            revert ErrorIPolicyServicePolicyExpirationTooEarly(policyNftId, TimestampLib.blockTimestamp(), expireAt);
+        }
+        if (policyInfo.openClaimsCount > 0) {
+            revert ErrorIPolicyServiceOpenClaims(policyNftId, policyInfo.openClaimsCount);
+        }
+
+        policyInfo.expiredAt = expireAt;
+        instance.getInstanceStore().updatePolicy(policyNftId, policyInfo, KEEP_STATE());
+
+        emit LogPolicyServicePolicyExpirationUpdated(policyNftId, expireAt);
+
+        return expireAt;
     }
 
     function close(
@@ -427,6 +480,7 @@ contract PolicyService is
             bundleNftId, 
             premium);
 
+        // TODO: centralize token handling (issue #471)
         // transfer premium amounts to target wallets
         tokenHandler.transfer(policyHolder, productWallet, premium.productFeeAmount);
         tokenHandler.transfer(policyHolder, distributionWallet, premium.distributionFeeAndCommissionAmount);

package/contracts/product/PolicyServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {PolicyService} from "./PolicyService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {VersionLib} from "../type/Version.sol";
 
 contract PolicyServiceManager is ProxyManager {
 

package/contracts/product/PricingServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {PricingService} from "./PricingService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract PricingServiceManager is ProxyManager {
 

package/contracts/product/Product.sol

@@ -102,6 +102,7 @@ abstract contract Product is
         onlyOwner()
     {
         _getProductStorage()._componentService.registerProduct();
+        _approveTokenHandler(type(uint256).max);
     }
 
 
@@ -134,7 +135,6 @@ abstract contract Product is
         return getRegistry().getNftId(address(_getProductStorage()._distribution));
     }
 
-
     function _initializeProduct(
         address registry,
         NftId instanceNftId,
@@ -265,6 +265,25 @@ abstract contract Product is
             activateAt);
     }
 
+    function _decline(
+        NftId policyNftId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.decline(
+            policyNftId);
+    }
+
+    function _expire(
+        NftId policyNftId,
+        Timestamp expireAt
+    )
+        internal
+        returns (Timestamp)
+    {
+        return _getProductStorage()._policyService.expire(policyNftId, expireAt);
+    }
+
     function _collectPremium(
         NftId policyNftId,
         Timestamp activateAt

package/contracts/product/ProductService.sol

@@ -1,45 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IProductComponent} from "./IProductComponent.sol";
-import {Product} from "./Product.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
-import {IPoolComponent} from "../pool/IPoolComponent.sol";
-import {IDistributionComponent} from "../distribution/IDistributionComponent.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
-import {IBundle} from "../instance/module/IBundle.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
+import {IPoolService} from "../pool/PoolService.sol";
 import {IProductService} from "./IProductService.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
-
-import {TokenHandler} from "../shared/TokenHandler.sol";
-
-import {IVersionable} from "../shared/IVersionable.sol";
-import {Versionable} from "../shared/Versionable.sol";
+import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IRisk} from "../instance/module/IRisk.sol";
 
-import {Timestamp, zeroTimestamp} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
 import {ObjectType, INSTANCE, PRODUCT, POOL, POLICY, REGISTRY} from "../type/ObjectType.sol";
-import {APPLIED, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
-import {Fee, FeeLib} from "../type/Fee.sol";
-import {ReferralId} from "../type/Referral.sol";
+import {KEEP_STATE} from "../type/StateId.sol";
+import {NftId} from "../type/NftId.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {StateId} from "../type/StateId.sol";
-import {Version, VersionLib} from "../type/Version.sol";
-import {RoleId, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
-
-import {IService} from "../shared/IService.sol";
-import {Service} from "../shared/Service.sol";
 import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
-import {IProductService} from "./IProductService.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IPoolService} from "../pool/PoolService.sol";
 
 contract ProductService is
     ComponentVerifyingService,

package/contracts/product/ProductServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {ProductService} from "./ProductService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {VersionLib} from "../type/Version.sol";
 
 contract ProductServiceManager is ProxyManager {
 

package/contracts/registry/IRegistry.sol

@@ -7,21 +7,29 @@ import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
 import {Timestamp} from "../type/Timestamp.sol";
-import {RoleId} from "../type/RoleId.sol";
 
+/// @title Chain Registry interface.
+/// A chain registry holds all protocol relevant objects with basic metadata.
+/// Registered objects include services, instances, products, pools, policies, bundles, stakes and more.
+/// Registered objects are represented by NFTs.
 interface IRegistry is IERC165 {
 
     event LogRegistration(NftId nftId, NftId parentNftId, ObjectType objectType, bool isInterceptor, address objectAddress, address initialOwner);
     event LogServiceRegistration(VersionPart majorVersion, ObjectType domain);
 
+    // register()
+    error ErrorRegistryCallerNotRegistryService();
+    error ErrorRegistryService(address service);
+
     // registerService()
     error ErrorRegistryCallerNotReleaseRegistry();
+    error ErrorRegistryServiceAddressZero(); 
+    error ErrorRegistryServiceVersionZero(); 
+    error ErrorRegistryNotService(address service, ObjectType objectType);
+    error ErrorRegistryServiceParentNotRegistry(NftId parentNftId);
     error ErrorRegistryDomainZero(address service);
     error ErrorRegistryDomainAlreadyRegistered(address service, VersionPart version, ObjectType domain);
 
-    // register()
-    error ErrorRegistryCallerNotRegistryService();
-
     // registerWithCustomTypes()
     error ErrorRegistryCoreTypeRegistration();
 
@@ -45,24 +53,29 @@ interface IRegistry is IERC165 {
         bytes32 salt;
         address[] addresses;
         string[] names;
-        // RoleId[][] serviceRoles;
-        // string[][] serviceRoleNames;
-        // RoleId[][] functionRoles;
-        // string[][] functionRoleNames;
-        // bytes4[][][] selectors;
         ObjectType[] domains;
         Timestamp activatedAt;
         Timestamp disabledAt;
     }
 
+    /// @dev Register an object with a known core type.
+    /// The function returns a newly minted object NFT ID.
+    /// May not be used to register services.
+    function register(ObjectInfo memory info) external returns (NftId nftId);
+
+    /// @dev Register a service with using the provided domain and version.
+    /// The function returns a newly minted service NFT ID.
+    /// May only be used to register services.
     function registerService(
         ObjectInfo memory serviceInfo, 
         VersionPart serviceVersion, 
         ObjectType serviceDomain
     ) external returns(NftId nftId);
 
-    function register(ObjectInfo memory info) external returns (NftId nftId);
-
+    /// @dev Register an object with a custom type.
+    /// The function returns a newly minted object NFT ID.
+    /// This function is reserved for GIF releases > 3.
+    /// May not be used to register known core types.
     function registerWithCustomType(ObjectInfo memory info) external returns (NftId nftId);
 
     function getInitialVersion() external view returns (VersionPart);

package/contracts/registry/IRegistryService.sol

@@ -50,14 +50,14 @@ interface IRegistryService is
      function registerComponent(IComponent component, ObjectType objectType, address owner)
           external returns(IRegistry.ObjectInfo memory info);
 
-     function registerProduct(IComponent product, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerProduct(IComponent product, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerPool(IComponent pool, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerPool(IComponent pool, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
-     function registerDistribution(IComponent distribution, address owner)
-          external returns(IRegistry.ObjectInfo memory info);
+     // function registerDistribution(IComponent distribution, address owner)
+     //      external returns(IRegistry.ObjectInfo memory info);
 
      function registerDistributor(IRegistry.ObjectInfo memory info) external returns(NftId nftId);