@etherisc/gif-next 0.0.2-91b514c-961 → 0.0.2-9272c43-568

package/contracts/instance/InstanceService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 
+import {IAccess} from "../authorization/IAccess.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IInstance} from "./IInstance.sol";
@@ -56,35 +57,100 @@ contract InstanceService is
     }
 
 
-    modifier onlyInstanceOwner(NftId instanceNftId) {        
-        if(msg.sender != getRegistry().ownerOf(instanceNftId)) {
-            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
-        }
-        _;
+    /// @inheritdoc IInstanceService
+    function createRole(
+        string memory roleName, 
+        RoleId adminRoleId,
+        uint32 maxMemberCount
+    )
+        external
+        restricted()
+        onlyInstance()
+        returns (RoleId roleId)
+    {
+        IInstance instance = IInstance(msg.sender);
+        roleId = instance.getInstanceAdmin().createRole(
+            roleName, 
+            adminRoleId, 
+            maxMemberCount);
     }
 
 
-    // TODO check component - service - instance version match
-    modifier onlyComponent() {
-        if (! getRegistry().isRegisteredComponent(msg.sender)) {
-            revert ErrorInstanceServiceRequestUnauhorized(msg.sender);
-        }
-        _;
+    /// @inheritdoc IInstanceService
+    function setRoleActive(RoleId roleId, bool active)
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().setRoleActive(roleId, active);
     }
 
+
     /// @inheritdoc IInstanceService
-    function setInstanceLocked(bool locked)
+    function grantRole(RoleId roleId, address account)
         external
-        virtual
         restricted()
         onlyInstance()
     {
-        address instanceAddress = msg.sender;
-        IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().grantRole(roleId, account);
     }
 
 
-    /// @dev Locks/unlocks the specified target constrolled by the corresponding instance admin.
+    /// @inheritdoc IInstanceService
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        instance.getInstanceAdmin().revokeRole(roleId, account);
+    }
+
+
+    /// @inheritdoc IInstanceService
+    function createTarget(address target, string memory name)
+        external
+        restricted()
+        onlyInstance()
+        returns (RoleId contractRoleId)
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().createTarget(target, name);
+    }
+
+
+    /// @inheritdoc IInstanceService
+    function authorizeFunctions(
+        address target, 
+        RoleId roleId, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external 
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().authorizeFunctions(target, roleId, functions);
+    }
+
+
+    /// @inheritdoc IInstanceService
+    function unauthorizeFunctions(
+        address target, 
+        IAccess.FunctionInfo[] memory functions
+    )
+        external
+        restricted()
+        onlyInstance()
+    {
+        IInstance instance = IInstance(msg.sender);
+        return instance.getInstanceAdmin().unauthorizeFunctions(target, functions);
+    }
+
+
+    /// @inheritdoc IInstanceService
     function setTargetLocked(address target, bool locked)
         external
         virtual
@@ -95,6 +161,19 @@ contract InstanceService is
         IInstance(instanceAddress).getInstanceAdmin().setTargetLocked(target, locked);
     }
 
+
+    /// @inheritdoc IInstanceService
+    function setInstanceLocked(bool locked)
+        external
+        virtual
+        restricted()
+        onlyInstance()
+    {
+        address instanceAddress = msg.sender;
+        IInstance(instanceAddress).getInstanceAdmin().setInstanceLocked(locked);
+    }
+
+
     /// @inheritdoc IInstanceService
     function createInstance(bool allowAnyToken)
         external 
@@ -120,9 +199,9 @@ contract InstanceService is
         IAuthorization instanceAuthorization = InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization();
         instanceAdmin.completeSetup(
             address(getRegistry()),
-            address(instance),
             address(instanceAuthorization),
-            getRelease());
+            getRelease(),
+            address(instance));
 
         // hard checks for newly cloned instance
         assert(address(instance.getRegistry()) == address(getRegistry()));
@@ -200,7 +279,7 @@ contract InstanceService is
         returns (Amount newBalance)
     {
         NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
-        _stakingService.withdrawInstanceRewardReserves(
+        newBalance = _stakingService.withdrawInstanceRewardReserves(
             instanceNftId,
             dipAmount);
     }
@@ -274,6 +353,7 @@ contract InstanceService is
         masterInstanceNftId = info.nftId;
     }
 
+
     function upgradeMasterInstanceReader(address instanceReaderAddress)
         external
         onlyOwner
@@ -288,10 +368,14 @@ contract InstanceService is
         _masterInstanceReader = instanceReaderAddress;
     }
 
+    //--- view functions ------------------------------------------------------------//
+
     function getMasterInstanceReader() external view returns (address) {
         return _masterInstanceReader;
     }
 
+    //--- internal functions --------------------------------------------------------//
+
     /// @dev create new cloned instance admin
     /// function used to setup a new instance
     function _cloneNewInstanceAdmin()
@@ -342,36 +426,7 @@ contract InstanceService is
     }
 
 
-    /// all gif targets MUST be children of instanceNftId
-    function _createGifTarget(
-        NftId instanceNftId,
-        address targetAddress,
-        string memory targetName,
-        RoleId[] memory roles,
-        bytes4[][] memory selectors
-    )
-        internal
-        virtual
-    {
-        // TODO instanceAdmin will check target instance match anyway
-        (
-            IInstance instance, // or instanceInfo
-            // or targetInfo
-        ) = _validateInstanceAndComponent(instanceNftId, targetAddress);
-
-        InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
-
-        // TODO refactor/implement
-        // instanceAdmin.createGifTarget(targetAddress, targetName);
-
-        // set proposed target config
-        for(uint roleIdx = 0; roleIdx < roles.length; roleIdx++) {
-            // TODO refactor/implement
-            // instanceAdmin.setTargetFunctionRoleByService(targetName, selectors[roleIdx], roles[roleIdx]);
-        }
-    }
-    
-    /// @dev top level initializer
+    /// @dev top level initializer (upgradable contract)
     function _initialize(
         address owner, 
         bytes memory data
@@ -414,12 +469,9 @@ contract InstanceService is
             }
 
             componentNftId = componentInfo.nftId;
-        } else {
-
         }
 
-        instance = Instance(instanceInfo.objectAddress);
-        
+        instance = Instance(instanceInfo.objectAddress);        
     }
 
 

package/contracts/instance/base/BalanceStore.sol

@@ -24,13 +24,12 @@ contract BalanceStore {
     mapping(NftId nftId => Amount balance) private _balanceAmount;
     mapping(NftId nftId => Amount locked) private _lockedAmount;
     mapping(NftId nftId => Amount fees) private _feeAmount;
-    mapping(NftId nftId => bool isRegistered) private _isRegistered;
 
-    // TODO check if this is made redundant by *Info struct updates
+    // used to indicate if the target has been registered as well as when it was last updated (not used externally atm)    
     mapping(NftId nftId => Blocknumber lastUpdatedIn) private _lastUpdatedIn;
 
     modifier onlyRegisteredTarget(NftId targetNftId) {
-        if (!_isRegistered[targetNftId]) {
+        if (!_lastUpdatedIn[targetNftId].gtz()) {
             revert ErrorBalanceStoreTargetNotRegistered(targetNftId);
         }
         _;
@@ -55,11 +54,10 @@ contract BalanceStore {
     }
 
     function _registerBalanceTarget(NftId targetNftId) internal {
-        if (_isRegistered[targetNftId]) {
+        if (_lastUpdatedIn[targetNftId].gtz()) {
             revert ErrorBalanceStoreTargetAlreadyRegistered(targetNftId);
         }
 
-        _isRegistered[targetNftId] = true;
         _setLastUpdatedIn(targetNftId);
 
         emit LogBalanceStoreTargetRegistered(targetNftId);

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -14,10 +14,26 @@ contract BasicOracleAuthorization
      is Authorization
 {
 
-     constructor(string memory componentName)
-          Authorization(componentName, ORACLE(), true, false)
+     constructor(
+          string memory componentName,
+          string memory commitHash
+     )
+          Authorization(
+               componentName, 
+               ORACLE(), 
+               3, 
+               commitHash, 
+               true, 
+               false)
      {}
 
+     function _setupServiceTargets()
+          internal
+          virtual override
+     {
+          _authorizeServiceDomain(ORACLE(), address(15));
+     }
+
      function _setupTargetAuthorizations()
           internal
           virtual override

package/contracts/oracle/OracleService.sol

@@ -48,7 +48,7 @@ contract OracleService is
     )
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
         onlyNftOfType(oracleNftId, ORACLE())
         returns (RequestId requestId) 
     {
@@ -104,7 +104,7 @@ contract OracleService is
     )
         external
         virtual
-        // restricted() // add authz
+        restricted()
         returns (bool success)
     {
         (
@@ -153,7 +153,7 @@ contract OracleService is
     function resend(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
             IRegistry.ObjectInfo memory info, 
@@ -192,7 +192,7 @@ contract OracleService is
     function cancel(RequestId requestId)
         external 
         virtual 
-        // restricted() // add authz
+        restricted()
     {
         (
             IRegistry.ObjectInfo memory info, 

package/contracts/pool/BasicPoolAuthorization.sol

@@ -18,15 +18,21 @@ contract BasicPoolAuthorization
 {
 
      constructor(string memory poolName)
-          Authorization(poolName, POOL(), true, true)
+          Authorization(
+               poolName, 
+               POOL(), 
+               3,
+               COMMIT_HASH,
+               true, 
+               true)
      {}
 
      function _setupServiceTargets()
           internal
           virtual override
      {
-          _addServiceTargetWithRole(COMPONENT());
-          _addServiceTargetWithRole(POOL());
+          _authorizeServiceDomain(COMPONENT(), address(11));
+          _authorizeServiceDomain(POOL(), address(12));
      }
 
      function _setupTokenHandlerAuthorizations() internal virtual override {

package/contracts/pool/BundleService.sol

@@ -4,7 +4,6 @@ pragma solidity ^0.8.20;
 import {IAccountingService} from "../accounting/IAccountingService.sol";
 import {IBundle} from "../instance/module/IBundle.sol";
 import {IBundleService} from "./IBundleService.sol";
-import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
@@ -13,19 +12,19 @@ import {InstanceStore} from "../instance/InstanceStore.sol";
 
 import {Amount, AmountLib} from "../type/Amount.sol";
 import {BundleSet} from "../instance/BundleSet.sol";
-import {ComponentVerifyingService} from "../shared/ComponentVerifyingService.sol";
 import {Fee} from "../type/Fee.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
 import {ObjectType, ACCOUNTING, COMPONENT, POOL, BUNDLE, POLICY, REGISTRY} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
+import {PoolLib} from "./PoolLib.sol";
 import {Seconds} from "../type/Seconds.sol";
+import {Service} from "../shared/Service.sol";
+import {StateId, ACTIVE, PAUSED, CLOSED, KEEP_STATE} from "../type/StateId.sol";
 import {Timestamp, TimestampLib, zeroTimestamp} from "../type/Timestamp.sol";
 
-string constant BUNDLE_SERVICE_NAME = "BundleService";
 
 contract BundleService is 
-    ComponentVerifyingService, 
+    Service, 
     IBundleService 
 {
     
@@ -69,7 +68,7 @@ contract BundleService is
     {
         _checkNftType(bundleNftId, BUNDLE());
 
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
         InstanceReader instanceReader = instance.getInstanceReader();
         IBundle.BundleInfo memory bundleInfo = instanceReader.getBundleInfo(bundleNftId);
         if(bundleInfo.poolNftId.eqz()) {
@@ -96,7 +95,7 @@ contract BundleService is
         restricted()
         returns(NftId bundleNftId)
     {
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
         // register bundle with registry
         bundleNftId = _registryService.registerBundle(
@@ -190,7 +189,7 @@ contract BundleService is
         // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
         // udpate bundle state
         instance.getInstanceStore().updateBundleState(bundleNftId, PAUSED());
@@ -212,7 +211,7 @@ contract BundleService is
         // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        (,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
 
         // effects
         // udpate bundle state
@@ -344,7 +343,7 @@ contract BundleService is
         // checks
         _checkNftType(bundleNftId, BUNDLE());
 
-        (NftId poolNftId,, IInstance instance) = _getAndVerifyActiveComponent(POOL());
+        (NftId poolNftId, IInstance instance) = PoolLib.getAndVerifyActivePool(getRegistry(), msg.sender);
         IBundle.BundleInfo memory bundleInfo = instance.getInstanceReader().getBundleInfo(bundleNftId);
         StateId bundleState = instance.getInstanceReader().getBundleState(bundleNftId);
 

package/contracts/pool/PoolLib.sol

@@ -15,6 +15,8 @@ import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, BUNDLE, POOL} from "../type/ObjectType.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed} from "../type/UFixed.sol";
 
 library PoolLib {
@@ -105,7 +107,7 @@ library PoolLib {
         Amount payoutAmount,
         address payoutBeneficiary
     )
-        external
+        public
         view
         returns (
             Amount netPayoutAmount,
@@ -204,6 +206,50 @@ library PoolLib {
         instance = IInstance(instanceAddress);
     }
 
+
+    function getAndVerifyActiveComponent(
+        IRegistry registry,
+        address sender,
+        ObjectType expectedComponentType
+    )
+        public
+        view
+        returns (
+            NftId componentNftId,
+            IInstance instance
+        )
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+            address instanceAddress
+        ) = ContractLib.getAndVerifyComponent(
+            registry, 
+            sender,
+            expectedComponentType,
+            true); // only active components
+
+        componentNftId = info.nftId;
+        instance = IInstance(instanceAddress);
+    }
+
+
+    function getInstanceForComponent(
+        IRegistry registry,
+        NftId componentNftId
+    )
+        public
+        view
+        returns (
+            IInstance instance
+        )
+    {
+        NftId productNftId = registry.getParentNftId(componentNftId);
+        NftId instanceNftId = registry.getParentNftId(productNftId);
+        address instanceAddress = registry.getObjectAddress(instanceNftId);
+        return IInstance(instanceAddress);
+    }
+
+
     function checkNftType(
         IRegistry registry, 
         NftId nftId, 
@@ -213,4 +259,95 @@ library PoolLib {
             revert INftOwnable.ErrorNftOwnableInvalidType(nftId, expectedObjectType);
         }
     }
+
+    function transferTokenAndNotifyPolicyHolder(
+        IRegistry registry,
+        InstanceReader instanceReader,
+        TokenHandler poolTokenHandler,
+        NftId productNftId,
+        NftId policyNftId,
+        PayoutId payoutId,
+        Amount payoutAmount,
+        address payoutBeneficiary
+    )
+        external
+    {
+        (
+            Amount netPayoutAmount,
+            Amount processingFeeAmount,
+            address beneficiary
+        ) = calculatePayoutAmounts(
+            registry,
+            instanceReader,
+            productNftId, 
+            policyNftId,
+            payoutAmount,
+            payoutBeneficiary);
+
+        // 1st token tx to payout to beneficiary
+        poolTokenHandler.pushToken(
+            beneficiary, 
+            netPayoutAmount);
+
+        // 2nd token tx to transfer processing fees to product wallet
+        // if processingFeeAmount > 0
+        if (processingFeeAmount.gtz()) {
+            poolTokenHandler.pushToken(
+                instanceReader.getWallet(productNftId), 
+                processingFeeAmount);
+        }
+
+        // callback to policy holder if applicable
+        policyHolderPayoutExecuted(
+            registry,
+            policyNftId, 
+            payoutId, 
+            beneficiary, 
+            netPayoutAmount);
+    }
+
+    function policyHolderPayoutExecuted(
+        IRegistry registry,
+        NftId policyNftId, 
+        PayoutId payoutId,
+        address beneficiary,
+        Amount payoutAmount
+    )
+        private
+    {
+        IPolicyHolder policyHolder = getPolicyHolder(registry, policyNftId);
+        if(address(policyHolder) != address(0)) {
+            policyHolder.payoutExecuted(policyNftId, payoutId, payoutAmount, beneficiary);
+        }
+    }
+
+    /// @dev Transfers the specified amount from the "from account" to the pool's wallet
+    function pullStakingAmount(
+        InstanceReader reader,
+        NftId poolNftId,
+        address from,
+        Amount amount
+    )
+        external
+    {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.pullToken(
+            from,
+            amount);
+    }
+
+    /// @dev Transfers the specified amount from the pool's wallet to the "to account"
+    function pushUnstakingAmount(
+        InstanceReader reader,
+        NftId poolNftId,
+        address to,
+        Amount amount
+    )
+        external
+    {
+        IComponents.ComponentInfo memory info = reader.getComponentInfo(poolNftId);
+        info.tokenHandler.pushToken(
+            to, 
+            amount);
+    }
 }