@etherisc/gif-next 0.0.2-743affe-003 → 0.0.2-770fd3b-604

package/contracts/shared/NftOwnable.sol

@@ -0,0 +1,190 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+// import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
+import {ERC165} from "./ERC165.sol";
+import {INftOwnable} from "./INftOwnable.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId, zeroNftId} from "../types/NftId.sol";
+import {RegistryLinked} from "./RegistryLinked.sol";
+
+contract NftOwnable is
+    ERC165,
+    RegistryLinked,
+    INftOwnable
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.NftOwnable")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant NFT_OWNABLE_STORAGE_LOCATION_V1 = 0x07ebcf49758b6ed3af50fa146bec0abe157c0218fe65dc0874c286e9d5da4f00;
+
+    struct NftOwnableStorage {
+        // IRegistry _registry;
+        NftId _nftId;
+        address _initialOwner; 
+    }
+
+    /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
+    modifier onlyOwner() {
+        if (msg.sender != getOwner()) {
+            revert ErrorNotOwner(msg.sender);
+        }
+        _;
+    }
+
+
+    /// @dev initialization for upgradable contracts
+    // used in _initializeRegisterable
+    function initializeNftOwnable(
+        address initialOwner,
+        address registryAddress
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        _setInitialOwner(initialOwner);
+
+        initializeRegistryLinked(registryAddress);
+        initializeERC165();
+        registerInterface(type(INftOwnable).interfaceId);
+    }
+
+
+    function initializeOwner(address initialOwner)
+        public
+        initializer()
+    {
+        _setInitialOwner(initialOwner);
+        initializeERC165();
+        registerInterface(type(INftOwnable).interfaceId);
+    }
+
+
+    /// @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
+        virtual
+    {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            revert ErrorAlreadyLinked(address(getRegistry()), $._nftId);
+        }
+
+        if (address(getRegistry()) == address(0)) {
+            revert ErrorRegistryNotInitialized();
+        }
+
+        address contractAddress = address(this);
+
+        if (!getRegistry().isRegistered(contractAddress)) {
+            revert ErrorContractNotRegistered(contractAddress);
+        }
+
+        $._nftId = getRegistry().getNftId(contractAddress);
+    }
+
+
+    // function getRegistry() public view virtual override returns (IRegistry) {
+    //     return _getNftOwnableStorage()._registry;
+    // }
+
+    function getNftId() public view virtual override returns (NftId) {
+        return _getNftOwnableStorage()._nftId;
+    }
+
+    function getInitialOwner() public view returns (address) {
+        return _getNftOwnableStorage()._initialOwner;
+    }
+
+    function getOwner() public view virtual override returns (address) {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            return getRegistry().ownerOf($._nftId);
+        }
+
+        return $._initialOwner;
+    }
+
+    /// @dev set initialOwner
+    /// initial owner may only be set during initialization
+    function _setInitialOwner(address initialOwner)
+        internal
+        virtual
+        onlyInitializing()
+    {
+        if(initialOwner == address(0)) {
+            revert ErrorInitialOwnerZero();
+        }
+
+        _getNftOwnableStorage()._initialOwner = initialOwner;
+    }
+
+    // TODO check if function can be refactored to work with a registry address set in an initializer
+    /// @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)
+    {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            revert ErrorAlreadyLinked(address(getRegistry()), $._nftId);
+        }
+
+        _setRegistry(registryAddress);
+
+        if (!getRegistry().isRegistered(nftOwnableAddress)) {
+            revert ErrorContractNotRegistered(nftOwnableAddress);
+        }
+
+        $._nftId = getRegistry().getNftId(nftOwnableAddress);
+
+        return $._nftId;
+    }
+
+
+    // function _setRegistry(address registryAddress)
+    //     private
+    // {
+    //     NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+    //     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);
+    //     }
+    // }
+
+
+    function _getNftOwnableStorage() private pure returns (NftOwnableStorage storage $) {
+        assembly {
+            $.slot := NFT_OWNABLE_STORAGE_LOCATION_V1
+        }
+    }
+}

package/contracts/shared/PolicyHolder.sol

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
+import {ERC165} from "./ERC165.sol";
+import {IPolicyHolder} from "./IPolicyHolder.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+import {NumberId} from "../types/NumberId.sol";
+import {RegistryLinked} from "./RegistryLinked.sol";
+
+/// @dev template implementation for IPolicyHolder
+contract PolicyHolder is
+    ERC165,
+    RegistryLinked,
+    IPolicyHolder
+{
+    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.PolicyHolder")) - 1)) & ~bytes32(uint256(0xff));
+    // TODO fix address
+    bytes32 public constant POLICY_HOLDER_STORAGE_LOCATION_V1 = 0x07ebcf49758b6ed3af50fa146bec0abe157c0218fe65dc0874c286e9d5da4f00;
+
+    // TODO uncomment/fix/refactor
+    struct PolicyHolderStorage {
+        // mapping(NftId policyId => mapping(NumberId claimId => address beneficiary)) private _claimBeneficiary;
+        // mapping(NftId policyId => address beneficiary) private _beneficiary;
+        bool dummy;
+    }
+
+    function initializePolicyHolder(
+        address registryAddress
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeRegistryLinked(registryAddress);
+    }
+
+    /// @dev empty default implementation
+    function policyCreatedCallback(NftId policyNftId) external virtual { }
+
+    /// @dev empty default implementation
+    function payoutExecutedCallback(NftId policyNftId, NumberId payoutId, address beneficiary, uint256 amount) external virtual { }
+
+    /// @dev determines beneficiary address that will be used in payouts targeting this contract
+    /// returned address will override GIF default where the policy nft holder is treated as beneficiary
+    function getBeneficiary(NftId policyId, NumberId claimId) external virtual view returns (address beneficiary) { 
+        // TODO add implementation
+    }
+
+    //--- IERC165 functions ---------------// 
+    function onERC721Received(
+        address, // operator
+        address, // from
+        uint256, // tokenId
+        bytes calldata // data
+    )
+        external
+        virtual
+        returns (bytes4)
+    {
+        return IERC721Receiver.onERC721Received.selector;
+    }
+
+    function _setBeneficiary(address beneficiary) internal {
+
+    }
+
+    function _setBeneficiary(NftId policyId, address beneficiary) internal {
+
+    }
+
+    function _getPolicyHolderStorage() private pure returns (PolicyHolderStorage storage $) {
+        assembly {
+            $.slot := POLICY_HOLDER_STORAGE_LOCATION_V1
+        }
+    }
+}

package/contracts/shared/ProxyManager.sol

@@ -1,16 +1,18 @@
 // 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";
 import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-import {IVersionable} from "./IVersionable.sol";
 
 /// @dev manages proxy deployments for upgradable contracs of type IVersionable
-contract ProxyManager is Ownable {
+contract ProxyManager is
+    NftOwnable
+{
 
     event LogProxyDeployed(address indexed proxy, address initialImplementation);
     event LogProxyDeployedWithSalt(address indexed proxy, address initialImplementation);
@@ -20,23 +22,26 @@ contract ProxyManager is Ownable {
     error ErrorAlreadyDeployedWithSalt();
     error ErrorNotYetDeployed();
 
-    UpgradableProxyWithAdmin private _proxy;
-    bool private _isDeployed;
+    UpgradableProxyWithAdmin internal _proxy;
+    bool internal _isDeployed;
 
     /// @dev only used to capture proxy owner
     constructor()
-        Ownable(msg.sender)
-    { }
+    { 
+        initializeOwner(msg.sender);
+    }
 
     /// @dev deploy initial contract
     function deploy(address initialImplementation, bytes memory initializationData)
         public
+        virtual
         onlyOwner()
         returns (IVersionable versionable)
     {
         if (_isDeployed) { revert ErrorAlreadyDeployed(); }
+        _isDeployed = true;
 
-        address currentProxyOwner = owner(); // used by implementation
+        address currentProxyOwner = getOwner(); // used by implementation
         address initialProxyAdminOwner = address(this); // used by proxy
         bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
         
@@ -46,36 +51,11 @@ contract ProxyManager is Ownable {
             data
         );
 
-        _isDeployed = true;
         versionable = IVersionable(address(_proxy));
 
         emit LogProxyDeployed(address(_proxy), initialImplementation);
     }
 
-    function deployWithSalt(address initialImplementation, bytes memory initializationData, bytes32 salt)
-        public
-        onlyOwner()
-        returns (IVersionable versionable)
-    {
-        if (_isDeployed) { revert ErrorAlreadyDeployedWithSalt(); }
-
-        address currentProxyOwner = owner(); // used by implementation
-        address initialProxyAdminOwner = address(this); // used by proxy
-        bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
-
-        // via create2
-        _proxy = new UpgradableProxyWithAdmin{salt: salt}(
-            initialImplementation,
-            initialProxyAdminOwner,
-            data
-        );
-
-        _isDeployed = true;
-        versionable = IVersionable(address(_proxy));
-
-        emit LogProxyDeployedWithSalt(address(_proxy), initialImplementation);
-    }
-
     /// @dev upgrade existing contract
     function upgrade(address newImplementation, bytes memory upgradeData)
         public
@@ -85,8 +65,8 @@ contract ProxyManager is Ownable {
     {
         if (!_isDeployed) { revert ErrorNotYetDeployed(); }
 
-        address currentProxyOwner = owner();
-        ProxyAdmin proxyAdmin = getProxyAdmin();
+        address currentProxyOwner = getOwner();
+        ProxyAdmin proxyAdmin = getProxy().getProxyAdmin();
         ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
         bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
 
@@ -102,14 +82,14 @@ contract ProxyManager is Ownable {
     }
 
     function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
-        return abi.encodeWithSelector(IVersionable.initialize.selector, implementation, proxyOwner, deployData);
+        return abi.encodeWithSelector(IVersionable.initializeVersionable.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);
+        return abi.encodeWithSelector(IVersionable.upgradeVersionable.selector, implementation, proxyOwner, upgradeData);
     }
 
-    function getProxyAdmin() public returns (ProxyAdmin) {
-        return _proxy.getProxyAdmin();
+    function getProxy() public returns (UpgradableProxyWithAdmin) {
+        return _proxy;
     }
 }

package/contracts/shared/Registerable.sol

@@ -1,29 +1,27 @@
 // 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";
 import {IRegisterable} from "./IRegisterable.sol";
 import {Versionable} from "./Versionable.sol";
 
-import {ERC165} from "./ERC165.sol";
-
-abstract contract Registerable is
-    ERC165,
-    IRegisterable,
-    Initializable
+contract Registerable is
+    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,15 +33,7 @@ abstract contract Registerable is
         }
     }
 
-    modifier onlyOwner() virtual {
-        require(
-            msg.sender == getOwner(),
-            "ERROR:RGB-001:NOT_OWNER"
-        );
-        _;
-    }
-
-    function _initializeRegisterable(
+    function initializeRegisterable(
         address registryAddress,
         NftId parentNftId,
         ObjectType objectType,
@@ -51,67 +41,41 @@ abstract contract Registerable is
         address initialOwner,
         bytes memory data
     )
-        internal
-        //onlyInitializing//TODO uncomment when "fully" upgradeable
+        public
         virtual
+        onlyInitializing
     {
-        require(
-            registryAddress != address(0),
-            "ERROR:RGB-010:REGISTRY_ZERO"
-        );
+        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);
+        registerInterface(type(IRegisterable).interfaceId);
     }
 
-    // from IOwnable
-    function getOwner() public view virtual returns (address) {
-        return _getRegisterableStorage()._registry.ownerOf(address(this));
-    }
-
-    // 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 
         view 
         virtual 
-        returns (IRegistry.ObjectInfo memory, bytes memory data) 
+        returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage storage $ = _getRegisterableStorage();
-        return (
-            IRegistry.ObjectInfo(
-                zeroNftId(),
-                $._parentNftId,
-                $._objectType,
-                $._isInterceptor,
-                address(this), 
-                $._initialOwner,
-                $._data
-            ),
-            bytes("")
-        );
+        RegisterableStorage memory $ = _getRegisterableStorage();
+        info = IRegistry.ObjectInfo(
+            zeroNftId(),
+            $._parentNftId,
+            $._objectType,
+            $._isInterceptor,
+            address(this), 
+            getInitialOwner(),
+            $._data);
     }
 }

package/contracts/shared/RegistryLinked.sol

@@ -0,0 +1,64 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegistryLinked} from "./IRegistryLinked.sol";
+
+contract RegistryLinked is
+    Initializable,
+    IRegistryLinked
+{
+
+    IRegistry private _registry;
+
+    /// @dev initialization for upgradable contracts
+    // used in _initializeRegisterable
+    function initializeRegistryLinked(
+        address registryAddress
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        _setRegistry(registryAddress);
+    }
+
+
+    function getRegistry() public view returns (IRegistry) {
+        return _registry;
+    }
+
+
+    function getRegistryAddress() public view returns (address) {
+        return address(_registry);
+    }
+
+
+    function _setRegistry(address registryAddress)
+        internal
+    {
+
+        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/Service.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType, SERVICE} from "../types/ObjectType.sol";
+import {NftId, zeroNftId} from "../types/NftId.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+
+import {Versionable} from "./Versionable.sol";
+import {IService} from "./IService.sol";
+import {IVersionable} from "./IVersionable.sol";
+import {Versionable} from "./Versionable.sol";
+import {Registerable} from "./Registerable.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+
+/// @dev service base contract
+abstract contract Service is 
+    Registerable,
+    Versionable,
+    IService
+{
+    function getDomain() public pure virtual override returns(ObjectType);
+
+    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
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        // service must provide its name and version upon registration
+        bytes memory data = abi.encode(getDomain(), 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;
+    }
+}