@etherisc/gif-next 3.0.0-2e16ebd-614 → 3.0.0-303db9f-884

package/contracts/instance/IBaseStore.sol

@@ -17,6 +17,14 @@ interface IBaseStore is ILifecycle {
     error ErrorBaseStoreStateZero(Key32 key);
     error ErrorBaseStoreNotExisting(Key32 key);
 
+    event LogBaseStoreMetadataCreated(
+        Key32 indexed key,
+        ObjectType indexed objectType,
+        StateId indexed state);
+    event LogBaseStoreMetadataUpdated(
+        Key32 indexed key,
+        StateId indexed oldState,
+        StateId indexed newState);
 
     struct Metadata {
         // slot 0

package/contracts/instance/IInstance.sol

@@ -12,6 +12,7 @@ import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
 import {ProductStore} from "./ProductStore.sol";
+import {RequestSet} from "./RequestSet.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -58,6 +59,7 @@ interface IInstance is
         ProductStore productStore;
         BundleSet bundleSet;
         RiskSet riskSet;
+        RequestSet requestSet;
         InstanceReader instanceReader;
     }
 
@@ -143,12 +145,13 @@ interface IInstance is
 
     // get products
     function products() external view returns (uint256 productCount);
-    function getProductNftId(uint256 idx) external view returns (NftId productNftId);
+    function getProduct(uint256 idx) external view returns (NftId productNftId);
 
     // get supporting contracts
     function getInstanceReader() external view returns (InstanceReader);
     function getBundleSet() external view returns (BundleSet);
     function getRiskSet() external view returns (RiskSet);
+    function getRequestSet() external view returns (RequestSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
     function getProductStore() external view returns (ProductStore);

package/contracts/instance/IInstanceService.sol

@@ -26,6 +26,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
     error ErrorInstanceServiceMasterBundleSetAlreadySet();
     error ErrorInstanceServiceMasterRiskSetAlreadySet();
+    error ErrorInstanceServiceMasterRequestSetAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
     error ErrorInstanceServiceMasterInstanceReaderNotSet();
@@ -38,15 +39,18 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceReaderZero();
     error ErrorInstanceServiceBundleSetZero();
     error ErrorInstanceServiceRiskSetZero();
+    error ErrorInstanceServiceRequestSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
     error ErrorInstanceServiceProductStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
     error ErrorInstanceServiceBundleSetAuthorityMismatch();
     error ErrorInstanceServiceRiskSetAuthorityMismatch();
+    error ErrorInstanceServiceRequestSetAuthorityMismatch();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
     error ErrorInstanceServiceBundleSetInstanceMismatch();
     error ErrorInstanceServiceRiskSetInstanceMismatch();
+    error ErrorInstanceServiceRequestSetInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
     error ErrorInstanceServiceProductStoreAuthorityMismatch();
 
@@ -58,6 +62,8 @@ interface IInstanceService is IService {
     
     event LogInstanceServiceInstanceLocked(NftId instanceNftId, bool locked);
     event LogInstanceServiceInstanceCreated(NftId instanceNftId, address instance);
+    event LogInstanceServiceMasterInstanceRegistered(NftId masterInstanceNftId, address masterInstance, address masterInstanceAdmin, address masterAccessManager, 
+                address masterInstanceReader, address masterInstanceBundleSet, address masterInstanceRiskSet, address masterInstanceRequestSet, address masterInstanceStore, address masterProductStore);
     event LogInstanceServiceMasterInstanceReaderUpgraded(NftId instanceNfId, address newInstanceReader);
     event LogInstanceServiceInstanceReaderUpgraded(NftId instanceNfId, address newInstanceReader);
 

package/contracts/instance/Instance.sol

@@ -17,6 +17,7 @@ import {InstanceStore} from "./InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
 import {ProductStore} from "./ProductStore.sol";
 import {Registerable} from "../shared/Registerable.sol";
+import {RequestSet} from "./RequestSet.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -26,6 +27,8 @@ contract Instance is
     IInstance,
     Registerable
 {
+    bool private _initialized;
+
     IComponentService internal _componentService;
     IInstanceService internal _instanceService;
 
@@ -33,6 +36,7 @@ contract Instance is
     InstanceReader internal _instanceReader;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
+    RequestSet internal _requestSet;
     InstanceStore internal _instanceStore;
     ProductStore internal _productStore;
     NftId [] internal _products;
@@ -57,6 +61,8 @@ contract Instance is
 
     function initialize(
         InstanceContracts memory instanceContracts,
+        IRegistry registry, 
+        VersionPart release,
         address initialOwner,
         bool tokenRegistryDisabled // only disable for testing
     ) 
@@ -70,9 +76,9 @@ contract Instance is
         _instanceAdmin = instanceContracts.instanceAdmin;
 
         // setup instance object info
-        IRegistry registry = _getRegistry();
         __Registerable_init({
             authority: instanceContracts.instanceAdmin.authority(),
+            registry: address(registry), 
             parentNftId: registry.getNftId(), 
             objectType: INSTANCE(), 
             isInterceptor: false, 
@@ -84,24 +90,26 @@ contract Instance is
         _productStore = instanceContracts.productStore;
         _bundleSet = instanceContracts.bundleSet;
         _riskSet = instanceContracts.riskSet;
+        _requestSet = instanceContracts.requestSet;
         _instanceReader = instanceContracts.instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
         _productStore.initialize();
-        _bundleSet.initialize(instanceContracts.instanceAdmin.authority());
-        _riskSet.initialize(instanceContracts.instanceAdmin.authority());
+        _bundleSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _requestSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
         _instanceReader.initialize();
 
         _componentService = IComponentService(
-            registry.getServiceAddress(
+            getRegistry().getServiceAddress(
                 COMPONENT(), 
-                getRelease()));
+                release));
 
         _instanceService = IInstanceService(
-            registry.getServiceAddress(
+            getRegistry().getServiceAddress(
                 INSTANCE(), 
-                getRelease()));
+                release));
 
         _tokenRegistryDisabled = tokenRegistryDisabled;
 
@@ -313,7 +321,7 @@ contract Instance is
         return _products.length;
     }
 
-    function getProductNftId(uint256 idx) external view returns (NftId productNftId) {
+    function getProduct(uint256 idx) external view returns (NftId productNftId) {
         return _products[idx];
     }
 
@@ -329,6 +337,10 @@ contract Instance is
         return _riskSet;
     }
 
+    function getRequestSet() external view returns (RequestSet) {
+        return _requestSet;
+    }
+
     function getInstanceAdmin() external view returns (InstanceAdmin) {
         return _instanceAdmin;
     }

package/contracts/instance/InstanceAdmin.sol

@@ -11,10 +11,9 @@ 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 {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";
+import {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME, REQUEST_SET_TARGET_NAME} from "./TargetNames.sol";
 
 
 contract InstanceAdmin is
@@ -27,12 +26,13 @@ contract InstanceAdmin is
     error ErrorInstanceAdminNotComponentOrCustomTarget(address target);
 
     IInstance internal _instance;
+    IRegistry internal _registry;
 
     uint64 internal _customRoleIdNext;
 
 
     modifier onlyInstanceService() {
-        if (msg.sender != _getRegistry().getServiceAddress(INSTANCE(), getRelease())) {
+        if (msg.sender != _registry.getServiceAddress(INSTANCE(), getRelease())) {
             revert ErrorInstanceAdminNotInstanceService(msg.sender);
         }
         _;
@@ -43,8 +43,7 @@ contract InstanceAdmin is
     constructor(address accessManager) {
         initialize(
             accessManager,
-            "MasterInstanceAdmin",
-            GIF_INITIAL_RELEASE());
+            "MasterInstanceAdmin");
     }
 
 
@@ -52,23 +51,32 @@ 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(instance, INSTANCE(), getRelease());
+        AccessAdminLib.checkIsRegistered(registry, instance, INSTANCE());
 
         // effects
+        AccessManagerCloneable(
+            authority()).completeSetup(
+                registry, 
+                release); 
+
         AccessAdminLib.checkAuthorization(
             address(_authorization), 
             authorization, 
             INSTANCE(), // expectedDomain
-            getRelease(), // expectedRelease
+            release, // expectedRelease
             false, // expectServiceAuthorization
             true); // checkAlreadyInitialized
 
+        _registry = IRegistry(registry);
         _instance = IInstance(instance);
         _authorization = IAuthorization(authorization);
         _customRoleIdNext = 0;
@@ -97,7 +105,7 @@ contract InstanceAdmin is
         for(uint256 i = 0; i < serviceDomains.length; i++) {
             ObjectType serviceDomain = serviceDomains[i];
             RoleId serviceRoleId = authorization.getServiceRole(serviceDomain);
-            address service = _getRegistry().getServiceAddress(serviceDomain, getRelease());
+            address service = _registry.getServiceAddress(serviceDomain, getRelease());
 
             _grantRoleToAccount(
                 serviceRoleId,
@@ -115,6 +123,7 @@ contract InstanceAdmin is
         _createInstanceTarget(address(_instance.getProductStore()), PRODUCT_STORE_TARGET_NAME); 
         _createInstanceTarget(address(_instance.getBundleSet()), BUNDLE_SET_TARGET_NAME); 
         _createInstanceTarget(address(_instance.getRiskSet()), RISK_SET_TARGET_NAME); 
+        _createInstanceTarget(address(_instance.getRequestSet()), REQUEST_SET_TARGET_NAME); 
     }
 
 
@@ -122,13 +131,11 @@ contract InstanceAdmin is
         _createTarget(target, name, TargetType.Instance, true); 
     }
 
-
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(
         address componentAddress,
-        ObjectType expectedType,
-        VersionPart expectedRelease
+        ObjectType expectedType
     )
         external
         restricted()

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -10,12 +10,11 @@ import {ACCOUNTING, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION
 import {BundleSet} from "../instance/BundleSet.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 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 {INSTANCE_TARGET_NAME, INSTANCE_ADMIN_TARGET_NAME, INSTANCE_STORE_TARGET_NAME, PRODUCT_STORE_TARGET_NAME, BUNDLE_SET_TARGET_NAME, RISK_SET_TARGET_NAME, REQUEST_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 {GIF_INITIAL_RELEASE} from "../registry/Registry.sol";
-import {RiskSet} from "../instance/RiskSet.sol";
-import {VersionPartLib} from "../type/Version.sol";
+import {RequestSet} from "../instance/RequestSet.sol";
+import {RiskSet} from "../instance/RiskSet.sol"; 
 
 
 contract InstanceAuthorizationV3
@@ -29,7 +28,7 @@ contract InstanceAuthorizationV3
           Authorization(
                INSTANCE_TARGET_NAME, 
                INSTANCE(), 
-               GIF_INITIAL_RELEASE(), 
+               3, 
                COMMIT_HASH,
                TargetType.Instance, 
                false)
@@ -73,6 +72,7 @@ contract InstanceAuthorizationV3
           _addInstanceTarget(PRODUCT_STORE_TARGET_NAME);
           _addInstanceTarget(BUNDLE_SET_TARGET_NAME);
           _addInstanceTarget(RISK_SET_TARGET_NAME);
+          _addInstanceTarget(REQUEST_SET_TARGET_NAME);
      }
 
 
@@ -86,6 +86,18 @@ contract InstanceAuthorizationV3
           _setupProductStoreAuthorization();
           _setupBundleSetAuthorization();
           _setUpRiskSetAuthorization();
+          _setUpRequestIdSetAuthorization();
+     }
+
+     function _setUpRequestIdSetAuthorization()
+          internal
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize oracle service role
+          functions = _authorizeForTarget(REQUEST_SET_TARGET_NAME, getServiceRole(ORACLE()));
+          _authorize(functions, RequestSet.add.selector, "add");
+          _authorize(functions, RequestSet.remove.selector, "remove");
      }
 
 

package/contracts/instance/InstanceReader.sol

@@ -28,32 +28,28 @@ 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 {RequestSet} from "./RequestSet.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {RiskSet} from "./RiskSet.sol";
 import {RoleId, INSTANCE_OWNER_ROLE} from "../type/RoleId.sol";
 import {StateId} from "../type/StateId.sol";
+import {Str, StrLib} from "../type/String.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 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 is
-    RegistryLinked
-{
+contract InstanceReader {
 
     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;
 
@@ -61,6 +57,7 @@ contract InstanceReader is
     ProductStore internal _productStore;
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
+    RequestSet internal _requestSet;
     IDistributionService internal _distributionService;
 
     /// @dev This initializer needs to be called from the instance itself.
@@ -84,24 +81,28 @@ contract InstanceReader is
         _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(
-            _getRegistry().getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
+        _requestSet = _instance.getRequestSet();
+        _distributionService = IDistributionService(_registry.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 _getRegistry().getNftIdForAddress(address(_instance));
+        return _registry.getNftIdForAddress(address(_instance));
     }
 
 
@@ -166,7 +167,9 @@ contract InstanceReader is
 
 
     /// @dev Returns the currently locked amount for the given NFT ID.
-    /// The target NFT ID may reference a pool or a bundle.
+    /// Locked amounts are only tracked for bundles, not for pool. To get the 
+    /// pool locked amount, then locked amounts of the bundles contained in the 
+    /// pool must be summed up. The target NFT ID may only a bundle. 
     function getLockedAmount(NftId targetNftId) external view returns (Amount) { 
         return _store.getLockedAmount(targetNftId);
     }
@@ -180,8 +183,8 @@ contract InstanceReader is
 
 
     /// @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);
     }
 
 
@@ -222,6 +225,12 @@ contract InstanceReader is
     }
 
 
+    /// @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);
@@ -243,10 +252,21 @@ contract InstanceReader is
 
 
     /// @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) {
@@ -344,6 +364,23 @@ contract InstanceReader is
         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());
+    }
+
+    function getActiveRequests(NftId oracleNftId) external view returns(uint256 numberOfRequests) {
+        return _requestSet.activeRequests(oracleNftId);
+    }
+
+    function getActiveRequestAt(NftId oracleNftId, uint256 idx) external view returns(RequestId requestId) {
+        return _requestSet.activeRequestAt(oracleNftId, idx);
+    }
+
+    function isRequestActive(NftId oracleNftId, RequestId requestId) external view returns(bool isActive) {
+        return _requestSet.contains(oracleNftId, requestId);
+    }
+
     //--- pool functions -----------------------------------------------------------//
 
     /// @dev Returns the pool info for the given pool NFT ID.
@@ -416,7 +453,7 @@ contract InstanceReader is
         return _store.getReferralInfo(referralId);
     }
 
-    // TODO reader dependce on service os wrong?
+
     function getDiscountPercentage(ReferralId referralId)
         public
         view
@@ -425,7 +462,10 @@ contract InstanceReader is
             ReferralStatus status
         )
     {
-        return _distributionService.getDiscountPercentage(
+        return IDistributionService(
+            _registry.getServiceAddress(
+                DISTRIBUTION(),
+                _instance.getRelease())).getDiscountPercentage(
                     this, // instance reader
                     referralId);
     }
@@ -444,6 +484,12 @@ contract InstanceReader is
     }
 
 
+    /// @dev Returns the role ID for the given index.
+    function getRoleForName(string memory name) public view returns (RoleId roleId, bool exists) {
+        return _instanceAdmin.getRoleForName(name);
+    }
+
+
     /// @dev Returns the role ID for the instance owner role.
     /// This role may be used as a "root" admin role for other custom roles defined for this instance.
     function getInstanceOwnerRole() public pure returns (RoleId roleId) {
@@ -573,13 +619,18 @@ contract InstanceReader is
     }
 
 
-    function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
-        return UFixedLib.toUFixed(value, exp);
+    function toInt(UFixed value) public pure returns (uint256) {
+        return UFixedLib.toInt(value);
     }
 
 
-    function toInt(UFixed value) public pure returns (uint256) {
-        return UFixedLib.toInt(value);
+    function toString(Str str) public pure returns (string memory) {
+        return StrLib.toString(str);
+    }
+
+
+    function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
+        return UFixedLib.toUFixed(value, exp);
     }
 
     //--- internal functions ----------------------------------------------------//