@etherisc/gif-next 0.0.2-d16f92c-416 → 0.0.2-d18e1c5-511

package/contracts/shared/PolicyHolder.sol

@@ -1,74 +1,51 @@
 // 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 {IPolicyHolder} from "./IPolicyHolder.sol";
 
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ERC165} from "./ERC165.sol";
-import {IPolicyHolder} from "./IPolicyHolder.sol";
+import {InitializableERC165} from "./InitializableERC165.sol";
 import {NftId} from "../type/NftId.sol";
-import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 /// @dev template implementation for IPolicyHolder
 contract PolicyHolder is
-    ERC165,
-    RegistryLinked, // TODO need upgradeable version
+    InitializableERC165,
+    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;
-
-    struct PolicyHolderStorage {
-        mapping(NftId policyId => mapping(PayoutId payoutId => address beneficiary)) _beneficiary;
-        address _beneficiaryDefault;
-    }
+    // TODO add modifier to protect callback functions from unauthorized access
+    // callbacks must only be allowed from the policy and claim services
+    // will need a release parameter to fetch the right service addresses for the modifiers
 
-    function initializePolicyHolder(
-        address registryAddress,
-        address beneficiaryDefault
+    function _initializePolicyHolder(
+        address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-
-        _getPolicyHolderStorage()._beneficiaryDefault = beneficiaryDefault;
-
-        registerInterface(type(IPolicyHolder).interfaceId);
+        __RegistryLinked_init(registryAddress);
+        _initializeERC165();
+        _registerInterface(type(IPolicyHolder).interfaceId);
     }
 
     /// @dev empty default implementation
-    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external { }
-
-    /// @dev empty default implementation
-    function policyActivated(NftId policyNftId) external {}
+    function policyActivated(NftId policyNftId, Timestamp activatedAt) external virtual {}
 
     /// @dev empty default implementation
-    function policyExpired(NftId policyNftId) external {}
+    function policyExpired(NftId policyNftId, Timestamp expiredAt) external virtual {}
 
     /// @dev empty default implementation
-    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external {}
+    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external virtual {}
 
     /// @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()];
-        }
-    }
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external virtual {}
 
     //--- IERC165 functions ---------------// 
     function onERC721Received(
@@ -83,20 +60,4 @@ contract PolicyHolder is
     {
         return IERC721Receiver.onERC721Received.selector;
     }
-
-    /// @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);
-    }
-
-    /// @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

@@ -1,16 +1,22 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
+import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
+import {ContractLib} from "../shared/ContractLib.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {NftOwnable} from "../shared/NftOwnable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
+import {VersionPart, VersionPartLib} from "../type/Version.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
+import {IRelease} from "../registry/IRelease.sol";
 
-contract Registerable is
+abstract contract Registerable is
+    AccessManagedUpgradeable,
     NftOwnable,
     IRegisterable
 {
@@ -24,46 +30,64 @@ contract Registerable is
         bytes _data;
     }
 
-    function initializeRegisterable(
-        address registryAddress,
+    modifier onlyActive() {
+        if (!isActive()) {
+            revert ErrorRegisterableNotActive();
+        }
+        _;
+    }
+
+    function __Registerable_init(
+        address authority,
+        address registry,
         NftId parentNftId,
         ObjectType objectType,
         bool isInterceptor,
         address initialOwner,
-        bytes memory registryData // writeonly data that will saved in the object info record of the registry
+        bytes memory data // writeonly data that will saved in the object info record of the registry
     )
-        public
+        internal
         virtual
-        onlyInitializing
+        onlyInitializing()
     {
-        initializeNftOwnable(
-            initialOwner,
-            registryAddress);
-
-        RegisterableStorage storage $;
-        assembly {
-            $.slot := REGISTERABLE_LOCATION_V1
+        if (!ContractLib.isAuthority(authority)) {
+            revert ErrorAuthorityInvalid(authority);
         }
 
+        __AccessManaged_init(authority);
+        __NftOwnable_init(registry, initialOwner);
+
+        RegisterableStorage storage $ = _getRegisterableStorage();
         $._parentNftId = parentNftId;
         $._objectType = objectType;
         $._isInterceptor = isInterceptor;
-        $._data = registryData;
+        $._data = data;
+
+        _registerInterface(type(IAccessManaged).interfaceId);
+    }
+
+
+    /// @inheritdoc IRegisterable
+    function isActive() public virtual view returns (bool active) {
+        return !AccessManagerCloneable(authority()).isTargetClosed(address(this));
+    }
+
+
+    /// @inheritdoc IRelease
+    function getRelease() public virtual view returns (VersionPart release) {
+        return AccessManagerCloneable(authority()).getRelease();
     }
 
 
+    /// @inheritdoc IRegisterable
     function getInitialInfo() 
         public 
         view 
         virtual 
         returns (IRegistry.ObjectInfo memory info) 
     {
-        RegisterableStorage storage $;
-        assembly {
-            $.slot := REGISTERABLE_LOCATION_V1
-        }
-
-        info = IRegistry.ObjectInfo(
+        RegisterableStorage storage $ = _getRegisterableStorage();
+        return IRegistry.ObjectInfo(
             NftIdLib.zero(),
             $._parentNftId,
             $._objectType,
@@ -72,4 +96,11 @@ contract Registerable is
             getOwner(),
             $._data);
     }
+
+
+    function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
+    }
 }

package/contracts/shared/RegistryLinked.sol

@@ -2,6 +2,8 @@
 pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
+import {ContractLib} from "../shared/ContractLib.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryLinked} from "./IRegistryLinked.sol";
 
@@ -10,30 +12,23 @@ contract RegistryLinked is
     IRegistryLinked
 {
 
+    // priorize simplicity and size over using standard upgradeability structs
     IRegistry private _registry;
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function initializeRegistryLinked(
-        address registryAddress
+    function __RegistryLinked_init(
+        address registry
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        if (registryAddress.code.length == 0) {
-            revert ErrorNotRegistry(registryAddress);
+        if (!ContractLib.isRegistry(registry)) {
+            revert ErrorNotRegistry(registry);
         }
 
-        _registry = IRegistry(registryAddress);
-
-        try _registry.supportsInterface(type(IRegistry).interfaceId) returns (bool isRegistry) {
-            if (!isRegistry) {
-                revert ErrorNotRegistry(registryAddress);
-            }
-        } catch {
-            revert ErrorNotRegistry(registryAddress);
-        }
+        _registry = IRegistry(registry);
     }
 
 

package/contracts/shared/Service.sol

@@ -1,41 +1,39 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "./IVersionable.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ObjectType, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-import {Versionable} from "./Versionable.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 /// @dev service base contract
 abstract contract Service is 
     Registerable,
     Versionable,
-    AccessManagedUpgradeable,
+    ReentrancyGuardUpgradeable,
     IService
 {
 
-    uint8 private constant GIF_MAJOR_VERSION = 3;
-
-
-    function initializeService(
-        address registry, 
+    function __Service_init(
         address authority, // real authority for registry service adress(0) for other services
+        address registry, 
         address initialOwner
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegisterable(
+        __ReentrancyGuard_init();
+
+        __Registerable_init(
+            authority,
             registry, 
             IRegistry(registry).getNftId(), 
             SERVICE(), 
@@ -43,41 +41,27 @@ abstract contract Service is
             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());
-        }
-
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IService).interfaceId);
+        _registerInterface(type(IService).interfaceId);
     }
 
     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));
+    function getVersion() public pure virtual override (IVersionable, Versionable) returns(Version) {
+        return VersionLib.toVersion(3, 0, 0);
     }
 
-    // from Versionable
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
-    {
-        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
+
+    function getRoleId() external virtual view returns(RoleId serviceRoleId) {
+        return RoleIdLib.toServiceRoleId(_getDomain(), getRelease());
     }
 
+    //--- internal functions --------------------------------------------------------//
     function _getDomain() internal virtual pure returns (ObjectType);
 
+
     function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+        return getRegistry().getServiceAddress(domain, getRelease());
     }
 }