@etherisc/gif-next 0.0.2-676522f-203 → 0.0.2-683d8b2-607

package/contracts/distribution/DistributionServiceManager.sol

@@ -1,12 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IVersionable} from "../shared/IVersionable.sol";
-import {ProxyManager} from "../shared/ProxyManager.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
+import {ProxyManager} from "../upgradeability/ProxyManager.sol";
 import {DistributionService} from "./DistributionService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract DistributionServiceManager is ProxyManager {
 

package/contracts/distribution/IDistributionComponent.sol

@@ -11,56 +11,38 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 interface IDistributionComponent is IInstanceLinkedComponent {
 
+    error ErrorDistributionNotDistributor(address distributor);
+    error ErrorDistributionAlreadyDistributor(address distributor, NftId distributorNftId);
+
     event LogDistributorUpdated(address to, address caller);
 
-    function setFees(
-        Fee memory distributionFee,
-        Fee memory minDistributionOwnerFee
-    ) external;
+    /// @dev Returns true iff the provided address is registered as a distributor with this distribution component.
+    function isDistributor(address candidate) external view returns (bool);
 
-    function createDistributorType(
-        string memory name,
-        UFixed minDiscountPercentage,
-        UFixed maxDiscountPercentage,
-        UFixed commissionPercentage,
-        uint32 maxReferralCount,
-        uint32 maxReferralLifetime,
-        bool allowSelfReferrals,
-        bool allowRenewals,
-        bytes memory data
-    ) external returns (DistributorType distributorType);
+    /// @dev Returns the distributor Nft Id for the provided address
+    function getDistributorNftId(address distributor) external view returns (NftId distributorNftId);
 
-    function createDistributor(
-        address distributor,
-        DistributorType distributorType,
-        bytes memory data
-    ) external returns(NftId distributorNftId);
+    function getDiscountPercentage(
+        string memory referralCode
+    ) external view returns (UFixed discountPercentage, ReferralStatus status);
 
-    function updateDistributorType(
-        NftId distributorNftId,
-        DistributorType distributorType,
-        bytes memory data
-    ) external;
+    function getReferralId(
+        string memory referralCode
+    ) external returns (ReferralId referralId);
 
     function calculateRenewalFeeAmount(
         ReferralId referralId,
         uint256 netPremiumAmount
     ) external view returns (uint256 feeAmount);
 
-    /// @dev callback from product service when a policy is renews for a specific referralId
+    /// @dev Callback function to process a renewal of a policy.
+    /// The default implementation is empty.
+    /// Overwrite this function to implement a use case specific behaviour.
     function processRenewal(
         ReferralId referralId,
         uint256 feeAmount
     ) external;
 
-    function getDiscountPercentage(
-        string memory referralCode
-    ) external view returns (UFixed discountPercentage, ReferralStatus status);
-
-    function getReferralId(
-        string memory referralCode
-    ) external returns (ReferralId referralId);
-
-    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    /// @dev Returns true to ensure component is called when transferring distributor Nft Ids.
     function isVerifying() external view returns (bool verifying);
 }

package/contracts/distribution/IDistributionService.sol

@@ -13,6 +13,7 @@ import {Timestamp} from "../type/Timestamp.sol";
 
 
 interface IDistributionService is IService {
+
     error ErrorDistributionServiceCallerNotRegistered(address caller);
     error ErrorIDistributionServiceParentNftIdNotInstance(NftId nftId, NftId parentNftId);
     error ErrorIDistributionServiceCallerNotDistributor(address caller);
@@ -25,7 +26,10 @@ interface IDistributionService is IService {
     error ErrorIDistributionServiceExpirationInvalid(Timestamp expiryAt);
     error ErrorIDistributionServiceCommissionTooHigh(uint256 commissionPercentage, uint256 maxCommissionPercentage);
     error ErrorIDistributionServiceMinFeeTooHigh(uint256 minFee, uint256 limit);
-    error ErrorIDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
+
+    error ErrorDistributionServiceVariableFeesTooHight(uint256 maxDiscountPercentage, uint256 limit);
+    error ErrorDistributionServiceMaxDiscountTooHigh(uint256 maxDiscountPercentage, uint256 limit);
+
     error ErrorIDistributionServiceReferralInvalid(NftId distributionNftId, ReferralId referralId);
     error ErrorDistributionServiceInvalidFeeTransferred(Amount transferredDistributionFeeAmount, Amount expectedDistributionFeeAmount);
 

package/contracts/instance/{BundleManager.sol → BundleSet.sol}

@@ -10,26 +10,26 @@ import {LibNftIdSet} from "../type/NftIdSet.sol";
 import {NftId} from "../type/NftId.sol";
 import {TimestampLib} from "../type/Timestamp.sol";
 
-import {ObjectManager} from "./base/ObjectManager.sol";
+import {ObjectSet} from "./base/ObjectSet.sol";
 
-contract BundleManager is 
-    ObjectManager
+contract BundleSet is 
+    ObjectSet
 {
 
-    event LogBundleManagerPolicyLinked(NftId bundleNftId, NftId policyNftId);
-    event LogBundleManagerPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleSetPolicyLinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleSetPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
 
-    event LogBundleManagerBundleAdded(NftId poolNftId, NftId bundleNftId);
-    event LogBundleManagerBundleUnlocked(NftId poolNftId, NftId bundleNftId);
-    event LogBundleManagerBundleLocked(NftId poolNftId, NftId bundleNftId);
-    event LogBundleManagerBundleClosed(NftId poolNftId, NftId bundleNftId);
+    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 ErrorBundleManagerPolicyAlreadyActivated(NftId policyNftId);
-    error ErrorBundleManagerBundleLocked(NftId bundleNftId, NftId policyNftId);
-    error ErrorBundleManagerPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
-    error ErrorBundleManagerPolicyNotCloseable(NftId policyNftId);
-    error ErrorBundleManagerBundleUnknown(NftId bundleNftId);
-    error ErrorBundleManagerBundleNotRegistered(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;
 
@@ -42,11 +42,11 @@ contract BundleManager is
 
         // ensure bundle is unlocked (in active set) and registered with this instance
         if (!_isActive(poolNftId, bundleNftId)) {
-            revert ErrorBundleManagerBundleLocked(bundleNftId, policyNftId);
+            revert ErrorBundleSetBundleLocked(bundleNftId, policyNftId);
         }
 
         LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
-        emit LogBundleManagerPolicyLinked(bundleNftId, policyNftId);
+        emit LogBundleSetPolicyLinked(bundleNftId, policyNftId);
     }
 
 
@@ -63,11 +63,11 @@ contract BundleManager is
 
         // ensure bundle is registered with this instance
         if (!_contains(poolNftId, bundleNftId)) {
-            revert ErrorBundleManagerBundleUnknown(bundleNftId);
+            revert ErrorBundleSetBundleUnknown(bundleNftId);
         }
 
         LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
-        emit LogBundleManagerPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+        emit LogBundleSetPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
     }
 
 
@@ -78,11 +78,11 @@ contract BundleManager is
 
         // ensure pool is registered with instance
         if(poolNftId.eqz()) {
-            revert ErrorBundleManagerBundleNotRegistered(bundleNftId);
+            revert ErrorBundleSetBundleNotRegistered(bundleNftId);
         }
 
         _add(poolNftId, bundleNftId);
-        emit LogBundleManagerBundleAdded(poolNftId, bundleNftId);
+        emit LogBundleSetBundleAdded(poolNftId, bundleNftId);
     }
 
 
@@ -90,14 +90,14 @@ contract BundleManager is
     function unlock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _activate(poolNftId, bundleNftId);
-        emit LogBundleManagerBundleUnlocked(poolNftId, bundleNftId);
+        emit LogBundleSetBundleUnlocked(poolNftId, bundleNftId);
     }
 
     /// @dev locked (deactivated) bundles may not collateralize any new policies
     function lock(NftId bundleNftId) external restricted() {
         NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
         _deactivate(poolNftId, bundleNftId);
-        emit LogBundleManagerBundleLocked(poolNftId, bundleNftId);
+        emit LogBundleSetBundleLocked(poolNftId, bundleNftId);
     }
 
     function bundles(NftId poolNftId) external view returns(uint256) {

package/contracts/instance/IInstance.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.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";
@@ -13,14 +14,15 @@ 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 {AccessManagerExtendedInitializeable} from "../shared/AccessManagerExtendedInitializeable.sol";
 import {IRegisterable} from "../shared/IRegisterable.sol";
 
 import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
 
 import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {BundleManager} from "./BundleManager.sol";
+import {BundleSet} from "./BundleSet.sol";
 import {InstanceReader} from "./InstanceReader.sol";
 import {InstanceStore} from "./InstanceStore.sol";
 
@@ -37,7 +39,6 @@ import {IPolicyService} from "../product/IPolicyService.sol";
 import {IBundleService} from "../pool/IBundleService.sol";
 
 
-
 interface IInstance is 
     IRegisterable, 
     ITransferInterceptor, 
@@ -47,15 +48,19 @@ interface IInstance is
     error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
     error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
-    error ErrorInstanceBundleManagerAlreadySet(address instanceBundleManager);
-    error ErrorInstanceBundleManagerInstanceMismatch(address instance);
-    error ErrorInstanceBundleManagerAuthorityMismatch(address instanceAuthority);
+    error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
+    error ErrorInstanceBundleSetInstanceMismatch(address instance);
+    error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
     error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
     error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
     error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
 
+    struct InstanceInfo {
+        uint64 requestsCount;
+    }
+
     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;
@@ -64,16 +69,18 @@ interface IInstance is
     function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
     function setTargetLocked(address target, bool locked) external;
 
-    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);
+    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 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);
-    function getInstanceAccessManager() external view returns (AccessManagerExtendedInitializeable);
 }

package/contracts/instance/IInstanceService.sol

@@ -1,25 +1,30 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+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 {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
-import {IService} from "../shared/IService.sol";
-
-import {InstanceAdmin} from "./InstanceAdmin.sol";
-import {Instance} from "./Instance.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
-import {InstanceStore} from "./InstanceStore.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 ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
     error ErrorInstanceServiceMasterInstanceAdminAlreadySet();
-    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleSetAlreadySet();
     error ErrorInstanceServiceInstanceAddressZero();
 
     error ErrorInstanceServiceMasterInstanceReaderNotSet();
@@ -27,40 +32,46 @@ interface IInstanceService is IService {
     error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch();
 
+    error ErrorInstanceServiceAccessManagerZero();
     error ErrorInstanceServiceInstanceAdminZero();
     error ErrorInstanceServiceInstanceReaderZero();
-    error ErrorInstanceServiceBundleManagerZero();
+    error ErrorInstanceServiceBundleSetZero();
     error ErrorInstanceServiceInstanceStoreZero();
 
     error ErrorInstanceServiceInstanceAuthorityMismatch();
-    error ErrorInstanceServiceBundleManagerAuthorityMismatch();
+    error ErrorInstanceServiceBundleSetAuthorityMismatch();
     error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
     error ErrorInstanceServiceBundleMangerInstanceMismatch();
     error ErrorInstanceServiceInstanceStoreAuthorityMismatch();
 
     error ErrorInstanceServiceRequestUnauhorized(address caller);
-    error ErrorInstanceServiceNotInstance(NftId nftId);
+    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 clonedOzAccessManager,
-        address clonedInstanceAccessManager,
-        address clonedInstance,
-        address clonedInstanceStore,
-        address clonedBundleManager, 
-        address clonedInstanceReader, 
-        NftId clonedInstanceNftId
-    );
-
-    function createInstanceClone()
+    event LogInstanceCloned(NftId instanceNftId, address instance);
+
+    function createInstance()
         external 
         returns (
+            // TODO check if Instance can be changed to IInstance
             Instance clonedInstance,
             NftId instanceNftId
         );
 
+
+    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,