@etherisc/gif-next 0.0.2-ebbe63d → 0.0.2-ebf1a6b-485

package/contracts/components/Product.sol

@@ -0,0 +1,289 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRisk} from "../instance/module/IRisk.sol";
+import {IApplicationService} from "../instance/service/IApplicationService.sol";
+import {IPolicyService} from "../instance/service/IPolicyService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IClaimService} from "../instance/service/IClaimService.sol";
+import {IProductComponent} from "./IProductComponent.sol";
+import {NftId, NftIdLib} from "../types/NftId.sol";
+import {PRODUCT, APPLICATION, POLICY, CLAIM } from "../types/ObjectType.sol";
+import {ReferralId} from "../types/Referral.sol";
+import {RiskId, RiskIdLib} from "../types/RiskId.sol";
+import {Seconds} from "../types/Seconds.sol";
+import {StateId} from "../types/StateId.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+import {Fee} from "../types/Fee.sol";
+import {Component} from "./Component.sol";
+
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+import {InstanceReader} from "../instance/InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {Pool} from "../components/Pool.sol";
+import {Distribution} from "../components/Distribution.sol";
+
+abstract contract Product is
+    Component, 
+    IProductComponent
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.Product")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant PRODUCT_STORAGE_LOCATION_V1 = 0x0bb7aafdb8e380f81267337bc5b5dfdf76e6d3a380ecadb51ec665246d9d6800;
+
+    struct ProductStorage {
+        IProductService _productService;
+        IApplicationService _applicationService;
+        IPolicyService _policyService;
+        IClaimService _claimService;
+        Pool _pool;
+        Distribution _distribution;
+        Fee _initialProductFee;
+        Fee _initialProcessingFee;
+        TokenHandler _tokenHandler;
+        NftId _poolNftId;
+        NftId _distributionNftId;
+    }
+
+    function initializeProduct(
+        address registry,
+        NftId instanceNftId,
+        string memory name,
+        address token,
+        bool isInterceptor,
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee,
+        address initialOwner,
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeComponent(registry, instanceNftId, name, token, PRODUCT(), isInterceptor, initialOwner, registryData);
+
+        ProductStorage storage $ = _getProductStorage();
+        // TODO add validation
+        // TODO refactor to go via registry
+        $._productService = IProductService(_getServiceAddress(PRODUCT())); 
+        $._applicationService = IApplicationService(_getServiceAddress(APPLICATION())); 
+        $._policyService = IPolicyService(_getServiceAddress(POLICY())); 
+        $._claimService = IClaimService(_getServiceAddress(CLAIM())); 
+        $._pool = Pool(pool);
+        $._distribution = Distribution(distribution);
+        $._initialProductFee = productFee;
+        $._initialProcessingFee = processingFee;  
+        $._tokenHandler = new TokenHandler(token);
+        $._poolNftId = getRegistry().getNftId(pool);
+        $._distributionNftId = getRegistry().getNftId(distribution);
+
+        registerInterface(type(IProductComponent).interfaceId);  
+    }
+
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        external 
+        view 
+        override 
+        returns (uint256 premiumAmount)
+    {
+        IPolicy.Premium memory premium = _getProductStorage()._applicationService.calculatePremium(
+            getNftId(),
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId
+        );
+        premiumAmount = premium.premiumAmount;
+    }
+
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        Seconds lifetime,
+        bytes memory applicationData
+    )
+        external
+        view
+        virtual override
+        returns (uint256 netPremiumAmount)
+    {
+        // default 10% of sum insured
+        return sumInsuredAmount / 10;
+    }
+
+    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
+        return RiskIdLib.toRiskId(riskName);
+    }
+
+    function _createRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _getProductService().createRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRisk(
+        RiskId id,
+        bytes memory data
+    ) internal {
+        _getProductService().updateRisk(
+            id,
+            data
+        );
+    }
+
+    function _updateRiskState(
+        RiskId id,
+        StateId state
+    ) internal {
+        _getProductService().updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
+        return getInstance().getInstanceReader().getRiskInfo(id);
+    }
+
+    function _createApplication(
+        address applicationOwner,
+        RiskId riskId,
+        uint256 sumInsuredAmount,
+        Seconds lifetime,
+        NftId bundleNftId,
+        ReferralId referralId,
+        bytes memory applicationData
+    )
+        internal
+        returns (NftId applicationNftId) 
+    {
+        return _getProductStorage()._applicationService.create(
+            applicationOwner,
+            riskId,
+            sumInsuredAmount,
+            lifetime,
+            bundleNftId,
+            referralId,
+            applicationData
+        );
+    }
+
+    function _underwrite(
+        NftId policyNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _getProductStorage()._policyService.underwrite(
+            policyNftId, 
+            requirePremiumPayment, 
+            activateAt);
+    }
+
+    function _collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _getProductStorage()._policyService.collectPremium(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    )
+        internal
+    {
+        _getProductStorage()._policyService.activate(
+            policyNftId, 
+            activateAt);
+    }
+
+    function _close(
+        NftId policyNftId
+    )
+        internal
+    {
+        _getProductStorage()._policyService.close(policyNftId);
+    }
+
+    function getPoolNftId() external view override returns (NftId poolNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._pool));
+    }
+
+    function getDistributionNftId() external view override returns (NftId distributionNftId) {
+        return getRegistry().getNftId(address(_getProductStorage()._distribution));
+    }
+
+    // from product component
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        external
+        onlyOwner
+        restricted()
+        override
+    {
+        _getProductService().setFees(productFee, processingFee);
+    }
+
+    function getSetupInfo() public view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        InstanceReader reader = getInstance().getInstanceReader();
+        setupInfo = reader.getProductSetupInfo(getNftId());
+
+        // fallback to initial setup info (wallet is always != address(0))
+        if(setupInfo.wallet == address(0)) {
+            setupInfo = _getInitialSetupInfo();
+        }
+    }
+
+    function _getInitialSetupInfo() internal view returns (ISetup.ProductSetupInfo memory setupInfo) {
+        ProductStorage storage $ = _getProductStorage();
+
+        return ISetup.ProductSetupInfo(
+            getToken(),
+            $._tokenHandler,
+            $._distributionNftId,
+            $._poolNftId,
+            $._initialProductFee,
+            $._initialProcessingFee,
+            false,
+            getWallet()
+        );
+    }
+
+    function _getProductStorage() private pure returns (ProductStorage storage $) {
+        assembly {
+            $.slot := PRODUCT_STORAGE_LOCATION_V1
+        }
+    }
+
+    function _getProductService() internal view returns (IProductService) {
+        return _getProductStorage()._productService;
+    }
+}

package/contracts/instance/BundleManager.sol

@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "./IInstance.sol";
+import {INSTANCE} from "../types/ObjectType.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {LibNftIdSet} from "../types/NftIdSet.sol";
+import {NftId} from "../types/NftId.sol";
+import {TimestampLib} from "../types/Timestamp.sol";
+
+import {ObjectManager} from "./ObjectManager.sol";
+
+contract BundleManager is 
+    ObjectManager
+{
+
+    event LogBundleManagerPolicyLinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleManagerPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
+
+    event LogBundleManagerBundleAdded(NftId poolNftId, NftId bundleNftId);
+    event LogBundleManagerBundleUnlocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleManagerBundleLocked(NftId poolNftId, NftId bundleNftId);
+
+    error ErrorBundleManagerErrorPolicyAlreadyActivated(NftId policyNftId);
+    error ErrorBundleManagerErrorBundleLocked(NftId bundleNftId, NftId policyNftId);
+    error ErrorBundleManagerPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
+    error ErrorBundleManagerPolicyNotCloseable(NftId policyNftId);
+    error ErrorBundleManagerBundleUnknown(NftId bundleNftId);
+    error ErrorBundleManagerBundleNotRegistered(NftId bundleNftId);
+
+    mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
+
+    /// @dev links a policy with its bundle
+    // to link a policy it MUST NOT yet have been activated
+    // the bundle MUST be unlocked (active) for linking (underwriting) and registered with this instance
+    function linkPolicy(NftId policyNftId) external restricted() {
+        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is unlocked (in active set) and registered with this instance
+        if (!_isActive(poolNftId, bundleNftId)) {
+            revert ErrorBundleManagerErrorBundleLocked(bundleNftId, policyNftId);
+        }
+
+        LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleManagerPolicyLinked(bundleNftId, policyNftId);
+    }
+
+
+    /// @dev unlinks a policy from its bundle
+    // to unlink a policy it must closable, ie. meet one of the following criterias
+    // - the policy MUST be past its expiry period and it MUST NOT have any open claims
+    // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
+    function unlinkPolicy(NftId policyNftId) external restricted() {
+        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
+
+        NftId bundleNftId = policyInfo.bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is registered with this instance
+        if (!_contains(poolNftId, bundleNftId)) {
+            revert ErrorBundleManagerBundleUnknown(bundleNftId);
+        }
+
+        LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleManagerPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+    }
+
+
+    /// @dev add a new bundle to a pool registerd with this instance
+    // the corresponding pool is fetched via instance reader
+    function add(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure pool is registered with instance
+        if(poolNftId.eqz()) {
+            revert ErrorBundleManagerBundleNotRegistered(bundleNftId);
+        }
+
+        _add(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleAdded(poolNftId, bundleNftId);
+    }
+
+    /// @dev unlocked (active) bundles are available to underwrite new policies
+    function unlock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _activate(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
+    }
+
+    /// @dev locked (deactivated) bundles may not underwrite any new policies
+    function lock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _deactivate(poolNftId, bundleNftId);
+        emit LogBundleManagerBundleLocked(poolNftId, bundleNftId);
+    }
+
+    function bundles(NftId poolNftId) external view returns(uint256) {
+        return _objects(poolNftId);
+    }
+
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getObject(poolNftId, idx);
+    }
+
+    function activeBundles(NftId poolNftId) external view returns(uint256) {
+        return _activeObjs(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getActiveObject(poolNftId, idx);
+    }
+
+    function activePolicies(NftId bundleNftId) external view returns(uint256) {
+        return LibNftIdSet.size(_activePolicies[bundleNftId]);
+    }
+
+    function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
+        return LibNftIdSet.getElementAt(_activePolicies[bundleNftId], idx);
+    }
+}

package/contracts/instance/Cloneable.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+abstract contract Cloneable is 
+    AccessManagedUpgradeable
+{
+    event CloneableInitialized(address authority, address registry);
+
+    error CloneableRegistryInvalid(address registry);
+
+    IRegistry internal _registry;
+
+    constructor() {
+        _registry = IRegistry(address(0));
+    }
+
+    /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
+    function initialize(
+        address authority,
+        address registry
+    )
+        public 
+        initializer
+    {
+        // check/handle access managed
+        __AccessManaged_init(authority);
+
+        // check/handle registry
+        if (registry.code.length == 0) {
+            revert CloneableRegistryInvalid(registry);
+        }
+
+        _registry = IRegistry(registry);
+
+        emit CloneableInitialized(authority, registry);
+    }
+
+    function getRegistry() external view returns (IRegistry) {
+        return _registry;
+    }
+}

package/contracts/instance/IInstance.sol

@@ -0,0 +1,92 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
+import {NftId} from "../types/NftId.sol";
+import {StateId} from "../types/StateId.sol";
+import {RiskId} from "../types/RiskId.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {BundleManager} from "./BundleManager.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+
+import {IBundle} from "./module/IBundle.sol";
+import {IBundleService} from "./service/IBundleService.sol";
+import {IDistributionService} from "./service/IDistributionService.sol";
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {IKeyValueStore} from "./base/IKeyValueStore.sol";
+import {IPolicy} from "./module/IPolicy.sol";
+import {IDistribution} from "./module/IDistribution.sol";
+import {IPolicyService} from "./service/IPolicyService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPolicyService} from "./service/IPolicyService.sol";
+import {IBundleService} from "./service/IBundleService.sol";
+import {IRisk} from "./module/IRisk.sol";
+import {ISetup} from "./module/ISetup.sol";
+import {NftId} from "../types/NftId.sol";
+import {RiskId} from "../types/RiskId.sol";
+import {StateId} from "../types/StateId.sol";
+import {VersionPart} from "../types/Version.sol";
+import {Key32} from "../types/Key32.sol";
+
+
+
+
+interface IInstance is IRegisterable, IKeyValueStore, IAccessManaged {
+
+    function getDistributionService() external view returns (IDistributionService);
+    function getProductService() external view returns (IProductService);
+    function getPoolService() external view returns (IPoolService);
+    function getPolicyService() external view returns (IPolicyService);
+    function getBundleService() external view returns (IBundleService);
+
+    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
+    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external;
+    function updateDistributionSetupState(NftId distributionNftId, StateId newState) external;
+
+    function createPoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup) external;
+    function updatePoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external;
+    function updatePoolSetupState(NftId poolNftId, StateId newState) external;
+
+    function createBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle) external;
+    function updateBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle, StateId newState) external;
+    function updateBundleState(NftId bundleNftId, StateId newState) external;
+
+    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external;
+    function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external;
+    function updateProductSetupState(NftId productNftId, StateId newState) external;
+
+    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external;
+    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
+    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external;
+
+    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external;
+    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external;
+    function updateDistributorState(NftId nftId, StateId newState) external;
+
+    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external;
+    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
+    function updateReferralState(Key32 referralKey, StateId newState) external;
+
+    function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external;
+    function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external;
+    function updateRiskState(RiskId riskId, StateId newState) external;
+
+    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external;
+    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+    function updateApplicationState(NftId applicationNftId, StateId newState) external;
+
+    function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+    function updatePolicyState(NftId policyNftId, StateId newState) external;
+
+    // TODO add claims/payouts function to instance
+    // function updateClaims(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
+
+    function getMajorVersion() external pure returns (VersionPart majorVersion);
+    function getInstanceReader() external view returns (InstanceReader);
+    function getBundleManager() external view returns (BundleManager);
+}

package/contracts/instance/IInstanceService.sol

@@ -0,0 +1,59 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {NftId} from "../types/NftId.sol";
+import {ObjectType} from "../types/ObjectType.sol";
+import {RoleId} from "../types/RoleId.sol";
+import {IService} from "../shared/IService.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IComponent} from "../components/IComponent.sol";
+
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {Instance} from "./Instance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {BundleManager} from "./BundleManager.sol";
+
+interface IInstanceService is IService {
+
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceAccessManagerZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleManagerZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+
+    error ErrorInstanceServiceRequestUnauhorized(address caller);
+    error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
+    error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
+    
+    event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
+
+    function createInstanceClone()
+        external 
+        returns (
+            InstanceAccessManager clonedAccessManager, 
+            Instance clonedInstance,
+            NftId instanceNftId,
+            InstanceReader clonedInstanceReader,
+            BundleManager clonedBundleManager
+        );
+
+    function hasRole(address account, RoleId role, address instanceAddress) external returns (bool);
+    function setTargetLocked(string memory targetName, bool locked) external;
+
+}
+