@etherisc/gif-next 0.0.2-a755cba-665 → 0.0.2-a7722ab-390

package/contracts/instance/InstanceStore.sol

@@ -7,10 +7,10 @@ import {Amount} from "../type/Amount.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR, FEE} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {StateId} from "../type/StateId.sol";
+import {StateId, KEEP_STATE} from "../type/StateId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -85,6 +85,17 @@ contract InstanceStore is
         _update(_toNftKey32(productNftId, PRODUCT()), abi.encode(info), newState);
     }
 
+
+    //--- Fee -----------------------------------------------------------//
+    function createFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _create(_toNftKey32(productNftId, FEE()), abi.encode(info));
+    }
+
+    // Fee only has one state, so no change change possible
+    function updateFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _update(_toNftKey32(productNftId, FEE()), abi.encode(info), KEEP_STATE());
+    }
+
     //--- Pool --------------------------------------------------------------//
 
     function createPool(

package/contracts/instance/RiskSet.sol

@@ -1,18 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IPolicy} from "../instance/module/IPolicy.sol";
 import {Key32} from "../type/Key32.sol";
 import {LibNftIdSet} from "../type/NftIdSet.sol";
 import {NftId} from "../type/NftId.sol";
-import {RiskIdLib, RiskId} from "../type/RiskId.sol";
-
 import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+import {RiskIdLib, RiskId} from "../type/RiskId.sol";
 
-contract RiskSet is 
+/// @dev RiskSet manages the risks and its active policies per product.
+contract RiskSet is
     ObjectSet
 {
-    using LibNftIdSet for LibNftIdSet.Set;
 
     event LogRiskSetPolicyLinked(RiskId riskId, NftId policyNftId);
     event LogRiskSetPolicyUnlinked(RiskId riskId, NftId policyNftId);
@@ -36,7 +35,7 @@ contract RiskSet is
             revert ErrorRiskSetRiskLocked(riskId, policyNftId);
         }
 
-        _activePolicies[riskId].add(policyNftId);
+        LibNftIdSet.add(_activePolicies[riskId], policyNftId);
         emit LogRiskSetPolicyLinked(riskId, policyNftId);
     }
 
@@ -48,14 +47,14 @@ contract RiskSet is
             revert ErrorRiskSetRiskUnknown(riskId);
         }
 
-        _activePolicies[riskId].remove(policyNftId);
+        LibNftIdSet.remove(_activePolicies[riskId], policyNftId);
         emit LogRiskSetPolicyUnlinked(riskId, policyNftId);
     }
 
     /// @dev add a new risk to a product registered with this instance
     // the corresponding product is fetched via instance reader
     function add(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
 
         // ensure product is registered with instance
         if(productNftId.eqz()) {
@@ -68,14 +67,14 @@ contract RiskSet is
 
     /// @dev Applications linked to active risks may be underwritten
     function activate(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _activate(productNftId, riskId.toKey32());
         emit LogRiskSetRiskActive(productNftId, riskId);
     }
 
     /// @dev Applications linked to paused/archived risks may not be underwritten
     function pause(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _deactivate(productNftId, riskId.toKey32());
         emit LogRiskSetRiskPaused(productNftId, riskId);
     }
@@ -110,10 +109,10 @@ contract RiskSet is
     }
 
     function linkedPolicies(RiskId riskId) external view returns(uint256) {
-        return _activePolicies[riskId].size();
+        return LibNftIdSet.size(_activePolicies[riskId]);
     }
 
     function getLinkedPolicyNftId(RiskId riskId, uint256 idx) external view returns(NftId policyNftId) {
-        return _activePolicies[riskId].getElementAt(idx);
+        return LibNftIdSet.getElementAt(_activePolicies[riskId], idx);
     }
 }

package/contracts/instance/base/ObjectLifecycle.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PREMIUM, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL} from "../../type/ObjectType.sol";
+import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PREMIUM, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL, FEE} from "../../type/ObjectType.sol";
 import {ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, COLLATERALIZED, REVOKED, SUBMITTED, CONFIRMED, DECLINED, EXPECTED, PAID, FULFILLED, FAILED, CANCELLED} from "../../type/StateId.sol";
 import {Lifecycle} from "../../shared/Lifecycle.sol";
 
@@ -100,6 +100,7 @@ contract ObjectLifecycle is
     // dummy lifecycle only
     function _setUpProductLifecycle() private {
         setInitialState(PRODUCT(), ACTIVE());
+        setInitialState(FEE(), ACTIVE());
     }
 
     // dummy lifecycles only

package/contracts/instance/base/ObjectSet.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.20;
 
 import {Cloneable} from "./Cloneable.sol";
 
-import {IInstance} from "../IInstance.sol";
 import {LibKey32Set} from "../../type/Key32Set.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Key32} from "../../type/Key32.sol";
@@ -19,21 +18,21 @@ contract ObjectSet is
 
     mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _activeObjects;
     mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _allObjects;
-    IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectSet initialization
+    address internal _instanceAddress;
 
     /// @dev This initializer needs to be called from the instance itself.
-    function initialize() 
+    function initialize(address authority, address registry) 
         external
         initializer()
     {
-        _instance = IInstance(msg.sender);
-        __Cloneable_init(_instance.authority(), address(_instance.getRegistry()));
+        _instanceAddress = msg.sender;
+        __Cloneable_init(authority, registry);
         
-        emit LogObjectSetInitialized(address(_instance));
+        emit LogObjectSetInitialized(address(_instanceAddress));
     }
 
-    function getInstance() external view returns (IInstance) {
-        return _instance;
+    function getInstanceAddress() external view returns (address) {
+        return _instanceAddress;
     }
 
     function _add(NftId componentNftId, Key32 key) internal {

package/contracts/instance/base/ObjectSetHelperLib.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IBundle} from "../module/IBundle.sol";
+import {IInstance} from "../IInstance.sol";
+import {IRisk} from "../module/IRisk.sol";
+import {NftId} from "../../type/NftId.sol";
+import {RiskId} from "../../type/RiskId.sol";
+
+
+library ObjectSetHelperLib {
+
+    function getRiskInfo(address instanceAddress, RiskId riskId) public view returns (IRisk.RiskInfo memory) {
+
+        return IInstance(instanceAddress).getInstanceReader().getRiskInfo(riskId);
+    }
+
+    function getProductNftId(address instanceAddress, RiskId riskId) public view returns (NftId) {
+        return getRiskInfo(instanceAddress, riskId).productNftId;
+    }
+
+    function getBundleInfo(address instanceAddress, NftId bundleNftId) public view returns (IBundle.BundleInfo memory) {
+        return IInstance(instanceAddress).getInstanceReader().getBundleInfo(bundleNftId);
+    }
+
+    function getPoolNftId(address instanceAddress, NftId bundleNftId) public view returns (NftId) {
+        return getBundleInfo(instanceAddress, bundleNftId).poolNftId;
+    }
+
+}

package/contracts/instance/module/IComponents.sol

@@ -6,7 +6,6 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 import {Amount} from "../../type/Amount.sol";
 import {Fee} from "../../type/Fee.sol";
 import {NftId} from "../../type/NftId.sol";
-import {RoleId} from "../../type/RoleId.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 import {UFixed} from "../../type/UFixed.sol";
 
@@ -14,7 +13,6 @@ interface IComponents {
 
     struct ComponentInfo {
         string name; // component name (needs to be unique per instance)
-        IERC20Metadata token;
         TokenHandler tokenHandler;
         bytes data; // will hold component type specific additional info (eg encoded pool info)
     }
@@ -28,6 +26,9 @@ interface IComponents {
         NftId poolNftId; // mandatory
         NftId distributionNftId; // 0..1 (optional)
         NftId [] oracleNftId; // 0..n (optional)
+    }
+
+    struct FeeInfo {
         Fee productFee; // product fee on net premium
         Fee processingFee; // product fee on payout amounts        
         Fee distributionFee; // distribution fee for sales that do not include commissions
@@ -37,7 +38,6 @@ interface IComponents {
         Fee performanceFee; // pool fee on profits from capital investors
     }
 
-
     struct PoolInfo {
         Amount maxBalanceAmount; // max balance amount allowed for pool
         bool isInterceptingBundleTransfers; // custom logic for bundle nft transfers

package/contracts/instance/module/IDistribution.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.20;
 import {Amount} from "../../type/Amount.sol";
 import {DistributorType} from "../../type/DistributorType.sol";
 import {NftId} from "../../type/NftId.sol";
+import {Seconds} from "../../type/Seconds.sol";
 import {Timestamp} from "../../type/Timestamp.sol";
 import {UFixed} from "../../type/UFixed.sol";
 
@@ -11,11 +12,12 @@ interface IDistribution {
 
     struct DistributorTypeInfo {
         string name;
+        NftId distributionNftId;
         UFixed minDiscountPercentage;
         UFixed maxDiscountPercentage;
         UFixed commissionPercentage;
         uint32 maxReferralCount;
-        uint32 maxReferralLifetime;
+        Seconds maxReferralLifetime;
         bool allowSelfReferrals;
         bool allowRenewals;
         bytes data;
@@ -28,7 +30,8 @@ interface IDistribution {
         uint32 numPoliciesSold;
     }
 
-    struct ReferralInfo {   
+    struct ReferralInfo {
+        NftId distributionNftId;
         NftId distributorNftId;
         string referralCode;
         UFixed discountPercentage;

package/contracts/instance/module/IRisk.sol

@@ -2,11 +2,13 @@
 pragma solidity ^0.8.20;
 
 import {NftId} from "../../type/NftId.sol";
+import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IRisk {
 
     struct RiskInfo {
         NftId productNftId;
+        Timestamp createdAt;
         bytes data;
     }
 }

package/contracts/oracle/BasicOracle.sol

@@ -27,8 +27,7 @@ contract BasicOracle is
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         internal
         virtual
@@ -41,7 +40,6 @@ contract BasicOracle is
             authorization,
             initialOwner,
             name,
-            token,
             "");
     }
 }

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -15,18 +15,9 @@ contract BasicOracleAuthorization
 {
 
      constructor(string memory componentName)
-          Authorization(componentName)
+          Authorization(componentName, ORACLE(), true, false)
      {}
 
-     function _setupTargets()
-          internal
-          virtual override
-     {
-          // basic component target
-          _addComponentTargetWithRole(ORACLE()); 
-     }
-
-
      function _setupTargetAuthorizations()
           internal
           virtual override
@@ -34,12 +25,12 @@ contract BasicOracleAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), getServiceRole(ORACLE()));
+          functions = _authorizeForTarget(getMainTargetName(), getServiceRole(ORACLE()));
           _authorize(functions, IOracle.request.selector, "request");
           _authorize(functions, IOracle.cancel.selector, "cancel");
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
           _authorize(functions, BasicOracle.respond.selector, "respond");
      }
 }

package/contracts/oracle/Oracle.sol

@@ -69,7 +69,7 @@ abstract contract Oracle is
         override(IInstanceLinkedComponent, InstanceLinkedComponent)
         onlyOwner()
         restricted()
-        returns (Amount withdrawnAmount)
+        returns (Amount)
     {
         revert ErrorOracleNotImplemented("withdrawFees");
     }
@@ -81,7 +81,6 @@ abstract contract Oracle is
         IAuthorization authorization,
         address initialOwner,
         string memory name,
-        address token,
         bytes memory componentData // component specifidc data 
     )
         internal
@@ -92,7 +91,6 @@ abstract contract Oracle is
             registry, 
             productNftId, 
             name, 
-            token, 
             ORACLE(), 
             authorization,
             true, 

package/contracts/oracle/OracleService.sol

@@ -32,11 +32,11 @@ contract OracleService is
         initializer()
     {
         (
-            address registryAddress,
-            address authority
+            address authority,
+            address registry
         ) = abi.decode(data, (address, address));
 
-        _initializeService(registryAddress, authority, owner);
+        __Service_init(authority, registry, owner);
         _registerInterface(type(IOracleService).interfaceId);
     }
 
@@ -52,11 +52,10 @@ contract OracleService is
         onlyNftOfType(oracleNftId, ORACLE())
         returns (RequestId requestId) 
     {
-        // IRegistry registry = getRegistry();
-
+        // checks
         // get and check active caller
         (
-            IRegistry.ObjectInfo memory info, 
+            IRegistry.ObjectInfo memory requesterInfo, 
             address instance
         ) = ContractLib.getAndVerifyAnyComponent(
             getRegistry(), msg.sender, true);
@@ -65,8 +64,9 @@ contract OracleService is
             NftId requesterNftId,
             IOracleComponent oracle
         ) = _checkRequestParams(
-            getRegistry(), oracleNftId, info, expiryAt, callbackMethodName);
+            getRegistry(), oracleNftId, requesterInfo, expiryAt, callbackMethodName);
 
+        // effects
         {
             // create request info
             IOracle.RequestInfo memory request = IOracle.RequestInfo({
@@ -84,14 +84,15 @@ contract OracleService is
             requestId = IInstance(instance).getInstanceStore().createRequest(request);
         }
 
+        emit LogOracleServiceRequestCreated(requestId, requesterNftId, oracleNftId, expiryAt);
+
+        // interactions
         // callback to oracle component
         oracle.request(
             requestId, 
             requesterNftId, 
             requestData, 
             expiryAt);
-
-        emit LogOracleServiceRequestCreated(requestId, requesterNftId, oracleNftId, expiryAt);
     }
 
 
@@ -220,7 +221,7 @@ contract OracleService is
     function _checkRequestParams(
         IRegistry registry,
         NftId oracleNftId,
-        IRegistry.ObjectInfo memory info,
+        IRegistry.ObjectInfo memory requesterInfo,
         Timestamp expiryAt,
         string memory callbackMethodName
     )
@@ -237,17 +238,17 @@ contract OracleService is
             registry, oracleNftId, true);
 
         // obtain return values
-        requesterNftId = info.nftId;
+        requesterNftId = requesterInfo.nftId;
         oracle = IOracleComponent(oracleInfo.objectAddress);
 
         // check that requester and oracle share same product cluster
-        if (info.objectType == PRODUCT()) {
+        if (requesterInfo.objectType == PRODUCT()) {
             if (oracleInfo.parentNftId != requesterNftId) {
-                revert ErrorOracleServiceProductMismatch(info.objectType, requesterNftId, oracleInfo.parentNftId);
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterNftId, oracleInfo.parentNftId);
             }
         } else {
-            if (oracleInfo.parentNftId != info.parentNftId) {
-                revert ErrorOracleServiceProductMismatch(info.objectType, info.parentNftId, oracleInfo.parentNftId);
+            if (oracleInfo.parentNftId != requesterInfo.parentNftId) {
+                revert ErrorOracleServiceProductMismatch(requesterInfo.objectType, requesterInfo.parentNftId, oracleInfo.parentNftId);
             }
         }
 

package/contracts/oracle/OracleServiceManager.sol

@@ -17,7 +17,7 @@ contract OracleServiceManager is ProxyManager {
     ) 
     {
         OracleService svc = new OracleService{salt: salt}();
-        bytes memory data = abi.encode(registry, authority);
+        bytes memory data = abi.encode(authority, registry);
         IVersionable versionable = initialize(
             registry,
             address(svc), 

package/contracts/pool/BasicPool.sol

@@ -21,7 +21,6 @@ abstract contract BasicPool is
         address registry,
         NftId productNftId,
         string memory name,
-        address token,
         IComponents.PoolInfo memory poolInfo,
         IAuthorization authorization,
         address initialOwner
@@ -34,7 +33,6 @@ abstract contract BasicPool is
             registry, 
             productNftId, 
             name, 
-            token, 
             poolInfo, 
             authorization,
             initialOwner, 

package/contracts/pool/BasicPoolAuthorization.sol

@@ -1,14 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Authorization} from "../authorization/Authorization.sol";
-import {BasicPool} from "./BasicPool.sol"; 
 import {IAccess} from "../authorization/IAccess.sol";
 import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IPoolComponent} from "./IPoolComponent.sol";
-import {POOL} from "../type/ObjectType.sol";
+
+import {Authorization} from "../authorization/Authorization.sol";
+import {BasicPool} from "./BasicPool.sol"; 
+import {COMPONENT, POOL} from "../type/ObjectType.sol";
 import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
 import {RoleId} from "../type/RoleId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 
 
 contract BasicPoolAuthorization
@@ -16,23 +18,30 @@ contract BasicPoolAuthorization
 {
 
      constructor(string memory poolName)
-          Authorization(poolName)
+          Authorization(poolName, POOL(), true, true)
      {}
 
      function _setupServiceTargets()
           internal
           virtual override
      {
+          _addServiceTargetWithRole(COMPONENT());
           _addServiceTargetWithRole(POOL());
      }
 
-     function _setupTargets()
-          internal
-          virtual override
-     {
-          _addComponentTargetWithRole(POOL()); // basic pool target
-     }
+     function _setupTokenHandlerAuthorizations() internal virtual override {
+          // authorize token handler functions for component service role
+          IAccess.FunctionInfo[] storage functions;
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(COMPONENT()));
+          _authorize(functions, TokenHandler.approve.selector, "approve");
+          _authorize(functions, TokenHandler.setWallet.selector, "setWallet");
+          _authorize(functions, TokenHandler.pushFeeToken.selector, "pushFeeToken");
 
+          // authorize token handler functions for pool service role
+          functions = _authorizeForTarget(getTokenHandlerName(), getServiceRole(POOL()));
+          _authorize(functions, TokenHandler.pullToken.selector, "pullToken");
+          _authorize(functions, TokenHandler.pushToken.selector, "pushToken");
+     }
 
      function _setupTargetAuthorizations()
           internal
@@ -41,7 +50,7 @@ contract BasicPoolAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
           _authorize(functions, BasicPool.stake.selector, "stake");
           _authorize(functions, BasicPool.unstake.selector, "unstake");
           _authorize(functions, BasicPool.extend.selector, "extend");
@@ -57,11 +66,10 @@ contract BasicPoolAuthorization
           _authorize(functions, BasicPool.extend.selector, "extend");
 
           _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
-
           _authorize(functions, BasicPool.withdrawBundleFees.selector, "withdrawBundleFees");
 
           // authorize pool service
-          functions = _authorizeForTarget(getTargetName(), getServiceRole(POOL()));
+          functions = _authorizeForTarget(getMainTargetName(), getServiceRole(POOL()));
           _authorize(functions, IPoolComponent.verifyApplication.selector, "verifyApplication");
      }
 }