@etherisc/gif-next 0.0.2-d13bb9e-069 → 0.0.2-d1ee1ae-450

package/contracts/instance/InstanceAuthorizationV3.sol

@@ -1,79 +1,62 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-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 {Authorization} from "../authorization/Authorization.sol";
+import {ACCOUNTING, ORACLE, POOL, INSTANCE, COMPONENT, DISTRIBUTION, APPLICATION, POLICY, CLAIM, BUNDLE, RISK} from "../../contracts/type/ObjectType.sol";
+import {BundleSet} from "../instance/BundleSet.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 {PUBLIC_ROLE} from "../type/RoleId.sol";
+import {RiskSet} from "../instance/RiskSet.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 RISK_SET_TARGET_NAME = "RiskSet";
 
-     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) {}
-
-
-     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);
-     }
-
-
-     function _setupTargets()
-          internal
-          override
-     {
-          // instance target
-          _addTargetWithRole(
-               INSTANCE_TARGET_NAME, 
-               _getTargetRoleId(INSTANCE()),
-               INSTANCE_ROLE_NAME);
-
-          // instance supporting targets
-          _addTarget(INSTANCE_STORE_TARGET_NAME);
-          _addTarget(INSTANCE_ADMIN_TARGET_NAME);
-          _addTarget(BUNDLE_SET_TARGET_NAME);
+     constructor()
+          Authorization(INSTANCE_TARGET_NAME, INSTANCE(), false, false)
+     { }
 
+     function _setupServiceTargets() internal virtual override {
           // service targets relevant to instance
           _addServiceTargetWithRole(INSTANCE());
+          _addServiceTargetWithRole(ACCOUNTING());
           _addServiceTargetWithRole(COMPONENT());
           _addServiceTargetWithRole(DISTRIBUTION());
           _addServiceTargetWithRole(ORACLE());
           _addServiceTargetWithRole(POOL());
           _addServiceTargetWithRole(BUNDLE());
-          _addServiceTargetWithRole(PRODUCT());
+          _addServiceTargetWithRole(RISK());
           _addServiceTargetWithRole(APPLICATION());
           _addServiceTargetWithRole(POLICY());
           _addServiceTargetWithRole(CLAIM());
      }
 
+     function _setupTargets()
+          internal
+          override
+     {
+          // instance supporting targets
+          // _addGifContractTarget(INSTANCE_ADMIN_TARGET_NAME);
+          _addTarget(INSTANCE_ADMIN_TARGET_NAME);
+          _addTarget(INSTANCE_STORE_TARGET_NAME);
+          _addTarget(BUNDLE_SET_TARGET_NAME);
+          _addTarget(RISK_SET_TARGET_NAME);
+
+     }
+
 
      function _setupTargetAuthorizations()
           internal
@@ -83,6 +66,7 @@ contract InstanceAuthorizationV3
           _setupInstanceAdminAuthorization();
           _setupInstanceStoreAuthorization();
           _setupBundleSetAuthorization();
+          _setUpRiskSetAuthorization();
      }
 
 
@@ -93,11 +77,31 @@ contract InstanceAuthorizationV3
 
           // authorize bundle service role
           functions = _authorizeForTarget(BUNDLE_SET_TARGET_NAME, getServiceRole(BUNDLE()));
-          _authorize(functions, BundleSet.linkPolicy.selector, "linkPolicy");
-          _authorize(functions, BundleSet.unlinkPolicy.selector, "unlinkPolicy");
           _authorize(functions, BundleSet.add.selector, "add");
           _authorize(functions, BundleSet.lock.selector, "lock");
           _authorize(functions, BundleSet.unlock.selector, "unlock");
+
+          // authorize bundle service role
+          functions = _authorizeForTarget(BUNDLE_SET_TARGET_NAME, getServiceRole(POLICY()));
+          _authorize(functions, BundleSet.linkPolicy.selector, "linkPolicy");
+          _authorize(functions, BundleSet.unlinkPolicy.selector, "unlinkPolicy");
+     }
+
+     function _setUpRiskSetAuthorization()
+          internal
+     {
+          IAccess.FunctionInfo[] storage functions;
+
+          // authorize risk service role
+          functions = _authorizeForTarget(RISK_SET_TARGET_NAME, getServiceRole(RISK()));
+          _authorize(functions, RiskSet.add.selector, "add");
+          _authorize(functions, RiskSet.pause.selector, "pause");
+          _authorize(functions, RiskSet.activate.selector, "activate");
+
+          // authorize policy service role
+          functions = _authorizeForTarget(RISK_SET_TARGET_NAME, getServiceRole(POLICY()));
+          _authorize(functions, RiskSet.linkPolicy.selector, "linkPolicy");
+          _authorize(functions, RiskSet.unlinkPolicy.selector, "unlinkPolicy");
      }
 
 
@@ -106,6 +110,25 @@ contract InstanceAuthorizationV3
      {
           IAccess.FunctionInfo[] storage functions;
 
+          // authorize instance service role
+          functions = _authorizeForTarget(INSTANCE_TARGET_NAME, PUBLIC_ROLE());
+          _authorize(functions, Instance.registerProduct.selector, "registerProduct");
+          _authorize(functions, Instance.upgradeInstanceReader.selector, "upgradeInstanceReader");
+
+          // staking
+          _authorize(functions, Instance.setStakingLockingPeriod.selector, "setStakingLockingPeriod");
+          _authorize(functions, Instance.setStakingRewardRate.selector, "setStakingRewardRate");
+          _authorize(functions, Instance.setStakingMaxAmount.selector, "setStakingMaxAmount");
+          _authorize(functions, Instance.refillStakingRewardReserves.selector, "refillStakingRewardReserves");
+          _authorize(functions, Instance.withdrawStakingRewardReserves.selector, "withdrawStakingRewardReserves");
+
+          // custom authz
+          _authorize(functions, Instance.createRole.selector, "createRole");
+          _authorize(functions, Instance.grantRole.selector, "grantRole");
+          _authorize(functions, Instance.revokeRole.selector, "revokeRole");
+          _authorize(functions, Instance.createTarget.selector, "createTarget");
+          _authorize(functions, Instance.setTargetFunctionRole.selector, "setTargetFunctionRole");
+
           // authorize instance service role
           functions = _authorizeForTarget(INSTANCE_TARGET_NAME, getServiceRole(INSTANCE()));
           _authorize(functions, Instance.setInstanceReader.selector, "setInstanceReader");
@@ -117,12 +140,15 @@ contract InstanceAuthorizationV3
      {
           IAccess.FunctionInfo[] storage functions;
 
-          // authorize instance role
-          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, _getTargetRoleId(INSTANCE()));
-          _authorize(functions, InstanceAdmin.grantRole.selector, "grantRole");
+          // authorize component service role
+          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getServiceRole(INSTANCE()));
+          _authorize(functions, InstanceAdmin.setInstanceLocked.selector, "setInstanceLocked");
+          _authorize(functions, InstanceAdmin.setTargetLocked.selector, "setTargetLocked");
 
-          // authorize instance service role
-          // functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getServiceRole(INSTANCE()));
+          // authorize component service role
+          functions = _authorizeForTarget(INSTANCE_ADMIN_TARGET_NAME, getServiceRole(COMPONENT()));
+          _authorize(functions, InstanceAdmin.initializeComponentAuthorization.selector, "initializeComponentAuthoriz");
+          _authorize(functions, InstanceAdmin.setComponentLocked.selector, "setComponentLocked");
      }
 
 
@@ -131,6 +157,13 @@ contract InstanceAuthorizationV3
      {
           IAccess.FunctionInfo[] storage functions;
 
+          // authorize accounting service role
+          functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(ACCOUNTING()));
+          _authorize(functions, InstanceStore.increaseBalance.selector, "increaseBalance");
+          _authorize(functions, InstanceStore.decreaseBalance.selector, "decreaseBalance");
+          _authorize(functions, InstanceStore.increaseFees.selector, "increaseFees");
+          _authorize(functions, InstanceStore.decreaseFees.selector, "decreaseFees");
+
           // authorize component service role
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(COMPONENT()));
           _authorize(functions, InstanceStore.createComponent.selector, "createComponent");
@@ -138,11 +171,9 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.createPool.selector, "createPool");
           _authorize(functions, InstanceStore.createProduct.selector, "createProduct");
           _authorize(functions, InstanceStore.updateProduct.selector, "updateProduct");
-          _authorize(functions, InstanceStore.increaseBalance.selector, "increaseBalance");
-          _authorize(functions, InstanceStore.decreaseBalance.selector, "decreaseBalance");
-          _authorize(functions, InstanceStore.increaseFees.selector, "increaseFees");
-          _authorize(functions, InstanceStore.decreaseFees.selector, "decreaseFees");
-
+          _authorize(functions, InstanceStore.createFee.selector, "createFee");
+          _authorize(functions, InstanceStore.updateFee.selector, "updateFee");
+          
           // authorize distribution service role
           functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(DISTRIBUTION()));
           _authorize(functions, InstanceStore.createDistributorType.selector, "createDistributorType");
@@ -174,7 +205,7 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.decreaseLocked.selector, "decreaseLocked");
 
           // authorize product service role
-          functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(PRODUCT()));
+          functions = _authorizeForTarget(INSTANCE_STORE_TARGET_NAME, getServiceRole(RISK()));
           _authorize(functions, InstanceStore.createRisk.selector, "createRisk");
           _authorize(functions, InstanceStore.updateRisk.selector, "updateRisk");
           _authorize(functions, InstanceStore.updateRiskState.selector, "updateRiskState");
@@ -199,6 +230,7 @@ contract InstanceAuthorizationV3
           _authorize(functions, InstanceStore.updateClaim.selector, "updateClaim");
           _authorize(functions, InstanceStore.createPayout.selector, "createPayout");
           _authorize(functions, InstanceStore.updatePayout.selector, "updatePayout");
+          _authorize(functions, InstanceStore.updatePayoutState.selector, "updatePayoutState");
      }
 }
 

package/contracts/instance/InstanceReader.sol

@@ -1,32 +1,38 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IBundle} from "../instance/module/IBundle.sol";
+import {IComponents} from "../instance/module/IComponents.sol";
+import {IDistribution} from "../instance/module/IDistribution.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IInstance} from "./IInstance.sol";
+import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
+import {IOracle} from "../oracle/IOracle.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRisk} from "../instance/module/IRisk.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+
 import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {BUNDLE, COMPONENT, DISTRIBUTOR, DISTRIBUTION, FEE, PREMIUM, POLICY, POOL, PRODUCT} from "../type/ObjectType.sol";
 import {ClaimId, ClaimIdLib} from "../type/ClaimId.sol";
 import {DistributorType} from "../type/DistributorType.sol";
+import {InstanceStore} from "./InstanceStore.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
-import {COMPONENT, DISTRIBUTOR, DISTRIBUTION, PREMIUM, PRODUCT, POLICY, POOL, BUNDLE} from "../type/ObjectType.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../type/Referral.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
+import {RiskSet} from "./RiskSet.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {StateId} from "../type/StateId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
-import {IBundle} from "../instance/module/IBundle.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
-import {IDistribution} from "../instance/module/IDistribution.sol";
-import {IInstance} from "./IInstance.sol";
-import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
-import {IOracle} from "../oracle/IOracle.sol";
-import {IPolicy} from "../instance/module/IPolicy.sol";
-import {IRisk} from "../instance/module/IRisk.sol";
-import {TimestampLib} from "../type/Timestamp.sol";
-
-import {InstanceStore} from "./InstanceStore.sol";
-import {BundleSet} from "./BundleSet.sol";
 
 
 contract InstanceReader {
@@ -36,9 +42,13 @@ contract InstanceReader {
 
     bool private _initialized = false;
 
+    IRegistry internal _registry;
     IInstance internal _instance;
+
     InstanceStore internal _store;
     BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
+    IDistributionService internal _distributionService;
 
     /// @dev This initializer needs to be called from the instance itself.
     function initialize() public {
@@ -49,18 +59,49 @@ contract InstanceReader {
         initializeWithInstance(msg.sender);
     }
 
-    /// @dev This initializer needs to be called from the instance itself.
-    function initializeWithInstance(address instanceAddress) public {
+    function initializeWithInstance(address instanceAddress)
+        public
+    {
         if(_initialized) {
             revert ErrorInstanceReaderAlreadyInitialized();
         }
 
         _initialized = true;
         _instance = IInstance(instanceAddress);
+        _registry = _instance.getRegistry();
+
         _store = _instance.getInstanceStore();
         _bundleSet = _instance.getBundleSet();
+        _riskSet = _instance.getRiskSet();
+        _distributionService = IDistributionService(_registry.getServiceAddress(DISTRIBUTION(), _instance.getRelease()));
+    }
+
+
+    // instance level functions
+
+    function getRegistry() public view returns (IRegistry registry) {
+        return _registry;
+    }
+
+    function getInstanceNftId() public view returns (NftId instanceNftid) {
+        return _registry.getNftIdForAddress(address(_instance));
+    }
+
+    function getInstance() public view returns (IInstance instance) {
+        return _instance;
     }
 
+    function components() public view returns (uint256 componentCount) {
+        return _instance.getInstanceAdmin().components();
+    }
+
+    function products() public view returns (uint256 productCount) {
+        return _instance.products();
+    }
+
+    function getProductNftId(uint256 idx) public view returns (NftId productNftId) {
+        return _instance.getProductNftId(idx);
+    }
 
     // module specific functions
 
@@ -102,10 +143,18 @@ contract InstanceReader {
         return _store.getState(toPremiumKey(policyNftId));
     }
 
+    function bundles(NftId poolNftId)
+        public
+        view
+        returns (uint256 bundleCount)
+    {
+        return _bundleSet.bundles(poolNftId);
+    }
+
     function activeBundles(NftId poolNftId)
         public
         view
-        returns (uint256 bundles)
+        returns (uint256 bundleCount)
     {
         return _bundleSet.activeBundles(poolNftId);
     }
@@ -118,6 +167,14 @@ contract InstanceReader {
         return _bundleSet.getActiveBundleNftId(poolNftId, idx);
     }
 
+    function getBundleNftId(NftId poolNftId, uint256 idx)
+        public
+        view
+        returns (NftId bundleNftId)
+    {
+        return _bundleSet.getBundleNftId(poolNftId, idx);
+    }
+
     function getBundleState(NftId bundleNftId)
         public
         view
@@ -145,7 +202,7 @@ contract InstanceReader {
     function claims(NftId policyNftId)
         public
         view
-        returns (uint16 claims)
+        returns (uint16 claimCount)
     {
         return getPolicyInfo(policyNftId).claimsCount;
     }
@@ -183,7 +240,7 @@ contract InstanceReader {
     function payouts(NftId policyNftId, ClaimId claimId)
         public
         view
-        returns (uint24 payouts)
+        returns (uint24 payoutCount)
     {
         return getClaimInfo(policyNftId, claimId).payoutsCount;
     }
@@ -226,6 +283,38 @@ contract InstanceReader {
         return _store.getState(payoutId.toKey32(policyNftId));
     }
 
+    function risks(NftId productNftId)
+        public
+        view
+        returns (uint256 riskCount)
+    {
+        return _riskSet.risks(productNftId);
+    }
+
+    function getRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getRiskId(productNftId, idx);
+    }
+
+    function activeRisks(NftId productNftId)
+        public
+        view
+        returns (uint256 activeRiskCount)
+    {
+        return _riskSet.activeRisks(productNftId);
+    }
+
+    function getActiveRiskId(NftId productNftId, uint256 idx)
+        public
+        view
+        returns (RiskId riskId)
+    {
+        return _riskSet.getActiveRiskId(productNftId, idx);
+    }
+
     function getRiskInfo(RiskId riskId)
         public 
         view 
@@ -237,32 +326,68 @@ contract InstanceReader {
         }
     }
 
-    function getWallet(NftId componentNftId)
+    function getRiskState(RiskId riskId)
+        public 
+        view 
+        returns (StateId stateId)
+    {
+        bytes memory data = _store.getData(riskId.toKey32());
+        return _store.getState(riskId.toKey32());
+    }
+
+    function policiesForRisk(RiskId riskId)
         public
         view
-        returns (address tokenHandler)
+        returns (uint256 linkedPolicies)
     {
-        bytes memory data = _store.getData(toComponentKey(componentNftId));
+        return _riskSet.linkedPolicies(riskId);
+    }
 
-        if (data.length > 0) {
-            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return info.wallet;
+    function getPolicyNftIdForRisk(RiskId riskId, uint256 idx)
+        public
+        view
+        returns (NftId linkedPolicyNftId)
+    {
+        return _riskSet.getLinkedPolicyNftId(riskId, idx);
+    }
+
+
+    function getToken(NftId componentNftId)
+        public
+        view
+        returns (IERC20Metadata token)
+    {
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.TOKEN();
+        }
+    }
+
+
+    function getWallet(NftId componentNftId)
+        public
+        view
+        returns (address wallet)
+    {
+        TokenHandler tokenHandler = getTokenHandler(componentNftId);
+        if (address(tokenHandler) != address(0)) {
+            return tokenHandler.getWallet();
         }
     }
 
+
     function getTokenHandler(NftId componentNftId)
         public
         view
-        returns (address tokenHandler)
+        returns (TokenHandler tokenHandler)
     {
         bytes memory data = _store.getData(toComponentKey(componentNftId));
-
         if (data.length > 0) {
-            IComponents.ComponentInfo memory info = abi.decode(data, (IComponents.ComponentInfo));
-            return address(info.tokenHandler);
+            return abi.decode(data, (IComponents.ComponentInfo)).tokenHandler;
         }
     }
 
+
     function getBundleInfo(NftId bundleNftId)
         public 
         view 
@@ -330,6 +455,17 @@ contract InstanceReader {
         }
     }
 
+    function getFeeInfo(NftId productNftId)
+        public
+        view
+        returns (IComponents.FeeInfo memory feeInfo)
+    {
+        bytes memory data = _store.getData(toFeeKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IComponents.FeeInfo));
+        }
+    }
+
     function getPoolInfo(NftId poolNftId)
         public
         view
@@ -352,6 +488,16 @@ contract InstanceReader {
         }
     }
 
+    function isReferralValid(NftId distributionNftId, ReferralId referralId)
+        external
+        view
+        returns (bool isValid)
+    {
+        return _distributionService.referralIsValid(
+            distributionNftId,
+            referralId);
+    }
+
     function getRequestInfo(RequestId requestId)
         public
         view
@@ -440,7 +586,7 @@ contract InstanceReader {
     }
 
 
-    function isTargetLocked(address target) public view returns (bool) {
+    function isLocked(address target) public view returns (bool) {
         return _instance.getInstanceAdmin().isTargetLocked(target);
     }
 
@@ -476,15 +622,24 @@ contract InstanceReader {
         return productNftId.toKey32(PRODUCT());
     }
 
-    // low level function
-    function getInstance() external view returns (IInstance instance) {
-        return _instance;
+    function toFeeKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(FEE());
     }
 
+    // low level function
+
     function getInstanceStore() external view returns (IKeyValueStore store) {
         return _store;
     }
 
+    function getBundleSet() external view returns (BundleSet bundleSet) {
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet riskSet) {
+        return _riskSet;
+    }
+
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
         return UFixedLib.toUFixed(value, exp);
     }