@etherisc/gif-next 0.0.2-f752d2a-551 → 0.0.2-f761c0d-394

package/contracts/shared/NftOwnable.sol

@@ -0,0 +1,107 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ERC165} from "./ERC165.sol";
+import {INftOwnable} from "./INftOwnable.sol";
+import {NftId} from "../type/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 {
+        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 ErrorNftOwnableNotOwner(msg.sender);
+        }
+        _;
+    }
+
+
+    /// @dev initialization for upgradable contracts
+    // used in _initializeRegisterable
+    function initializeNftOwnable(
+        address initialOwner,
+        address registryAddress
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        initializeRegistryLinked(registryAddress);
+        initializeERC165();
+
+        if(initialOwner == address(0)) {
+            revert ErrorNftOwnableInitialOwnerZero();
+        }
+
+        _getNftOwnableStorage()._initialOwner = initialOwner;
+    }
+
+
+    /// @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
+        returns (NftId nftId)
+    {
+        return _linkToNftOwnable(address(this));
+    }
+
+    function getNftId() public view virtual override returns (NftId) {
+        return _getNftOwnableStorage()._nftId;
+    }
+
+    function getOwner() public view virtual override returns (address) {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            return getRegistry().ownerOf($._nftId);
+        }
+
+        return $._initialOwner;
+    }
+
+    /// @dev used in constructor of registry service manager
+    // links ownership of registry service manager ot nft owner of registry service
+    function _linkToNftOwnable(
+        address nftOwnableAddress
+    )
+        internal
+        returns (NftId)
+    {
+        NftOwnableStorage storage $ = _getNftOwnableStorage();
+
+        if ($._nftId.gtz()) {
+            revert ErrorNftOwnableAlreadyLinked($._nftId);
+        }
+
+        if (!getRegistry().isRegistered(nftOwnableAddress)) {
+            revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
+        }
+
+        $._nftId = getRegistry().getNftId(nftOwnableAddress);
+
+        return $._nftId;
+    }
+
+
+    function _getNftOwnableStorage() private pure returns (NftOwnableStorage storage $) {
+        assembly {
+            $.slot := NFT_OWNABLE_STORAGE_LOCATION_V1
+        }
+    }
+}

package/contracts/shared/PolicyHolder.sol

@@ -0,0 +1,102 @@
+// 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 {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {ERC165} from "./ERC165.sol";
+import {IPolicyHolder} from "./IPolicyHolder.sol";
+import {NftId} from "../type/NftId.sol";
+import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {RegistryLinked} from "./RegistryLinked.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+
+/// @dev template implementation for IPolicyHolder
+contract PolicyHolder is
+    ERC165,
+    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 requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external { }
+
+    /// @dev empty default implementation
+    function policyActivated(NftId policyNftId) external {}
+
+    /// @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 ---------------// 
+    function onERC721Received(
+        address, // operator
+        address, // from
+        uint256, // tokenId
+        bytes calldata // data
+    )
+        external
+        virtual
+        returns (bytes4)
+    {
+        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/ProxyManager.sol

@@ -0,0 +1,199 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+
+import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
+import {IVersionable} from "./IVersionable.sol";
+import {NftOwnable} from "./NftOwnable.sol";
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
+import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
+import {Version, VersionLib} from "../type/Version.sol";
+import {NftId} from "../type/NftId.sol";
+
+/// @dev manages proxy deployments for upgradable contracs of type IVersionable
+contract ProxyManager is
+    NftOwnable
+{
+
+    struct VersionInfo {
+        Version version;
+        address implementation;
+        address activatedBy;
+        Timestamp activatedAt;
+        Blocknumber activatedIn;
+    }
+
+    event LogProxyManagerVersionableDeployed(address indexed proxy, address initialImplementation);
+    event LogProxyManagerVersionableUpgraded(address indexed proxy, address upgradedImplementation);
+
+    error ErrorProxyManagerAlreadyDeployed();
+    error ErrorProxyManagerNotYetDeployed();
+
+    error ErrorProxyManagerZeroVersion();
+    error ErrorProxyManagerNextVersionNotIncreasing(Version nextVersion);
+
+    UpgradableProxyWithAdmin internal _proxy;
+
+    // state to keep version history
+    mapping(Version version => VersionInfo info) _versionHistory;
+    Version [] _versions;
+
+    /// @dev only used to capture proxy owner
+    constructor(address registry)
+    { 
+        initializeProxyManager(registry);
+    }
+
+    function initializeProxyManager(address registry)
+        public
+        initializer()
+    {
+        initializeNftOwnable(msg.sender, registry);
+    }
+
+    /// @dev deploy initial contract
+    function deploy(address initialImplementation, bytes memory initializationData)
+        public
+        virtual
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner(); // used by implementation
+        address initialProxyAdminOwner = address(this); // used by proxy
+        
+        _proxy = new UpgradableProxyWithAdmin(
+            initialImplementation,
+            initialProxyAdminOwner,
+            getDeployData(currentProxyOwner, initializationData)
+        );
+
+        versionable = IVersionable(address(_proxy));
+        _updateVersionHistory(versionable.getVersion(), initialImplementation, currentProxyOwner);
+
+        emit LogProxyManagerVersionableDeployed(address(_proxy), initialImplementation);
+    }
+
+    function deployDetermenistic(address initialImplementation, bytes memory initializationData, bytes32 salt)
+        public
+        virtual
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+
+        address currentProxyOwner = getOwner();
+        address initialProxyAdminOwner = address(this);
+
+        _proxy = new UpgradableProxyWithAdmin{salt: salt}(
+            initialImplementation,
+            initialProxyAdminOwner,
+            getDeployData(currentProxyOwner, initializationData)
+        );
+
+        versionable = IVersionable(address(_proxy));
+        _updateVersionHistory(versionable.getVersion(), initialImplementation, currentProxyOwner);
+
+        emit LogProxyManagerVersionableDeployed(address(_proxy), initialImplementation);
+    }
+
+    /// @dev upgrade existing contract
+    function upgrade(address newImplementation, bytes memory upgradeData)
+        public
+        virtual
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        if (_versions.length == 0) { 
+            revert ErrorProxyManagerNotYetDeployed();
+        }
+
+        address currentProxyOwner = getOwner();
+        ProxyAdmin proxyAdmin = getProxy().getProxyAdmin();
+        ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
+
+        proxyAdmin.upgradeAndCall(
+            proxy,
+            newImplementation, 
+            getUpgradeData(upgradeData));
+
+        versionable = IVersionable(address(_proxy));
+        _updateVersionHistory(versionable.getVersion(), newImplementation, currentProxyOwner);
+
+        emit LogProxyManagerVersionableUpgraded(address(_proxy), newImplementation);
+
+    }
+
+    function linkToProxy() public returns (NftId) {
+        return _linkToNftOwnable(address(_proxy));
+    }
+
+    function getDeployData(address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
+        return abi.encodeWithSelector(
+            IVersionable.initializeVersionable.selector, 
+            proxyOwner, 
+            deployData);
+    }
+
+    function getUpgradeData(bytes memory upgradeData) public pure returns (bytes memory data) {
+        return abi.encodeWithSelector(
+            IVersionable.upgradeVersionable.selector, 
+            upgradeData);
+    }
+
+    function getProxy() public view returns (UpgradableProxyWithAdmin) {
+        return _proxy;
+    }
+
+    function getVersion() external view virtual returns(Version) {
+        return IVersionable(address(_proxy)).getVersion();
+    }
+
+    function getVersionCount() external view returns(uint256) {
+        return _versions.length;
+    }
+
+    function getVersion(uint256 idx) external view returns(Version) {
+        return _versions[idx];
+    }
+
+    function getVersionInfo(Version _version) external view returns(VersionInfo memory) {
+        return _versionHistory[_version];
+    }
+
+    function _updateVersionHistory(
+        Version newVersion,
+        address implementation,
+        address activatedBy
+    )
+        private
+    {
+        if(newVersion == VersionLib.zeroVersion()) {
+            revert ErrorProxyManagerZeroVersion();
+        }
+
+        if(_versions.length > 0) {
+            if(newVersion.toInt() <= _versions[_versions.length-1].toInt()) {
+                revert ErrorProxyManagerNextVersionNotIncreasing(newVersion);
+            }
+        }
+
+        // update version history
+        _versions.push(newVersion);
+        _versionHistory[newVersion] = VersionInfo(
+            newVersion,
+            implementation,
+            activatedBy,
+            TimestampLib.blockTimestamp(),
+            blockNumber()
+        );
+    }
+}

package/contracts/shared/Registerable.sol

@@ -1,86 +1,75 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {NftId, zeroNftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
+
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {NftOwnable} from "../shared/NftOwnable.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.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"
-        );
-        _;
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
+
+    struct RegisterableStorage {
+        NftId _parentNftId;
+        ObjectType _objectType;
+        bool _isInterceptor;
+        bytes _data;
     }
 
-    constructor(
+    function initializeRegisterable(
         address registryAddress,
-        NftId parentNftId
+        NftId parentNftId,
+        ObjectType objectType,
+        bool isInterceptor,
+        address initialOwner,
+        bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
-        ERC165()
+        public
+        virtual
+        onlyInitializing
     {
-        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"
-        );
-
-        _initialOwner = msg.sender;
-
-        // register support for IRegisterable
-        _registerInterface(type(IRegisterable).interfaceId);
-    }
+        initializeNftOwnable(
+            initialOwner,
+            registryAddress);
 
-    // from IRegistryLinked
-    function register() public onlyOwner virtual override returns (NftId nftId) {
-        return _registry.register(address(this));
-    }
-
-    function getRegistry() public view virtual override returns (IRegistry registry) {
-        return _registry;
-    }
-
-    function getOwner() public view virtual override returns (address owner) {
-        NftId nftId = _registry.getNftId(address(this));
-        if(nftId == zeroNftId()) {
-            return _initialOwner;
+        RegisterableStorage storage $;
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
         }
 
-        return _registry.getOwner(nftId);
+        $._parentNftId = parentNftId;
+        $._objectType = objectType;
+        $._isInterceptor = isInterceptor;
+        $._data = registryData;
     }
 
-    function getNftId() public view override returns (NftId nftId) {
-        return _registry.getNftId(address(this));
-    }
 
-    function getParentNftId() public view override returns (NftId nftId) {
-        return _parentNftId;
-    }
+    function getInitialInfo() 
+        public 
+        view 
+        virtual 
+        returns (IRegistry.ObjectInfo memory info) 
+    {
+        RegisterableStorage storage $;
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
 
-    function getData() public view virtual override returns (bytes memory data) {
-        return "";
+        info = IRegistry.ObjectInfo(
+            NftIdLib.zero(),
+            $._parentNftId,
+            $._objectType,
+            $._isInterceptor,
+            address(this), 
+            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

@@ -0,0 +1,83 @@
+// 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 {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 {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";
+
+
+/// @dev service base contract
+abstract contract Service is 
+    Registerable,
+    Versionable,
+    AccessManagedUpgradeable,
+    IService
+{
+
+    uint8 private constant GIF_MAJOR_VERSION = 3;
+
+
+    function initializeService(
+        address registry, 
+        address authority, // real authority for registry service adress(0) for other services
+        address initialOwner
+    )
+        public
+        virtual
+        onlyInitializing()
+    {
+        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());
+        }
+
+        registerInterface(type(IAccessManaged).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));
+    }
+
+    // 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));
+    }
+}