@etherisc/gif-next 0.0.2-f034782-101 → 0.0.2-f08528a-758

package/contracts/instance/base/KeyValueStore.sol

@@ -1,175 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
-import {Key32, KeyId, Key32Lib} from "../../types/Key32.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE} from "../../types/StateId.sol";
-import {Timestamp, TimestampLib} from "../../types/Timestamp.sol";
-
-import {Lifecycle} from "./Lifecycle.sol";
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-contract KeyValueStore is Lifecycle, IKeyValueStore {
-
-    mapping(Key32 key32 => Value value) private _value;
-
-    function create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        _create(key32, data);
-    }
-
-    function _create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        ObjectType objectType = key32.toObjectType();
-        require(objectType.gtz(), "ERROR:KVS-010:TYPE_UNDEFINED");
-
-        Metadata storage metadata = _value[key32].metadata;
-        require(metadata.state.eqz(), "ERROR:KVS-012:ALREADY_CREATED");
-
-        address createdBy = msg.sender;
-        Blocknumber blocknumber = blockBlocknumber();
-        StateId initialState = hasLifecycle(objectType) ? getInitialState(objectType) : ACTIVE();
-
-        // set metadata
-        metadata.objectType = objectType;
-        metadata.state = initialState;
-        metadata.updatedBy = createdBy;
-        metadata.updatedIn = blocknumber;
-        metadata.createdIn = blocknumber;
-
-        // set data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoCreated(key32.toObjectType(), key32.toKeyId(), initialState, createdBy, tx.origin);
-    }
-
-    function update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        _update(key32, data, state);
-    }
-
-    function _update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        require(state.gtz(), "ERROR:KVS-020:STATE_UNDEFINED");
-        Metadata storage metadata = _value[key32].metadata;
-        StateId stateOld = metadata.state;
-        require(stateOld.gtz(), "ERROR:KVS-021:NOT_EXISTING");
-
-        // update data
-        _value[key32].data = data;
-
-        // update metadata (and state)
-        address updatedBy = msg.sender;
-        Blocknumber lastUpdatedIn = metadata.updatedIn;
-        metadata.state = state;
-        metadata.updatedBy = updatedBy;
-        metadata.updatedIn = blockBlocknumber();
-
-        // create log entries
-        // solhint-disable avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, updatedBy, tx.origin, lastUpdatedIn);
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
-        // solhing-enable
-    }
-
-    function updateData(Key32 key32, bytes memory data) 
-        internal
-    {
-        _updateData(key32, data);
-    }
-
-    function _updateData(Key32 key32, bytes memory data) 
-        internal
-    {
-        Metadata storage metadata = _value[key32].metadata;
-        StateId state = metadata.state;
-        require(state.gtz(), "ERROR:KVS-030:NOT_EXISTING");
-
-        // update data
-        _value[key32].data = data;
-
-        // update metadata
-        address updatedBy = msg.sender;
-        Blocknumber lastUpdatedIn = metadata.updatedIn;
-        metadata.updatedBy = updatedBy;
-        metadata.updatedIn = blockBlocknumber();
-
-        // create log entry
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
-    }
-
-    function updateState(Key32 key32, StateId state)
-        internal
-    {
-        _updateState(key32, state);
-    }
-
-    function _updateState(Key32 key32, StateId state)
-        internal
-    {
-        require(state.gtz(), "ERROR:KVS-040:STATE_UNDEFINED");
-        Metadata storage metadata = _value[key32].metadata;
-        StateId stateOld = metadata.state;
-        require(stateOld.gtz(), "ERROR:KVS-041:NOT_EXISTING");
-
-        // ensure state transistion is valid
-        checkTransition(metadata.objectType, stateOld, state);
-
-        // update metadata (and state)
-        address updatedBy = msg.sender;
-        Blocknumber lastUpdatedIn = metadata.updatedIn;
-        metadata.state = state;
-        metadata.updatedBy = updatedBy;
-        metadata.updatedIn = blockBlocknumber();
-
-        // create log entry
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, updatedBy, tx.origin, lastUpdatedIn);
-    }
-
-    function exists(Key32 key32) public view returns (bool) {
-        return _value[key32].metadata.state.gtz();
-    }
-
-    function get(Key32 key32) public view returns (Value memory value) {
-        return _value[key32];
-    }
-
-    function getMetadata(Key32 key32) public view returns (Metadata memory metadata) {
-        return _value[key32].metadata;
-    }
-
-    function getData(Key32 key32) public view returns (bytes memory data) {
-        return _value[key32].data;
-    }
-
-    function getState(Key32 key32) public view returns (StateId state) {
-        return _value[key32].metadata.state;
-    }
-
-    function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
-        return Key32Lib.toKey32(objectType, id);
-    }
-}

package/contracts/instance/base/Lifecycle.sol

@@ -1,109 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
-
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType, COMPONENT, BUNDLE, POLICY, RISK} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, UNDERWRITTEN, REVOKED, DECLINED} from "../../types/StateId.sol";
-import {ILifecycle} from "./ILifecycle.sol";
-
-contract Lifecycle is
-    Initializable,
-    ILifecycle
-{
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    function initializeLifecycle()
-        public
-        onlyInitializing
-    {
-        _setupBundleLifecycle();
-        _setupComponentLifecycle();
-        _setupPolicyLifecycle();
-        _setupRiskLifecycle();
-    }
-
-    function hasLifecycle(
-        ObjectType objectType
-    )
-        public
-        view
-        override
-        returns (bool)
-    {
-        return _initialState[objectType].gtz();
-    }
-
-    function getInitialState(
-        ObjectType objectType
-    )
-        public
-        view
-        returns (StateId)
-    {
-        return _initialState[objectType];
-    }
-
-    function checkTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    )
-        public
-        view
-    {
-        // return if no life cycle support
-        if (_initialState[objectType].eqz()) {
-            return;
-        }
-
-        // enforce valid state transition
-        if (!_isValidTransition[objectType][fromId][toId]) {
-            revert ErrorInvalidStateTransition(objectType, fromId, toId);
-        }
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) public view returns (bool) {
-        return _isValidTransition[objectType][fromId][toId];
-    }
-
-    function _setupComponentLifecycle() internal {
-        _initialState[COMPONENT()] = ACTIVE();
-        _isValidTransition[COMPONENT()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[COMPONENT()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[COMPONENT()][PAUSED()][ARCHIVED()] = true;
-    }
-
-    function _setupBundleLifecycle() internal {
-        _initialState[BUNDLE()] = ACTIVE();
-        _isValidTransition[BUNDLE()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[BUNDLE()][ACTIVE()][CLOSED()] = true;
-        _isValidTransition[BUNDLE()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[BUNDLE()][PAUSED()][CLOSED()] = true;
-    }
-
-    function _setupPolicyLifecycle() internal {
-        _initialState[POLICY()] = APPLIED();
-        _isValidTransition[POLICY()][APPLIED()][REVOKED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][DECLINED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][UNDERWRITTEN()] = true;
-        _isValidTransition[POLICY()][UNDERWRITTEN()][ACTIVE()] = true;
-        _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
-    }
-
-    function _setupRiskLifecycle() internal {
-        _initialState[RISK()] = ACTIVE();
-        _isValidTransition[RISK()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[RISK()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[RISK()][PAUSED()][ARCHIVED()] = true;
-    }
-}

package/contracts/instance/module/ISetup.sol

@@ -1,33 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {Fee} from "../../types/Fee.sol";
-import {NftId} from "../../types/NftId.sol";
-import {RoleId} from "../../types/RoleId.sol";
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-import {UFixed} from "../../types/UFixed.sol";
-
-interface ISetup {
-
-    struct ProductSetupInfo {
-        IERC20Metadata token;
-        TokenHandler tokenHandler;
-        NftId distributionNftId;
-        NftId poolNftId;
-        Fee productFee; // product fee on net premium
-        Fee processingFee; // product fee on payout amounts        
-        bool isIntercepting; // intercepts nft transfers (for products)
-        address wallet;
-    }
-
-    struct DistributionSetupInfo {
-        NftId productNftId;
-        TokenHandler tokenHandler;
-        Fee minDistributionOwnerFee;
-        Fee distributionFee; // recalculated whenever any fee on the product/pool/dist/disttype is changed
-        address wallet;
-        uint256 sumDistributionOwnerFees;
-    }
-}

package/contracts/instance/module/ITreasury.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {Fee} from "../../types/Fee.sol";
-import {NftId} from "../../types/NftId.sol";
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-interface ITreasury {
-    struct TreasuryInfo {
-        IERC20Metadata token;
-        TokenHandler tokenHandler;
-        NftId distributionNftId;
-        NftId poolNftId;
-        Fee distributionFee; // default distribution fee (no referral id)
-        Fee productFee; // product fee on net premium
-        Fee processingFee; // product fee on payout amounts
-        Fee poolFee; // pool fee on net premium
-        Fee stakingFee; // pool fee on staked capital from investor
-        Fee performanceFee; // pool fee on profits from capital investors
-    }
-}

package/contracts/instance/service/ApplicationService.sol

@@ -1,350 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRisk} from "../module/IRisk.sol";
-import {IService} from "./IApplicationService.sol";
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {Product} from "../../components/Product.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IInstance} from "../IInstance.sol";
-import {IComponents} from "../module/IComponents.sol";
-import {IPolicy} from "../module/IPolicy.sol";
-import {IRisk} from "../module/IRisk.sol";
-import {IBundle} from "../module/IBundle.sol";
-import {IProductService} from "./IProductService.sol";
-import {ITreasury} from "../module/ITreasury.sol";
-import {ISetup} from "../module/ISetup.sol";
-
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {Seconds} from "../../types/Seconds.sol";
-import {Timestamp, TimestampLib, zeroTimestamp} from "../../types/Timestamp.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {ObjectType, DISTRIBUTION, INSTANCE, PRODUCT, POOL, APPLICATION, POLICY, BUNDLE} from "../../types/ObjectType.sol";
-import {APPLIED, REVOKED, UNDERWRITTEN, ACTIVE, KEEP_STATE, CLOSED} from "../../types/StateId.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {ReferralId} from "../../types/Referral.sol";
-import {RiskId} from "../../types/RiskId.sol";
-import {StateId} from "../../types/StateId.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {ComponentService} from "../base/ComponentService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-import {IApplicationService} from "./IApplicationService.sol";
-import {IBundleService} from "./IBundleService.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-import {IPoolService} from "./IPoolService.sol";
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-
-
-contract ApplicationService is 
-    ComponentService, 
-    IApplicationService
-{
-    IDistributionService internal _distributionService;
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        virtual override
-        initializer()
-    {
-        // TODO check this, might no longer be the way, refactor if necessary
-        address registryAddress;
-        address initialOwner;
-        (registryAddress, initialOwner) = abi.decode(data, (address, address));
-
-        initializeService(registryAddress, owner);
-        registerInterface(type(IApplicationService).interfaceId);
-
-        _distributionService = IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), getMajorVersion()));
-    }
-
-
-    function getDomain() public pure override(IService, Service) returns(ObjectType) {
-        return APPLICATION();
-    }
-
-
-    function create(
-        address applicationOwner,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        Seconds lifetime,
-        NftId bundleNftId,
-        ReferralId referralId,
-        bytes memory applicationData
-    )
-        external
-        virtual
-        returns (NftId applicationNftId)
-    {
-        (IRegistry.ObjectInfo memory productInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        // TODO: add validations (see create bundle in pool service)
-
-        applicationNftId = getRegistryService().registerPolicy(
-            IRegistry.ObjectInfo(
-                zeroNftId(),
-                productInfo.nftId,
-                POLICY(),
-                false, // intercepting property for policies is defined on product
-                address(0),
-                applicationOwner,
-                ""
-            )
-        );
-
-        // (uint256 premiumAmount,,,,,) = calculatePremium(
-        IPolicy.Premium memory premium = calculatePremium(
-            productInfo.nftId,
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-
-        IPolicy.PolicyInfo memory policyInfo = IPolicy.PolicyInfo(
-            productInfo.nftId,
-            bundleNftId,
-            referralId,
-            riskId,
-            sumInsuredAmount,
-            premium.premiumAmount,
-            0,
-            lifetime,
-            applicationData,
-            "",
-            0,
-            0,
-            0,
-            zeroTimestamp(),
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-        
-        instance.createApplication(applicationNftId, policyInfo);
-
-        // TODO: add logging
-    }
-
-
-    function renew(
-        NftId policyNftId, // policy to be renewd (renewal inherits policy attributes)
-        NftId bundleNftId // will likely need a newer bundle for underwriting
-    )
-        external
-        virtual override
-        returns (NftId applicationNftId)
-    {
-
-    }
-
-
-    function adjust(
-        NftId applicationNftId,
-        RiskId riskId,
-        NftId bundleNftId,
-        ReferralId referralId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
-        bytes memory applicationData
-    )
-        external
-        virtual override
-    {
-
-    }
-
-    function revoke(NftId applicationNftId)
-        external
-        virtual override
-    {
-        (, IInstance instance) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        instance.updateApplicationState(applicationNftId, REVOKED());
-    }
-
-    // TODO: maybe move this to a pricing service later
-    function calculatePremium(
-        NftId productNftId,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        Seconds lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        public
-        view
-        virtual override
-        returns (
-            IPolicy.Premium memory premium
-        )
-    {
-        uint256 netPremiumAmount = _getAndVerifyProduct(productNftId).calculateNetPremium(
-            sumInsuredAmount,
-            riskId,
-            lifetime,
-            applicationData
-        );
-
-        premium = _getFixedFeeAmounts(
-            netPremiumAmount,
-            _getAndVerifyProduct(productNftId),
-            bundleNftId,
-            referralId
-        );
-
-        (
-            premium
-        ) = _calculateVariableFeeAmounts(
-            premium,
-            _getAndVerifyProduct(productNftId),
-            bundleNftId,
-            referralId
-        );
-    }
-
-
-    // internal functions
-    function _getFixedFeeAmounts(
-        uint256 netPremiumAmount,
-        Product product,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        internal
-        view
-        returns (
-            IPolicy.Premium memory premium
-        )
-    {
-        InstanceReader instanceReader;
-        {
-            IInstance instance = product.getInstance();
-            instanceReader = instance.getInstanceReader();
-        }
-        
-        NftId poolNftId = product.getPoolNftId();
-        premium = IPolicy.Premium(
-            netPremiumAmount, // net premium
-            netPremiumAmount, // full premium
-            0, // premium
-            0, 0, 0, 0, // fix fees
-            0, 0, 0, 0, // variable fees
-            0, 0, 0, 0); // distribution owner fee/commission/discount
-
-        {
-            {
-                ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(product.getProductNftId());
-                uint256 t = productSetupInfo.productFee.fixedFee;
-                premium.productFeeFixAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                bytes memory componentData = instanceReader.getComponentInfo(poolNftId).data;
-                uint256 t = abi.decode(componentData, (IComponents.PoolInfo)).poolFee.fixedFee;
-                premium.poolFeeFixAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-                if(bundleInfo.poolNftId != poolNftId) {
-                    revert IApplicationServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
-                }
-                uint256 t = bundleInfo.fee.fixedFee;
-                premium.bundleFeeFixAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                ISetup.DistributionSetupInfo memory distInto = instanceReader.getDistributionSetupInfo(product.getDistributionNftId());
-                uint256 t = distInto.distributionFee.fixedFee;
-                premium.distributionFeeFixAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-        }
-        
-    }
-
-    function _calculateVariableFeeAmounts(
-        IPolicy.Premium memory premium,
-        Product product,
-        NftId bundleNftId,
-        ReferralId referralId
-    )
-        internal
-        view
-        returns (
-            IPolicy.Premium memory finalPremium
-        )
-    {
-        InstanceReader instanceReader;
-        {
-            IInstance instance = product.getInstance();
-            instanceReader = instance.getInstanceReader();
-        }
-        
-        NftId poolNftId = product.getPoolNftId();
-        uint256 netPremiumAmount = premium.netPremiumAmount;
-
-        {
-            {
-                ISetup.ProductSetupInfo memory productSetupInfo = instanceReader.getProductSetupInfo(product.getProductNftId());
-                uint256 t = (UFixedLib.toUFixed(netPremiumAmount) * productSetupInfo.productFee.fractionalFee).toInt();
-                premium.productFeeVarAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                bytes memory componentData = instanceReader.getComponentInfo(poolNftId).data;
-                UFixed poolFractionalFee = abi.decode(componentData, (IComponents.PoolInfo)).poolFee.fractionalFee;
-                uint256 t = (UFixedLib.toUFixed(netPremiumAmount) * poolFractionalFee).toInt();
-                premium.poolFeeVarAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-                if(bundleInfo.poolNftId != poolNftId) {
-                    revert IApplicationServiceBundlePoolMismatch(bundleNftId, bundleInfo.poolNftId, poolNftId);
-                }
-                uint256 t = (UFixedLib.toUFixed(netPremiumAmount) * bundleInfo.fee.fractionalFee).toInt();
-                premium.bundleFeeVarAmount = t;
-                premium.fullPremiumAmount += t;
-            }
-            {
-                premium = _distributionService.calculateFeeAmount(
-                    product.getDistributionNftId(),
-                    referralId,
-                    premium
-                );
-            }
-        }
-
-        return premium;
-    }
-
-
-    function _getAndVerifyInstanceAndProduct() internal view returns (Product product) {
-        IRegistry.ObjectInfo memory productInfo;
-        (productInfo,) = _getAndVerifyComponentInfoAndInstance(PRODUCT());
-        product = Product(productInfo.objectAddress);
-    }
-
-    function _getAndVerifyProduct(NftId productNftId) internal view returns (Product product) {
-        IRegistry registry = getRegistry();        
-        IRegistry.ObjectInfo memory productInfo = registry.getObjectInfo(productNftId);
-        require(productInfo.objectType == PRODUCT(), "OBJECT_TYPE_INVALID");
-        product = Product(productInfo.objectAddress);
-    }
-}