@etherisc/gif-next 0.0.2-b63c0fc-410 → 0.0.2-b6e6545-463

package/contracts/instance/service/PoolService.sol

@@ -1,211 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Pool} from "../../components/Pool.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IBundle} from "../../instance/module/IBundle.sol";
-import {TokenHandler} from "../../instance/module/ITreasury.sol";
-import {ISetup} from "../module/ISetup.sol";
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {Versionable} from "../../shared/Versionable.sol";
-import {INftOwnable} from "../../shared/INftOwnable.sol";
-
-import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
-import {POOL, BUNDLE} from "../../types/ObjectType.sol";
-import {POOL_OWNER_ROLE} from "../../types/RoleId.sol";
-import {Fee, FeeLib} from "../../types/Fee.sol";
-import {Version, VersionLib} from "../../types/Version.sol";
-import {KEEP_STATE} from "../../types/StateId.sol";
-import {zeroTimestamp} from "../../types/Timestamp.sol";
-
-import {IService} from "../../shared/IService.sol";
-import {Service} from "../../shared/Service.sol";
-import {ComponentServiceBase} from "../base/ComponentServiceBase.sol";
-import {IPoolService} from "./IPoolService.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceReader} from "../InstanceReader.sol";
-
-
-string constant POOL_SERVICE_NAME = "PoolService";
-
-contract PoolService is 
-    ComponentServiceBase, 
-    IPoolService 
-{
-    using NftIdLib for NftId;
-
-    string public constant NAME = "PoolService";
-
-    address internal _registryAddress;
-    InstanceService internal _instanceService;
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
-
-        IRegistry registry = IRegistry(_registryAddress);
-        _instanceService = InstanceService(registry.getServiceAddress("InstanceService", getMajorVersion()));
-
-        _initializeService(_registryAddress, initialOwner);
-
-        _registerInterface(type(IService).interfaceId);
-        _registerInterface(type(IPoolService).interfaceId);
-    }
-
-    function getName() public pure override(Service, IService) returns(string memory name) {
-        return NAME;
-    }
-
-    function register(address poolComponentAddress) 
-        external 
-        returns (NftId poolNftId)
-    {
-        address componentOwner = msg.sender;
-        Pool pool = Pool(poolComponentAddress);
-        IInstance instance = pool.getInstance();
-        INftOwnable nftOwnable = INftOwnable(address(instance));
-        
-        require(_instanceService.hasRole(componentOwner, POOL_OWNER_ROLE(), nftOwnable.getNftId()), "ERROR:POS-001:NOT_POOL_OWNER_ROLE");
-        
-        IRegistryService registryService = getRegistryService();
-        (IRegistry.ObjectInfo memory poolObjInfo, ) = registryService.registerPool(
-            pool,
-            componentOwner
-        );
-        poolNftId = poolObjInfo.nftId;
-
-        ISetup.PoolSetupInfo memory initialSetup = pool.getInitialSetupInfo();
-        instance.createPoolSetup(poolNftId, initialSetup);
-    }
-
-    function setFees(
-        Fee memory poolFee,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory poolInfo, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = poolInfo.nftId;
-
-        ISetup.PoolSetupInfo memory poolSetupInfo = instanceReader.getPoolSetupInfo(poolNftId);
-        poolSetupInfo.poolFee = poolFee;
-        poolSetupInfo.stakingFee = stakingFee;
-        poolSetupInfo.performanceFee = performanceFee;
-        
-        instance.updatePoolSetup(poolNftId, poolSetupInfo, KEEP_STATE());
-    }
-
-    function createBundle(
-        address owner, 
-        Fee memory fee, 
-        uint256 stakingAmount, 
-        uint256 lifetime, 
-        bytes calldata filter
-    )
-        external
-        override
-        returns(NftId bundleNftId)
-    {
-        (IRegistry.ObjectInfo memory info, IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
-
-        IBundle.BundleInfo  memory bundleInfo = IBundle.BundleInfo(
-            poolNftId,
-            FeeLib.zeroFee(),
-            filter,
-            stakingAmount,
-            0,
-            stakingAmount,
-            lifetime,
-            zeroTimestamp(),
-            zeroTimestamp()
-        );
-
-        // register bundle with registry
-        bundleNftId = getRegistryService().registerBundle(
-            IRegistry.ObjectInfo(
-                zeroNftId(), 
-                poolNftId,
-                BUNDLE(),
-                false, // intercepting property for bundles is defined on pool
-                address(0),
-                owner,
-                abi.encode(bundleInfo)
-            )
-        );
-
-        // create bundle info in instance
-        instance.createBundle(bundleNftId, bundleInfo);
-
-        // TODO add bundle to pool in instance
-        
-        // collect capital
-        _processStakingByTreasury(
-            instanceReader,
-            zeroNftId(),
-            poolNftId,
-            bundleNftId,
-            stakingAmount);
-
-        // TODO add logging
-    }
-
-    function setBundleFee(
-        NftId bundleNftId,
-        Fee memory fee
-    )
-        external
-        override
-    {
-        (IRegistry.ObjectInfo memory info , IInstance instance) = _getAndVerifyComponentInfoAndInstance(POOL());
-        InstanceReader instanceReader = instance.getInstanceReader();
-        NftId poolNftId = info.nftId;
-
-        IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
-        require(bundleInfo.poolNftId.gtz(), "ERROR:PLS-010:BUNDLE_UNKNOWN");
-        require(poolNftId == bundleInfo.poolNftId, "ERROR:PLS-011:BUNDLE_POOL_MISMATCH");
-
-        bundleInfo.fee = fee;
-
-        instance.updateBundle(bundleNftId, bundleInfo, KEEP_STATE());
-    }
-
-
-
-    function _processStakingByTreasury(
-        InstanceReader instanceReader,
-        NftId productNftId,
-        NftId poolNftId,
-        NftId bundleNftId,
-        uint256 stakingAmount
-    )
-        internal
-    {
-        // process token transfer(s)
-        if(stakingAmount > 0) {
-            TokenHandler tokenHandler = TokenHandler(instanceReader.getTokenHandler(productNftId));
-            address bundleOwner = getRegistry().ownerOf(bundleNftId);
-            ISetup.PoolSetupInfo memory poolInfo = instanceReader.getPoolSetupInfo(poolNftId);
-            
-            tokenHandler.transfer(
-                bundleOwner,
-                poolInfo.wallet,
-                stakingAmount
-            );
-        }
-    }
-}

package/contracts/instance/service/PoolServiceManager.sol

@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IVersionable} from "../../shared/IVersionable.sol";
-import {ProxyManager} from "../../shared/ProxyManager.sol";
-import {PoolService} from "./PoolService.sol";
-import {Registry} from "../../registry/Registry.sol";
-import {RegistryService} from "../../registry/RegistryService.sol";
-import {VersionLib} from "../../types/Version.sol";
-
-contract PoolServiceManager is ProxyManager {
-
-    PoolService private _poolService;
-
-    /// @dev initializes proxy manager with pool service implementation 
-    constructor(
-        address registryAddress
-    )
-        ProxyManager()
-    {
-        PoolService poolSrv = new PoolService();
-        bytes memory data = abi.encode(registryAddress, address(this));
-        IVersionable versionable = deploy(
-            address(poolSrv), 
-            data);
-
-        _poolService = PoolService(address(versionable));
-
-        Registry registry = Registry(registryAddress);
-        address registryServiceAddress = registry.getServiceAddress("RegistryService", VersionLib.toVersion(3, 0, 0).toMajorPart());
-        RegistryService registryService = RegistryService(registryServiceAddress);
-        
-        registryService.registerService(_poolService);
-        
-        // link ownership of instance service manager ot nft owner of instance service
-        _linkToNftOwnable(
-            address(registryAddress),
-            address(_poolService));
-
-        // implies that after this constructor call only upgrade functionality is available
-        _isDeployed = true;
-    }
-
-    //--- view functions ----------------------------------------------------//
-    function getPoolService()
-        external
-        view
-        returns (PoolService poolService)
-    {
-        return _poolService;
-    }
-
-}

package/contracts/shared/ContractDeployerLib.sol

@@ -1,72 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-library ContractDeployerLib {
-
-    event LogContractDeployed(address contractAddress);
-
-    error ErrorCreationCodeHashMismatch(bytes32 expectedHash, bytes32 actualHash);
-
-    /// @dev deploys a new contract using the provided creation code
-    function deploy(
-        bytes memory creationCode,
-        bytes32 expectedCreationCodeHash
-    ) 
-        public
-        returns (address contractAdress)
-    {
-        // check against expected hash, if provided
-        if (expectedCreationCodeHash != bytes32(0)) {
-            bytes32 creationCodeHash = getHash(creationCode);
-            if (creationCodeHash != expectedCreationCodeHash) {
-                revert ErrorCreationCodeHashMismatch(expectedCreationCodeHash, creationCodeHash);
-            }
-        }
-
-        // solhint-disable no-inline-assembly
-        assembly {
-            contractAdress := create(0, add(creationCode, 0x20), mload(creationCode))  
-
-            if iszero(extcodesize(contractAdress)) {
-                revert(0, 0)
-            }
-        }
-        // solhint enable
-
-        emit LogContractDeployed(contractAdress);
-    }
-
-    /// @dev gets the creation code for the new contract
-    // for terminology see eg https://www.rareskills.io/post/ethereum-contract-creation-code
-    function getCreationCode(
-        bytes memory byteCodeWithInitCode, // what you get with type(<Contract>).creationCode
-        bytes memory encodedConstructorArguments // what you get with 
-    )
-        public
-        pure
-        returns (bytes memory creationCode)
-    {
-        return abi.encodePacked(byteCodeWithInitCode, encodedConstructorArguments);
-    }
-
-
-    function matchesWithHash(
-        bytes memory creationCode,
-        bytes32 expectedHash
-    )
-        public
-        pure
-        returns (bool isMatching)
-    {
-        return getHash(creationCode) == expectedHash;
-    }
-
-
-    function getHash(bytes memory creationCode)
-        public
-        pure
-        returns (bytes32 hash)
-    {
-        return keccak256(creationCode);
-    }
-}

package/contracts/shared/RegisterableUpgradable.sol

@@ -1,16 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Registerable} from "./Registerable.sol";
-import {Versionable} from "./Versionable.sol";
-
-/// @dev base contract for upgradable objects like services and upgradable components
-/// deriving contracs need to call _initializeRegisterable
-/// TODO internalizes versionable here, a non-registerable versionalbe might itself have some value but is outside the scope of the gif
-/// after this merge versionable will no longer exist on its own in gif
-/// only registerable and upgradable (which is a registerable too) will remain
-abstract contract RegisterableUpgradable is 
-    Registerable,
-    Versionable
-{
-}

package/contracts/test/TestFee.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {UFixed, UFixedLib} from "../types/UFixed.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-
-contract TestFee {
-
-    function createFee(
-        uint256 fractionalValue,
-        int8 exponent,
-        uint256 fixedValue
-    )
-        external 
-        pure 
-        returns(Fee memory fee)
-    {
-        return FeeLib.toFee(UFixedLib.toUFixed(fractionalValue, exponent), fixedValue);
-    }
-
-    function getZeroFee() external pure returns(Fee memory fee) {
-        return FeeLib.zeroFee();
-    }
-
-}

package/contracts/test/TestRegisterable.sol

@@ -1,18 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType, TOKEN} from "../../contracts/types/ObjectType.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
-import {Registerable} from "../../contracts/shared/Registerable.sol";
-
-contract TestRegisterable is Registerable {
-
-    constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
-        //Registerable(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        bytes memory data = "";
-        _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
-    }
-}

package/contracts/test/TestRoleId.sol

@@ -1,14 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {RoleId, RoleIdLib, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
-
-contract TestRoleId {
-    function getRole(uint256 roleNum) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleNum); }
-
-    function getProductOwnerRoleName() external pure returns (string memory) { return PRODUCT_OWNER_ROLE_NAME(); }
-    function getProductOwnerRole() external pure returns (RoleId) { return PRODUCT_OWNER_ROLE(); } 
-
-    function getPoolOwnerRoleName() external pure returns (string memory) { return POOL_OWNER_ROLE_NAME(); }
-    function getPoolOwnerRole() external pure returns (RoleId) { return POOL_OWNER_ROLE(); } 
-}

package/contracts/test/TestService.sol

@@ -1,24 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../contracts/types/NftId.sol";
-import {Version, VersionLib} from "../../contracts/types/Version.sol";
-import {Service} from "../../contracts/shared/Service.sol";
-
-import {IVersionable} from "../../contracts/shared/IVersionable.sol";
-import {Versionable} from "../../contracts/shared/Versionable.sol";
-
-contract TestService is Service {
-
-    string public constant NAME = "TestService";
-
-    constructor(address registry, NftId registryNftId, address initialOwner)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        _initializeService(registry, initialOwner);
-    }
-
-    function getName() public pure override returns(string memory name) {
-        return NAME;
-    }
-}

package/contracts/test/TestToken.sol

@@ -1,26 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
-
-contract TestUsdc is ERC20 {
-
-    // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
-    string public constant NAME = "USDC - Test";
-    string public constant SYMBOL = "USDC";
-    uint8 public constant DECIMALS = 6;
-    uint256 public constant INITIAL_SUPPLY = 10**9 * 10**DECIMALS; // 1 Billion 1'000'000'000
-    // decimals == 18 (openzeppelin erc20 default)
-    constructor()
-        ERC20(NAME, SYMBOL)
-    {
-        _mint(
-            _msgSender(),
-            INITIAL_SUPPLY
-        );   
-    }
-
-    function decimals() public pure override returns(uint8) {
-        return DECIMALS;
-    }
-}

package/contracts/test/TestVersion.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
-
-contract TestVersion {
-
-    function createVersion(uint major, uint minor, uint patch) external pure returns(Version) {
-        return VersionLib.toVersion(major, minor, patch);
-    }
-
-    function createVersionPart(uint versionPart) external pure returns(VersionPart) {
-        return VersionLib.toVersionPart(uint8(versionPart));
-    }
-
-    function getVersionParts(Version version)
-        external
-        pure
-        returns(
-            VersionPart major,
-            VersionPart minor,
-            VersionPart patch
-        )
-    {
-        return version.toVersionParts();
-    }
-
-    function getMajorPart(Version version) external pure returns(VersionPart major) {
-        return version.toMajorPart();
-    }
-
-    function getZeroVersion() external pure returns(Version) {
-        return VersionLib.zeroVersion();
-    }
-
-    function isSameVersion(Version a, Version b) external pure returns(bool) {
-        return a == b;
-    }
-
-    function isLargerVersion(Version a, Version b) external pure returns(bool) {
-        return a > b;
-    }
-
-}

package/contracts/test/TestVersionable.sol

@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Version, VersionLib} from "../../contracts/types/Version.sol";
-import {Versionable} from "../../contracts/shared/Versionable.sol";
-
-contract TestVersionable is Versionable {
-
-    function getVersion()
-        public 
-        pure 
-        virtual override
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
-}

package/contracts/types/ChainId.sol

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-/// @dev bytes5 (uint40) allows for chain ids up to 13 digits
-type ChainId is bytes5;
-
-// type bindings
-using {eqChainId as ==, neChainId as !=, ChainIdLib.toInt} for ChainId global;
-
-// general pure free functions
-/// @dev Converts the uint256 to a ChainId.
-function toChainId(uint256 chainId) pure returns (ChainId) {
-    return ChainId.wrap(bytes5(uint40(chainId)));
-}
-
-/// @dev Return the ChainId for the chain the contract is deployed to
-function thisChainId() view returns (ChainId) {
-    return toChainId(block.chainid);
-}
-
-// pure free functions for operators
-/// @dev Returns true if the values are equal (==).
-function eqChainId(ChainId a, ChainId b) pure returns (bool isSame) {
-    return ChainId.unwrap(a) == ChainId.unwrap(b);
-}
-
-/// @dev Returns true if the values are not equal (!=).
-function neChainId(ChainId a, ChainId b) pure returns (bool isDifferent) {
-    return ChainId.unwrap(a) != ChainId.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library ChainIdLib {
-    /// @dev Converts the ChainId to a uint256.
-    function toInt(ChainId chainId) internal pure returns (uint256) {
-        return uint256(uint40(ChainId.unwrap(chainId)));
-    }
-}

package/contracts/types/NftIdSet.sol

@@ -1,60 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../types/NftId.sol";
-
-// based on https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/EnumerableSet.sol
-library LibNftIdSet {
-
-    struct Set {
-        NftId[] ids;
-        mapping(NftId nftid => uint256 index) at;
-    }
-
-    function add(Set storage set, NftId nftId) external returns(bool added) {
-        if (set.at[nftId] == 0) {
-            set.ids.push(nftId);
-            set.at[nftId] = set.ids.length;
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    function remove(Set storage set, NftId nftId) external returns(bool removed) {
-        uint256 nftIdIndex = set.at[nftId];
-
-        if (nftIdIndex > 0) {
-            uint256 toDeleteIndex = nftIdIndex - 1;
-            uint256 lastIndex = set.ids.length - 1;
-
-            if (lastIndex != toDeleteIndex) {
-                NftId lastId = set.ids[lastIndex];
-                set.ids[toDeleteIndex] = lastId;
-                set.at[lastId] = nftIdIndex; // Replace lastValue's index to valueIndex
-            }
-
-            set.ids.pop();
-            delete set.at[nftId];
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-    function isEmpty(Set storage set) external view returns(bool empty) {
-        return set.ids.length == 0;
-    }
-
-    function contains(Set storage set, NftId nftId) external view returns(bool inSet) {
-        return set.at[nftId] > 0;
-    }
-
-    function getLength(Set storage set) external view returns(uint256 length) {
-        return set.ids.length;
-    }
-
-    function getElementAt(Set storage set, uint256 index) external view returns(NftId nftId) {
-        return set.ids[index];
-    }
-}

package/contracts/types/NumberId.sol

@@ -1,52 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-// uint32 allows for 4'294'967'296 individual items
-type NumberId is uint32;
-
-// type bindings
-using {
-    eqNumberId as ==, 
-    neNumberId as !=, 
-    NumberIdLib.eqz,
-    NumberIdLib.gtz,
-    NumberIdLib.toInt
-} for NumberId global;
-
-
-// pure free functions for operators
-function eqNumberId(NumberId a, NumberId b) pure returns (bool isSame) {
-    return NumberId.unwrap(a) == NumberId.unwrap(b);
-}
-
-function neNumberId(NumberId a, NumberId b) pure returns (bool isDifferent) {
-    return NumberId.unwrap(a) != NumberId.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library NumberIdLib {
-    /// @dev Converts the NumberId to a uint.
-    function zero() public pure returns (NumberId) {
-        return NumberId.wrap(0);
-    }
-
-    /// @dev Converts an uint into a NumberId.
-    function toNumberId(uint256 a) public pure returns (NumberId) {
-        return NumberId.wrap(uint32(a));
-    }
-
-    /// @dev Converts the NumberId to a uint.
-    function toInt(NumberId a) public pure returns (uint32) {
-        return uint32(NumberId.unwrap(a));
-    }
-
-    /// @dev Returns true if the value is non-zero (> 0).
-    function gtz(NumberId a) public pure returns (bool) {
-        return NumberId.unwrap(a) > 0;
-    }
-
-    /// @dev Returns true if the value is zero (== 0).
-    function eqz(NumberId a) public pure returns (bool) {
-        return NumberId.unwrap(a) == 0;
-    }
-}