@etherisc/gif-next 0.0.2-bb3faee-097 → 0.0.2-bb9ecaf-723

package/contracts/authorization/ServiceAuthorization.sol

@@ -4,7 +4,8 @@ pragma solidity ^0.8.20;
 import {IAccess} from "../authorization/IAccess.sol";
 import {IServiceAuthorization} from "./IServiceAuthorization.sol";
 
-import {ADMIN_ROLE_NAME, PUBLIC_ROLE_NAME} from "./AccessAdmin.sol";
+import {AccessAdminLib} from "./AccessAdminLib.sol";
+import {BlocknumberLib} from "../type/Blocknumber.sol";
 import {InitializableERC165} from "../shared/InitializableERC165.sol";
 import {ObjectType, ObjectTypeLib, ALL} from "../type/ObjectType.sol";
 import {RoleId, RoleIdLib, ADMIN_ROLE, PUBLIC_ROLE} from "../type/RoleId.sol";
@@ -87,8 +88,8 @@ contract ServiceAuthorization is
           _commitHash = commitHash;
 
           // setup of roles defined in OpenZeppelin AccessManager
-          _addRole(ADMIN_ROLE(), _toRoleInfo(ADMIN_ROLE(), RoleType.Core, 1, ADMIN_ROLE_NAME()));
-          _addRole(PUBLIC_ROLE(), _toRoleInfo(ADMIN_ROLE(), RoleType.Core, 1, PUBLIC_ROLE_NAME()));
+          _addRole(ADMIN_ROLE(), AccessAdminLib.adminRoleInfo());
+          _addRole(PUBLIC_ROLE(), AccessAdminLib.publicRoleInfo());
 
           // defines service domains relevant for the authorization
           _setupDomains();
@@ -163,7 +164,7 @@ contract ServiceAuthorization is
 
      /// @inheritdoc IServiceAuthorization
      function roleExists(RoleId roleId) public view returns(bool exists) {
-          return _roleInfo[roleId].roleType != RoleType.Undefined;
+          return _roleInfo[roleId].targetType != TargetType.Undefined;
      }
 
      /// @inheritdoc IServiceAuthorization
@@ -238,7 +239,9 @@ contract ServiceAuthorization is
           if (roleId != RoleIdLib.zero()) {
                // add role if new
                if (!roleExists(roleId)) {
-                    _addContractRole(roleId, roleName);
+                    _addRole(
+                         roleId, 
+                         AccessAdminLib.serviceRoleInfo(roleName));
                }
 
                // link target to role
@@ -247,18 +250,6 @@ contract ServiceAuthorization is
      }
 
 
-     /// @dev Add a contract role for the provided role id and name.
-     function _addContractRole(RoleId roleId, string memory name) internal {
-          _addRole(
-               roleId,
-               _toRoleInfo(
-                    ADMIN_ROLE(),
-                    RoleType.Contract,
-                    1,
-                    name));
-     }
-
-
      /// @dev Use this method to to add an authorized role.
      function _addRole(RoleId roleId, RoleInfo memory info) internal {
           _roles.push(roleId);
@@ -266,18 +257,6 @@ contract ServiceAuthorization is
      }
 
 
-     /// @dev creates a role info object from the provided parameters
-     function _toRoleInfo(RoleId adminRoleId, RoleType roleType, uint32 maxMemberCount, string memory name) internal view returns (RoleInfo memory info) {
-          return RoleInfo({
-               name: StrLib.toStr(name),
-               adminRoleId: adminRoleId,
-               roleType: roleType,
-               maxMemberCount: maxMemberCount,
-               createdAt: TimestampLib.current(),
-               pausedAt: TimestampLib.max()});
-     }
-
-
      /// @dev Use this method to authorize the specified domain to access the service domain.
      function _authorizeForService(
           ObjectType serviceDomain, 
@@ -315,6 +294,7 @@ contract ServiceAuthorization is
                IAccess.FunctionInfo({
                     selector: SelectorLib.toSelector(selector),
                     name: StrLib.toStr(name),
-                    createdAt: TimestampLib.current()}));
+                    createdAt: TimestampLib.current(),
+                    lastUpdateIn: BlocknumberLib.current()}));
      }
 }

package/contracts/distribution/BasicDistribution.sol

@@ -135,7 +135,6 @@ contract BasicDistribution is
             authorization,
             false,
             initialOwner, 
-            name, 
-            ""); // component specifc data
+            name); 
     }
 }

package/contracts/distribution/BasicDistributionAuthorization.sol

@@ -22,7 +22,7 @@ contract BasicDistributionAuthorization
                DISTRIBUTION(), 
                3,
                COMMIT_HASH,
-               true, 
+               TargetType.Component, 
                true)
      {}
 

package/contracts/distribution/Distribution.sol

@@ -109,8 +109,7 @@ abstract contract Distribution is
         IAuthorization authorization, 
         bool isInterceptor,
         address initialOwner,
-        string memory name,
-        bytes memory componentData // component specifidc data 
+        string memory name
     )
         internal
         virtual
@@ -123,8 +122,7 @@ abstract contract Distribution is
             DISTRIBUTION(), 
             authorization,
             isInterceptor,
-            initialOwner, 
-            componentData);
+            initialOwner);
 
         DistributionStorage storage $ = _getDistributionStorage();
         $._distributionService = IDistributionService(_getServiceAddress(DISTRIBUTION())); 

package/contracts/instance/BaseStore.sol

@@ -0,0 +1,93 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IBaseStore} from "./IBaseStore.sol";
+
+import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
+import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {StateId, KEEP_STATE} from "../type/StateId.sol";
+import {Lifecycle} from "../shared/Lifecycle.sol";
+
+abstract contract BaseStore is
+    Lifecycle, 
+    IBaseStore
+{
+
+    mapping(Key32 key32 => IBaseStore.Metadata metadata) private _metadata;
+
+    function _createMetadata(
+        Key32 key32
+    )
+        internal
+    {
+        ObjectType objectType = key32.toObjectType();
+        if (objectType.eqz()) {
+            revert ErrorBaseStoreTypeUndefined(objectType);
+        }
+
+        Metadata storage metadata = _metadata[key32];
+        if (metadata.updatedIn.gtz()) {
+            revert ErrorBaseStoreAlreadyCreated(key32, objectType);
+        }
+
+        if(!hasLifecycle(objectType)) {
+            revert ErrorBaseStoreNoLifecycle(objectType);
+        }
+
+        Blocknumber blocknumber = BlocknumberLib.current();
+        StateId initialState = getInitialState(objectType);
+
+        // set metadata
+        metadata.objectType = objectType;
+        metadata.state = initialState;
+        metadata.updatedIn = blocknumber;
+    }
+
+    function _updateState(
+        Key32 key32, 
+        StateId state
+    )
+        internal
+        returns (Blocknumber lastUpdatedIn, StateId oldState)
+    {
+        if (state.eqz()) {
+            revert ErrorBaseStoreStateZero(key32);
+        }
+
+        Metadata storage metadata = _metadata[key32];
+        oldState = metadata.state;
+        lastUpdatedIn = metadata.updatedIn;
+
+        if (oldState.eqz()) {
+            revert ErrorBaseStoreNotExisting(key32);
+        }
+
+        // update state 
+        if(state != KEEP_STATE()) {
+            checkTransition(oldState, metadata.objectType, oldState, state);
+            metadata.state = state;
+
+            // solhint-disable-next-line avoid-tx-origin
+        }
+
+        // update metadata
+        metadata.updatedIn = BlocknumberLib.current();
+    }
+
+    function exists(Key32 key32) public view returns (bool) {
+        return _metadata[key32].state.gtz();
+    }
+
+    function getMetadata(Key32 key32) public view returns (Metadata memory metadata) {
+        return _metadata[key32];
+    }
+
+    function getState(Key32 key32) public view returns (StateId state) {
+        return _metadata[key32].state;
+    }
+
+    function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
+        return Key32Lib.toKey32(objectType, id);
+    }
+}

package/contracts/instance/IBaseStore.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ILifecycle} from "../shared/ILifecycle.sol";
+
+import {Blocknumber} from "../type/Blocknumber.sol";
+import {Key32, KeyId} from "../type/Key32.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {StateId} from "../type/StateId.sol";
+
+
+interface IBaseStore is ILifecycle {
+
+    error ErrorBaseStoreTypeUndefined(ObjectType objectType);
+    error ErrorBaseStoreAlreadyCreated(Key32 key, ObjectType objectType);
+    error ErrorBaseStoreNoLifecycle(ObjectType objectType);
+    error ErrorBaseStoreStateZero(Key32 key);
+    error ErrorBaseStoreNotExisting(Key32 key);
+
+
+    struct Metadata {
+        // slot 0
+        ObjectType objectType;
+        StateId state;
+        Blocknumber updatedIn;
+    }
+
+    /// @dev check if a metadata entry with the key exists
+    function exists(Key32 key) external view returns (bool);
+    /// @dev retrieve the metadata for a given key
+    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
+    /// @dev retrieve the state for a given key
+    function getState(Key32 key) external view returns (StateId state);
+
+    /// @dev convert an object type and an id to a key32
+    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
+}

package/contracts/instance/IInstance.sol

@@ -11,6 +11,7 @@ import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
+import {ProductStore} from "./ProductStore.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
 import {UFixed} from "../type/UFixed.sol";
@@ -51,6 +52,15 @@ interface IInstance is
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
     error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
 
+    struct InstanceContracts {
+        InstanceAdmin instanceAdmin;
+        InstanceStore instanceStore;
+        ProductStore productStore;
+        BundleSet bundleSet;
+        RiskSet riskSet;
+        InstanceReader instanceReader;
+    }
+
     struct InstanceInfo {
         uint64 requestsCount;
     }
@@ -141,5 +151,6 @@ interface IInstance is
     function getRiskSet() external view returns (RiskSet);
     function getInstanceAdmin() external view returns (InstanceAdmin);
     function getInstanceStore() external view returns (InstanceStore);
+    function getProductStore() external view returns (ProductStore);
     function isTokenRegistryDisabled() external view returns (bool);
 }

package/contracts/instance/IInstanceService.sol

@@ -39,6 +39,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceBundleSetZero();
     error ErrorInstanceServiceRiskSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
+    error ErrorInstanceServiceProductStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
     error ErrorInstanceServiceBundleSetAuthorityMismatch();
@@ -47,6 +48,7 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceBundleSetInstanceMismatch();
     error ErrorInstanceServiceRiskSetInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
+    error ErrorInstanceServiceProductStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
     error ErrorInstanceServiceNotInstanceNftId(NftId nftId);

package/contracts/instance/Instance.sol

@@ -15,6 +15,7 @@ import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 import {NftId} from "../type/NftId.sol";
+import {ProductStore} from "./ProductStore.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RoleId} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
@@ -35,6 +36,7 @@ contract Instance is
     BundleSet internal _bundleSet;
     RiskSet internal _riskSet;
     InstanceStore internal _instanceStore;
+    ProductStore internal _productStore;
     NftId [] internal _products;
     bool internal _tokenRegistryDisabled;
 
@@ -56,11 +58,7 @@ contract Instance is
 
 
     function initialize(
-        InstanceAdmin instanceAdmin, 
-        InstanceStore instanceStore,
-        BundleSet bundleSet,
-        RiskSet riskSet,
-        InstanceReader instanceReader,
+        InstanceContracts memory instanceContracts,
         IRegistry registry, 
         VersionPart release,
         address initialOwner,
@@ -69,15 +67,15 @@ contract Instance is
         external 
         initializer()
     {
-        if(address(instanceAdmin) == address(0)) {
+        if(address(instanceContracts.instanceAdmin) == address(0)) {
             revert ErrorInstanceInstanceAdminZero();
         }
 
-        _instanceAdmin = instanceAdmin;
+        _instanceAdmin = instanceContracts.instanceAdmin;
 
         // setup instance object info
         __Registerable_init({
-            authority: instanceAdmin.authority(),
+            authority: instanceContracts.instanceAdmin.authority(),
             registry: address(registry), 
             parentNftId: registry.getNftId(), 
             objectType: INSTANCE(), 
@@ -86,15 +84,17 @@ contract Instance is
             data: ""});
 
         // store instance supporting contracts
-        _instanceStore = instanceStore;
-        _bundleSet = bundleSet;
-        _riskSet = riskSet;
-        _instanceReader = instanceReader;
+        _instanceStore = instanceContracts.instanceStore;
+        _productStore = instanceContracts.productStore;
+        _bundleSet = instanceContracts.bundleSet;
+        _riskSet = instanceContracts.riskSet;
+        _instanceReader = instanceContracts.instanceReader;
 
         // initialize instance supporting contracts
         _instanceStore.initialize();
-        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
-        _riskSet.initialize(instanceAdmin.authority(), address(registry));
+        _productStore.initialize();
+        _bundleSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceContracts.instanceAdmin.authority(), address(registry));
         _instanceReader.initialize();
 
         _componentService = IComponentService(
@@ -341,6 +341,10 @@ contract Instance is
         return _instanceStore;
     }
 
+    function getProductStore() external view returns (ProductStore) {
+        return _productStore;
+    }
+
     function isTokenRegistryDisabled() external view returns (bool) {
         return _tokenRegistryDisabled;
     }