@etherisc/gif-next 0.0.2-eb1b869-461 → 0.0.2-eb4b6ab-521

package/contracts/instance/BundleSet.sol

@@ -0,0 +1,130 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {LibNftIdSet} from "../type/NftIdSet.sol";
+import {NftId, NftIdLib} from "../type/NftId.sol";
+import {Key32} from "../type/Key32.sol";
+import {BUNDLE} from "../type/ObjectType.sol";
+
+import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+
+contract BundleSet is 
+    ObjectSet
+{
+    using LibNftIdSet for LibNftIdSet.Set;
+
+    event LogBundleSetPolicyLinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleSetPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
+
+    event LogBundleSetBundleAdded(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleUnlocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleLocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleClosed(NftId poolNftId, NftId bundleNftId);
+
+    error ErrorBundleSetPolicyAlreadyActivated(NftId policyNftId);
+    error ErrorBundleSetBundleLocked(NftId bundleNftId, NftId policyNftId);
+    error ErrorBundleSetPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
+    error ErrorBundleSetPolicyNotCloseable(NftId policyNftId);
+    error ErrorBundleSetBundleUnknown(NftId bundleNftId);
+    error ErrorBundleSetBundleNotRegistered(NftId bundleNftId);
+
+    mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
+
+    /// @dev links a policy to its bundle
+    function linkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
+
+        // ensure bundle is unlocked (in active set) and registered with this instance
+        if (!_isActive(poolNftId, _toBundleKey32(bundleNftId))) {
+            revert ErrorBundleSetBundleLocked(bundleNftId, policyNftId);
+        }
+
+        _activePolicies[bundleNftId].add(policyNftId);
+        emit LogBundleSetPolicyLinked(bundleNftId, policyNftId);
+    }
+
+
+    /// @dev unlinks a policy from its bundle
+    function unlinkPolicy(NftId poolNftId, NftId bundleNftId, NftId policyNftId) external restricted() {
+
+        // ensure bundle is registered with this instance
+        if (!_contains(poolNftId, _toBundleKey32(bundleNftId))) {
+            revert ErrorBundleSetBundleUnknown(bundleNftId);
+        }
+
+        _activePolicies[bundleNftId].remove(policyNftId);
+        emit LogBundleSetPolicyUnlinked(bundleNftId, policyNftId);
+    }
+
+
+    /// @dev add a new bundle to a pool registerd with this instance
+    // the corresponding pool is fetched via instance reader
+    function add(NftId bundleNftId) external restricted() {
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
+
+        // ensure pool is registered with instance
+        if(poolNftId.eqz()) {
+            revert ErrorBundleSetBundleNotRegistered(bundleNftId);
+        }
+
+        _add(poolNftId, _toBundleKey32(bundleNftId));
+        emit LogBundleSetBundleAdded(poolNftId, bundleNftId);
+    }
+
+
+    /// @dev unlocked (active) bundles are available to collateralize new policies
+    function unlock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
+        _activate(poolNftId, _toBundleKey32(bundleNftId));
+        emit LogBundleSetBundleUnlocked(poolNftId, bundleNftId);
+    }
+
+    /// @dev locked (deactivated) bundles may not collateralize any new policies
+    function lock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = ObjectSetHelperLib.getPoolNftId(_instanceAddress, bundleNftId);
+        _deactivate(poolNftId, _toBundleKey32(bundleNftId));
+        emit LogBundleSetBundleLocked(poolNftId, bundleNftId);
+    }
+
+
+    function checkBundle(NftId productNftId, NftId bundleId)
+        public
+        view 
+        returns (bool exists, bool active)
+    {
+        Key32 bundleKey32 = bundleId.toKey32(BUNDLE());
+        exists = _contains(productNftId, bundleKey32);
+
+        if (exists) {
+            active = _isActive(productNftId, bundleKey32);
+        }
+    }
+
+    function bundles(NftId poolNftId) external view returns(uint256) {
+        return _objects(poolNftId);
+    }
+
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getObject(poolNftId, idx).toKeyId());
+    }
+
+    function activeBundles(NftId poolNftId) external view returns(uint256) {
+        return _activeObjs(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId) {
+        return NftIdLib.toNftId(_getActiveObject(poolNftId, idx).toKeyId());
+    }
+
+    function activePolicies(NftId bundleNftId) external view returns(uint256) {
+        return _activePolicies[bundleNftId].size();
+    }
+
+    function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
+        return _activePolicies[bundleNftId].getElementAt(idx);
+    }
+
+    function _toBundleKey32(NftId nftId) private pure returns (Key32) {
+        return nftId.toKey32(BUNDLE());
+    }
+}

package/contracts/instance/IInstance.sol

@@ -1,25 +1,66 @@
 // SPDX-License-Identifier: Apache-2.0
-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,
-    ITreasuryModule
+pragma solidity ^0.8.20;
+
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {NftId} from "../type/NftId.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+
+
+interface IInstance is 
+    IRegisterable
 {
+    error ErrorInstanceInstanceAdminZero();
+    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
+    error ErrorInstanceBundleSetInstanceMismatch(address instance);
+    error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceRiskSetAlreadySet(address instanceRiskSet);
+    error ErrorInstanceRiskSetInstanceMismatch(address instance);
+    error ErrorInstanceRiskSetAuthorityMismatch(address instanceAuthority);
+
+    error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
+
+    error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
+    error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
+
+    struct InstanceInfo {
+        uint64 requestsCount;
+    }
+
+    /// @dev Register a product with the instance.
+    function registerProduct(address product) external returns (NftId productNftId);
+
+    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
+    function grantRole(RoleId roleId, address account) external;
+    function revokeRole(RoleId roleId, address account) external;
+
+    function createTarget(address target, string memory name) external;
+    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+    function setLocked(address target, bool locked) external;
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(Amount dipAmount) external;
+
+    /// @dev Defunds the staking reward reserves for the specified target.
+    /// Permissioned: only the target owner may call this function.
+    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
 
-}
+    // get instance release and supporting contracts
+    function getInstanceReader() external view returns (InstanceReader);
+    function getBundleSet() external view returns (BundleSet);
+    function getRiskSet() external view returns (RiskSet);
+    function getInstanceAdmin() external view returns (InstanceAdmin);
+    function getInstanceStore() external view returns (InstanceStore);
+}

package/contracts/instance/IInstanceService.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount} from "../type/Amount.sol";
+import {IInstance} from "./IInstance.sol";
+import {IService} from "../shared/IService.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
+
+interface IInstanceService is IService {
+
+    // onlyInstance
+    error ErrorInstanceServiceNotRegistered(address instance);
+    error ErrorInstanceServiceNotInstance(address instance, ObjectType objectType);
+    error ErrorInstanceServiceInstanceVersionMismatch(address instance, VersionPart instanceVersion);
+
+    error ErrorInstanceServiceComponentNotInstanceLinked(address component);
+
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
+    error ErrorInstanceServiceMasterBundleSetAlreadySet();
+    error ErrorInstanceServiceMasterRiskSetAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceAccessManagerZero();
+    error ErrorInstanceServiceInstanceAdminZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleSetZero();
+    error ErrorInstanceServiceRiskSetZero();
+    error ErrorInstanceServiceInstanceStoreZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceBundleSetAuthorityMismatch();
+    error ErrorInstanceServiceRiskSetAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleSetInstanceMismatch();
+    error ErrorInstanceServiceRiskSetInstanceMismatch();
+    error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
+
+    error ErrorInstanceServiceRequestUnauhorized(address caller);
+    error ErrorInstanceServiceNotInstanceNftId(NftId nftId);
+    error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
+    error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
+    
+    event LogInstanceCloned(NftId instanceNftId, address instance);
+
+    function createInstance()
+        external 
+        returns (
+            IInstance instance,
+            NftId instanceNftId
+        );
+
+    function upgradeInstanceReader(NftId instanceNftId) external;
+    function upgradeMasterInstanceReader(address instanceReaderAddress) external;
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(address rewardProvider, Amount dipAmount) external;
+
+    /// @dev Defunds the staking reward reserves for the specified target.
+    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
+}

package/contracts/instance/Instance.sol

@@ -1,72 +1,235 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-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";
+pragma solidity ^0.8.20;
 
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {RiskSet} from "./RiskSet.sol";
+import {COMPONENT, INSTANCE} from "../type/ObjectType.sol";
 import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
-import {NftId, toNftId} from "../types/NftId.sol";
+import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceService} from "./IInstanceService.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../type/NftId.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 contract Instance is
-    Registerable,
-    AccessModule,
-    LifecycleModule,
-    ComponentModule,
-    PolicyModule,
-    PoolModule,
-    ProductModule,
-    TreasuryModule,
-    IInstance
+    IInstance,
+    Registerable
 {
-    constructor(
-        address registry,
-        address componentOwnerService,
-        address productService
-    )
-        Registerable(registry)
-        AccessModule()
-        ComponentModule(componentOwnerService)
-        PolicyModule(productService)
-        ProductModule(productService)
-        PoolModule(productService)
-    // solhint-disable-next-line no-empty-blocks
+    bool private _initialized;
+
+    IComponentService internal _componentService;
+    IInstanceService internal _instanceService;
+    InstanceAdmin internal _instanceAdmin;
+    InstanceReader internal _instanceReader;
+    BundleSet internal _bundleSet;
+    RiskSet internal _riskSet;
+    InstanceStore internal _instanceStore;
+
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert();
+        }
+        _;
+    }
+
+    function initialize(
+        InstanceAdmin instanceAdmin, 
+        InstanceStore instanceStore,
+        BundleSet bundleSet,
+        RiskSet riskSet,
+        InstanceReader instanceReader,
+        IRegistry registry, 
+        address initialOwner
+    ) 
+        external 
+        initializer()
+    {
+        if(address(instanceAdmin) == address(0)) {
+            revert ErrorInstanceInstanceAdminZero();
+        }
+
+        _instanceAdmin = instanceAdmin;
+
+        // setup instance object info
+        __Registerable_init(
+            instanceAdmin.authority(),
+            address(registry), 
+            registry.getNftId(), 
+            INSTANCE(), 
+            true, 
+            initialOwner, 
+            "");
+
+        // store instance supporting contracts
+        _instanceStore = instanceStore;
+        _bundleSet = bundleSet;
+        _riskSet = riskSet;
+        _instanceReader = instanceReader;
+
+        // initialize instance supporting contracts
+        _instanceStore.initialize();
+        _bundleSet.initialize(instanceAdmin.authority(), address(registry));
+        _riskSet.initialize(instanceAdmin.authority(), address(registry));
+        _instanceReader.initialize();
+
+        _componentService = IComponentService(
+            getRegistry().getServiceAddress(
+                COMPONENT(), 
+                getRelease()));
+
+        _instanceService = IInstanceService(
+            getRegistry().getServiceAddress(
+                INSTANCE(), 
+                getRelease()));
+
+        _registerInterface(type(IInstance).interfaceId);    
+    }
+
+    //--- ProductRegistration ----------------------------------------------//
+    function registerProduct(address product)
+        external
+        onlyOwner()
+        returns (NftId productNftId)
+    {
+        return _componentService.registerProduct(product);
+    }
+
+    //--- Staking ----------------------------------------------------------//
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod)
+        external
+        onlyOwner()
+    {
+        _instanceService.setStakingLockingPeriod(stakeLockingPeriod);
+    }
+
+    function setStakingRewardRate(UFixed rewardRate)
+        external
+        onlyOwner()
     {
+        _instanceService.setStakingRewardRate(rewardRate);
+    }
 
+    function refillStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+    {
+        address instanceOwner = msg.sender;
+        _instanceService.refillStakingRewardReserves(instanceOwner, dipAmount);
     }
 
-    // from registerable
-    function register() external override returns (NftId nftId) {
-        require(
-            address(_registry) != address(0),
-            "ERROR:PRD-001:REGISTRY_ZERO"
-        );
-        return _registry.register(address(this));
+    function withdrawStakingRewardReserves(Amount dipAmount)
+        external
+        onlyOwner()
+        returns (Amount newBalance)
+    {
+        return _instanceService.withdrawStakingRewardReserves(dipAmount);
     }
 
-    // from registerable
-    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
-        return toNftId(0);
+    //--- Roles ------------------------------------------------------------//
+
+    function createRole(string memory roleName, string memory adminName)
+        external
+        onlyOwner()
+        returns (RoleId roleId, RoleId admin)
+    {
+        // TODO refactor
+        // (roleId, admin) = _instanceAdmin.createRole(roleName, adminName);
     }
 
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
+    function grantRole(RoleId roleId, address account) 
+        external 
+        onlyOwner()
+    {
+        _instanceAdmin.grantRole(roleId, account);
     }
 
-    // from registerable
-    function getData() external pure override returns (bytes memory data) {
-        return bytes(abi.encode(0));
+    function revokeRole(RoleId roleId, address account) 
+        external 
+        onlyOwner()
+    {
+        // TODO refactor
+        // AccessManagerExtendedInitializeable(authority()).revokeRole(roleId.toInt(), account);
     }
-}
+
+    //--- Targets ------------------------------------------------------------//
+
+    function createTarget(address target, string memory name) 
+        external 
+        onlyOwner()
+    {
+        // TODO refactor
+        // _instanceAdmin.createTarget(target, name);
+    }
+
+    function setTargetFunctionRole(
+        string memory targetName,
+        bytes4[] calldata selectors,
+        RoleId roleId
+    ) 
+        external 
+        onlyOwner()
+    {
+        // TODO refactor
+        // _instanceAdmin.setTargetFunctionRoleByInstance(targetName, selectors, roleId);
+    }
+
+    function setLocked(address target, bool locked)
+        external 
+        onlyOwner()
+    {
+        _componentService.setLockedFromInstance(target, locked);
+    }
+
+    //--- ITransferInterceptor ----------------------------------------------//
+
+    function nftTransferFrom(address from, address to, uint256 tokenId, address operator) external onlyChainNft {
+        // TODO refactor
+        // _instanceAdmin.transferInstanceOwnerRole(from, to);
+    }
+
+    //--- initial setup functions -------------------------------------------//
+
+
+    function setInstanceReader(InstanceReader instanceReader)
+        external
+        restricted()
+    {
+        if(instanceReader.getInstance() != Instance(this)) {
+            revert ErrorInstanceInstanceReaderInstanceMismatch(address(this));
+        }
+
+        _instanceReader = instanceReader;
+    }
+
+    //--- external view functions -------------------------------------------//
+
+    function getInstanceReader() external view returns (InstanceReader) {
+        return _instanceReader;
+    }
+
+    function getBundleSet() external view returns (BundleSet) {
+        return _bundleSet;
+    }
+
+    function getRiskSet() external view returns (RiskSet) {
+        return _riskSet;
+    }
+
+    function getInstanceAdmin() external view returns (InstanceAdmin) {
+        return _instanceAdmin;
+    }
+
+    function getInstanceStore() external view returns (InstanceStore) {
+        return _instanceStore;
+    }
+
+    //--- internal view/pure functions --------------------------------------//
+}