@etherisc/gif-next 0.0.2-fbe22f0-239 → 0.0.2-fbe6493-116

package/contracts/shared/NftOwnable.sol

@@ -1,22 +1,20 @@
 // 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 {InitializableERC165} from "./InitializableERC165.sol";
 import {INftOwnable} from "./INftOwnable.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId, zeroNftId} from "../types/NftId.sol";
+import {NftId} from "../type/NftId.sol";
+import {RegistryLinked} from "./RegistryLinked.sol";
 
 contract NftOwnable is
-    ERC165,
+    InitializableERC165,
+    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; 
     }
@@ -24,7 +22,7 @@ contract NftOwnable is
     /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
     modifier onlyOwner() {
         if (msg.sender != getOwner()) {
-            revert ErrorNotOwner(msg.sender);
+            revert ErrorNftOwnableNotOwner(msg.sender);
         }
         _;
     }
@@ -40,20 +38,14 @@ contract NftOwnable is
         virtual
         onlyInitializing()
     {
-        _setInitialOwner(initialOwner);
-        _setRegistry(registryAddress);
+        initializeRegistryLinked(registryAddress);
         initializeERC165();
-        registerInterface(type(INftOwnable).interfaceId);
-    }
 
+        if(initialOwner == address(0)) {
+            revert ErrorNftOwnableInitialOwnerZero();
+        }
 
-    function initializeOwner(address initialOwner)
-        public
-        initializer()
-    {
-        _setInitialOwner(initialOwner);
-        initializeERC165();
-        registerInterface(type(INftOwnable).interfaceId);
+        _getNftOwnableStorage()._initialOwner = initialOwner;
     }
 
 
@@ -64,121 +56,49 @@ contract NftOwnable is
     function linkToRegisteredNftId()
         public
         virtual
+        returns (NftId nftId)
     {
-        NftOwnableStorage storage $ = _getNftOwnableStorage();
-
-        if ($._nftId.gtz()) {
-            revert ErrorAlreadyLinked(address($._registry), $._nftId);
-        }
-
-        if (address($._registry) == address(0)) {
-            revert ErrorRegistryNotInitialized();
-        }
-
-        address contractAddress = address(this);
-
-        if (!$._registry.isRegistered(contractAddress)) {
-            revert ErrorContractNotRegistered(contractAddress);
-        }
-
-        $._nftId = $._registry.getNftId(contractAddress);
-    }
-
-
-    function getRegistry() public view virtual override returns (IRegistry) {
-        return _getNftOwnableStorage()._registry;
+        return _linkToNftOwnable(address(this));
     }
 
     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 $._registry.ownerOf($._nftId);
+            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($._registry), $._nftId);
+            revert ErrorNftOwnableAlreadyLinked($._nftId);
         }
 
-        _setRegistry(registryAddress);
-
-        if (!$._registry.isRegistered(nftOwnableAddress)) {
-            revert ErrorContractNotRegistered(nftOwnableAddress);
+        if (!getRegistry().isRegistered(nftOwnableAddress)) {
+            revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
         }
 
-        $._nftId = $._registry.getNftId(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

@@ -1,31 +1,70 @@
 // 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 {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {InitializableERC165} from "./InitializableERC165.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 {NftId} from "../type/NftId.sol";
+import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {RegistryLinked} from "./RegistryLinked.sol";
 
+/// @dev template implementation for IPolicyHolder
 contract PolicyHolder is
-    ERC165,
+    InitializableERC165,
+    RegistryLinked, // TODO need upgradeable version
     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;
+
+    struct PolicyHolderStorage {
+        mapping(NftId policyId => mapping(PayoutId payoutId => address beneficiary)) _beneficiary;
+        address _beneficiaryDefault;
+    }
+
+    function initializePolicyHolder(
+        address registryAddress,
+        address beneficiaryDefault
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeRegistryLinked(registryAddress);
+
+        _getPolicyHolderStorage()._beneficiaryDefault = beneficiaryDefault;
+
+        registerInterface(type(IPolicyHolder).interfaceId);
+    }
 
     /// @dev empty default implementation
-    function policyCreated(NftId policyNftId) external virtual { }
+    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external { }
 
     /// @dev empty default implementation
-    function payoutProcessed(NftId policyNftId, NumberId payoutId, address beneficiary, uint256 amount) external virtual { }
+    function policyActivated(NftId policyNftId) external {}
 
-    /// @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
+    /// @dev empty default implementation
+    function policyExpired(NftId policyNftId) external {}
+
+    /// @dev empty default implementation
+    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external {}
+
+    /// @dev empty default implementation
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external {}
+
+    /// @dev returns payout specific beneficiary
+    /// when no such beneficiary is defined the policy specific beneficiary is returned
+    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external virtual view returns (address beneficiary) {
+        beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId];
+
+        // fallback to claim independent beneficiary
+        if(beneficiary == address(0) && payoutId.gtz()) {
+            beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][PayoutIdLib.zero()];
+        }
     }
 
     //--- IERC165 functions ---------------// 
@@ -42,11 +81,19 @@ contract PolicyHolder is
         return IERC721Receiver.onERC721Received.selector;
     }
 
-    function _setBeneficiary(address beneficiary) internal {
-
+    /// @dev sets policy specific beneficiary (used when no payout specific beneficiary is defined)
+    function _setBeneficiary(NftId policyNftId, address beneficiary) internal {
+        _setBeneficiary(policyNftId, PayoutIdLib.zero(), beneficiary);
     }
 
-    function _setBeneficiary(NftId policyId, address beneficiary) internal {
+    /// @dev sets policy and claim specific beneficiary
+    function _setBeneficiary(NftId policyNftId, PayoutId payoutId, address beneficiary) internal {
+        _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId] = beneficiary;
+    }
 
+    function _getPolicyHolderStorage() private pure returns (PolicyHolderStorage storage $) {
+        assembly {
+            $.slot := POLICY_HOLDER_STORAGE_LOCATION_V1
+        }
     }
 }

package/contracts/shared/Registerable.sol

@@ -3,13 +3,12 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-import {NftId, zeroNftId} from "../types/NftId.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
-import {ObjectType} from "../types/ObjectType.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
-import {Versionable} from "./Versionable.sol";
 
 contract Registerable is
     NftOwnable,
@@ -18,8 +17,6 @@ contract Registerable is
     // 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 {
         NftId _parentNftId;
         ObjectType _objectType;
@@ -27,19 +24,13 @@ contract Registerable is
         bytes _data;
     }
 
-    function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
-        assembly {
-            $.slot := REGISTERABLE_LOCATION_V1
-        }
-    }
-
     function initializeRegisterable(
         address registryAddress,
         NftId parentNftId,
         ObjectType objectType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory data
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
         public
         virtual
@@ -49,16 +40,15 @@ contract Registerable is
             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...
+        RegisterableStorage storage $;
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
 
-        RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        $._data = data;
-
-        registerInterface(type(IRegisterable).interfaceId);
+        $._data = registryData;
     }
 
 
@@ -68,14 +58,18 @@ contract Registerable is
         virtual 
         returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage memory $ = _getRegisterableStorage();
+        RegisterableStorage storage $;
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
+
         info = IRegistry.ObjectInfo(
-            zeroNftId(),
+            NftIdLib.zero(),
             $._parentNftId,
             $._objectType,
             $._isInterceptor,
             address(this), 
-            getInitialOwner(),
+            getOwner(),
             $._data);
     }
 }

package/contracts/shared/RegistryLinked.sol

@@ -0,0 +1,43 @@
+// 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()
+    {
+        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 getRegistry() public view returns (IRegistry) {
+        return _registry;
+    }
+}

package/contracts/shared/Service.sol

@@ -1,60 +1,82 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {ObjectType, SERVICE} from "../types/ObjectType.sol";
-import {NftId, zeroNftId} from "../types/NftId.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {Versionable} from "./Versionable.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "./IVersionable.sol";
-import {Versionable} from "./Versionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
+import {RoleId, RoleIdLib} from "../type/RoleId.sol";
+import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 /// @dev service base contract
 abstract contract Service is 
     Registerable,
     Versionable,
+    AccessManagedUpgradeable,
     IService
 {
-    function getDomain() public pure virtual override returns(ObjectType);
 
-    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
-        return getVersion().toMajorPart(); 
-    }
+    uint8 private constant GIF_MAJOR_VERSION = 3;
 
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
 
     function initializeService(
         address registry, 
+        address authority, // real authority for registry service adress(0) for other services
         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, 
+            IRegistry(registry).getNftId(), 
+            SERVICE(), 
+            false, // is interceptor
+            initialOwner, 
+            ""); // data
+
+        // externally provided authority
+        if(authority != address(0)) {
+            __AccessManaged_init(authority);
+        } else {
+            address registryServiceAddress = _getServiceAddress(REGISTRY());
+
+            // copy authority from already registered registry services
+            __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
+        }
 
-        initializeRegisterable(registry, registryNftId, SERVICE(), isInterceptor, initialOwner, data);
+        registerInterface(type(IAccessManaged).interfaceId);
         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);
+    function getDomain() external virtual pure returns(ObjectType serviceDomain) {
+        return _getDomain();
+    }
+
+    function getRoleId() external virtual pure returns(RoleId serviceRoleId) {
+        return RoleIdLib.roleForTypeAndVersion(_getDomain(), VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+    }
+
+    // from Versionable
+    function getVersion()
+        public 
+        pure 
+        virtual override (IVersionable, Versionable)
+        returns(Version)
+    {
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+    }
+
+    function _getDomain() internal virtual pure returns (ObjectType);
+
+    function _getServiceAddress(ObjectType domain) internal view returns (address) {
+        return getRegistry().getServiceAddress(domain, VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
     }
 }

package/contracts/shared/TokenHandler.sol

@@ -4,24 +4,59 @@ 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";
 
+import {Amount} from "../type/Amount.sol";
+
+/// @dev token specific transfer helper
+/// a default token contract is provided via contract constructor
+/// relies internally on oz SafeERC20.safeTransferFrom
 contract TokenHandler {
+    event LogTokenHandlerTokenTransfer(address token, address from, address to, uint256 amount);
+
     IERC20Metadata private _token;
 
     constructor(address token) {
         _token = IERC20Metadata(token);
     }
 
-    // TODO add logging
+    /// @dev transfer amount default tokens 
     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);
+        Amount amount
+    )
+        external
+    {
+        emit LogTokenHandlerTokenTransfer(address(_token), from, to, amount.toInt());
+        SafeERC20.safeTransferFrom(
+            _token, 
+            from, 
+            to, 
+            amount.toInt());
+    }
+
+    /// @dev transfer amount of the specified token
+    function safeTransferFrom(
+        address token,
+        address from,
+        address to,
+        Amount amount
+    )
+        external
+    {
+        emit LogTokenHandlerTokenTransfer(token, from, to, amount.toInt());
+        SafeERC20.safeTransferFrom(
+            IERC20Metadata(token), 
+            from, 
+            to, 
+            amount.toInt());
     }
 
-    function getToken() external view returns (IERC20Metadata) {
+    /// @dev returns the default token defined for this TokenHandler
+    function getToken()
+        external
+        view 
+        returns (IERC20Metadata)
+    {
         return _token;
     }
 }

package/contracts/shared/TokenTransferLib.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount} from "../type/Amount.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+
+// library 
+library TokenTransferLib {
+
+    error ErrorTokenTransferLibAmountIsZero();
+    error ErrorTokenTransferLibAllowanceTooSmall(address from, address spender, uint256 allowance, uint256 amount);
+    
+    /// @dev collect tokens from outside of the gif and transfer them to a wallet within the scope of gif
+    function collectTokens(
+        address from,
+        address to,
+        Amount amount,
+        TokenHandler tokenHandler
+    )
+        internal
+    {
+        _transfer(from, to, amount, tokenHandler);
+    }
+
+    /// @dev distribute tokens from a wallet within the scope of gif to an external address
+    function distributeTokens(
+        address from,
+        address to,
+        Amount amount,
+        TokenHandler tokenHandler
+    )
+        internal
+    {
+        _transfer(from, to, amount, tokenHandler);
+    }
+
+    function _transfer(
+        address from,
+        address to,
+        Amount amount,
+        TokenHandler tokenHandler
+    )
+        internal
+    {
+        if (amount.eqz()) {
+            revert ErrorTokenTransferLibAmountIsZero();
+        }
+
+        uint256 allowance = tokenHandler.getToken().allowance(from, address(tokenHandler));
+        if (allowance < amount.toInt()) {
+            revert ErrorTokenTransferLibAllowanceTooSmall(from, address(tokenHandler), allowance, amount.toInt());
+        }
+
+        tokenHandler.transfer(
+            from,
+            to,
+            amount);
+    }
+
+}