@etherisc/gif-next 0.0.2-836a512-798 → 0.0.2-839b2a2-792

package/contracts/components/Pool.sol

@@ -7,7 +7,6 @@ import {IPoolComponent} from "./IPool.sol";
 import {Component} from "./Component.sol";
 
 contract Pool is Component, IPoolComponent {
-
     Fee private _stakingFee;
     Fee private _performanceFee;
 
@@ -17,24 +16,32 @@ contract Pool is Component, IPoolComponent {
         address token,
         Fee memory stakingFee,
         Fee memory performanceFee
-    )
-        Component(registry, instance, token)
-    {
+    ) Component(registry, instance, token) {
         _stakingFee = stakingFee;
         _performanceFee = performanceFee;
     }
 
     // from pool component
-    function getStakingFee() external view override returns(Fee memory stakingFee) {
+    function getStakingFee()
+        external
+        view
+        override
+        returns (Fee memory stakingFee)
+    {
         return _stakingFee;
     }
 
-    function getPerformanceFee() external view override returns(Fee memory performanceFee) {
+    function getPerformanceFee()
+        external
+        view
+        override
+        returns (Fee memory performanceFee)
+    {
         return _performanceFee;
     }
 
     // from registerable
-    function getType() public pure override returns(ObjectType) {
+    function getType() public pure override returns (ObjectType) {
         return POOL();
     }
 

package/contracts/components/Product.sol

@@ -22,9 +22,7 @@ contract Product is Component, IProductComponent {
         address pool,
         Fee memory policyFee,
         Fee memory processingFee
-    )
-        Component(registry, instance, token)
-    {
+    ) Component(registry, instance, token) {
         // TODO add validation
         _productService = _instance.getProductService();
         _pool = pool;
@@ -61,16 +59,26 @@ contract Product is Component, IProductComponent {
     }
 
     // from product component
-    function getPolicyFee() external view override returns(Fee memory policyFee) {
+    function getPolicyFee()
+        external
+        view
+        override
+        returns (Fee memory policyFee)
+    {
         return _policyFee;
     }
 
-    function getProcessingFee() external view override returns(Fee memory processingFee) {
+    function getProcessingFee()
+        external
+        view
+        override
+        returns (Fee memory processingFee)
+    {
         return _processingFee;
     }
 
     // from registerable
-    function getType() public pure override returns(ObjectType) {
+    function getType() public pure override returns (ObjectType) {
         return PRODUCT();
     }
 

package/contracts/experiment/statemachine/Dummy.sol

@@ -4,30 +4,24 @@ pragma solidity ^0.8.19;
 import {ObjectType} from "../../types/ObjectType.sol";
 import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
 
-
 contract LifeCycleModule {
+    mapping(ObjectType objectType => StateId initialState)
+        private _initialState;
 
-    mapping(ObjectType objectType => StateId initialState) private _initialState;
-
-    mapping(ObjectType objectType => 
-        mapping(StateId stateFrom => 
-            mapping(StateId stateTo => bool isValid))) private _isValidTransition;
+    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
+        private _isValidTransition;
 
-
-    function getInitialState(ObjectType objectType)
-        external
-        view
-        returns(StateId)
-    {
+    function getInitialState(
+        ObjectType objectType
+    ) external view returns (StateId) {
         return _initialState[objectType];
     }
 
-
-    function isValidTransition(ObjectType objectType, StateId fromId, StateId toId)
-        external
-        view
-        returns(bool)
-    {
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) external view returns (bool) {
         return _isValidTransition[objectType][fromId][toId];
     }
 }

package/contracts/experiment/statemachine/ISM.sol

@@ -15,6 +15,11 @@ interface ISMEE {
 
 interface ISM is ISMEE {
     function changeToState(StateId newStateId) external;
-    function isValidTransition(StateId currentStateId, StateId newStateId) external view returns(bool isValid);
-    function getState() external view returns(StateId currentStateId);
+
+    function isValidTransition(
+        StateId currentStateId,
+        StateId newStateId
+    ) external view returns (bool isValid);
+
+    function getState() external view returns (StateId currentStateId);
 }

package/contracts/experiment/statemachine/SM.sol

@@ -5,36 +5,36 @@ import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
 import {ISM} from "./ISM.sol";
 
 contract SM is ISM {
-
-    mapping(StateId currentState => mapping(StateId newState => bool isValid)) private _isValidTransition;
+    mapping(StateId currentState => mapping(StateId newState => bool isValid))
+        private _isValidTransition;
 
     StateId internal _state;
 
-
     function setInitialState(StateId initialStateId) internal {
-        if(initialStateId == zeroStateId()) {
+        if (initialStateId == zeroStateId()) {
             revert ErrorInitialStateUndefined();
         }
 
         _state = initialStateId;
     }
 
-
-    function addTransition(StateId currentStateId, StateId nextStateId) internal {
-        if(currentStateId == zeroStateId()) {
+    function addTransition(
+        StateId currentStateId,
+        StateId nextStateId
+    ) internal {
+        if (currentStateId == zeroStateId()) {
             revert ErrorStartStateUndefined();
         }
 
-        if(nextStateId == zeroStateId()) {
+        if (nextStateId == zeroStateId()) {
             revert ErrorNextStateUndefined();
         }
 
         _isValidTransition[currentStateId][nextStateId] = true;
     }
 
-
     function changeToState(StateId newStateId) external override {
-        if(!_isValidTransition[_state][newStateId]) {
+        if (!_isValidTransition[_state][newStateId]) {
             revert ErrorStateChangeInvalid(_state, newStateId);
         }
 
@@ -44,11 +44,14 @@ contract SM is ISM {
         emit LogStateChanged(stateOld, _state);
     }
 
-    function isValidTransition(StateId currentStateId, StateId newStateId) external view override returns(bool isValid) {
+    function isValidTransition(
+        StateId currentStateId,
+        StateId newStateId
+    ) external view override returns (bool isValid) {
         return _isValidTransition[currentStateId][newStateId];
     }
 
-    function getState() external view override returns(StateId state) {
+    function getState() external view override returns (StateId state) {
         return _state;
     }
 }

package/contracts/experiment/statemachine/SimpleStateMachine.sol

@@ -5,7 +5,6 @@ import {StateId, toStateId} from "../../types/StateId.sol";
 import {SM} from "./SM.sol";
 
 contract SimpleStateMachine is SM {
-
     uint8 public constant STATE_ACTIVE = 10;
     uint8 public constant STATE_PAUSED = 20;
     uint8 public constant STATE_ARCHIVED = 30;
@@ -18,7 +17,15 @@ contract SimpleStateMachine is SM {
         setInitialState(ACTIVE());
     }
 
-    function ACTIVE() public pure returns(StateId stateId) { return toStateId(STATE_ACTIVE); }
-    function PAUSED() public pure returns(StateId stateId) { return toStateId(STATE_PAUSED); }
-    function ARCHIVED() public pure returns(StateId stateId) { return toStateId(STATE_ARCHIVED); }
+    function ACTIVE() public pure returns (StateId stateId) {
+        return toStateId(STATE_ACTIVE);
+    }
+
+    function PAUSED() public pure returns (StateId stateId) {
+        return toStateId(STATE_PAUSED);
+    }
+
+    function ARCHIVED() public pure returns (StateId stateId) {
+        return toStateId(STATE_ARCHIVED);
+    }
 }

package/contracts/instance/IInstance.sol

@@ -10,6 +10,7 @@ import {IPolicyModule} from "./policy/IPolicy.sol";
 import {IPoolModule} from "./pool/IPoolModule.sol";
 import {ITreasuryModule} from "./treasury/ITreasury.sol";
 
+// solhint-disable-next-line no-empty-blocks
 interface IInstance is
     IRegisterable,
     IAccessModule,
@@ -19,4 +20,6 @@ interface IInstance is
     IComponentModule,
     IProductModule,
     ITreasuryModule
-{}
+{
+
+}

package/contracts/instance/Instance.sol

@@ -19,9 +19,9 @@ import {NftId, toNftId} from "../types/NftId.sol";
 contract Instance is
     Registerable,
     AccessModule,
-    LifecycleModule, 
-    ComponentModule, 
-    PolicyModule, 
+    LifecycleModule,
+    ComponentModule,
+    PolicyModule,
     PoolModule,
     ProductModule,
     TreasuryModule,
@@ -38,7 +38,10 @@ contract Instance is
         PolicyModule(productService)
         ProductModule(productService)
         PoolModule(productService)
-    {}
+    // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
 
     // from registerable
     function register() external override returns (NftId nftId) {
@@ -58,7 +61,7 @@ contract Instance is
     }
 
     // from registerable
-    function getType() external pure override returns(ObjectType objectType) {
+    function getType() external pure override returns (ObjectType objectType) {
         return INSTANCE();
     }
 

package/contracts/instance/component/ComponentModule.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {RegistryLinked} from "../../registry/Registry.sol";
 import {IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
@@ -9,6 +9,7 @@ import {IAccessComponentTypeRoles, IAccessCheckRole} from "../access/IAccess.sol
 import {IInstance} from "../IInstance.sol";
 
 import {LifecycleModule} from "../lifecycle/LifecycleModule.sol";
+import {ITreasuryModule} from "../treasury/ITreasury.sol";
 import {TreasuryModule} from "../treasury/TreasuryModule.sol";
 import {IComponent, IComponentContract, IComponentModule, IComponentOwnerService} from "./IComponent.sol";
 import {IProductComponent} from "../../components/IProduct.sol";
@@ -55,12 +56,9 @@ abstract contract ComponentModule is
         _componentOwnerService = ComponentOwnerService(componentOwnerService);
     }
 
-    function registerComponent(IComponentContract component)
-        external
-        override
-        onlyComponentOwnerService
-        returns(NftId nftId)
-    {
+    function registerComponent(
+        IComponentContract component
+    ) external override onlyComponentOwnerService returns (NftId nftId) {
         ObjectType objectType = component.getType();
         bytes32 typeRole = getRoleForType(objectType);
         require(
@@ -69,17 +67,18 @@ abstract contract ComponentModule is
         );
 
         nftId = this.getRegistry().register(address(component));
-        IERC20 token = component.getToken();
+        IERC20Metadata token = component.getToken();
         address wallet = component.getWallet();
 
         // create component info
         _componentInfo[nftId] = ComponentInfo(
             nftId,
             _lifecycleModule.getInitialState(objectType),
-            token);
+            token
+        );
 
         // component type specific registration actions
-        if(component.getType() == PRODUCT()) {
+        if (component.getType() == PRODUCT()) {
             IProductComponent product = IProductComponent(address(component));
             NftId poolNftId = product.getPoolNftId();
             require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
@@ -89,15 +88,15 @@ abstract contract ComponentModule is
             // implement and add validation
             NftId distributorNftId = zeroNftId();
             _treasuryModule.registerProduct(
-                nftId, 
-                distributorNftId, 
-                poolNftId, 
-                token, 
-                wallet, 
+                nftId,
+                distributorNftId,
+                poolNftId,
+                token,
+                wallet,
                 product.getPolicyFee(),
-                product.getProcessingFee()); 
-        }
-        else if(component.getType() == POOL()) {
+                product.getProcessingFee()
+            );
+        } else if (component.getType() == POOL()) {
             IPoolComponent pool = IPoolComponent(address(component));
 
             // register with pool
@@ -105,10 +104,11 @@ abstract contract ComponentModule is
 
             // register with tresury
             _treasuryModule.registerPool(
-                nftId, 
-                wallet, 
+                nftId,
+                wallet,
                 pool.getStakingFee(),
-                pool.getPerformanceFee()); 
+                pool.getPerformanceFee()
+            );
         }
         // TODO add distribution
 
@@ -140,7 +140,12 @@ abstract contract ComponentModule is
         // just a generic setXYZInfo and implicit state transitions
         // when in doubt go for the explicit approach ...
         ObjectType objectType = this.getRegistry().getInfo(nftId).objectType;
-        _lifecycleModule.checkAndLogTransition(nftId, objectType, _componentInfo[nftId].state, info.state);
+        _lifecycleModule.checkAndLogTransition(
+            nftId,
+            objectType,
+            _componentInfo[nftId].state,
+            info.state
+        );
         _componentInfo[nftId] = info;
     }
 
@@ -150,10 +155,6 @@ abstract contract ComponentModule is
         return _componentInfo[nftId];
     }
 
-    function getComponentOwner(
-        NftId nftId
-    ) external view returns (address owner) {}
-
     function getComponentId(
         address componentAddress
     ) external view returns (NftId componentNftId) {
@@ -175,18 +176,16 @@ abstract contract ComponentModule is
         return _nftIds.length;
     }
 
-    function getRoleForType(ObjectType cType)
-        public
-        view
-        returns(bytes32 role)
-    {
-        if(cType == PRODUCT()) {
+    function getRoleForType(
+        ObjectType cType
+    ) public view returns (bytes32 role) {
+        if (cType == PRODUCT()) {
             return this.PRODUCT_OWNER_ROLE();
         }
-        if(cType == POOL()) {
+        if (cType == POOL()) {
             return this.POOL_OWNER_ROLE();
         }
-        if(cType == ORACLE()) {
+        if (cType == ORACLE()) {
             return this.ORACLE_OWNER_ROLE();
         }
     }
@@ -210,7 +209,12 @@ contract ComponentOwnerService is
         _;
     }
 
-    constructor(address registry) RegistryLinked(registry) {}
+    constructor(
+        address registry
+    ) RegistryLinked(registry) // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
 
     function register(
         IComponentContract component
@@ -251,4 +255,20 @@ contract ComponentOwnerService is
         // setComponentInfo checks for valid state changes
         instance.setComponentInfo(info);
     }
+
+    function setProductFees(
+        IComponentContract product,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external override onlyComponentOwner(product) {
+        require(product.getType() == PRODUCT(), "ERROR_NOT_PRODUCT");
+
+        address instanceAddress = address(product.getInstance());
+        ITreasuryModule treasuryModule = ITreasuryModule(instanceAddress);
+        treasuryModule.setProductFees(
+            product.getNftId(),
+            policyFee,
+            processingFee
+        );
+    }
 }

package/contracts/instance/component/IComponent.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
 import {IInstance} from "../IInstance.sol";
@@ -11,12 +11,11 @@ import {Fee} from "../../types/Fee.sol";
 import {UFixed} from "../../types/UFixed.sol";
 
 interface IComponent {
-
     // component dynamic info (static info kept in registry)
     struct ComponentInfo {
         NftId nftId;
         StateId state;
-        IERC20 token;
+        IERC20Metadata token;
     }
 }
 
@@ -25,13 +24,10 @@ interface IInstanceLinked {
     function getInstance() external view returns (IInstance instance);
 }
 
-interface IComponentContract is
-    IRegisterable,
-    IInstanceLinked,
-    IComponent
-{
-    function getToken() external view returns(IERC20 token);
-    function getWallet() external view returns(address walletAddress);
+interface IComponentContract is IRegisterable, IInstanceLinked, IComponent {
+    function getToken() external view returns (IERC20Metadata token);
+
+    function getWallet() external view returns (address walletAddress);
 }
 
 interface IComponentOwnerService is IRegistryLinked {
@@ -42,6 +38,12 @@ interface IComponentOwnerService is IRegistryLinked {
     function lock(IComponentContract component) external;
 
     function unlock(IComponentContract component) external;
+
+    function setProductFees(
+        IComponentContract product,
+        Fee memory policyFee,
+        Fee memory processingFee
+    ) external;
 }
 
 interface IComponentModule is IOwnable, IRegistryLinked, IComponent {
@@ -57,10 +59,6 @@ interface IComponentModule is IOwnable, IRegistryLinked, IComponent {
         NftId nftId
     ) external view returns (ComponentInfo memory info);
 
-    function getComponentOwner(
-        NftId nftId
-    ) external view returns (address owner);
-
     function getComponentId(
         address componentAddress
     ) external view returns (NftId nftId);

package/contracts/instance/lifecycle/ILifecycle.sol

@@ -6,27 +6,42 @@ import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
 import {NftId} from "../../types/NftId.sol";
 
 interface ILifecycle {
-
-    event LogComponentStateChanged(NftId nftId, ObjectType objectType, StateId fromStateId, StateId toStateId);
-    event LogBundleStateChanged(NftId nftId, StateId fromStateId, StateId toStateId);
-    event LogPolicyStateChanged(NftId nftId, StateId fromStateId, StateId toStateId);
+    event LogComponentStateChanged(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromStateId,
+        StateId toStateId
+    );
+    event LogBundleStateChanged(
+        NftId nftId,
+        StateId fromStateId,
+        StateId toStateId
+    );
+    event LogPolicyStateChanged(
+        NftId nftId,
+        StateId fromStateId,
+        StateId toStateId
+    );
     // event LogClaimStateChanged(NftId nftId, ClaimId claimId, StateId fromStateId, StateId toStateId);
     // event LogPayoutStateChanged(NftId nftId, ClaimId claimId, PayoutId payoutId, StateId fromStateId, StateId toStateId);
 
     error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
-    error ErrorInvalidStateTransition(NftId nftId, ObjectType objectType, StateId fromStateId, StateId toStateId);
+    error ErrorInvalidStateTransition(
+        NftId nftId,
+        ObjectType objectType,
+        StateId fromStateId,
+        StateId toStateId
+    );
 }
 
 interface ILifecycleModule is ILifecycle {
-
-    function getInitialState(ObjectType objectType)
-        external
-        view
-        returns(StateId);
-
-
-    function isValidTransition(ObjectType objectType, StateId fromId, StateId toId)
-        external
-        view
-        returns(bool);
-}
+    function getInitialState(
+        ObjectType objectType
+    ) external view returns (StateId);
+
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) external view returns (bool);
+}