@etherisc/gif-next 0.0.2-f63e99e-607 → 0.0.2-f677999-878

package/contracts/instance/service/PoolService.sol

@@ -1,208 +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, RoleId} 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;
-
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        address initialOwner = address(0);
-        (_registryAddress, initialOwner) = abi.decode(data, (address, address));
-
-        _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 
-        onlyInstanceRole(POOL_OWNER_ROLE(), poolComponentAddress)
-        returns (NftId poolNftId)
-    {
-        address componentOwner = msg.sender;
-        Pool pool = Pool(poolComponentAddress);
-        IInstance instance = pool.getInstance();
-        
-        IRegistryService registryService = getRegistryService();
-        (IRegistry.ObjectInfo memory poolObjInfo, bytes memory initialObjData ) = registryService.registerPool(
-            pool,
-            componentOwner
-        );
-        poolNftId = poolObjInfo.nftId;
-
-        ISetup.PoolSetupInfo memory initialSetup = abi.decode(
-            initialObjData,
-            (ISetup.PoolSetupInfo)
-        );
-        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
-        
-        // TODO 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/ERC165.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-
-contract ERC165 is IERC165 {
-    mapping(bytes4 => bool) private _isSupported;
-
-    constructor() {
-        _initializeERC165();
-    }
-
-    function supportsInterface(bytes4 interfaceId) external view override returns (bool) {
-        return _isSupported[interfaceId];
-    }
-
-    // @dev register support for ERC165 itself
-    function _initializeERC165() internal {
-        _isSupported[type(IERC165).interfaceId] = true;
-    }
-
-    function _registerInterface(bytes4 interfaceId) internal {
-        _isSupported[interfaceId] = true;
-    }
-}

package/contracts/shared/ProxyManager.sol

@@ -1,94 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
-import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-import {NftOwnable} from "./NftOwnable.sol";
-import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-
-/// @dev manages proxy deployments for upgradable contracs of type IVersionable
-contract ProxyManager is
-    NftOwnable
-{
-
-    event LogProxyDeployed(address indexed proxy, address initialImplementation);
-    event LogProxyDeployedWithSalt(address indexed proxy, address initialImplementation);
-    event LogProxyUpgraded(address indexed proxy, address upgradedImplementation);
-
-    error ErrorAlreadyDeployed();
-    error ErrorAlreadyDeployedWithSalt();
-    error ErrorNotYetDeployed();
-
-    UpgradableProxyWithAdmin internal _proxy;
-    bool internal _isDeployed;
-
-    /// @dev only used to capture proxy owner
-    constructor()
-        NftOwnable()
-    { }
-
-    /// @dev deploy initial contract
-    function deploy(address initialImplementation, bytes memory initializationData)
-        public
-        virtual
-        onlyOwner()
-        returns (IVersionable versionable)
-    {
-        if (_isDeployed) { revert ErrorAlreadyDeployed(); }
-
-        address currentProxyOwner = getOwner(); // used by implementation
-        address initialProxyAdminOwner = address(this); // used by proxy
-        bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
-        
-        _proxy = new UpgradableProxyWithAdmin(
-            initialImplementation,
-            initialProxyAdminOwner,
-            data
-        );
-
-        _isDeployed = true;
-        versionable = IVersionable(address(_proxy));
-
-        emit LogProxyDeployed(address(_proxy), initialImplementation);
-    }
-
-    /// @dev upgrade existing contract
-    function upgrade(address newImplementation, bytes memory upgradeData)
-        public
-        virtual
-        onlyOwner()
-        returns (IVersionable versionable)
-    {
-        if (!_isDeployed) { revert ErrorNotYetDeployed(); }
-
-        address currentProxyOwner = getOwner();
-        ProxyAdmin proxyAdmin = getProxy().getProxyAdmin();
-        ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
-        bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
-
-        proxyAdmin.upgradeAndCall(
-            proxy,
-            newImplementation, 
-            data);
-
-        versionable = IVersionable(address(_proxy));
-
-        emit LogProxyUpgraded(address(_proxy), newImplementation);
-
-    }
-
-    function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
-        return abi.encodeWithSelector(IVersionable.initialize.selector, implementation, proxyOwner, deployData);
-    }
-
-    function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
-        return abi.encodeWithSelector(IVersionable.upgrade.selector, implementation, proxyOwner, upgradeData);
-    }
-
-    function getProxy() public returns (UpgradableProxyWithAdmin) {
-        return _proxy;
-    }
-}

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/shared/Versionable.sol

@@ -1,147 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
-
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-
-
-
-abstract contract Versionable is 
-    Initializable,
-    IVersionable 
-{
-    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant VERSIONABLE_LOCATION_V1 = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
-
-
-    /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
-    struct VersionableStorage {
-        mapping(Version version => VersionInfo info) _versionHistory;
-        Version [] _versions;
-        Version _v1;
-    }
-
-
-    constructor() {
-        _disableInitializers();
-    }
-    // TODO write test where new version of private _updateVersionHistory is added and used... 
-    function initialize(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        public
-        initializer
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _initialize(activatedBy, data);
-    }
-
-    // TODO activatedBy MUST ALWAYS be an owner?
-    function upgrade(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        external
-        reinitializer(VersionLib.toUint64(getVersion()))
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _upgrade(data);
-    }
-
-    function isInitialized(Version _version) public override view returns(bool) {
-        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
-    }
-
-    function getVersion() public pure virtual returns(Version);
-
-    function getVersionCount() public view override returns(uint256) {
-        return _getVersionableStorage()._versions.length;
-    }
-
-    function getVersion(uint256 idx) public view override returns(Version) {
-        return _getVersionableStorage()._versions[idx];
-    }
-
-    function getVersionInfo(Version _version) public override view returns(VersionInfo memory) {
-        return _getVersionableStorage()._versionHistory[_version];
-    }
-
-    function getInitializedVersion() public view returns(uint64) {
-        return _getInitializedVersion();
-    }
-
-
-
-    // IMPORTANT each version must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    // each implementation MUST call intializers of all base contracts...
-    function _initialize(address owner, bytes memory data) 
-        internal
-        onlyInitializing
-        virtual 
-    {
-        revert();
-    }
-
-
-    // IMPORTANT each version except version "1" must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    function _upgrade(bytes memory data)
-        internal
-        onlyInitializing
-        virtual
-    {
-        revert();
-    }
-
-    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
-        assembly {
-            $.slot := VERSIONABLE_LOCATION_V1
-        }
-    }
-
-    // can only be called once per contract
-    // needs to be called inside the proxy upgrade tx
-    // TODO run reinitializer(version().toUint64()) modifier after "version()" is checked, 
-    function _updateVersionHistory(
-        address implementation,
-        address activatedBy
-    )
-        private
-        onlyInitializing
-    {
-        VersionableStorage storage $ = _getVersionableStorage();
-
-        uint64 version = _getInitializedVersion();
-
-        Version thisVersion = getVersion();
-
-        if(version == 1) {
-            // thisVersion is alias to version "1"
-            $._v1 = thisVersion;
-        }
-        else {
-            require(thisVersion > $._v1, "INVALID VERSION");
-        }
-
-        // update version history
-        $._versions.push(thisVersion);
-        $._versionHistory[thisVersion] = VersionInfo(
-            thisVersion,
-            implementation,
-            activatedBy,
-            TimestampLib.blockTimestamp(),
-            blockNumber()
-        );
-
-        emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
-    }
-}

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(); } 
-}