@etherisc/gif-next 0.0.2-c4efd5e → 0.0.2-c630f3f-038

package/contracts/experiment/statemachine/README.md

@@ -0,0 +1,112 @@
+# State Machines
+
+Most GIF objects have a life cycle defined by a state machine.
+
+For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
+
+## Object Types without States
+
+* Protocol
+* Chains
+* Registries (both chain and main registry)
+
+## Object Types with States
+
+* Tokens
+* Instances
+* Products
+* Oracles
+* Pools
+* Bundles
+* Policies
+* Claim (non-NFT)
+* Payout (non-NFT)
+
+### Simple State Machine
+
+Valid states
+
+* Active (initial state)
+* Paused
+* Archived (final state)
+
+Valid state transitions:
+
+* Active -> Paused
+* Paused -> Active
+* Paused -> Archived
+
+
+Candidate object types for simple state machine
+
+* Token
+* Instance
+* Product
+* Oracle
+* Pool
+
+To discuss: 
+
+* Archived is final state
+* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
+* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
+
+### Bundle State Machine
+
+Valid states
+
+* Active (initial state)
+* Paused
+* Expired (implicit state)
+* Closed (final state)
+
+Expired is not an explicit state. 
+A bundle is expired for block.timestamp >= expiredAt
+
+### Policy State Machine
+
+Valid states
+
+* Applied (initial state)
+* Revoked (final state)
+* Declined (final state)
+* Active
+* Expired (implicit state)
+* Closed (final state)
+
+Expired is not an explicit state. 
+A policy is expired for block.timestamp >= expiredAt
+
+To discuss: 
+
+* Should 'Closed' be less explicit using a closedAt state variable? 
+* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
+
+Valid state transitions:
+
+* Applied -> Revoked
+* Applied -> Declined
+* Applied -> Active
+* Active -> Closed (needs to be expired)
+
+### Claim State Machine
+
+Valid states
+* Applied (initial state)
+* Confirmed
+* Declined (final state)
+* Closed (final state)
+
+Valid state transitions:
+* Applied -> Confirmed
+* Applied -> Declined
+* Confirmed -> Closed
+
+### Payout State Machine
+
+Valid states
+* Expected
+* PaidOut
+
+Valid state transitions:
+* Expected -> PaidOut

package/contracts/experiment/statemachine/SM.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+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;
+
+    StateId internal _state;
+
+    function setInitialState(StateId initialStateId) internal {
+        if (initialStateId == zeroStateId()) {
+            revert ErrorInitialStateUndefined();
+        }
+
+        _state = initialStateId;
+    }
+
+    function addTransition(
+        StateId currentStateId,
+        StateId nextStateId
+    ) internal {
+        if (currentStateId == zeroStateId()) {
+            revert ErrorStartStateUndefined();
+        }
+
+        if (nextStateId == zeroStateId()) {
+            revert ErrorNextStateUndefined();
+        }
+
+        _isValidTransition[currentStateId][nextStateId] = true;
+    }
+
+    function changeToState(StateId newStateId) external override {
+        if (!_isValidTransition[_state][newStateId]) {
+            revert ErrorStateChangeInvalid(_state, newStateId);
+        }
+
+        StateId stateOld = _state;
+        _state = newStateId;
+
+        emit LogStateChanged(stateOld, _state);
+    }
+
+    function isValidTransition(
+        StateId currentStateId,
+        StateId newStateId
+    ) external view override returns (bool isValid) {
+        return _isValidTransition[currentStateId][newStateId];
+    }
+
+    function getState() external view override returns (StateId state) {
+        return _state;
+    }
+}

package/contracts/experiment/statemachine/SimpleStateMachine.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+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;
+
+    constructor() {
+        addTransition(ACTIVE(), PAUSED());
+        addTransition(PAUSED(), ACTIVE());
+        addTransition(PAUSED(), ARCHIVED());
+
+        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);
+    }
+}

package/contracts/instance/IInstance.sol

@@ -3,16 +3,23 @@ pragma solidity ^0.8.19;
 
 import {IRegisterable} from "../registry/IRegistry.sol";
 import {IAccessModule} from "./access/IAccess.sol";
+import {ILifecycleModule} from "./lifecycle/ILifecycle.sol";
 import {IComponentModule} from "./component/IComponent.sol";
 import {IProductModule} from "./product/IProductService.sol";
 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,
+    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
     IComponentModule,
-    IProductModule
-{}
+    IProductModule,
+    ITreasuryModule
+{
+
+}

package/contracts/instance/Instance.sol

@@ -5,21 +5,26 @@ import {Registerable} from "../registry/Registry.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IAccessModule, AccessModule} from "./access/Access.sol";
+import {LifecycleModule} from "./lifecycle/LifecycleModule.sol";
 import {ComponentModule} from "./component/ComponentModule.sol";
 import {ProductModule} from "./product/ProductService.sol";
 import {PolicyModule} from "./policy/PolicyModule.sol";
 import {PoolModule} from "./pool/PoolModule.sol";
+import {TreasuryModule} from "./treasury/TreasuryModule.sol";
 
 import {IInstance} from "./IInstance.sol";
+import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
 import {NftId, toNftId} from "../types/NftId.sol";
 
 contract Instance is
     Registerable,
     AccessModule,
+    LifecycleModule,
     ComponentModule,
     PolicyModule,
     PoolModule,
     ProductModule,
+    TreasuryModule,
     IInstance
 {
     constructor(
@@ -33,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) {
@@ -45,7 +53,7 @@ contract Instance is
     }
 
     // from registerable
-    function getParentNftId() public view override returns (NftId) {
+    function getParentNftId() public pure override returns (NftId) {
         // TODO  add self registry and exchange 0 for_registry.getNftId();
         // define parent tree for all registerables
         // eg 0 <- chain(mainnet) <- global registry <- chain registry <- instance <- component <- policy/bundle
@@ -53,12 +61,12 @@ contract Instance is
     }
 
     // from registerable
-    function getType() external view override returns (uint256 objectType) {
-        return _registry.INSTANCE();
+    function getType() external pure override returns (ObjectType objectType) {
+        return INSTANCE();
     }
 
     // from registerable
-    function getData() external view override returns (bytes memory data) {
+    function getData() external pure override returns (bytes memory data) {
         return bytes(abi.encode(0));
     }
 }

package/contracts/instance/component/ComponentModule.sol

@@ -1,15 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {RegistryLinked} from "../../registry/Registry.sol";
 import {IRegistry, IRegistryLinked} from "../../registry/IRegistry.sol";
 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";
+import {IPoolComponent} from "../../components/IPool.sol";
 import {IPoolModule} from "../pool/IPoolModule.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
+import {ObjectType, PRODUCT, ORACLE, POOL} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED} from "../../types/StateId.sol";
+import {NftId, NftIdLib, zeroNftId} from "../../types/NftId.sol";
+import {Fee, zeroFee} from "../../types/Fee.sol";
 
 abstract contract ComponentModule is
     IRegistryLinked,
@@ -20,12 +29,15 @@ abstract contract ComponentModule is
     using NftIdLib for NftId;
 
     mapping(NftId nftId => ComponentInfo info) private _componentInfo;
-    mapping(NftId nftId => NftId poolNftId) private _poolNftIdForProduct;
     mapping(address cAddress => NftId nftId) private _nftIdByAddress;
     NftId[] private _nftIds;
 
-    mapping(uint256 cType => bytes32 role) private _componentOwnerRole;
+    mapping(ObjectType cType => bytes32 role) private _componentOwnerRole;
 
+    // TODO maybe move this to Instance contract as internal variable?
+    LifecycleModule private _lifecycleModule;
+    TreasuryModule private _treasuryModule;
+    IPoolModule private _poolModule;
     IComponentOwnerService private _componentOwnerService;
 
     modifier onlyComponentOwnerService() {
@@ -37,51 +49,73 @@ abstract contract ComponentModule is
     }
 
     constructor(address componentOwnerService) {
+        address componentAddress = address(this);
+        _lifecycleModule = LifecycleModule(componentAddress);
+        _treasuryModule = TreasuryModule(componentAddress);
+        _poolModule = IPoolModule(componentAddress);
         _componentOwnerService = ComponentOwnerService(componentOwnerService);
     }
 
     function registerComponent(
         IComponentContract component
     ) external override onlyComponentOwnerService returns (NftId nftId) {
-        bytes32 typeRole = getRoleForType(component.getType());
+        ObjectType objectType = component.getType();
+        bytes32 typeRole = getRoleForType(objectType);
         require(
             this.hasRole(typeRole, component.getInitialOwner()),
             "ERROR:CMP-004:TYPE_ROLE_MISSING"
         );
 
         nftId = this.getRegistry().register(address(component));
+        IERC20Metadata token = component.getToken();
+        address wallet = component.getWallet();
+
+        // create component info
+        _componentInfo[nftId] = ComponentInfo(
+            nftId,
+            _lifecycleModule.getInitialState(objectType),
+            token
+        );
 
-        _componentInfo[nftId] = ComponentInfo(nftId, CState.Active);
-
-        // special case product -> persist product - pool assignment
-        if (component.getType() == this.getRegistry().PRODUCT()) {
+        // component type specific registration actions
+        if (component.getType() == PRODUCT()) {
             IProductComponent product = IProductComponent(address(component));
             NftId poolNftId = product.getPoolNftId();
             require(poolNftId.gtz(), "ERROR:CMP-005:POOL_UNKNOWN");
-            // add more validation (type, token, ...)
+            // validate pool token and product token are same
 
-            _poolNftIdForProduct[nftId] = poolNftId;
+            // register with tresury
+            // implement and add validation
+            NftId distributorNftId = zeroNftId();
+            _treasuryModule.registerProduct(
+                nftId,
+                distributorNftId,
+                poolNftId,
+                token,
+                wallet,
+                product.getPolicyFee(),
+                product.getProcessingFee()
+            );
+        } else if (component.getType() == POOL()) {
+            IPoolComponent pool = IPoolComponent(address(component));
 
-            // add creation of productInfo
-        } else if (component.getType() == this.getRegistry().POOL()) {
-            IPoolModule poolModule = IPoolModule(address(this));
-            poolModule.createPoolInfo(
+            // register with pool
+            _poolModule.registerPool(nftId);
+
+            // register with tresury
+            _treasuryModule.registerPool(
                 nftId,
-                address(component), // set pool as its wallet
-                address(0) // don't deal with token yet
+                wallet,
+                pool.getStakingFee(),
+                pool.getPerformanceFee()
             );
         }
+        // TODO add distribution
 
         _nftIdByAddress[address(component)] = nftId;
         _nftIds.push(nftId);
 
-        // add logging
-    }
-
-    function getPoolNftId(
-        NftId productNftId
-    ) external view override returns (NftId poolNftId) {
-        poolNftId = _poolNftIdForProduct[productNftId];
+        // TODO add loggingx
     }
 
     function getComponentOwnerService()
@@ -102,9 +136,17 @@ abstract contract ComponentModule is
             "ERROR:CMP-006:COMPONENT_UNKNOWN"
         );
 
+        // TODO decide if state changes should have explicit functions and not
+        // 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
+        );
         _componentInfo[nftId] = info;
-
-        // add logging
     }
 
     function getComponentInfo(
@@ -113,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) {
@@ -138,14 +176,16 @@ abstract contract ComponentModule is
         return _nftIds.length;
     }
 
-    function getRoleForType(uint256 cType) public view returns (bytes32 role) {
-        if (cType == this.getRegistry().PRODUCT()) {
+    function getRoleForType(
+        ObjectType cType
+    ) public view returns (bytes32 role) {
+        if (cType == PRODUCT()) {
             return this.PRODUCT_OWNER_ROLE();
         }
-        if (cType == this.getRegistry().POOL()) {
+        if (cType == POOL()) {
             return this.POOL_OWNER_ROLE();
         }
-        if (cType == this.getRegistry().ORACLE()) {
+        if (cType == ORACLE()) {
             return this.ORACLE_OWNER_ROLE();
         }
     }
@@ -169,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
@@ -191,9 +236,9 @@ contract ComponentOwnerService is
             component.getNftId()
         );
         require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-        // TODO add state change validation
 
-        info.state = CState.Locked;
+        info.state = PAUSED();
+        // setComponentInfo checks for valid state changes
         instance.setComponentInfo(info);
     }
 
@@ -205,9 +250,25 @@ contract ComponentOwnerService is
             component.getNftId()
         );
         require(info.nftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-        // TODO state change validation
 
-        info.state = CState.Active;
+        info.state = ACTIVE();
+        // 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,22 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {IOwnable, IRegistryLinked, IRegisterable} from "../../registry/IRegistry.sol";
 import {IInstance} from "../IInstance.sol";
+import {StateId} from "../../types/StateId.sol";
 import {NftId} from "../../types/NftId.sol";
+import {Fee} from "../../types/Fee.sol";
+import {UFixed} from "../../types/UFixed.sol";
 
 interface IComponent {
-    // TODO decide if enum or uints with constants (as in IRegistry.PRODUCT())
-    enum CState {
-        Undefined,
-        Active,
-        Locked
-    }
-
     // component dynamic info (static info kept in registry)
     struct ComponentInfo {
         NftId nftId;
-        CState state;
+        StateId state;
+        IERC20Metadata token;
     }
 }
 
@@ -25,7 +24,11 @@ interface IInstanceLinked {
     function getInstance() external view returns (IInstance instance);
 }
 
-interface IComponentContract is IRegisterable, IInstanceLinked, IComponent {}
+interface IComponentContract is IRegisterable, IInstanceLinked, IComponent {
+    function getToken() external view returns (IERC20Metadata token);
+
+    function getWallet() external view returns (address walletAddress);
+}
 
 interface IComponentOwnerService is IRegistryLinked {
     function register(
@@ -35,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 {
@@ -50,20 +59,12 @@ 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);
 
     function getComponentId(uint256 idx) external view returns (NftId nftId);
 
-    function getPoolNftId(
-        NftId productNftId
-    ) external view returns (NftId poolNftId);
-
     function components() external view returns (uint256 numberOfCompnents);
 
     function getComponentOwnerService()

package/contracts/instance/lifecycle/ILifecycle.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "../../types/ObjectType.sol";
+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 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
+    );
+}
+
+interface ILifecycleModule is ILifecycle {
+    function getInitialState(
+        ObjectType objectType
+    ) external view returns (StateId);
+
+    function isValidTransition(
+        ObjectType objectType,
+        StateId fromId,
+        StateId toId
+    ) external view returns (bool);
+}