@etherisc/gif-next 0.0.2-abde86b-349 → 0.0.2-ac4bee9-682

package/contracts/examples/unpermissioned/SimpleProduct.sol

@@ -5,6 +5,7 @@ import {Amount, AmountLib} from "../../type/Amount.sol";
 import {BasicProduct} from "../../product/BasicProduct.sol";
 import {ClaimId} from "../../type/ClaimId.sol";
 import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
 import {IOracleService} from "../../oracle/IOracleService.sol";
 import {ORACLE} from "../../type/ObjectType.sol";
 import {NftId} from "../../type/NftId.sol";
@@ -32,38 +33,33 @@ contract SimpleProduct is
 
     constructor(
         address registry,
-        NftId instanceNftid,
-        IAuthorization authorization,
-        address initialOwner,
+        NftId instanceNftId,
+        string memory name,
         address token,
-        bool isInterceptor,
-        address pool,
-        address distribution
+        IComponents.ProductInfo memory productInfo,
+        IAuthorization authorization,
+        address initialOwner
     )
     {
         initialize(
             registry,
-            instanceNftid,
-            authorization,
-            initialOwner,
-            "SimpleProduct",
+            instanceNftId,
+            name,
             token,
-            isInterceptor,
-            pool,
-            distribution); 
+            productInfo,
+            authorization,
+            initialOwner); 
     }
 
 
     function initialize(
         address registry,
         NftId instanceNftid,
-        IAuthorization authorization,
-        address initialOwner,
         string memory name,
         address token,
-        bool isInterceptor,
-        address pool,
-        address distribution
+        IComponents.ProductInfo memory productInfo,
+        IAuthorization authorization,
+        address initialOwner
     )
         public
         virtual
@@ -72,13 +68,11 @@ contract SimpleProduct is
         _initializeBasicProduct(
             registry,
             instanceNftid,
-            authorization,
-            initialOwner,
             name,
             token,
-            isInterceptor,
-            pool,
-            distribution); 
+            productInfo,
+            authorization,
+            initialOwner); 
 
         _oracleService = IOracleService(_getServiceAddress(ORACLE()));
     }

package/contracts/instance/IInstance.sol

@@ -10,6 +10,7 @@ import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {NftId} from "../type/NftId.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -38,6 +39,9 @@ interface IInstance is
         uint64 requestsCount;
     }
 
+    /// @dev Register a product with the instance.
+    function registerProduct(address product) external returns (NftId productNftId);
+
     function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
     function grantRole(RoleId roleId, address account) external;
     function revokeRole(RoleId roleId, address account) external;
@@ -55,7 +59,6 @@ interface IInstance is
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
     // get instance release and supporting contracts
-    function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleSet() external view returns (BundleSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);

package/contracts/instance/IInstanceService.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
-import {Instance} from "./Instance.sol";
+import {IInstance} from "./IInstance.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
@@ -55,8 +55,7 @@ interface IInstanceService is IService {
     function createInstance()
         external 
         returns (
-            // TODO check if Instance can be changed to IInstance
-            Instance clonedInstance,
+            IInstance instance,
             NftId instanceNftId
         );
 
@@ -68,25 +67,5 @@ interface IInstanceService is IService {
     /// @dev Defunds the staking reward reserves for the specified target.
     function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
-    /// @dev Sets up the component authorization for the specified instance.
-    /// The authorization is based on the authz specification provided by the component via getAuthorization.
-    function initializeAuthorization(NftId instanceNftId, IInstanceLinkedComponent component) external;
-
-    function createComponentTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    ) external;
-
-    function createGifTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        bytes4[][] memory selectors,
-        RoleId[] memory roles
-    ) external;
-
     function setComponentLocked(bool locked) external;
 }

package/contracts/instance/Instance.sol

@@ -5,13 +5,15 @@ import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/acce
 
 import {Amount} from "../type/Amount.sol";
 import {BundleSet} from "./BundleSet.sol";
+import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
 import {IInstance} from "./IInstance.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstanceService} from "./IInstanceService.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.sol";
-import {INSTANCE} from "../type/ObjectType.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../type/NftId.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -23,10 +25,9 @@ contract Instance is
     AccessManagedUpgradeable,
     Registerable
 {
-    uint256 public constant GIF_MAJOR_VERSION = 3;
-
     bool private _initialized;
 
+    IComponentService internal _componentService;
     IInstanceService internal _instanceService;
     InstanceAdmin internal _instanceAdmin;
     InstanceReader internal _instanceReader;
@@ -53,7 +54,6 @@ contract Instance is
     {
         _instanceAdmin = instanceAdmin;
         if(_instanceAdmin.authority() == address(0)) {
-            // TODO rename error
             revert ErrorInstanceInstanceAdminZero();
         }
 
@@ -79,19 +79,32 @@ contract Instance is
         _bundleManager.initialize();
         _instanceReader.initialize();
 
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                getRelease()));
+
         _instanceService = IInstanceService(
             getRegistry().getServiceAddress(
                 INSTANCE(), 
-                getMajorVersion()));
+                getRelease()));
 
         _registerInterface(type(IInstance).interfaceId);    
     }
 
+    //--- ProductRegistration ----------------------------------------------//
+    function registerProduct(address product)
+        external
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        return _componentService.registerProduct(product);
+    }
+
     //--- Staking ----------------------------------------------------------//
 
     function setStakingLockingPeriod(Seconds stakeLockingPeriod)
         external
-        // TODO decide if onlyOwner or restricted to instance owner role is better
         onlyOwner()
     {
         _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
@@ -178,13 +191,7 @@ contract Instance is
 
     //--- ITransferInterceptor ----------------------------------------------//
 
-    // TODO interception of child components nfts
-    function nftMint(address to, uint256 tokenId) external onlyChainNft {
-        // TODO refactor
-        // _instanceAdmin.transferInstanceOwnerRole(address(0), to);
-    }
-
-    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
         // TODO refactor
         // _instanceAdmin.transferInstanceOwnerRole(from, to);
     }
@@ -221,9 +228,5 @@ contract Instance is
         return _instanceStore;
     }
 
-    function getMajorVersion() public pure returns (VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
-    }
-
     //--- internal view/pure functions --------------------------------------//
 }

package/contracts/instance/InstanceAdmin.sol

@@ -7,13 +7,13 @@ import {AccessAdmin} from "../authorization/AccessAdmin.sol";
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {IAccessAdmin} from "../authorization/IAccessAdmin.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
-import {IComponent} from "../shared/IComponent.sol";
-import {IModuleAuthorization} from "../authorization/IModuleAuthorization.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IInstance} from "./IInstance.sol";
 import {IService} from "../shared/IService.sol";
 import {ObjectType, ObjectTypeLib, ALL, POOL, RELEASE} from "../type/ObjectType.sol";
-import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
+import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Str, StrLib} from "../type/String.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -38,16 +38,16 @@ contract InstanceAdmin is
     IRegistry internal _registry;
     uint64 _idNext;
 
-    IModuleAuthorization _instanceAuthorization;
+    IAuthorization _instanceAuthorization;
 
     /// @dev Only used for master instance admin.
     /// Contracts created via constructor come with disabled initializers.
     constructor(
-        IModuleAuthorization instanceAuthorization
+        address instanceAuthorization
     )
         AccessAdmin()
     {
-        _instanceAuthorization = instanceAuthorization;
+        _instanceAuthorization = IAuthorization(instanceAuthorization);
     }
 
     /// @dev Initializes this instance admin with the provided instances authorization specification.
@@ -56,7 +56,7 @@ contract InstanceAdmin is
     /// Important: Initialization of this instance admin is only complete after calling function initializeInstance. 
     function initialize(
         AccessManagerCloneable accessManager,
-        IModuleAuthorization instanceAuthorization
+        address instanceAuthorization
     )
         external
         initializer() 
@@ -68,7 +68,7 @@ contract InstanceAdmin is
         _createAdminAndPublicRoles();
 
         // store instance authorization specification
-        _instanceAuthorization = IModuleAuthorization(instanceAuthorization);
+        _instanceAuthorization = IAuthorization(instanceAuthorization);
     }
 
     function _checkTargetIsReadyForAuthorization(address target)
@@ -96,7 +96,7 @@ contract InstanceAdmin is
         _registry = _instance.getRegistry();
 
         // check matching releases
-        if (_instanceAuthorization.getRelease() != _instance.getMajorVersion()) {
+        if (_instanceAuthorization.getRelease() != _instance.getRelease()) {
             revert ErrorInstanceAdminReleaseMismatch();
         }
 
@@ -104,22 +104,22 @@ contract InstanceAdmin is
         _createRoles(_instanceAuthorization);
         _createModuleTargetsWithRoles();
         _createTargetAuthorizations(_instanceAuthorization);
-
-        // grant component owner roles to instance owner
-        _grantComponentOwnerRoles();
     }
 
 
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
-        IComponent component,
-        IAuthorization authorization
+        IInstanceLinkedComponent component
     )
         external
     {
         _checkTargetIsReadyForAuthorization(address(component));
 
+        // get authorization specification
+        IAuthorization authorization = component.getAuthorization();
+
+        // create roles
         _createRoles(authorization);
 
         // create component target
@@ -135,12 +135,12 @@ contract InstanceAdmin is
             true, 
             false);
         
-        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
         FunctionInfo[] memory functions = new FunctionInfo[](3);
         functions[0] = toFunction(TokenHandler.collectTokens.selector, "collectTokens");
         functions[1] = toFunction(TokenHandler.collectTokensToThreeRecipients.selector, "collectTokensToThreeRecipients");
         functions[2] = toFunction(TokenHandler.distributeTokens.selector, "distributeTokens");
 
+        // FIXME: make this a bit nicer and work with IAuthorization. Use a specific role, not public - access to TokenHandler must be restricted
         _authorizeTargetFunctions(
             address(component.getTokenHandler()),
             getPublicRole(),
@@ -148,23 +148,12 @@ contract InstanceAdmin is
 
         _grantRoleToAccount(
             authorization.getTargetRole(
-                authorization.getTarget()), 
+                authorization.getMainTarget()), 
             address(component));
         
         _createTargetAuthorizations(authorization);
     }
 
-
-    function _grantComponentOwnerRoles()
-        internal
-    {
-        address instanceOwner = _registry.ownerOf(_instance.getNftId());
-        _grantRoleToAccount(DISTRIBUTION_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(ORACLE_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(POOL_OWNER_ROLE(), instanceOwner);
-        _grantRoleToAccount(PRODUCT_OWNER_ROLE(), instanceOwner);
-    }
-
     /// @dev Creates a custom role
     // TODO implement
     // function createRole()
@@ -188,7 +177,7 @@ contract InstanceAdmin is
     function getInstanceAuthorization()
         external
         view
-        returns (IModuleAuthorization instanceAuthorizaion)
+        returns (IAuthorization instanceAuthorizaion)
     {
         return _instanceAuthorization;
     }

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -5,44 +5,33 @@ import {
      PRODUCT, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION, POLICY, CLAIM, BUNDLE
 } from "../../contracts/type/ObjectType.sol";
 
-import {
-     DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE
-} from "../../contracts/type/RoleId.sol";
-
 import {BundleSet} from "../instance/BundleSet.sol"; 
 import {IAccess} from "../authorization/IAccess.sol";
 import {Instance} from "../instance/Instance.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {ModuleAuthorization} from "../authorization/ModuleAuthorization.sol";
+import {Authorization} from "../authorization/Authorization.sol";
 
 
 contract InstanceAuthorizationV3
-     is ModuleAuthorization
+     is Authorization
 {
 
+     string public constant INSTANCE_ROLE_NAME = "InstanceRole";
+
      string public constant INSTANCE_TARGET_NAME = "Instance";
      string public constant INSTANCE_STORE_TARGET_NAME = "InstanceStore";
      string public constant INSTANCE_ADMIN_TARGET_NAME = "InstanceAdmin";
      string public constant BUNDLE_SET_TARGET_NAME = "BundleSet";
 
-     string public constant INSTANCE_ROLE_NAME = "InstanceRole";
-     string public constant DISTRIBUTION_OWNER_ROLE_NAME = "DistributionOwnerRole";
-     string public constant ORACLE_OWNER_ROLE_NAME = "OracleOwnerRole";
-     string public constant POOL_OWNER_ROLE_NAME = "PoolOwnerRole";
-     string public constant PRODUCT_OWNER_ROLE_NAME = "ProductOwnerRole";
-
-     constructor() ModuleAuthorization(INSTANCE_TARGET_NAME) {}
+     constructor() Authorization(INSTANCE_TARGET_NAME) {}
 
 
      function _setupRoles()
           internal
           override
      {
-          _addGifRole(DISTRIBUTION_OWNER_ROLE(), DISTRIBUTION_OWNER_ROLE_NAME);
-          _addGifRole(ORACLE_OWNER_ROLE(), ORACLE_OWNER_ROLE_NAME);
-          _addGifRole(POOL_OWNER_ROLE(), POOL_OWNER_ROLE_NAME);
-          _addGifRole(PRODUCT_OWNER_ROLE(), PRODUCT_OWNER_ROLE_NAME);
+          // empty implementation
      }
 
 
@@ -53,7 +42,7 @@ contract InstanceAuthorizationV3
           // instance target
           _addTargetWithRole(
                INSTANCE_TARGET_NAME, 
-               _getTargetRoleId(INSTANCE()),
+               _toTargetRoleId(INSTANCE()),
                INSTANCE_ROLE_NAME);
 
           // instance supporting targets
@@ -83,6 +72,7 @@ contract InstanceAuthorizationV3
           _setupInstanceAdminAuthorization();
           _setupInstanceStoreAuthorization();
           _setupBundleSetAuthorization();
+
      }
 
 
@@ -118,7 +108,7 @@ contract InstanceAuthorizationV3
           IAccess.FunctionInfo[] storage functions;
 
           // authorize instance role
-          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, _getTargetRoleId(INSTANCE()));
+          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, _toTargetRoleId(INSTANCE()));
           _authorize(functions, InstanceAdmin.grantRole.selector, "grantRole");
 
           // authorize instance service role

package/contracts/instance/InstanceReader.sol

@@ -126,7 +126,6 @@ contract InstanceReader {
         return _store.getState(toBundleKey(bundleNftId));
     }
 
-
     /// @dev Returns true iff policy is active.
     function policyIsActive(NftId policyNftId)
         public
@@ -143,37 +142,6 @@ contract InstanceReader {
         return true;
     }
 
-
-    /// @dev Returns true iff policy may be closed.
-    /// A policy can be closed all conditions below are met
-    /// - policy exists
-    /// - has been activated
-    /// - is not yet closed
-    /// - has no open claims
-    /// - claim amount matches sum insured amount or is expired
-    function policyIsCloseable(NftId policyNftId)
-        public
-        view
-        returns (bool isCloseable)
-    {
-        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
-
-        if (info.productNftId.eqz()) { return false; } // not closeable: policy does not exist (or does not belong to this instance)
-        if (info.activatedAt.eqz()) { return false; } // not closeable: not yet activated
-        if (info.closedAt.gtz()) { return false; } // not closeable: already closed
-        if (info.openClaimsCount > 0) { return false; } // not closeable: has open claims
-
-        // closeable: if sum of claims matches sum insured a policy may be closed prior to the expiry date
-        if (info.claimAmount == info.sumInsuredAmount) { return true; }
-
-        // not closeable: not yet expired
-        if (TimestampLib.blockTimestamp() < info.expiredAt) { return false; }
-
-        // all conditionsl to close the policy are met
-        return true; 
-    }
-
-
     function claims(NftId policyNftId)
         public
         view
@@ -191,7 +159,6 @@ contract InstanceReader {
         return ClaimIdLib.toClaimId(idx + 1);
     }
 
-
     function getClaimInfo(NftId policyNftId, ClaimId claimId)
         public
         view
@@ -231,6 +198,15 @@ contract InstanceReader {
     }
 
 
+    function getRemainingClaimableAmount(NftId policyNftId)
+        public
+        view
+        returns (Amount remainingClaimableAmount)
+    {
+        IPolicy.PolicyInfo memory info = getPolicyInfo(policyNftId);
+        return info.sumInsuredAmount - info.claimAmount;
+    }
+
     function getPayoutInfo(NftId policyNftId, PayoutId payoutId)
         public
         view
@@ -270,7 +246,7 @@ contract InstanceReader {
 
         if (data.length > 0) {
             IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return info.wallet;
+            return info.tokenHandler.getWallet();
         }
     }