@etherisc/gif-next 3.0.0-d7939fe-905 → 3.0.0-dd00d66-173

package/contracts/instance/InstanceAdmin.sol

@@ -11,9 +11,10 @@ import {AccessAdminLib} from "../authorization/AccessAdminLib.sol";
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {ObjectType, INSTANCE} from "../type/ObjectType.sol";
 import {RoleId, ADMIN_ROLE} from "../type/RoleId.sol";
+import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
 import {Str} from "../type/String.sol";
-import {VersionPart} from "../type/Version.sol";
 import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME} from "./TargetNames.sol";
+import {VersionPart} from "../type/Version.sol";
 
 
 contract InstanceAdmin is
@@ -26,13 +27,12 @@ contract InstanceAdmin is
     error ErrorInstanceAdminNotComponentOrCustomTarget(address target);
 
     IInstance internal _instance;
-    IRegistry internal _registry;
 
     uint64 internal _customRoleIdNext;
 
 
     modifier onlyInstanceService() {
-        if (msg.sender != _registry.getServiceAddress(INSTANCE(), getRelease())) {
+        if (msg.sender != _getRegistry().getServiceAddress(INSTANCE(), getRelease())) {
             revert ErrorInstanceAdminNotInstanceService(msg.sender);
         }
         _;
@@ -43,7 +43,8 @@ contract InstanceAdmin is
     constructor(address accessManager) {
         initialize(
             accessManager,
-            "MasterInstanceAdmin");
+            "MasterInstanceAdmin",
+            GIF_INITIAL_RELEASE());
     }
 
 
@@ -51,32 +52,23 @@ contract InstanceAdmin is
     /// Important: Initialization of instance admin is only complete after calling this function. 
     /// Important: The instance MUST be registered and all instance supporting contracts must be wired to this instance.
     function completeSetup(
-        address registry,
         address authorization,
-        VersionPart release,
         address instance
     )
         external
-        reinitializer(uint64(release.toInt()))
     {
         // checks
-        AccessAdminLib.checkIsRegistered(registry, instance, INSTANCE());
+        AccessAdminLib.checkIsRegistered(instance, INSTANCE(), getRelease());
 
         // effects
-        AccessManagerCloneable(
-            authority()).completeSetup(
-                registry, 
-                release); 
-
         AccessAdminLib.checkAuthorization(
             address(_authorization), 
             authorization, 
             INSTANCE(), // expectedDomain
-            release, // expectedRelease
+            getRelease(), // expectedRelease
             false, // expectServiceAuthorization
             true); // checkAlreadyInitialized
 
-        _registry = IRegistry(registry);
         _instance = IInstance(instance);
         _authorization = IAuthorization(authorization);
         _customRoleIdNext = 0;
@@ -105,7 +97,7 @@ contract InstanceAdmin is
         for(uint256 i = 0; i < serviceDomains.length; i++) {
             ObjectType serviceDomain = serviceDomains[i];
             RoleId serviceRoleId = authorization.getServiceRole(serviceDomain);
-            address service = _registry.getServiceAddress(serviceDomain, getRelease());
+            address service = _getRegistry().getServiceAddress(serviceDomain, getRelease());
 
             _grantRoleToAccount(
                 serviceRoleId,
@@ -135,7 +127,8 @@ contract InstanceAdmin is
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
         address componentAddress,
-        ObjectType expectedType
+        ObjectType expectedType,
+        VersionPart expectedRelease
     )
         external
         restricted()

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -13,7 +13,9 @@ import {InstanceStore} from "../instance/InstanceStore.sol";
 import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME} from "./TargetNames.sol";
 import {ProductStore} from "../instance/ProductStore.sol";
 import {ADMIN_ROLE, INSTANCE_OWNER_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
-import {RiskSet} from "../instance/RiskSet.sol"; 
+import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
+import {RiskSet} from "../instance/RiskSet.sol";
+import {VersionPartLib} from "../type/Version.sol";
 
 
 contract InstanceAuthorizationV3
@@ -27,7 +29,7 @@ contract InstanceAuthorizationV3
           Authorization(
                INSTANCE_TARGET_NAME, 
                INSTANCE(), 
-               3, 
+               GIF_INITIAL_RELEASE(), 
                COMMIT_HASH,
                TargetType.Instance, 
                false)

package/contracts/instance/InstanceReader.sol

@@ -28,6 +28,7 @@ import {NftId} from "../type/NftId.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {PolicyServiceLib} from "../product/PolicyServiceLib.sol";
 import {ProductStore} from "./ProductStore.sol";
+import {RegistryLinked} from "../shared/RegistryLinked.sol";
 import {ReferralId, ReferralStatus, ReferralLib} from "../type/Referral.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
@@ -40,14 +41,19 @@ import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
 /// @dev Central reader contract for a specific instance.
 /// Provides reading functions for all instance data and related component data.
-contract InstanceReader {
+contract InstanceReader is
+    RegistryLinked
+{
 
     error ErrorInstanceReaderAlreadyInitialized();
     error ErrorInstanceReaderInstanceAddressZero();
-
+    // TODO make state immutable:
+    // 1. instance receives reader through setInstanceReader()
+    // 2. this way instance initialization is not depends on reader
+    // 3. and reader is simple contract with constructor
+    // 4. no _initialized in storage, the rest is immutable
     bool private _initialized = false;
 
-    IRegistry internal _registry;
     IInstance internal _instance;
     InstanceAdmin internal _instanceAdmin;
 
@@ -78,27 +84,24 @@ contract InstanceReader {
         _initialized = true;
         _instance = IInstance(instanceAddress);
         _instanceAdmin = _instance.getInstanceAdmin();
-        _registry = _instance.getRegistry();
 
         _store = _instance.getInstanceStore();
         _productStore = _instance.getProductStore();
         _bundleSet = _instance.getBundleSet();
         _riskSet = _instance.getRiskSet();
-        _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
+
+        _distributionService = IDistributionService(
+            _getRegistry().getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
     }
 
 
     //--- instance functions ---------------------------------------------------------//
 
-    /// @dev Returns the registry this instance is registered in.
-    function getRegistry() public view returns (IRegistry registry) {
-        return _registry;
-    }
 
 
     /// @dev Returns the instance NFT ID.
     function getInstanceNftId() public view returns (NftId instanceNftid) {
-        return _registry.getNftIdForAddress(address(_instance));
+        return _getRegistry().getNftIdForAddress(address(_instance));
     }
 
 
@@ -177,8 +180,8 @@ contract InstanceReader {
 
 
     /// @dev Returns th product NFT ID for the given index.
-    function getProductNftId(uint256 idx) public view returns (NftId productNftId) {
-        return _instance.getProductNftId(idx);
+    function getProduct(uint256 idx) public view returns (NftId productNftId) {
+        return _instance.getProduct(idx);
     }
 
 
@@ -219,6 +222,12 @@ contract InstanceReader {
     }
 
 
+    /// @dev Returns true if the specified risk exists for the given product NFT ID.
+    function isProductRisk(NftId productNftId, RiskId riskId) public view returns (bool exists) {
+        return _riskSet.hasRisk(productNftId, riskId);
+    }
+
+
     /// @dev Returns the risk info for the given risk ID.
     function getRiskInfo(RiskId riskId) public view returns (IRisk.RiskInfo memory info) {
         return _productStore.getRiskInfo(riskId);
@@ -240,10 +249,21 @@ contract InstanceReader {
 
 
     /// @dev Returns the linked policy NFT ID for the given risk ID and index.
-    function getPolicyNftIdForRisk(RiskId riskId, uint256 idx) public view returns (NftId linkedPolicyNftId) {
+    function getPolicyForRisk(RiskId riskId, uint256 idx) public view returns (NftId linkedPolicyNftId) {
         return _riskSet.getLinkedPolicyNftId(riskId, idx);
     }
 
+    /// @dev Returns the number of linked policies for the given bundle NFT ID.
+    function policiesForBundle(NftId bundleNftId) public view returns (uint256 linkedPolicies) {
+        return _bundleSet.activePolicies(bundleNftId);
+    }
+
+
+    /// @dev Returns the linked policy NFT ID for the given risk ID and index.
+    function getPolicyForBundle(NftId bundleNftId, uint256 idx) public view returns (NftId linkedPolicyNftId) {
+        return _bundleSet.getActivePolicy(bundleNftId, idx);
+    }
+
 
     /// @dev Returns the info for the given policy NFT ID.
     function getPolicyInfo(NftId policyNftId) public view returns (IPolicy.PolicyInfo memory info) {
@@ -341,6 +361,11 @@ contract InstanceReader {
         return _store.getRequestInfo(requestId);
     }
 
+    /// @dev Returns the request info for the given oracle request ID.
+    function getRequestState(RequestId requestId) public view returns (StateId state) {
+        return getState(requestId.toKey32());
+    }
+
     //--- pool functions -----------------------------------------------------------//
 
     /// @dev Returns the pool info for the given pool NFT ID.
@@ -413,7 +438,7 @@ contract InstanceReader {
         return _store.getReferralInfo(referralId);
     }
 
-
+    // TODO reader dependce on service os wrong?
     function getDiscountPercentage(ReferralId referralId)
         public
         view
@@ -422,10 +447,7 @@ contract InstanceReader {
             ReferralStatus status
         )
     {
-        return IDistributionService(
-            _registry.getServiceAddress(
-                DISTRIBUTION(),
-                _instance.getRelease())).getDiscountPercentage(
+        return _distributionService.getDiscountPercentage(
                     this, // instance reader
                     referralId);
     }

package/contracts/instance/InstanceService.sol

@@ -175,7 +175,7 @@ contract InstanceService is
         IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
 
         emit LogInstanceServiceInstanceLocked(
-            getRegistry().getNftIdForAddress(instanceAddress),
+            _getRegistry().getNftIdForAddress(instanceAddress),
             locked);
     }
 
@@ -204,13 +204,11 @@ contract InstanceService is
         // MUST be set after instance is set up and registered
         IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
         instanceAdmin.completeSetup(
-            address(getRegistry()),
             address(instanceAuthorization),
-            getRelease(),
             address(instance));
 
         // hard checks for newly cloned instance
-        assert(address(instance.getRegistry()) == address(getRegistry()));
+        //assert(address(instance._getRegistry()) == address(_getRegistry()));// consider deleting this
         assert(instance.getRelease() == getRelease());
 
         // register cloned instance as staking target
@@ -231,7 +229,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceLockingPeriod(
             instanceNftId,
             stakeLockingPeriod);
@@ -244,7 +242,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceRewardRate(
             instanceNftId,
             rewardRate);
@@ -256,7 +254,7 @@ contract InstanceService is
         restricted()
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceMaxStakedAmount(
             instanceNftId,
             maxStakedAmount);
@@ -270,7 +268,7 @@ contract InstanceService is
         onlyInstance()
         returns (Amount newBalance)
     {
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
         newBalance = _stakingService.refillInstanceRewardReserves(
             instanceNftId,
             rewardProvider,
@@ -285,7 +283,7 @@ contract InstanceService is
         onlyInstance()
         returns (Amount newBalance)
     {
-        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
+        NftId instanceNftId = _getRegistry().getNftIdForAddress(msg.sender);
         newBalance = _stakingService.withdrawInstanceRewardReserves(
             instanceNftId,
             dipAmount);
@@ -308,7 +306,7 @@ contract InstanceService is
         instance.setInstanceReader(upgradedInstanceReaderClone);
 
         emit LogInstanceServiceInstanceReaderUpgraded(
-            getRegistry().getNftIdForAddress(instanceAddress),
+            _getRegistry().getNftIdForAddress(instanceAddress),
             address(upgradedInstanceReaderClone));
     }
 
@@ -349,6 +347,7 @@ contract InstanceService is
             if(instanceStoreAddress == address(0)) { revert ErrorInstanceServiceInstanceStoreZero(); }
             if(productStoreAddress == address(0)) { revert ErrorInstanceServiceProductStoreZero(); } // TODO: rename exception
             
+            // TODO check instance cluster release
             if(instance.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceInstanceAuthorityMismatch(); }
             if(bundleSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceBundleSetAuthorityMismatch(); }
             if(riskSet.authority() != instanceAdmin.authority()) { revert ErrorInstanceServiceRiskSetAuthorityMismatch(); }
@@ -391,7 +390,7 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
 
         emit LogInstanceServiceMasterInstanceReaderUpgraded(
-            getRegistry().getNftIdForAddress(_masterInstance),
+            _getRegistry().getNftIdForAddress(_masterInstance),
             instanceReaderAddress);
     }
 
@@ -419,7 +418,8 @@ contract InstanceService is
 
         clonedAdmin.initialize(
             address(clonedAccessManager),
-            "InstanceAdmin");
+            "InstanceAdmin",
+            getRelease());
     }
 
 
@@ -445,8 +445,6 @@ contract InstanceService is
                 riskSet: RiskSet(Clones.clone(_masterInstanceRiskSet)),
                 instanceReader: InstanceReader(Clones.clone(address(_masterInstanceReader)))
             }),
-            getRegistry(),
-            getRelease(),
             instanceOwner,
             allowAnyToken);
 
@@ -461,14 +459,13 @@ contract InstanceService is
     )
         internal
         virtual override
-        initializer()
+        onlyInitializing()
     {
         (
-            address authority,
-            address registry
-        ) = abi.decode(data, (address, address));
+            address authority
+        ) = abi.decode(data, (address));
 
-        __Service_init(authority, registry, owner);
+        __Service_init(authority, owner);
 
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
         _stakingService = IStakingService(_getServiceAddress(STAKING()));
@@ -486,7 +483,8 @@ contract InstanceService is
         virtual
         view
     {
-        IRegistry registry = getRegistry();
+        // TODO use ContractLib to verify registration, type and release
+        IRegistry registry = _getRegistry();
 
         NftId instanceNftId = registry.getNftIdForAddress(instanceAddress);
         if (instanceNftId.eqz()) {

package/contracts/instance/InstanceServiceManager.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {IUpgradeable} from "../upgradeability/IUpgradeable.sol";
 import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {InstanceService} from "./InstanceService.sol";
 
@@ -12,19 +12,17 @@ contract InstanceServiceManager is ProxyManager {
     /// @dev initializes proxy manager with instance service implementation
     constructor(
         address authority, 
-        address registry,
         bytes32 salt
     ) 
     {
         InstanceService svc = new InstanceService{salt: salt}();
-        bytes memory data = abi.encode(authority, registry);
-        IVersionable versionable = initialize(
-            registry,
+        bytes memory data = abi.encode(authority);
+        IUpgradeable upgradeable = initialize(
             address(svc), 
             data,
             salt);
 
-        _instanceService = InstanceService(address(versionable));
+        _instanceService = InstanceService(address(upgradeable));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/instance/base/Cloneable.sol

@@ -4,25 +4,19 @@ pragma solidity ^0.8.20;
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
 import {IRegistry} from "../../registry/IRegistry.sol";
+import {RegistryLinked} from "../../shared/RegistryLinked.sol";
 
 abstract contract Cloneable is 
-    AccessManagedUpgradeable
+    AccessManagedUpgradeable,
+    RegistryLinked
 {
-    IRegistry internal _registry;
-
     /// @dev call to initialize MUST be made in the same transaction as cloning of the contract
     function __Cloneable_init(
-        address authority,
-        address registry
+        address authority
     )
         internal 
         onlyInitializing
     {
         __AccessManaged_init(authority);
-        _registry = IRegistry(registry);
-    }
-
-    function getRegistry() external view returns (IRegistry) {
-        return _registry;
     }
 }

package/contracts/instance/base/ObjectSet.sol

@@ -21,12 +21,12 @@ contract ObjectSet is
     address internal _instanceAddress;
 
     /// @dev This initializer needs to be called from the instance itself.
-    function initialize(address authority, address registry) 
+    function initialize(address authority) 
         external
         initializer()
     {
         _instanceAddress = msg.sender;
-        __Cloneable_init(authority, registry);
+        __Cloneable_init(authority);
         
         emit LogObjectSetInitialized(address(_instanceAddress));
     }

package/contracts/oracle/BasicOracle.sol

@@ -23,7 +23,6 @@ contract BasicOracle is
     }
 
     function _initializeBasicOracle(
-        address registry,
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
@@ -35,7 +34,6 @@ contract BasicOracle is
     {
 
         __Oracle_init(
-            registry,
             instanceNftId,
             authorization,
             initialOwner,

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -8,6 +8,8 @@ import {IAccess} from "../authorization/IAccess.sol";
 import {IOracle} from "./IOracle.sol"; 
 import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
 import {RoleId} from "../type/RoleId.sol";
+import {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
+import {VersionPartLib} from "../type/Version.sol";
 
 
 contract BasicOracleAuthorization
@@ -21,7 +23,7 @@ contract BasicOracleAuthorization
           Authorization(
                componentName, 
                ORACLE(), 
-               3, 
+               GIF_INITIAL_RELEASE(),
                commitHash, 
                TargetType.Component, 
                false)

package/contracts/oracle/IOracleService.sol

@@ -18,13 +18,9 @@ interface IOracleService is IService {
     event LogOracleServiceRequestCancelled(RequestId requestId, NftId requesterNftId);
 
     // create request
-    error ErrorOracleServiceProductMismatch(ObjectType callerObjectType, NftId productNft, NftId oracleParentNftId);
     error ErrorOracleServiceExpiryInThePast(Timestamp blockTimestamp, Timestamp expiryAt);
     error ErrorOracleServiceCallbackMethodNameEmpty();
 
-    // respond
-    error ErrorOracleServiceNotResponsibleOracle(RequestId requestId, NftId expectedOracleNftId, NftId oracleNftId);
-
     // get request info
     error ErrorOracleServiceRequestStateNotActive(RequestId requestId, StateId state);
     error ErrorOracleServiceCallerNotResponsibleOracle(RequestId requestId, NftId oracleNftId, NftId callerNftId);
@@ -41,26 +37,26 @@ interface IOracleService is IService {
         string calldata callbackMethodName
     ) external returns (RequestId requestId);
 
-    /// @dev respond to oracle request by oracle compnent.
-    /// the response data is amende in the request info stored with the instance.
-    /// the request state changes to FULFILLED (when calling the callback method of the requester is successful)
+    /// @dev Respond to oracle request by oracle compnent.
+    /// The response data is amended in the request info stored with the instance.
+    /// The request state changes to FULFILLED (when calling the callback method of the requester is successful)
     /// or to FAILED when calling the requester is not succesful.
-    /// the function returns true iff the state changes to FULFILLED.
-    /// permissioned: only the oracle component linked to the request id may call this method
+    /// The function returns true iff the state changes to FULFILLED.
+    /// Permissioned: only the receiving oracle component may call this method
     function respond(
         RequestId requestId,
         bytes calldata responseData
     ) external returns (bool success);
 
-    /// @dev re send a failed response to the requester.
-    /// only requests in state FAILED may be re sent.
-    /// the request state changes to FULFILLED when calling the callback method of the requester is successful.
-    /// permissioned: only the requester may resend a request
+    /// @dev Resend a failed response to the requester.
+    /// Only requests in state FAILED may be resent.
+    /// The request state changes to FULFILLED when calling the callback method of the requester is successful.
+    /// Permissioned: only the receiving oracle may resend a request
     function resend(RequestId requestId) external;
 
-    /// @dev notify the oracle component that the specified request has become invalid.
-    /// only requests in state ACTIVE may be cancelled.
-    /// permissioned: only the requester may cancel a request
+    /// @dev Notify the oracle component that the specified request has become invalid.
+    /// Only requests in state ACTIVE may be cancelled.
+    /// Permissioned: only the requester may cancel a request
     function cancel(RequestId requestId) external;
 
 }

package/contracts/oracle/Oracle.sol

@@ -5,10 +5,11 @@ import {Amount} from "../type/Amount.sol";
 import {COMPONENT, PRODUCT, ORACLE} from "../type/ObjectType.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
-import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IComponent} from "../shared/IComponent.sol";
 import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
 import {NftId} from "../type/NftId.sol";
+import {Component} from "../shared/Component.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -66,7 +67,7 @@ abstract contract Oracle is
     function withdrawFees(Amount amount)
         external
         virtual
-        override(IInstanceLinkedComponent, InstanceLinkedComponent)
+        override(IComponent, Component)
         onlyOwner()
         restricted()
         returns (Amount)
@@ -76,7 +77,6 @@ abstract contract Oracle is
 
 
     function __Oracle_init(
-        address registry,
         NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
@@ -87,7 +87,6 @@ abstract contract Oracle is
         onlyInitializing()
     {
         __InstanceLinkedComponent_init(
-            registry, 
             productNftId, 
             name, 
             ORACLE(),