@etherisc/gif-next 0.0.2-e8ea17d-715 → 0.0.2-e8ea5fe-337

package/contracts/instance/InstanceService.sol

@@ -60,7 +60,7 @@ contract InstanceService is
 
     modifier onlyInstance() {        
         address instanceAddress = msg.sender;
-        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         if (instanceNftId.eqz()) {
             revert ErrorInstanceServiceNotRegistered(instanceAddress);
         }
@@ -104,32 +104,9 @@ contract InstanceService is
         // tx sender will become instance owner
         address instanceOwner = msg.sender;
 
-        // start with setting up a new OZ access manager
-        AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
-            Clones.clone(_masterAccessManager));
-        
-        // set up the instance admin
-        InstanceAdmin clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
-        clonedAccessManager.initialize(
-            address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
-
-        clonedInstanceAdmin.initialize(
-            clonedAccessManager,
-            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
-
-        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
-        BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
-        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
-
-        // clone instance
-        clonedInstance = Instance(Clones.clone(_masterInstance));
-        clonedInstance.initialize(
-            clonedInstanceAdmin,
-            clonedInstanceStore,
-            clonedBundleSet,
-            clonedInstanceReader,
-            getRegistry(),
-            instanceOwner);
+        // create instance admin and instance
+        InstanceAdmin instanceAdmin = _createInstanceAdmin();
+        clonedInstance = _createInstance(instanceAdmin, instanceOwner);
 
         // register cloned instance with registry
         clonedInstanceNftId = _registryService.registerInstance(
@@ -142,7 +119,7 @@ contract InstanceService is
             TargetManagerLib.getDefaultRewardRate());
 
         // MUST be set after instance is set up and registered
-        clonedInstanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
+        instanceAdmin.initializeInstanceAuthorization(address(clonedInstance));
 
         emit LogInstanceCloned(
             clonedInstanceNftId,
@@ -155,7 +132,7 @@ contract InstanceService is
         virtual
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceLockingPeriod(
             instanceNftId,
             stakeLockingPeriod);
@@ -167,7 +144,7 @@ contract InstanceService is
         virtual
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.setInstanceRewardRate(
             instanceNftId,
             rewardRate);
@@ -179,7 +156,7 @@ contract InstanceService is
         virtual
         onlyInstance()
     {
-        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.refillInstanceRewardReserves(
             instanceNftId,
             rewardProvider,
@@ -193,7 +170,7 @@ contract InstanceService is
         onlyInstance()
         returns (Amount newBalance)
     {
-        NftId instanceNftId = getRegistry().getNftId(msg.sender);
+        NftId instanceNftId = getRegistry().getNftIdForAddress(msg.sender);
         _stakingService.withdrawInstanceRewardReserves(
             instanceNftId,
             dipAmount);
@@ -337,7 +314,7 @@ contract InstanceService is
 
         InstanceAdmin instanceAdmin = instance.getInstanceAdmin();
         instanceAdmin.initializeComponentAuthorization(
-            address(component),
+            component,
             component.getAuthorization());
     }
 
@@ -362,6 +339,53 @@ contract InstanceService is
         );
     }
 
+    /// @dev create new cloned instance admin
+    /// function used to setup a new instance
+    function _createInstanceAdmin()
+        internal
+        virtual
+        returns (InstanceAdmin clonedInstanceAdmin)
+    {
+        // start with setting up a new OZ access manager
+        AccessManagerCloneable clonedAccessManager = AccessManagerCloneable(
+            Clones.clone(_masterAccessManager));
+        
+        // set up the instance admin
+        clonedInstanceAdmin = InstanceAdmin(Clones.clone(_masterInstanceAdmin));
+        clonedAccessManager.initialize(
+            address(clonedInstanceAdmin)); // grant ADMIN_ROLE to instance admin
+
+        clonedInstanceAdmin.initialize(
+            clonedAccessManager,
+            InstanceAdmin(_masterInstanceAdmin).getInstanceAuthorization());
+    }
+
+
+    /// @dev create new cloned instance
+    /// function used to setup a new instance
+    function _createInstance(
+        InstanceAdmin instanceAdmin,
+        address instanceOwner
+    )
+        internal
+        virtual
+        returns (Instance clonedInstance)
+    {
+        InstanceStore clonedInstanceStore = InstanceStore(Clones.clone(address(_masterInstanceStore)));
+        BundleSet clonedBundleSet = BundleSet(Clones.clone(_masterInstanceBundleSet));
+        InstanceReader clonedInstanceReader = InstanceReader(Clones.clone(address(_masterInstanceReader)));
+
+        // clone instance
+        clonedInstance = Instance(Clones.clone(_masterInstance));
+        clonedInstance.initialize(
+            instanceAdmin,
+            clonedInstanceStore,
+            clonedBundleSet,
+            clonedInstanceReader,
+            getRegistry(),
+            instanceOwner);
+    }
+
 
     /// all gif targets MUST be children of instanceNftId
     function _createGifTarget(

package/contracts/instance/InstanceServiceManager.sol

@@ -1,13 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Instance} from "./Instance.sol";
-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 {InstanceService} from "./InstanceService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract InstanceServiceManager is ProxyManager {
 

package/contracts/instance/InstanceStore.sol

@@ -7,7 +7,7 @@ import {Amount} from "../type/Amount.sol";
 import {Key32} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ObjectType, BUNDLE, POLICY, POOL, PRODUCT, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../type/ObjectType.sol";
+import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
 import {StateId} from "../type/StateId.sol";
@@ -116,6 +116,7 @@ contract InstanceStore is
 
     //--- Distributor -------------------------------------------------------//
     function createDistributor(NftId distributorNftId, IDistribution.DistributorInfo memory info) external restricted() {
+        _registerBalanceTarget(distributorNftId);
         _create(_toNftKey32(distributorNftId, DISTRIBUTOR()), abi.encode(info));
     }
 
@@ -194,6 +195,16 @@ contract InstanceStore is
         _updateState(_toNftKey32(policyNftId, POLICY()), newState);
     }
 
+    
+    //--- Premium (Policy) ----------------------------------------------//
+    function createPremium(NftId policyNftId, IPolicy.PremiumInfo memory premium) external restricted() {
+        _create(_toNftKey32(policyNftId, PREMIUM()), abi.encode(premium));
+    }
+
+    function updatePremiumState(NftId policyNftId, StateId newState) external restricted() {
+        _updateState(_toNftKey32(policyNftId, PREMIUM()), newState);
+    }
+
     //--- Claim -------------------------------------------------------------//
     function createClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim) external restricted() {
         _create(_toClaimKey32(policyNftId, claimId), abi.encode(claim));

package/contracts/instance/base/ObjectLifecycle.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL} from "../../type/ObjectType.sol";
+import {COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT, POOL, PREMIUM, PRODUCT, DISTRIBUTION, DISTRIBUTOR, DISTRIBUTOR_TYPE, REFERRAL} from "../../type/ObjectType.sol";
 import {ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, COLLATERALIZED, REVOKED, SUBMITTED, CONFIRMED, DECLINED, EXPECTED, PAID, FULFILLED, FAILED, CANCELLED} from "../../type/StateId.sol";
 import {Lifecycle} from "../../shared/Lifecycle.sol";
 
@@ -23,6 +23,7 @@ contract ObjectLifecycle is
         _setupBundleLifecycle();
         _setupComponentLifecycle();
         _setupPolicyLifecycle();
+        _setupPremiumLifecycle();
         _setupClaimLifecycle();
         _setupPayoutLifecycle();
         _setupRiskLifecycle();
@@ -54,9 +55,12 @@ contract ObjectLifecycle is
         setStateTransition(POLICY(), APPLIED(), REVOKED());
         setStateTransition(POLICY(), APPLIED(), DECLINED());
         setStateTransition(POLICY(), APPLIED(), COLLATERALIZED());
-        setStateTransition(POLICY(), APPLIED(), ACTIVE());
-        setStateTransition(POLICY(), COLLATERALIZED(), ACTIVE());
-        setStateTransition(POLICY(), ACTIVE(), CLOSED());
+        setStateTransition(POLICY(), COLLATERALIZED(), CLOSED());
+    }
+
+    function _setupPremiumLifecycle() private {
+        setInitialState(PREMIUM(), EXPECTED());
+        setStateTransition(PREMIUM(), EXPECTED(), PAID());
     }
 
     function _setupClaimLifecycle() private {
@@ -68,6 +72,7 @@ contract ObjectLifecycle is
 
     function _setupPayoutLifecycle() private {
         setInitialState(PAYOUT(), EXPECTED());
+        // TODO: add state cancelled
         setStateTransition(PAYOUT(), EXPECTED(), PAID());
     }
 

package/contracts/instance/module/IBundle.sol

@@ -13,7 +13,7 @@ interface IBundle {
         NftId poolNftId;
         Fee fee; // bundle fee on net premium amounts
         bytes filter; // required conditions for applications to be considered for collateralization by this bundle
-        Seconds lifetime; // lifetime of bundle after creation
+        Timestamp activatedAt; 
         Timestamp expiredAt; // no new policies starting with this timestamp
         Timestamp closedAt; // no open policies, locked amount = 0
     }

package/contracts/instance/module/IComponents.sol

@@ -21,7 +21,6 @@ interface IComponents {
         bytes data; // will hold component type specific additional info (eg encoded pool info)
     }
 
-
     struct ProductInfo {
         NftId distributionNftId;
         NftId poolNftId;
@@ -36,17 +35,12 @@ interface IComponents {
 
 
     struct PoolInfo {
-        NftId productNftId; // the nft of the product this pool is linked to
+        Amount maxBalanceAmount; // max balance amount allowed for pool
         RoleId bundleOwnerRole; // the required role for bundle owners
-        // TODO maxCapitalAmount -> maxBalanceAmount
-        Amount maxCapitalAmount; // max capital amount allowed for pool
         bool isInterceptingBundleTransfers; // intercepts nft transfers for bundles
         bool isExternallyManaged; // funding bundles is restricted to book keeping, actual funds may be provided as needed to support payouts
         bool isVerifyingApplications; // underwriting requires the pool component checks/confirms the applications 
         UFixed collateralizationLevel; // factor to calculate collateral for sum insurance (default 100%)
         UFixed retentionLevel; // amount of collateral held in pool (default 100%)
-        Fee poolFee; // pool fee on net premium
-        Fee stakingFee; // pool fee on staked capital from investor
-        Fee performanceFee; // pool fee on profits from capital investors
     }
 }

package/contracts/instance/module/IDistribution.sol

@@ -25,7 +25,6 @@ interface IDistribution {
         DistributorType distributorType;
         bool active;
         bytes data;
-        Amount commissionAmount;
         uint32 numPoliciesSold;
     }
 

package/contracts/instance/module/IPolicy.sol

@@ -11,7 +11,7 @@ import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IPolicy {
 
-    struct Premium {
+    struct PremiumInfo {
         // premium splitting per target wallet
         Amount productFeeAmount;
         Amount distributionFeeAndCommissionAmount;
@@ -19,26 +19,26 @@ interface IPolicy {
 
         // detailed positions
         // this is the net premium calculated by the product 
-        uint256 netPremiumAmount;
+        Amount netPremiumAmount;
         // fullPremium = netPremium + all fixed amounts + all variable amounts (excl commission and minDistribtuionOwnerFee variable part)
-        uint256 fullPremiumAmount;
-        // premium = fullPremium - discount
-        uint256 premiumAmount;
-        uint256 productFeeFixAmount;
-        uint256 poolFeeFixAmount;
-        uint256 bundleFeeFixAmount;
-        uint256 distributionFeeFixAmount;
-        uint256 productFeeVarAmount;
-        uint256 poolFeeVarAmount;
-        uint256 bundleFeeVarAmount;
-        uint256 distributionFeeVarAmount;
-        uint256 distributionOwnerFeeFixAmount;
+        Amount fullPremiumAmount;
+        // effective premium = fullPremium - discount 
+        Amount premiumAmount;
+        Amount productFeeFixAmount;
+        Amount poolFeeFixAmount;
+        Amount bundleFeeFixAmount;
+        Amount distributionFeeFixAmount;
+        Amount productFeeVarAmount;
+        Amount poolFeeVarAmount;
+        Amount bundleFeeVarAmount;
+        Amount distributionFeeVarAmount;
+        Amount distributionOwnerFeeFixAmount;
         // this is the remaining amount when the commission and discount are subtracted from the distribution fee variable part (must be at least the minDistributionOwnerFee)
-        uint256 distributionOwnerFeeVarAmount;
+        Amount distributionOwnerFeeVarAmount;
         // this value is based on distributor type referenced in the referral 
-        uint256 commissionAmount;
+        Amount commissionAmount;
         // this is based on referral used
-        uint256 discountAmount;
+        Amount discountAmount;
     }
 
     /// @dev policy data for the full policy lifecycle
@@ -49,7 +49,6 @@ interface IPolicy {
         RiskId riskId;
         Amount sumInsuredAmount;
         Amount premiumAmount; // expected premium at application time
-        Amount premiumPaidAmount; // actual paid premium 
         Seconds lifetime;
         // policy application data, no changes after applying for a policy
         bytes applicationData;
@@ -69,8 +68,8 @@ interface IPolicy {
         Amount paidAmount;
         uint8 payoutsCount;
         uint8 openPayoutsCount;
-        bytes submissionData; // claim submission data, no changes after submitting the claim
-        bytes processData; // data that may include information supporting confirm or decline
+        bytes submissionData; // use case specific claim submission data, no changes after submitting the claim
+        bytes processData; // use case specific data that may include information supporting confirm or decline
         Timestamp closedAt; // payment of confirmed claim amount (or declinedAt)
     }
 
@@ -78,7 +77,8 @@ interface IPolicy {
     struct PayoutInfo {
         ClaimId claimId;
         Amount amount;
-        bytes data;
-        Timestamp paidAt; // payoment of confirmed claim amount (or declinedAt)
+        address beneficiary; // for address(0) beneficiary is policy nft owner
+        bytes data; // use case specific supporting data
+        Timestamp paidAt; // timestamp for actual payout
     }
 }

package/contracts/mock/Dip.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
 contract Dip is ERC20 {
 

package/contracts/oracle/IOracleComponent.sol

@@ -11,7 +11,8 @@ import {UFixed} from "../type/UFixed.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 
 interface IOracleComponent is IInstanceLinkedComponent {
-
+    error ErrorOracleNotImplemented(string methodName);
+    
     /// @dev callback method for requesting some data from the oracle
     function request(
         RequestId requestId,

package/contracts/oracle/Oracle.sol

@@ -1,19 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {Amount} from "../type/Amount.sol";
 import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponentService} from "../shared/IComponentService.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
 import {IOracleComponent} from "./IOracleComponent.sol";
 import {IOracleService} from "./IOracleService.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
-import {NftId, NftIdLib} from "../type/NftId.sol";
+import {NftId} from "../type/NftId.sol";
 import {InstanceLinkedComponent} from "../shared/InstanceLinkedComponent.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
 import {RequestId} from "../type/RequestId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {UFixed} from "../type/UFixed.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 
 abstract contract Oracle is
@@ -73,6 +71,18 @@ abstract contract Oracle is
         return false;
     }
 
+    /// @dev Not relevant for oracle components
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        override(IInstanceLinkedComponent, InstanceLinkedComponent)
+        onlyOwner()
+        restricted()
+        returns (Amount withdrawnAmount)
+    {
+        revert ErrorOracleNotImplemented("withdrawFees");
+    }
+
 
     function _initializeOracle(
         address registry,

package/contracts/oracle/OracleService.sol

@@ -64,6 +64,7 @@ contract OracleService is
             ORACLE(), 
             true); // only active
 
+        // TODO move to stronger validation, requester and oracle need to belong to same product cluster
         // check that requester and oracle share same instance
         if (componentInfo.parentNftId != oracleInfo.parentNftId) {
             revert ErrorOracleServiceInstanceMismatch(componentInfo.parentNftId, oracleInfo.parentNftId);

package/contracts/oracle/OracleServiceManager.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 {OracleService} from "./OracleService.sol";
-import {Registry} from "../registry/Registry.sol";
-import {RegistryService} from "../registry/RegistryService.sol";
-import {REGISTRY} from "../type/ObjectType.sol";
 
 contract OracleServiceManager is ProxyManager {
 

package/contracts/pool/BasicPool.sol

@@ -14,6 +14,7 @@ import {NftId, NftIdLib} from "../type/NftId.sol";
 import {BUNDLE, COMPONENT, POOL} from "../type/ObjectType.sol";
 import {RoleId, PUBLIC_ROLE} from "../type/RoleId.sol";
 import {Seconds} from "../type/Seconds.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {UFixed, UFixedLib} from "../type/UFixed.sol";
 
@@ -81,8 +82,9 @@ abstract contract BasicPool is
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
+        returns(Timestamp newExpiredAt)
     {
-        _extend(bundleNftId, lifetimeExtension);
+        return _extend(bundleNftId, lifetimeExtension);
     }
 
 
@@ -106,13 +108,13 @@ abstract contract BasicPool is
     }
 
 
-    function close(NftId bundleNftId)
+    function closeBundle(NftId bundleNftId)
         public
         virtual
         restricted()
         onlyBundleOwner(bundleNftId)
     {
-        _close(bundleNftId);
+        _closeBundle(bundleNftId);
     }
 
 
@@ -129,13 +131,13 @@ abstract contract BasicPool is
     }
 
 
-    function setMaxCapitalAmount(Amount maxCapitalAmount)
+    function setMaxBalanceAmount(Amount maxBalanceAmount)
         public
         virtual
         restricted()
         onlyOwner()
     {
-        _setMaxCapitalAmount(maxCapitalAmount);
+        _setMaxBalanceAmount(maxBalanceAmount);
     }
 
 

package/contracts/pool/BasicPoolAuthorization.sol

@@ -4,6 +4,8 @@ pragma solidity ^0.8.20;
 import {Authorization} from "../authorization/Authorization.sol";
 import {BasicPool} from "./BasicPool.sol"; 
 import {IAccess} from "../authorization/IAccess.sol";
+import {IInstanceLinkedComponent} from "../shared/IInstanceLinkedComponent.sol";
+import {IPoolComponent} from "./IPoolComponent.sol";
 import {POOL} from "../type/ObjectType.sol";
 import {PUBLIC_ROLE} from "../../contracts/type/RoleId.sol";
 import {RoleId} from "../type/RoleId.sol";
@@ -38,12 +40,19 @@ contract BasicPoolAuthorization
           _authorize(functions, BasicPool.extend.selector, "extend");
           _authorize(functions, BasicPool.lockBundle.selector, "lockBundle");
           _authorize(functions, BasicPool.unlockBundle.selector, "unlockBundle");
-          _authorize(functions, BasicPool.close.selector, "close");
+          _authorize(functions, BasicPool.closeBundle.selector, "closeBundle");
           _authorize(functions, BasicPool.setBundleFee.selector, "setBundleFee");
 
-          _authorize(functions, BasicPool.setMaxCapitalAmount.selector, "setMaxCapitalAmount");
+          _authorize(functions, BasicPool.setMaxBalanceAmount.selector, "setMaxBalanceAmount");
           _authorize(functions, BasicPool.setBundleOwnerRole.selector, "setBundleOwnerRole");
           _authorize(functions, BasicPool.setFees.selector, "setFees");
+          _authorize(functions, BasicPool.stake.selector, "stake");
+          _authorize(functions, BasicPool.unstake.selector, "unstake");
+          _authorize(functions, BasicPool.extend.selector, "extend");
+
+          _authorize(functions, IInstanceLinkedComponent.withdrawFees.selector, "withdrawFees");
+
+          _authorize(functions, IPoolComponent.withdrawBundleFees.selector, "withdrawBundleFees");
      }
 }