@etherisc/gif-next 0.0.2-bdcb44f-543 → 0.0.2-be7d052-160

package/contracts/instance/IInstance.sol

@@ -3,90 +3,84 @@ pragma solidity ^0.8.20;
 
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
-import {NftId} from "../types/NftId.sol";
-import {StateId} from "../types/StateId.sol";
-import {RiskId} from "../types/RiskId.sol";
+import {Amount} from "../type/Amount.sol";
+import {ClaimId} from "../type/ClaimId.sol";
+import {DistributorType} from "../type/DistributorType.sol";
+import {PayoutId} from "../type/PayoutId.sol";
+import {NftId} from "../type/NftId.sol";
+import {StateId} from "../type/StateId.sol";
+import {ReferralId} from "../type/Referral.sol";
+import {RiskId} from "../type/RiskId.sol";
+import {VersionPart} from "../type/Version.sol";
+import {Key32} from "../type/Key32.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
 
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
-import {BundleManager} from "./BundleManager.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-
-import {IBundle} from "./module/IBundle.sol";
-import {IBundleService} from "./service/IBundleService.sol";
-import {IDistributionService} from "./service/IDistributionService.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
-import {IKeyValueStore} from "./base/IKeyValueStore.sol";
-import {IPolicy} from "./module/IPolicy.sol";
-import {IDistribution} from "./module/IDistribution.sol";
-import {IPolicyService} from "./service/IPolicyService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPolicyService} from "./service/IPolicyService.sol";
-import {IBundleService} from "./service/IBundleService.sol";
-import {IRisk} from "./module/IRisk.sol";
-import {ISetup} from "./module/ISetup.sol";
-import {NftId} from "../types/NftId.sol";
-import {RiskId} from "../types/RiskId.sol";
-import {StateId} from "../types/StateId.sol";
-import {VersionPart} from "../types/Version.sol";
-import {Key32} from "../types/Key32.sol";
-
-
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 
+import {InstanceAdmin} from "./InstanceAdmin.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
 
-interface IInstance is IRegisterable, IKeyValueStore, IAccessManaged {
+import {IKeyValueStore} from "../shared/IKeyValueStore.sol";
 
-    function getDistributionService() external view returns (IDistributionService);
-    function getProductService() external view returns (IProductService);
-    function getPoolService() external view returns (IPoolService);
-    function getPolicyService() external view returns (IPolicyService);
-    function getBundleService() external view returns (IBundleService);
+import {IAccess} from "./module/IAccess.sol";
 
-    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
-    function updateDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup, StateId newState) external;
-    function updateDistributionSetupState(NftId distributionNftId, StateId newState) external;
+import {IBundleService} from "../pool/IBundleService.sol";
+import {IDistributionService} from "../distribution/IDistributionService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IPoolService} from "../pool/IPoolService.sol";
+import {IProductService} from "../product/IProductService.sol";
+import {IPolicyService} from "../product/IPolicyService.sol";
+import {IBundleService} from "../pool/IBundleService.sol";
 
-    function createPoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup) external;
-    function updatePoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external;
-    function updatePoolSetupState(NftId poolNftId, StateId newState) external;
 
-    function createBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle) external;
-    function updateBundle(NftId bundleNftId, IBundle.BundleInfo memory bundle, StateId newState) external;
-    function updateBundleState(NftId bundleNftId, StateId newState) external;
+interface IInstance is 
+    IRegisterable, 
+    ITransferInterceptor, 
+    IAccessManaged
+{
+    error ErrorInstanceInstanceAdminZero();
+    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
-    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external;
-    function updateProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup, StateId newState) external;
-    function updateProductSetupState(NftId productNftId, StateId newState) external;
+    error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
+    error ErrorInstanceBundleSetInstanceMismatch(address instance);
+    error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
-    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external;
-    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external;
-    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external;
+    error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
-    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external;
-    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external;
-    function updateDistributorState(NftId nftId, StateId newState) external;
+    error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
+    error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
 
-    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external;
-    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external;
-    function updateReferralState(Key32 referralKey, StateId newState) external;
+    struct InstanceInfo {
+        uint64 requestsCount;
+    }
 
-    function createRisk(RiskId riskId, IRisk.RiskInfo memory risk) external;
-    function updateRisk(RiskId riskId, IRisk.RiskInfo memory risk, StateId newState) external;
-    function updateRiskState(RiskId riskId, StateId newState) external;
+    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 createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external;
-    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
-    function updateApplicationState(NftId applicationNftId, StateId newState) external;
+    function createTarget(address target, string memory name) external;
+    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+    function setTargetLocked(address target, bool locked) external;
 
-    function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external;
-    function updatePolicyState(NftId policyNftId, StateId newState) external;
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(Amount dipAmount) external;
 
-    // TODO add claims/payouts function to instance
-    // function updateClaims(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) 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 getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
-    function getBundleManager() external view returns (BundleManager);
+    function getBundleSet() external view returns (BundleSet);
+    function getInstanceAdmin() external view returns (InstanceAdmin);
+    function getInstanceStore() external view returns (InstanceStore);
 }

package/contracts/instance/IInstanceService.sol

@@ -1,25 +1,30 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
-import {RoleId} from "../types/RoleId.sol";
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {Instance} from "./Instance.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IService} from "../shared/IService.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
 
-import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IComponent} from "../components/IComponent.sol";
+interface IInstanceService is IService {
 
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
-import {Instance} from "./Instance.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
+    // onlyInstance
+    error ErrorInstanceServiceNotRegistered(address instance);
+    error ErrorInstanceServiceNotInstance(address instance, ObjectType objectType);
+    error ErrorInstanceServiceInstanceVersionMismatch(address instance, VersionPart instanceVersion);
 
-interface IInstanceService is IService {
+    error ErrorInstanceServiceComponentNotInstanceLinked(address component);
 
     error ErrorInstanceServiceMasterInstanceAlreadySet();
-    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
-    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
+    error ErrorInstanceServiceMasterBundleSetAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
     error ErrorInstanceServiceMasterInstanceReaderNotSet();
@@ -28,32 +33,60 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceReaderInstanceMismatch();
 
     error ErrorInstanceServiceAccessManagerZero();
+    error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
-    error ErrorInstanceServiceBundleManagerZero();
+    error ErrorInstanceServiceBundleSetZero();
+    error ErrorInstanceServiceInstanceStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceBundleSetAuthorityMismatch();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
     error ErrorInstanceServiceBundleMangerInstanceMismatch();
+    error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
-    error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
+    error ErrorInstanceServiceNotInstanceNftId(NftId nftId);
     error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
     error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
     
-    event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
+    event LogInstanceCloned(NftId instanceNftId, address instance);
 
-    function createInstanceClone()
+    function createInstance()
         external 
         returns (
-            InstanceAccessManager clonedAccessManager, 
+            // TODO check if Instance can be changed to IInstance
             Instance clonedInstance,
-            NftId instanceNftId,
-            InstanceReader clonedInstanceReader,
-            BundleManager clonedBundleManager
+            NftId instanceNftId
         );
 
-    function hasRole(address account, RoleId role, address instanceAddress) external returns (bool);
-    function setTargetLocked(string memory targetName, bool locked) 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);
+
+    /// @dev Sets up the component authorization for the specified instance.
+    /// The authorization is based on the authz specification provided by the component via getAuthorization.
+    function initializeAuthorization(NftId instanceNftId, IInstanceLinkedComponent component) external;
+
+    function createComponentTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    ) external;
+
+    function createGifTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    ) external;
 
+    function setComponentLocked(bool locked) external;
+}