@etherisc/gif-next 0.0.2-e37834a-021 → 0.0.2-e43a6c3-340

package/contracts/registry/TokenRegistry.sol

@@ -0,0 +1,111 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {ERC165Checker} from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IRegistry} from "./IRegistry.sol";
+import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
+import {NftOwnable} from "../shared/NftOwnable.sol";
+
+/// @title contract to register token per GIF major release.
+contract TokenRegistry is
+    NftOwnable
+{
+
+    string public constant REGISTRY_SERVICE_NAME = "RegistryService";
+
+    event LogRegistered(address token, string symbol, uint256 decimals);
+    event LogTokenStateSet(address token, VersionPart majorVersion, bool active);
+
+    error NotContract(address account);
+    error NotToken(address account);
+    error TokenDecimalsZero();
+    error TokenMajorVersionInvalid(VersionPart majorVersion);
+
+    address [] internal _token;
+    mapping(address token => bool registered) internal _registered;
+    mapping(address token => mapping(VersionPart majorVersion => bool isActive)) internal _active;
+
+    constructor()
+        NftOwnable()
+    { }
+
+
+    /// @dev link ownership of token registry to nft owner of registry service
+    function linkToNftOwnable(address registryAddress) 
+        external
+        onlyOwner
+    {
+        IRegistry registry = IRegistry(registryAddress);
+        address registryServiceAddress = registry.getServiceAddress(REGISTRY_SERVICE_NAME, registry.getMajorVersion());
+
+        _linkToNftOwnable(registryAddress, registryServiceAddress);
+    }
+
+    /// @dev token state is informative, registry have no clue about used tokens
+    // component owner is responsible for token selection and operations
+    // service MUST deny registration of component with inactive token 
+    function setActive(address token, VersionPart majorVersion, bool active)
+        external
+        onlyOwner
+    {
+        // verify that token is registered
+        if (!_registered[token]) {
+            _registerToken(token);
+        }
+
+        // verify valid major version
+        // ensure major version increments is one
+        uint256 version = majorVersion.toInt();
+        if (version < _registry.getMajorVersionMin().toInt() || version > _registry.getMajorVersionMax().toInt()) {
+            revert TokenMajorVersionInvalid(majorVersion);
+        }
+
+        _active[token][majorVersion] = active;
+
+        emit LogTokenStateSet(token, majorVersion, active);
+    }
+
+    function tokens() external view returns (uint256) {
+        return _token.length;
+    }
+
+    function getToken(uint256 idx) external view returns (IERC20Metadata token) {
+        return IERC20Metadata(_token[idx]);
+    }
+
+    function isRegistered(address token) external view returns (bool) {
+        return _registered[token];
+    }
+
+     function isActive(address token, VersionPart majorVersion) external view returns (bool) {
+        return _active[token][majorVersion];
+    }
+
+    /// @dev some sanity checks to prevent unintended registration
+    function _registerToken(address token) internal {
+
+        // MUST be contract
+        if(token.code.length == 0) {
+            revert NotContract(token);
+        }
+
+        // MUST not be GIF registerable
+        if(ERC165Checker.supportsInterface(token, type(IRegisterable).interfaceId)) {
+            revert NotToken(token);
+        }
+
+        // MUST have decimals > 0
+        IERC20Metadata erc20 = IERC20Metadata(token);
+        if(erc20.decimals() == 0) {
+            revert TokenDecimalsZero();
+        }
+
+        _registered[token] = true;
+        _token.push(token);
+
+        emit LogRegistered(token, erc20.symbol(), erc20.decimals());
+    }
+}

package/contracts/shared/ERC165.sol

@@ -1,20 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
 contract ERC165 is IERC165 {
     mapping(bytes4 => bool) private _isSupported;
 
     constructor() {
-        // register support for ERC165
-        _registerInterface(type(IERC165).interfaceId);
+        _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/INftOwnable.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface INftOwnable {
+    error ErrorNotOwner(address account);
+
+    error ErrorAlreadyLinked(address registry, NftId nftId);
+    error ErrorRegistryAlreadyInitialized(address registry);
+    error ErrorRegistryNotInitialized();
+    error ErrorRegistryAddressZero();
+    error ErrorNotRegistry(address registryAddress);
+    error ErrorContractNotRegistered(address contractAddress);
+
+    function linkToRegisteredNftId() external;
+
+    function getRegistry() external view returns (IRegistry);
+    function getNftId() external view returns (NftId);
+    function getOwner() external view returns (address);
+}

package/contracts/shared/IRegisterable.sol

@@ -1,22 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin5/contracts/utils/introspection/IERC165.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 
-import {IOwnable} from "./IOwnable.sol";
-
-interface IRegisterable is IERC165, IOwnable {
-    function getRegistry() external view returns (IRegistry registry);
-
-    function getNftId() external view returns (NftId nftId);
+interface IRegisterable is IERC165, INftOwnable {
 
     function getInitialInfo() 
         external 
         view
         returns (IRegistry.ObjectInfo memory, bytes memory data);
-
 }

package/contracts/{instance/base → shared}/IService.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {VersionPart} from "../../types/Version.sol";
+import {VersionPart} from "../types/Version.sol";
 
-import {IRegisterable} from "../../shared/IRegisterable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
+import {IRegisterable} from "./IRegisterable.sol";
+import {IVersionable} from "./IVersionable.sol";
 
 interface IService is 
     IRegisterable,

package/contracts/shared/NftOwnable.sol

@@ -1,31 +1,23 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IOwnable} from "./IOwnable.sol";
+import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId, zeroNftId} from "../types/NftId.sol";
 
-contract NftOwnable is
-    IOwnable
-{
-    error ErrorNftOwnableUnauthorized(address account);
-
-    error ErrorAlreadyInitialized(address registry, NftId nftId);
-    error ErrorRegistryAlreadyInitialized(address registry);
-    error ErrorRegistryNotInitialized();
-    error ErrorRegistryAddressZero();
-    error ErrorContractNotRegistered(address contractAddress);
+contract NftOwnable is INftOwnable {
 
     IRegistry internal _registry;
     NftId private _nftId;
     address private _initialOwner; 
 
+    /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
     modifier onlyOwner() {
         address owner = getOwner();
 
         // owner == address(0) is eg uninitialized upgradable contract
         if (owner != address(0) && msg.sender != owner) {
-            revert ErrorNftOwnableUnauthorized(msg.sender);
+            revert ErrorNotOwner(msg.sender);
         }
         _;
     }
@@ -34,54 +26,111 @@ contract NftOwnable is
         _initialOwner = msg.sender;
     }
 
-    // function only needed during bootstrapping on a new chain
-    function linkToRegistry(
-        address registryAddress,
-        address contractAddress
-    )
-        internal
-        onlyOwner()
-        returns (NftId)
-    {
+    /// @dev links this contract to nft after registration
+    // needs to be done once per registered contract and 
+    // reduces registry calls to check ownership
+    // does not need any protection as function can only do the "right thing"
+    function linkToRegisteredNftId() public {
         if (_nftId.gtz()) {
-            revert ErrorAlreadyInitialized(address(_registry), _nftId);
+            revert ErrorAlreadyLinked(address(_registry), _nftId);
         }
 
-        if (address(_registry) != address(0)) {
-            revert ErrorRegistryAlreadyInitialized(address(_registry));
+        if (address(_registry) == address(0)) {
+            revert ErrorRegistryNotInitialized();
         }
 
-        if (registryAddress == address(0)) {
-            revert ErrorRegistryAddressZero();
-        }
-
-        _registry = IRegistry(registryAddress);
+        address contractAddress = address(this);
 
         if (!_registry.isRegistered(contractAddress)) {
             revert ErrorContractNotRegistered(contractAddress);
         }
 
         _nftId = _registry.getNftId(contractAddress);
-
-        return _nftId;
     }
 
 
-    function getRegistry() external view returns (IRegistry) {
+    function getRegistry() public view virtual override returns (IRegistry) {
         return _registry;
     }
 
 
-    function getNftId() external view returns (NftId) {
+    function getNftId() public view virtual override returns (NftId) {
         return _nftId;
     }
 
 
-    function getOwner() public view returns (address) {
+    function getOwner() public view virtual override returns (address) {
         if (_nftId.gtz()) {
             return _registry.ownerOf(_nftId);
         }
 
         return _initialOwner;
     }
+
+
+    /// @dev initialization for upgradable contracts
+    // used in _initializeRegisterable
+    function _initializeNftOwnable(
+        address initialOwner,
+        address registryAddress
+    )
+        internal
+        virtual
+    {
+        _initialOwner = initialOwner;
+        _setRegistry(registryAddress);
+    }
+
+
+    /// @dev used in constructor of registry service manager
+    // links ownership of registry service manager ot nft owner of registry service
+    function _linkToNftOwnable(
+        address registryAddress,
+        address nftOwnableAddress
+    )
+        internal
+        onlyOwner()
+        returns (NftId)
+    {
+        if (_nftId.gtz()) {
+            revert ErrorAlreadyLinked(address(_registry), _nftId);
+        }
+
+        _setRegistry(registryAddress);
+
+        if (!_registry.isRegistered(nftOwnableAddress)) {
+            revert ErrorContractNotRegistered(nftOwnableAddress);
+        }
+
+        _nftId = _registry.getNftId(nftOwnableAddress);
+
+        return _nftId;
+    }
+
+
+    function _setRegistry(address registryAddress)
+        private
+    {
+        if (address(_registry) != address(0)) {
+            revert ErrorRegistryAlreadyInitialized(address(_registry));
+        }
+
+        if (registryAddress == address(0)) {
+            revert ErrorRegistryAddressZero();
+        }
+
+        if (registryAddress.code.length == 0) {
+            revert ErrorNotRegistry(registryAddress);
+        }
+
+        _registry = IRegistry(registryAddress);
+
+        try _registry.supportsInterface(type(IRegistry).interfaceId) returns (bool isRegistry) {
+            if (!isRegistry) {
+                revert ErrorNotRegistry(registryAddress);
+            }
+        } catch {
+            revert ErrorNotRegistry(registryAddress);
+        }
+    }
 }

package/contracts/shared/ProxyManager.sol

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Ownable} from "@openzeppelin5/contracts/access/Ownable.sol";
-import {ProxyAdmin} from "@openzeppelin5/contracts/proxy/transparent/ProxyAdmin.sol";
-import {ITransparentUpgradeableProxy} from "@openzeppelin5/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+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";
@@ -55,15 +55,6 @@ contract ProxyManager is
         emit LogProxyDeployed(address(_proxy), initialImplementation);
     }
 
-    function linkToRegistry(address registryAddress)
-        public
-        virtual
-    {
-        // links ownership for this proxy manager to the owner of the underlying proxy nft
-        // applies onlyOwner modifier internally
-        linkToRegistry(registryAddress, address(_proxy));
-    }
-
     /// @dev upgrade existing contract
     function upgrade(address newImplementation, bytes memory upgradeData)
         public

package/contracts/shared/Registerable.sol

@@ -1,9 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol"; 
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {NftId, zeroNftId} from "../types/NftId.sol";
+import {NftOwnable} from "../shared/NftOwnable.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
@@ -12,18 +13,19 @@ import {Versionable} from "./Versionable.sol";
 
 import {ERC165} from "./ERC165.sol";
 
-abstract contract Registerable is
+contract Registerable is
     ERC165,
-    IRegisterable,
-    Initializable
+    Initializable,
+    NftOwnable,
+    IRegisterable
 {
     // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
     bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
 
+    error ErrorRegisterableNotRegistry(address registryAddress);
+
     struct RegisterableStorage {
-        IRegistry _registry;
         NftId _parentNftId;
-        address _initialOwner;
         ObjectType _objectType;
         bool _isInterceptor;
         bytes _data;
@@ -35,14 +37,6 @@ abstract contract Registerable is
         }
     }
 
-    modifier onlyOwner() virtual {
-        require(
-            msg.sender == getOwner(),
-            "ERROR:RGB-001:NOT_OWNER"
-        );
-        _;
-    }
-
     function _initializeRegisterable(
         address registryAddress,
         NftId parentNftId,
@@ -55,44 +49,23 @@ abstract contract Registerable is
         //onlyInitializing//TODO uncomment when "fully" upgradeable
         virtual
     {
-        require(
-            registryAddress != address(0),
-            "ERROR:RGB-010:REGISTRY_ZERO"
-        );
+        _initializeERC165();
+        _initializeNftOwnable(
+            initialOwner,
+            registryAddress);
 
         // TODO check parentNftId -> registry.isRegistered(parentNftId)
         // TODO check object-parent type pair -> registry.isValidTypeCombo() or something...verify with registry that setup will be able to register...
 
-        IRegistry registry = IRegistry(registryAddress);
-        require(
-            registry.supportsInterface(type(IRegistry).interfaceId),
-            "ERROR:RGB-011:NOT_REGISTRY"
-        );
-
         RegisterableStorage storage $ = _getRegisterableStorage();
-        $._registry = registry;
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        $._initialOwner = initialOwner;// not msg.sender because called in proxy constructor where msg.sender is proxy deployer
         $._data = data;
 
-        _registerInterface(type(Registerable).interfaceId);
-    }
-
-    // from IOwnable
-    function getOwner() public view virtual returns (address) {
-        return _getRegisterableStorage()._registry.ownerOf(address(this));
+        _registerInterface(type(IRegisterable).interfaceId);
     }
 
-    // from IRegisterable
-    function getRegistry() public view virtual returns (IRegistry registry) {
-        return _getRegisterableStorage()._registry;
-    }
-
-    function getNftId() public view virtual returns (NftId nftId) {
-        return _getRegisterableStorage()._registry.getNftId(address(this));
-    }
 
     function getInitialInfo() 
         public 
@@ -103,12 +76,12 @@ abstract contract Registerable is
         RegisterableStorage storage $ = _getRegisterableStorage();
         return (
             IRegistry.ObjectInfo(
-                zeroNftId(),
+                getNftId(),
                 $._parentNftId,
                 $._objectType,
                 $._isInterceptor,
                 address(this), 
-                $._initialOwner,
+                getOwner(),
                 $._data
             ),
             bytes("")

package/contracts/shared/RegisterableUpgradable.sol

@@ -0,0 +1,16 @@
+// 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/Service.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IService} from "./IService.sol";
+import {IVersionable} from "./IVersionable.sol";
+import {NftId, zeroNftId} from "../types/NftId.sol";
+import {RegisterableUpgradable} from "./RegisterableUpgradable.sol";
+import {SERVICE} from "../types/ObjectType.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {Versionable} from "./Versionable.sol";
+
+/// @dev service base contract
+abstract contract Service is 
+    RegisterableUpgradable,
+    IService
+{
+    function getName() public pure virtual override returns(string memory name);
+
+    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
+        return getVersion().toMajorPart(); 
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(3,0,0);
+    }
+
+    function _initializeService(
+        address registry, 
+        address initialOwner
+    )
+        internal
+        virtual
+        //onlyInitializing //TODO uncomment when "fully" upgradeable
+    {
+        // service must provide its name and version upon registration
+        bytes memory data = abi.encode(getName(), getMajorVersion());
+        NftId registryNftId = _getRegistryNftId(registry); 
+        bool isInterceptor = false;
+
+        _initializeRegisterable(registry, registryNftId, SERVICE(), isInterceptor, initialOwner, data);
+        _registerInterface(type(IService).interfaceId);
+    }
+
+    // this is just a conveniene function, actual validation will be done upon registration
+    function _getRegistryNftId(address registryAddress) internal view returns (NftId) {
+        return IRegistry(registryAddress).getNftId(registryAddress);
+    }
+}

package/contracts/shared/TokenHandler.sol

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+
+contract TokenHandler {
+    IERC20Metadata private _token;
+
+    constructor(address token) {
+        _token = IERC20Metadata(token);
+    }
+
+    // TODO add logging
+    function transfer(
+        address from,
+        address to,
+        uint256 amount // TODO add authz (only treasury/instance/product/pool/ service)
+    ) external {
+        SafeERC20.safeTransferFrom(_token, from, to, amount);
+        // _token.transferFrom(from, to, amount);
+    }
+
+    function getToken() external view returns (IERC20Metadata) {
+        return _token;
+    }
+}

package/contracts/shared/UpgradableProxyWithAdmin.sol

@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ProxyAdmin} from "@openzeppelin5/contracts/proxy/transparent/ProxyAdmin.sol";
-import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin5/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 
 import {IVersionable} from "./IVersionable.sol";
 

package/contracts/shared/Versionable.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
 import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
+import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
 import {Version, VersionPart, VersionLib} from "../types/Version.sol";
 
 import {IVersionable} from "./IVersionable.sol";
@@ -138,7 +138,7 @@ abstract contract Versionable is
             thisVersion,
             implementation,
             activatedBy,
-            blockTimestamp(),
+            TimestampLib.blockTimestamp(),
             blockNumber()
         );
 

package/contracts/test/TestFee.sol

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