@etherisc/gif-next 0.0.2-fd275d2-234 → 0.0.2-fd4931b-974

package/contracts/instance/base/KeyValueStore.sol

@@ -1,172 +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(), state, stateOld, 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");
-
-        // 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(), state, stateOld, 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/module/ISetup.sol

@@ -1,46 +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 {UFixed} from "../../types/UFixed.sol";
-import {TokenHandler} from "../../shared/TokenHandler.sol";
-
-interface ISetup {
-    struct ProductSetupInfo {
-        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
-        bool isIntercepting; // intercepts nft transfers (for products)
-        address wallet;
-    }
-
-    struct DistributionSetupInfo {
-        NftId productNftId;
-        TokenHandler tokenHandler;
-        Fee distributionFee; // default distribution fee (no referral id)
-        bool isIntercepting; // intercepts nft transfers (for distributors)
-        address wallet;
-    }
-
-    struct PoolSetupInfo {
-        NftId productNftId;
-        TokenHandler tokenHandler;
-        UFixed collateralizationLevel;
-        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
-        bool isIntercepting; // intercepts nft transfers (for bundles)
-        bool isConfirmingApplication; // confirms applications before they are underwritten
-        address wallet;
-    }
-}

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/ComponentOwnerService.sol

@@ -1,317 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../IInstance.sol";
-
-import {ITreasury} from "../module/ITreasury.sol";
-// import {TreasuryModule} from "../module/TreasuryModule.sol";
-import {ISetup} from "../module/ISetup.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IKeyValueStore} from "../../instance/base/IKeyValueStore.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../types/RoleId.sol";
-import {ObjectType, TOKEN, COMPONENT, PRODUCT, ORACLE, POOL, DISTRIBUTION} from "../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
-import {Key32} from "../../types/Key32.sol";
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {UFixed, UFixedLib} from "../../types/UFixed.sol";
-
-import {IDistributionComponent} from "../../components/IDistributionComponent.sol";
-import {IPoolComponent} from "../../components/IPoolComponent.sol";
-import {IProductComponent} from "../../components/IProductComponent.sol";
-import {IService} from "../../shared/IService.sol";
-import {IComponentOwnerService} from "./IComponentOwnerService.sol";
-import {Service} from "../../shared/Service.sol";
-// import {IPool, IPoolModule} from "../module/IPoolModule.sol";
-
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-
-contract ComponentOwnerService is
-    Service,
-    IComponentOwnerService
-{
-    using NftIdLib for NftId;
-
-    error MissingTypeRole();
-    error WalletIsZero();
-    error InvalidToken();
-    error InvalidPool();
-    error InvalidDistribution();
-    error InvalidPoolsInstance();
-    error InvalidDistributionsInstance();
-
-    error CollateralizationLevelIsZero();
-
-    string public constant NAME = "ComponentOwnerService";
-
-    modifier onlyRegisteredComponent(IBaseComponent component) {
-        NftId nftId = getRegistry().getNftId(address(component));
-        require(nftId.gtz(), "ERROR:COS-001:COMPONENT_UNKNOWN");
-        _;
-    }
-
-    constructor(
-        address registry,
-        NftId registryNftId,
-        address initialOwner
-    )
-    {
-        _initializeService(registry, initialOwner);
-        _registerInterface(type(IComponentOwnerService).interfaceId);
-    }
-
-    function getName() public pure override(IService, Service) returns(string memory name) {
-        return NAME;
-    }
-
-    function getRoleForType(
-        ObjectType cType
-    ) public pure override returns (RoleId role) {
-        if (cType == PRODUCT()) {
-            return PRODUCT_OWNER_ROLE();
-        }
-        if (cType == POOL()) {
-            return POOL_OWNER_ROLE();
-        }
-        if (cType == DISTRIBUTION()) {
-            return DISTRIBUTION_OWNER_ROLE();
-        }
-        if (cType == ORACLE()) {
-            return ORACLE_OWNER_ROLE();
-        }
-    }
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        address service = getRegistry().getServiceAddress("RegistryService", getMajorVersion());
-        return IRegistryService(service);
-    }
-
-    function registerProduct(	
-        IBaseComponent product
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerProduct(
-            product,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(PRODUCT());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-        
-        _registerProduct(
-                info.nftId, 
-                instanceNftId,
-                instance,
-                data
-        );
-    }
-
-    function registerPool(	
-        IBaseComponent pool
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerPool(
-            pool,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(POOL());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // } 
-
-        _registerPool(
-            info.nftId,
-            instanceNftId,
-            instance,
-            data
-        );
-    }
-
-    function registerDistribution(	
-        IBaseComponent distribution
-    ) external returns (NftId nftId) {	
-
-        // TODO some info parameters from component and from register may differ -> getObjectInfo() after registration?
-        (
-            IRegistry.ObjectInfo memory info,
-            bytes memory data
-        ) = getRegistryService().registerDistribution(
-            distribution,
-            msg.sender);	
-
-        NftId instanceNftId = info.parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        IInstance instance = IInstance(instanceAddress);
-
-        RoleId typeRole = getRoleForType(DISTRIBUTION());
-        // TODO refactor to use access manager infra
-        // if(instance.hasRole(typeRole, msg.sender) == false) {
-        //     revert MissingTypeRole();
-        // }
-    }
-
-    function lock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        // instance.updateState(key, PAUSED());
-    }
-
-    function unlock(
-        IBaseComponent component
-    ) external override onlyRegisteredComponent(component) {
-        // TODO use msg.sender to get component and get instance via registered parent nft id
-        IInstance instance = component.getInstance();
-        NftId nftId = component.getNftId();
-        Key32 key = nftId.toKey32(COMPONENT());
-        // instance.updateState(key, ACTIVE());
-    }
-
-    // Internals
-
-    function _registerProduct(
-        NftId nftId, 
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        // TODO change treasury info to product setup info
-        (ISetup.ProductSetupInfo memory info) = abi.decode(data, (ISetup.ProductSetupInfo));
-        // (
-        //     ITreasury.TreasuryInfo memory info,
-        //     address wallet
-        // )  = abi.decode(data, (ITreasury.TreasuryInfo, address));
-
-        // IRegistry _registry = getRegistry();
-
-        // if(wallet == address(0)) {
-        //     revert WalletIsZero();
-        // }
-
-        // IRegistry.ObjectInfo memory tokenInfo = _registry.getObjectInfo(address(info.token));
-
-        // if(tokenInfo.objectType != TOKEN()) {
-        //     revert InvalidToken();
-        // } 
-
-        // IRegistry.ObjectInfo memory poolInfo = _registry.getObjectInfo(info.poolNftId);
-
-        // if(poolInfo.objectType != POOL()) {
-        //     revert InvalidPool();
-        // }
-
-        // if(poolInfo.parentNftId != instanceNftId) {
-        //     revert InvalidPoolsInstance();
-        // }
-        // // TODO pool have the same token
-        // //ITreasury.PoolSetup memory poolSetup = instance.getPoolSetup(info.poolNftId);
-        // //require(tokenInfo.objectAddress == address(poolSetup.token), "ERROR:COS-018:PRODUCT_POOL_TOKEN_MISMATCH");
-        // // TODO pool is not linked
-
-        // IRegistry.ObjectInfo memory distributionInfo = _registry.getObjectInfo(info.distributionNftId);
-
-        // if(distributionInfo.objectType != DISTRIBUTION()) {
-        //     revert  InvalidDistribution();
-        // } 
-
-        // if(distributionInfo.parentNftId != instanceNftId) {
-        //     revert InvalidDistributionsInstance();
-        // }
-        // // TODO distribution have the same token
-        // // TODO distribution is not linked
-
-        // // component module
-        // instance.registerComponent(
-        //     nftId,
-        //     info.token,
-        //     wallet // TODO move wallet into TreasuryInfo?
-        // );
-
-        // treasury module
-        instance.createProductSetup(
-            nftId, 
-            info
-        );
-    }
-
-    function _registerPool(
-        NftId nftId,
-        NftId instanceNftId,
-        IInstance instance,
-        bytes memory data
-    )
-        internal
-    {
-        (
-            ISetup.PoolSetupInfo memory info,
-            address wallet,
-            IERC20Metadata token,
-            /*poolFee*/,
-            /*stakingFee*/,
-            /*performanceFee*/
-        )  = abi.decode(data, (ISetup.PoolSetupInfo, address, IERC20Metadata, Fee, Fee, Fee));
-
-        IRegistry _registry = getRegistry();
-
-        if(wallet == address(0)) {
-            revert WalletIsZero();
-        }
-
-        ObjectType tokenType = _registry.getObjectInfo(address(token)).objectType;
-
-        if(tokenType != TOKEN()) {
-            revert InvalidToken();
-        } 
-
-        if(UFixedLib.eqz(info.collateralizationLevel)) { 
-            revert CollateralizationLevelIsZero();
-        }
-
-        // TODO add more validations
-
-        // // component module
-        // instance.registerComponent(
-        //     nftId,
-        //     token,
-        //     wallet
-        // ); 
-
-        // pool module
-        instance.createPoolSetup(
-            nftId, 
-            info
-        );
-    }
-}

package/contracts/instance/service/DistributionService.sol

@@ -1,88 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {InstanceReader} from "../../instance/InstanceReader.sol";
-import {ISetup} from "../../instance/module/ISetup.sol";
-import {ITreasury} from "../../instance/module/ITreasury.sol";
-
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {DISTRIBUTION_OWNER_ROLE} from "../../types/RoleId.sol";
-import {KEEP_STATE} from "../../types/StateId.sol";
-import {DISTRIBUTION} from "../../types/ObjectType.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
-import {IDistributionService} from "./IDistributionService.sol";
-import {Distribution} from "../../components/Distribution.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {Instance} from "../Instance.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
-
-string constant DISTRIBUTION_SERVICE_NAME = "DistributionService";
-
-contract DistributionService is
-    ComponentServiceBase,
-    IDistributionService
-{
-    using NftIdLib for NftId;
-
-    string public constant NAME = "DistributionService";
-
-    address internal _registryAddress;
-    
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
-        // TODO while DistributionService is not deployed in DistributionServiceManager constructor
-        //      owner is DistributionServiceManager deployer
-        _initializeService(_registryAddress, owner);
-
-        _registerInterface(type(IService).interfaceId);
-        _registerInterface(type(IDistributionService).interfaceId);
-    }
-
-
-    function getName() public pure override(IService, Service) returns(string memory name) {
-        return NAME;
-    }
-
-    function _finalizeComponentRegistration(NftId componentNftId, bytes memory initialObjData, IInstance instance) internal override {
-        ISetup.DistributionSetupInfo memory initialSetup = abi.decode(
-            initialObjData,
-            (ISetup.DistributionSetupInfo)
-        );
-        instance.createDistributionSetup(componentNftId, initialSetup);
-    }
-
-    function setFees(
-        Fee memory distributionFee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(DISTRIBUTION());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId distributionNftId = info.nftId;
-
-        ISetup.DistributionSetupInfo memory distSetupInfo = instanceReader.getDistributionSetupInfo(distributionNftId);
-        distSetupInfo.distributionFee = distributionFee;
-        
-        instance.updateDistributionSetup(distributionNftId, distSetupInfo, KEEP_STATE());
-    }
-}

package/contracts/instance/service/IComponentOwnerService.sol

@@ -1,20 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {RoleId} from "../../types/RoleId.sol";
-import {IBaseComponent} from "../../components/IBaseComponent.sol";
-import {IService} from "../../shared/IService.sol";
-
-// TODO rename to registry service
-interface IComponentOwnerService is IService {
-
-    // TODO move to product/pool services
-    function lock(IBaseComponent component) external;
-
-    // TODO move to product/pool services
-    function unlock(IBaseComponent component) external;
-
-    function getRoleForType(ObjectType cType) external pure returns (RoleId role);
-}

package/contracts/instance/service/IDistributionService.sol

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../types/NftId.sol";
-import {Fee} from "../../types/Fee.sol";
-import {IService} from "../../shared/IService.sol";
-
-interface IDistributionService is IService {
-    function setFees(
-        Fee memory distributionFee
-    ) external;
-}