@etherisc/gif-next 0.0.2-bc11089-132 → 0.0.2-bca28f1-161

package/contracts/shared/NftOwnable.sol

@@ -1,15 +1,27 @@
 // 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";
-
-contract NftOwnable is INftOwnable {
-
-    IRegistry internal _registry;
-    NftId private _nftId;
-    address private _initialOwner; 
+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() {
@@ -19,67 +31,100 @@ contract NftOwnable is INftOwnable {
         _;
     }
 
-    constructor() {
-        _initialOwner = 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 {
-        if (_nftId.gtz()) {
-            revert ErrorAlreadyLinked(address(_registry), _nftId);
+    function linkToRegisteredNftId()
+        public
+        virtual
+    {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            revert ErrorAlreadyLinked(address(getRegistry()), $._nftId);
         }
 
-        if (address(_registry) == address(0)) {
+        if (address(getRegistry()) == address(0)) {
             revert ErrorRegistryNotInitialized();
         }
 
         address contractAddress = address(this);
 
-        if (!_registry.isRegistered(contractAddress)) {
+        if (!getRegistry().isRegistered(contractAddress)) {
             revert ErrorContractNotRegistered(contractAddress);
         }
 
-        _nftId = _registry.getNftId(contractAddress);
+        $._nftId = getRegistry().getNftId(contractAddress);
     }
 
 
-    function getRegistry() public view virtual override returns (IRegistry) {
-        return _registry;
-    }
-
+    // function getRegistry() public view virtual override returns (IRegistry) {
+    //     return _getNftOwnableStorage()._registry;
+    // }
 
     function getNftId() public view virtual override returns (NftId) {
-        return _nftId;
+        return _getNftOwnableStorage()._nftId;
     }
 
+    function getInitialOwner() public view returns (address) {
+        return _getNftOwnableStorage()._initialOwner;
+    }
 
     function getOwner() public view virtual override returns (address) {
-        if (_nftId.gtz()) {
-            return _registry.ownerOf(_nftId);
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            return getRegistry().ownerOf($._nftId);
         }
 
-        return _initialOwner;
+        return $._initialOwner;
     }
 
-
-    /// @dev initialization for upgradable contracts
-    // used in _initializeRegisterable
-    function _initializeNftOwnable(
-        address initialOwner,
-        address registryAddress
-    )
+    /// @dev set initialOwner
+    /// initial owner may only be set during initialization
+    function _setInitialOwner(address initialOwner)
         internal
         virtual
+        onlyInitializing()
     {
-        require(initialOwner > address(0), "NftOwnable: initial owner is 0");
-        _initialOwner = initialOwner;
-        _setRegistry(registryAddress);
-    }
+        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(
@@ -90,45 +135,56 @@ contract NftOwnable is INftOwnable {
         onlyOwner()
         returns (NftId)
     {
-        if (_nftId.gtz()) {
-            revert ErrorAlreadyLinked(address(_registry), _nftId);
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            revert ErrorAlreadyLinked(address(getRegistry()), $._nftId);
         }
 
         _setRegistry(registryAddress);
 
-        if (!_registry.isRegistered(nftOwnableAddress)) {
+        if (!getRegistry().isRegistered(nftOwnableAddress)) {
             revert ErrorContractNotRegistered(nftOwnableAddress);
         }
 
-        _nftId = _registry.getNftId(nftOwnableAddress);
+        $._nftId = getRegistry().getNftId(nftOwnableAddress);
 
-        return _nftId;
+        return $._nftId;
     }
 
 
-    function _setRegistry(address registryAddress)
-        private
-    {
-        if (address(_registry) != address(0)) {
-            revert ErrorRegistryAlreadyInitialized(address(_registry));
-        }
+    // function _setRegistry(address registryAddress)
+    //     private
+    // {
+    //     NftOwnableStorage storage $ = _getNftOwnableStorage();
 
-        if (registryAddress == address(0)) {
-            revert ErrorRegistryAddressZero();
-        }
+    //     if (address($._registry) != address(0)) {
+    //         revert ErrorRegistryAlreadyInitialized(address($._registry));
+    //     }
 
-        if (registryAddress.code.length == 0) {
-            revert ErrorNotRegistry(registryAddress);
-        }
+    //     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);
+    //     }
+    // }
 
-        _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

@@ -27,8 +27,9 @@ contract ProxyManager is
 
     /// @dev only used to capture proxy owner
     constructor()
-        NftOwnable()
-    { }
+    { 
+        initializeOwner(msg.sender);
+    }
 
     /// @dev deploy initial contract
     function deploy(address initialImplementation, bytes memory initializationData)
@@ -38,6 +39,7 @@ contract ProxyManager is
         returns (IVersionable versionable)
     {
         if (_isDeployed) { revert ErrorAlreadyDeployed(); }
+        _isDeployed = true;
 
         address currentProxyOwner = getOwner(); // used by implementation
         address initialProxyAdminOwner = address(this); // used by proxy
@@ -49,7 +51,6 @@ contract ProxyManager is
             data
         );
 
-        _isDeployed = true;
         versionable = IVersionable(address(_proxy));
 
         emit LogProxyDeployed(address(_proxy), initialImplementation);
@@ -81,11 +82,11 @@ contract ProxyManager is
     }
 
     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 getProxy() public returns (UpgradableProxyWithAdmin) {

package/contracts/shared/Registerable.sol

@@ -11,11 +11,7 @@ import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
 import {Versionable} from "./Versionable.sol";
 
-import {ERC165} from "./ERC165.sol";
-
 contract Registerable is
-    ERC165,
-    Initializable,
     NftOwnable,
     IRegisterable
 {
@@ -37,7 +33,7 @@ contract Registerable is
         }
     }
 
-    function _initializeRegisterable(
+    function initializeRegisterable(
         address registryAddress,
         NftId parentNftId,
         ObjectType objectType,
@@ -45,12 +41,11 @@ contract Registerable is
         address initialOwner,
         bytes memory data
     )
-        internal
-        //onlyInitializing//TODO uncomment when "fully" upgradeable
+        public
         virtual
+        onlyInitializing
     {
-        _initializeERC165();
-        _initializeNftOwnable(
+        initializeNftOwnable(
             initialOwner,
             registryAddress);
 
@@ -63,7 +58,7 @@ contract Registerable is
         $._isInterceptor = isInterceptor;
         $._data = data;
 
-        _registerInterface(type(IRegisterable).interfaceId);
+        registerInterface(type(IRegisterable).interfaceId);
     }
 
 
@@ -71,20 +66,16 @@ contract Registerable is
         public 
         view 
         virtual 
-        returns (IRegistry.ObjectInfo memory, bytes memory data) 
+        returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage storage $ = _getRegisterableStorage();
-        return (
-            IRegistry.ObjectInfo(
-                getNftId(),
-                $._parentNftId,
-                $._objectType,
-                $._isInterceptor,
-                address(this), 
-                getOwner(),
-                $._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

@@ -1,21 +1,26 @@
 // 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 {ObjectType, SERVICE} from "../types/ObjectType.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";
+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 
-    RegisterableUpgradable,
+    Registerable,
+    Versionable,
     IService
 {
-    function getName() public pure virtual override returns(string memory name);
+    function getDomain() public pure virtual override returns(ObjectType);
 
     function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
         return getVersion().toMajorPart(); 
@@ -31,21 +36,21 @@ abstract contract Service is
         return VersionLib.toVersion(3,0,0);
     }
 
-    function _initializeService(
+    function initializeService(
         address registry, 
         address initialOwner
     )
-        internal
+        public
         virtual
-        //onlyInitializing //TODO uncomment when "fully" upgradeable
+        onlyInitializing()
     {
         // service must provide its name and version upon registration
-        bytes memory data = abi.encode(getName(), getMajorVersion());
+        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);
+        initializeRegisterable(registry, registryNftId, SERVICE(), isInterceptor, initialOwner, data);
+        registerInterface(type(IService).interfaceId);
     }
 
     // this is just a conveniene function, actual validation will be done upon registration

package/contracts/shared/Versionable.sol

@@ -31,7 +31,8 @@ abstract contract Versionable is
         _disableInitializers();
     }
     // TODO write test where new version of private _updateVersionHistory is added and used... 
-    function initialize(
+
+    function initializeVersionable(
         address implementation,
         address activatedBy,
         bytes memory data
@@ -44,7 +45,7 @@ abstract contract Versionable is
     }
 
     // TODO activatedBy MUST ALWAYS be an owner?
-    function upgrade(
+    function upgradeVersionable(
         address implementation,
         address activatedBy,
         bytes memory data

package/contracts/test/TestRegisterable.sol

@@ -13,6 +13,6 @@ contract TestRegisterable is Registerable {
     // solhint-disable-next-line no-empty-blocks
     {
         bytes memory data = "";
-        _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
+        initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
     }
 }

package/contracts/test/TestService.sol

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

package/contracts/types/DistributorType.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Key32, KeyId, Key32Lib} from "./Key32.sol";
 import {NftId} from "./NftId.sol";
-import {DISTRIBUTION_TYPE} from "./ObjectType.sol";
+import {DISTRIBUTOR_TYPE} from "./ObjectType.sol";
 
 type DistributorType is bytes8;
 
@@ -45,7 +45,7 @@ library DistributorTypeLib {
 
     /// @dev Returns the key32 value for the specified nft id and object type.
     function toKey32(DistributorType id) public pure returns (Key32 key) {
-        return Key32Lib.toKey32(DISTRIBUTION_TYPE(), toKeyId(id));
+        return Key32Lib.toKey32(DISTRIBUTOR_TYPE(), toKeyId(id));
     }
 
     /// @dev Returns the key id value for the specified nft id

package/contracts/types/ObjectType.sol

@@ -66,7 +66,7 @@ function DISTRIBUTION() pure returns (ObjectType) {
     return toObjectType(120);
 }
 
-function DISTRIBUTION_TYPE() pure returns (ObjectType) {
+function DISTRIBUTOR_TYPE() pure returns (ObjectType) {
     return toObjectType(121);
 }
 
@@ -90,10 +90,14 @@ function RISK() pure returns (ObjectType) {
     return toObjectType(200);
 }
 
-function POLICY() pure returns (ObjectType) {
+function APPLICATION() pure returns (ObjectType) {
     return toObjectType(210);
 }
 
+function POLICY() pure returns (ObjectType) {
+    return toObjectType(211);
+}
+
 function BUNDLE() pure returns (ObjectType) {
     return toObjectType(220);
 }