@etherisc/gif-next 0.0.2-ce2fc91-485 → 0.0.2-ce8407f-016

package/contracts/components/Pool.sol

@@ -1,174 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType, POOL} from "../types/ObjectType.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IPoolService} from "../instance/service/IPoolService.sol";
-import {NftId} from "../types/NftId.sol";
-import {Fee} from "../types/Fee.sol";
-import {UFixed} from "../types/UFixed.sol";
-import {IPoolComponent} from "./IPoolComponent.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-
-contract Pool is BaseComponent, IPoolComponent {
-
-    bool internal _isVerifying;
-    UFixed internal _collateralizationLevel;
-
-    // may be used to interact with instance by derived contracts
-    IPoolService internal _poolService;
-
-    // only relevant to protect callback functions for "active" pools
-    IProductService private _productService;
-
-    modifier onlyPoolService() {
-        require(
-            msg.sender == address(_poolService), 
-            "ERROR:POL-001:NOT_POOL_SERVICE");
-        _;
-    }
-
-    modifier onlyProductService() {
-        require(
-            msg.sender == address(_productService), 
-            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId instanceNftId,
-        // TODO refactor into tokenNftId
-        address token,
-        bool verifying,
-        UFixed collateralizationLevel
-    )
-        BaseComponent(registry, instanceNftId, token)
-    {
-        _isVerifying = verifying;
-        // TODO add validation
-        _collateralizationLevel = collateralizationLevel;
-
-        _poolService = _instance.getPoolService();
-        _productService = _instance.getProductService();
-    }
-
-    function createBundle(
-        uint256 initialAmount,
-        uint256 lifetime,
-        bytes memory filter
-    )
-        external
-        virtual override
-        returns(NftId bundleNftId)
-    {
-        address owner = msg.sender;
-        bundleNftId = _poolService.createBundle(
-            owner,
-            initialAmount,
-            lifetime,
-            filter
-        );
-
-        // TODO add logging
-    }
-
-    /**
-     * @dev see {IPool.underwrite}. 
-     * Default implementation that only writes a {LogUnderwrittenByPool} entry.
-     */
-    function underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    )
-        external
-        onlyProductService
-        virtual override 
-    {
-        _underwrite(policyNftId, policyData, bundleFilter, collateralizationAmount);
-    }
-
-    /**
-     * @dev see {IPoolComponent.policyMatchesBundle}. 
-     * Default implementation always returns true
-     */
-    function policyMatchesBundle(
-        bytes memory, // policyData
-        bytes memory // bundleFilter
-    )
-        public
-        view
-        virtual override
-        returns (bool isMatching)
-    {
-        return true;
-    }
-
-
-    function isVerifying() external view override returns (bool verifying) {
-        return _isVerifying;
-    }
-
-    function getCollateralizationLevel() external view override returns (UFixed collateralizationLevel) {
-        return _collateralizationLevel;
-    }
-
-    function _underwrite(
-        NftId policyNftId, 
-        bytes memory policyData,
-        bytes memory bundleFilter,
-        uint256 collateralizationAmount
-    )
-        internal 
-    {
-        require(
-            policyMatchesBundle(policyData, bundleFilter),
-            "ERROR:POL-020:POLICY_BUNDLE_MISMATCH"
-        );
-
-        emit LogUnderwrittenByPool(policyNftId, collateralizationAmount, address(this));
-    }
-
-    function _createBundle(
-        address bundleOwner,
-        uint256 amount,
-        uint256 lifetime, 
-        bytes calldata filter
-    )
-        internal
-        returns(NftId bundleNftId)
-    {
-        bundleNftId = _poolService.createBundle(
-            bundleOwner,
-            amount,
-            lifetime,
-            filter
-        );
-    }
-
-    // from pool component
-    function getStakingFee()
-        external
-        view
-        override
-        returns (Fee memory stakingFee)
-    {
-        return _instance.getPoolSetup(getNftId()).stakingFee;
-    }
-
-    function getPerformanceFee()
-        external
-        view
-        override
-        returns (Fee memory performanceFee)
-    {
-        return _instance.getPoolSetup(getNftId()).performanceFee;
-    }
-
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return POOL();
-    }
-}

package/contracts/components/Product.sol

@@ -1,117 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IProductComponent} from "./IProductComponent.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
-import {Timestamp} from "../types/Timestamp.sol";
-import {Fee} from "../types/Fee.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-
-contract Product is BaseComponent, IProductComponent {
-    IProductService private _productService;
-    address private _pool;
-
-    constructor(
-        address registry,
-        NftId instanceNftid,
-        address token,
-        address pool
-    ) BaseComponent(registry, instanceNftid, token) {
-        // TODO add validation
-        _productService = _instance.getProductService();
-        _pool = pool;
-    }
-
-    function _createApplication(
-        address applicationOwner,
-        uint256 sumInsuredAmount,
-        uint256 premiumAmount,
-        uint256 lifetime,
-        NftId bundleNftId
-    ) internal returns (NftId nftId) {
-        nftId = _productService.createApplication(
-            applicationOwner,
-            sumInsuredAmount,
-            premiumAmount,
-            lifetime,
-            bundleNftId
-        );
-    }
-
-    function _underwrite(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.underwrite(
-            policyNftId, 
-            requirePremiumPayment, 
-            activateAt);
-    }
-
-    function _collectPremium(
-        NftId policyNftId,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.collectPremium(
-            policyNftId, 
-            activateAt);
-    }
-
-    function _activate(
-        NftId policyNftId,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.activate(
-            policyNftId, 
-            activateAt);
-    }
-
-    function getPoolNftId() external view override returns (NftId poolNftId) {
-        return _registry.getNftId(_pool);
-    }
-
-    // from product component
-    function setFees(
-        Fee memory policyFee,
-        Fee memory processingFee
-    )
-        external
-        onlyOwner
-        override
-    {
-        _productService.setFees(policyFee, processingFee);
-    }
-
-
-    function getPolicyFee()
-        external
-        view
-        override
-        returns (Fee memory policyFee)
-    {
-        return _instance.getProductSetup(getNftId()).policyFee;
-    }
-
-    function getProcessingFee()
-        external
-        view
-        override
-        returns (Fee memory processingFee)
-    {
-        return _instance.getProductSetup(getNftId()).processingFee;
-    }
-
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return PRODUCT();
-    }
-}

package/contracts/experiment/statemachine/README.md

@@ -1,112 +0,0 @@
-# State Machines
-
-Most GIF objects have a life cycle defined by a state machine.
-
-For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
-
-## Object Types without States
-
-* Protocol
-* Chains
-* Registries (both chain and main registry)
-
-## Object Types with States
-
-* Tokens
-* Instances
-* Products
-* Oracles
-* Pools
-* Bundles
-* Policies
-* Claim (non-NFT)
-* Payout (non-NFT)
-
-### Simple State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Archived (final state)
-
-Valid state transitions:
-
-* Active -> Paused
-* Paused -> Active
-* Paused -> Archived
-
-
-Candidate object types for simple state machine
-
-* Token
-* Instance
-* Product
-* Oracle
-* Pool
-
-To discuss: 
-
-* Archived is final state
-* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
-* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
-
-### Bundle State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A bundle is expired for block.timestamp >= expiredAt
-
-### Policy State Machine
-
-Valid states
-
-* Applied (initial state)
-* Revoked (final state)
-* Declined (final state)
-* Active
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A policy is expired for block.timestamp >= expiredAt
-
-To discuss: 
-
-* Should 'Closed' be less explicit using a closedAt state variable? 
-* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
-
-Valid state transitions:
-
-* Applied -> Revoked
-* Applied -> Declined
-* Applied -> Active
-* Active -> Closed (needs to be expired)
-
-### Claim State Machine
-
-Valid states
-* Applied (initial state)
-* Confirmed
-* Declined (final state)
-* Closed (final state)
-
-Valid state transitions:
-* Applied -> Confirmed
-* Applied -> Declined
-* Confirmed -> Closed
-
-### Payout State Machine
-
-Valid states
-* Expected
-* PaidOut
-
-Valid state transitions:
-* Expected -> PaidOut

package/contracts/instance/IInstanceLinked.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IInstance} from "./IInstance.sol";
-
-interface IInstanceLinked {
-    function getInstance() external view returns (IInstance instance);
-}

package/contracts/instance/base/ComponentServiceBase.sol

@@ -1,42 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-
-import {ServiceBase} from "./ServiceBase.sol";
-
-abstract contract ComponentServiceBase is ServiceBase {
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        ServiceBase(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-    }
-
-
-    function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = _registry.getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = _registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-    }
-}

package/contracts/instance/base/IInstanceBase.sol

@@ -1,14 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.sol";
-
-interface IInstanceBase {
-    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
-    function getComponentOwnerService() external view returns(IComponentOwnerService service);
-    function getProductService() external view returns(IProductService service);
-    function getPoolService() external view returns(IPoolService service);
-}

package/contracts/instance/base/InstanceBase.sol

@@ -1,80 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Versionable} from "../../shared/Versionable.sol";
-import {Registerable} from "../../shared/Registerable.sol";
-// import {IRegistry} from "../registry/IRegistry.sol";
-
-// import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../../types/ObjectType.sol";
-import {NftId} from "../../types/NftId.sol";
-import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
-
-import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-import {IInstance} from "../IInstance.sol";
-import {IInstanceBase} from "./IInstanceBase.sol";
-
-import {KeyValueStore} from "./KeyValueStore.sol";
-
-abstract contract InstanceBase is
-    Versionable,
-    Registerable,
-    IInstanceBase
-{
-    IKeyValueStore internal _keyValueStore;
-
-    IComponentOwnerService internal _componentOwnerService;
-    IProductService internal _productService;
-    IPoolService internal _poolService;
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        Registerable(registry, registryNftId)
-        Versionable()
-    {
-        _keyValueStore = new KeyValueStore();
-
-        _registerInterface(type(IInstance).interfaceId);
-        _linkToServicesInRegistry();
-    }
-
-    function getKeyValueStore() public view virtual override returns (IKeyValueStore keyValueStore) { return _keyValueStore; }
-
-    // from versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
-
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
-
-
-    // internal / private functions
-    function _linkToServicesInRegistry() internal {
-        VersionPart majorVersion = getVersion().toMajorPart();
-        _componentOwnerService = IComponentOwnerService(_getAndCheck("ComponentOwnerService", majorVersion));
-        _productService = IProductService(_getAndCheck("ProductService", majorVersion));
-        _poolService = IPoolService(_getAndCheck("PoolService", majorVersion));
-    }
-
-    function _getAndCheck(string memory serviceName, VersionPart majorVersion) internal view returns (address serviceAddress) {
-        serviceAddress = _registry.getServiceAddress(serviceName, majorVersion);
-        require(
-            serviceAddress != address(0),
-            "ERROR:INS-001:NOT_REGISTERED"
-        );
-    }
-}

package/contracts/instance/base/ModuleBase.sol

@@ -1,52 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-
-import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
-import {Key32, KeyId} from "../../types/Key32.sol";
-import {LibNftIdSet} from "../../types/NftIdSet.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL, BUNDLE, POLICY} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, REVOKED, DECLINED} from "../../types/StateId.sol";
-import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-abstract contract ModuleBase {
-
-    IKeyValueStore private _store;
-    ObjectType private _type;
-
-    function _initialize(IKeyValueStore keyValueStore, ObjectType objectType) internal {
-        _store = keyValueStore;
-        _type = objectType;
-    }
-
-    function _create(NftId nftId, bytes memory data) internal {
-        _store.create(
-            _toKey32(nftId), 
-            _type,
-            data);
-    }
-
-    function _updateData(NftId nftId, bytes memory data) internal {
-        _store.updateData(_toKey32(nftId), data);
-    }
-
-    function _updateState(NftId nftId, StateId state) internal {
-        _store.updateState(_toKey32(nftId), state);
-    }
-
-    function _getData(NftId nftId) internal view returns(bytes memory data) {
-        return _store.getData(_toKey32(nftId));
-    }
-
-    function _getState(NftId nftId) internal view returns(StateId) {
-        return _store.getState(_toKey32(nftId));
-    }
-
-    function _toKey32(NftId nftId) internal view returns (Key32 key32) {
-        return nftId.toKey32(_type);
-    } 
-}