@etherisc/gif-next 0.0.2-d408403-475 → 0.0.2-d48ae55-246

package/contracts/shared/IVersionable.sol

@@ -1,9 +1,34 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
-import {Version, VersionPart} from "../types/Version.sol";
+import {Blocknumber} from "../types/Blocknumber.sol";
+import {Timestamp} from "../types/Timestamp.sol";
+import {Version} from "../types/Version.sol";
+
+
+/// IMPORTANT
+// Upgradeable contract MUST:
+// 1) inherit from Versionable
+// 2) implement version() function
+// 3) implement internal _initialize() function with onlyInitializing modifier 
+// 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
+// 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
+// 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
+// 7) use namespace storage
+// 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version 
+// Upgradeable contract SHOULD:
+// 9) define all non private methods as virtual (in order to be able to upgrade them latter)
+//    otherwise, it is still possible to upgrade contract, but everyone who is using it will have to switch to a new fucntions
+//    in some cases this ok but not in the others...
+//
+// IMPORTANT
+// Each version MUST:
+// 1) define namespace storage struct if accessing storage
+//      - DO NOT use structs inside, except
+//      - CAN use structs ONLY inside mappings
+// 2) ALWAYS define private getter if accessing storage
+//      - MUST use default implementation, CAN change ONLY return type
+//      - MUST use the same "LOCATION_V1"
 
 interface IVersionable {
 
@@ -15,22 +40,35 @@ interface IVersionable {
         Blocknumber activatedIn;
     }
 
-    event LogVersionableActivated(Version version, address implementation, address activatedBy);
+    event LogVersionableInitialized(Version version, address implementation, address activatedBy);
+
+    // TODO uncomment when all implementations are ready
+    /**
+     * @dev IMPORTANT
+     * implementation MUST be guarded by initializer modifier
+     * implementation MUST call internal function Versionable._updateVersionHistory 
+     * new version MUST inherit from previous version
+     */
+    function initializeVersionable(address implementation, address activatedBy, bytes memory activationData) external;
 
     /**
-     * @dev IMPORTANT this function needs to be implemented by each new version
-     * any such activate implementation needs to call internal function call _activate() 
-     * any new version needs to inherit from previous version
+     * @dev
+     * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
+     * implementation MUST call internal function Versionable._updateVersionHistory
+     * new version MUST inherit from previous version
+     * the first verion MUST revert 
      */
-    function activate(address implementation, address activatedBy) external;
+    function upgradeVersionable(address implementation, address activatedBy, bytes memory upgradeData) external;
 
     /**
      * @dev returns true if the specified version has been activated for the current contract
      */
-    function isActivated(Version version) external view returns(bool);
+    function isInitialized(Version version) external view returns(bool);
 
     /**
-     * @dev returns currently active version of this contract
+     * @dev returns version of this contract
+     * each new implementation MUST implement this function
+     * version number MUST increase 
      */
     function getVersion() external pure returns(Version);
 
@@ -49,4 +87,10 @@ interface IVersionable {
      */
     function getVersionInfo(Version version) external view returns(VersionInfo memory versionInfo);
 
+    // TODO make sure it is needed here
+    /**
+     * @dev returns currently active version
+     */
+    function getInitializedVersion() external view returns(uint64);
+
 }

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

@@ -0,0 +1,95 @@
+// 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()
+    { 
+        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 = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
+        bytes memory data = getDeployData(initialImplementation, currentProxyOwner, initializationData);
+        
+        _proxy = new UpgradableProxyWithAdmin(
+            initialImplementation,
+            initialProxyAdminOwner,
+            data
+        );
+
+        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.initializeVersionable.selector, implementation, proxyOwner, deployData);
+    }
+
+    function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
+        return abi.encodeWithSelector(IVersionable.upgradeVersionable.selector, implementation, proxyOwner, upgradeData);
+    }
+
+    function getProxy() public returns (UpgradableProxyWithAdmin) {
+        return _proxy;
+    }
+}

package/contracts/shared/Registerable.sol

@@ -1,86 +1,81 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
+
+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,
+contract Registerable is
+    NftOwnable,
     IRegisterable
 {
-    IRegistry internal immutable _registry;
-    NftId internal immutable _parentNftId;
-    address internal immutable _initialOwner;
-
-    modifier onlyOwner() virtual {
-        require(
-            msg.sender == getOwner(),
-            "ERROR:RGB-001:NOT_OWNER"
-        );
-        _;
-    }
-
-    constructor(
-        address registryAddress,
-        NftId parentNftId
-    )
-        ERC165()
-    {
-        require(
-            address(registryAddress) != address(0),
-            "ERROR:RGB-010:REGISTRY_ZERO"
-        );
-
-        _registry = IRegistry(registryAddress);
-        require(
-            _registry.supportsInterface(type(IRegistry).interfaceId),
-            "ERROR:RGB-011:NOT_REGISTRY"
-        );
-
-        _parentNftId = parentNftId;
-        require(
-            _registry.isRegistered(_parentNftId),
-            "ERROR:RGB-012:PARENT_NOT_REGISTERED"
-        );
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
 
-        _initialOwner = msg.sender;
+    error ErrorRegisterableNotRegistry(address registryAddress);
 
-        // register support for IRegisterable
-        _registerInterface(type(IRegisterable).interfaceId);
+    struct RegisterableStorage {
+        NftId _parentNftId;
+        ObjectType _objectType;
+        bool _isInterceptor;
+        bytes _data;
     }
 
-    // from IRegistryLinked
-    function register() public onlyOwner virtual override returns (NftId nftId) {
-        return _registry.register(address(this));
+    function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
     }
 
-    function getRegistry() public view virtual override returns (IRegistry registry) {
-        return _registry;
-    }
+    function initializeRegisterable(
+        address registryAddress,
+        NftId parentNftId,
+        ObjectType objectType,
+        bool isInterceptor,
+        address initialOwner,
+        bytes memory data
+    )
+        public
+        virtual
+        onlyInitializing
+    {
+        initializeNftOwnable(
+            initialOwner,
+            registryAddress);
 
-    function getOwner() public view virtual override returns (address owner) {
-        NftId nftId = _registry.getNftId(address(this));
-        if(nftId == zeroNftId()) {
-            return _initialOwner;
-        }
+        // 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...
 
-        return _registry.getOwner(nftId);
-    }
+        RegisterableStorage storage $ = _getRegisterableStorage();
+        $._parentNftId = parentNftId;
+        $._objectType = objectType;
+        $._isInterceptor = isInterceptor;
+        $._data = data;
 
-    function getNftId() public view override returns (NftId nftId) {
-        return _registry.getNftId(address(this));
+        registerInterface(type(IRegisterable).interfaceId);
     }
 
-    function getParentNftId() public view override returns (NftId nftId) {
-        return _parentNftId;
-    }
 
-    function getData() public view virtual override returns (bytes memory data) {
-        return "";
+    function getInitialInfo() 
+        public 
+        view 
+        virtual 
+        returns (IRegistry.ObjectInfo memory info) 
+    {
+        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);
+        }
+    }
+}