@etherisc/gif-next 0.0.2-bf51045-496 → 0.0.2-bf9f7e6-880

package/contracts/instance/InstanceStore.sol

@@ -7,10 +7,10 @@ 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, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR} from "../type/ObjectType.sol";
+import {ObjectType, BUNDLE, POLICY, POOL, PREMIUM, PRODUCT, COMPONENT, DISTRIBUTOR, FEE} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {RiskId} from "../type/RiskId.sol";
-import {StateId} from "../type/StateId.sol";
+import {StateId, KEEP_STATE} from "../type/StateId.sol";
 import {ReferralId} from "../type/Referral.sol";
 import {DistributorType} from "../type/DistributorType.sol";
 import {PayoutId} from "../type/PayoutId.sol";
@@ -85,6 +85,17 @@ contract InstanceStore is
         _update(_toNftKey32(productNftId, PRODUCT()), abi.encode(info), newState);
     }
 
+
+    //--- Fee -----------------------------------------------------------//
+    function createFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _create(_toNftKey32(productNftId, FEE()), abi.encode(info));
+    }
+
+    // Fee only has one state, so no change change possible
+    function updateFee(NftId productNftId, IComponents.FeeInfo memory info) external restricted() {
+        _update(_toNftKey32(productNftId, FEE()), abi.encode(info), KEEP_STATE());
+    }
+
     //--- Pool --------------------------------------------------------------//
 
     function createPool(

package/contracts/instance/RiskSet.sol

@@ -1,18 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IPolicy} from "../instance/module/IPolicy.sol";
 import {Key32} from "../type/Key32.sol";
 import {LibNftIdSet} from "../type/NftIdSet.sol";
 import {NftId} from "../type/NftId.sol";
-import {RiskIdLib, RiskId} from "../type/RiskId.sol";
-
 import {ObjectSet} from "./base/ObjectSet.sol";
+import {ObjectSetHelperLib} from "./base/ObjectSetHelperLib.sol";
+import {RiskIdLib, RiskId} from "../type/RiskId.sol";
 
-contract RiskSet is 
+/// @dev RiskSet manages the risks and its active policies per product.
+contract RiskSet is
     ObjectSet
 {
-    using LibNftIdSet for LibNftIdSet.Set;
 
     event LogRiskSetPolicyLinked(RiskId riskId, NftId policyNftId);
     event LogRiskSetPolicyUnlinked(RiskId riskId, NftId policyNftId);
@@ -36,7 +35,7 @@ contract RiskSet is
             revert ErrorRiskSetRiskLocked(riskId, policyNftId);
         }
 
-        _activePolicies[riskId].add(policyNftId);
+        LibNftIdSet.add(_activePolicies[riskId], policyNftId);
         emit LogRiskSetPolicyLinked(riskId, policyNftId);
     }
 
@@ -48,14 +47,14 @@ contract RiskSet is
             revert ErrorRiskSetRiskUnknown(riskId);
         }
 
-        _activePolicies[riskId].remove(policyNftId);
+        LibNftIdSet.remove(_activePolicies[riskId], policyNftId);
         emit LogRiskSetPolicyUnlinked(riskId, policyNftId);
     }
 
     /// @dev add a new risk to a product registered with this instance
     // the corresponding product is fetched via instance reader
     function add(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
 
         // ensure product is registered with instance
         if(productNftId.eqz()) {
@@ -68,14 +67,14 @@ contract RiskSet is
 
     /// @dev Applications linked to active risks may be underwritten
     function activate(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _activate(productNftId, riskId.toKey32());
         emit LogRiskSetRiskActive(productNftId, riskId);
     }
 
     /// @dev Applications linked to paused/archived risks may not be underwritten
     function pause(RiskId riskId) external restricted() {
-        NftId productNftId = _instance.getInstanceReader().getRiskInfo(riskId).productNftId;
+        NftId productNftId = ObjectSetHelperLib.getProductNftId(_instanceAddress, riskId);
         _deactivate(productNftId, riskId.toKey32());
         emit LogRiskSetRiskPaused(productNftId, riskId);
     }
@@ -110,10 +109,10 @@ contract RiskSet is
     }
 
     function linkedPolicies(RiskId riskId) external view returns(uint256) {
-        return _activePolicies[riskId].size();
+        return LibNftIdSet.size(_activePolicies[riskId]);
     }
 
     function getLinkedPolicyNftId(RiskId riskId, uint256 idx) external view returns(NftId policyNftId) {
-        return _activePolicies[riskId].getElementAt(idx);
+        return LibNftIdSet.getElementAt(_activePolicies[riskId], idx);
     }
 }

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, PREMIUM, 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, FEE} 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";
 
@@ -65,6 +65,7 @@ contract ObjectLifecycle is
 
     function _setupClaimLifecycle() private {
         setInitialState(CLAIM(), SUBMITTED());
+        setStateTransition(CLAIM(), SUBMITTED(), REVOKED());
         setStateTransition(CLAIM(), SUBMITTED(), CONFIRMED());
         setStateTransition(CLAIM(), SUBMITTED(), DECLINED());
         setStateTransition(CLAIM(), CONFIRMED(), CLOSED());
@@ -72,8 +73,8 @@ contract ObjectLifecycle is
 
     function _setupPayoutLifecycle() private {
         setInitialState(PAYOUT(), EXPECTED());
-        // TODO: add state cancelled
         setStateTransition(PAYOUT(), EXPECTED(), PAID());
+        setStateTransition(PAYOUT(), EXPECTED(), CANCELLED());
     }
 
     function _setupRiskLifecycle() private {
@@ -99,6 +100,7 @@ contract ObjectLifecycle is
     // dummy lifecycle only
     function _setUpProductLifecycle() private {
         setInitialState(PRODUCT(), ACTIVE());
+        setInitialState(FEE(), ACTIVE());
     }
 
     // dummy lifecycles only

package/contracts/instance/base/ObjectSet.sol

@@ -3,7 +3,6 @@ pragma solidity ^0.8.20;
 
 import {Cloneable} from "./Cloneable.sol";
 
-import {IInstance} from "../IInstance.sol";
 import {LibKey32Set} from "../../type/Key32Set.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Key32} from "../../type/Key32.sol";
@@ -19,21 +18,21 @@ contract ObjectSet is
 
     mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _activeObjects;
     mapping(NftId compnentNftId => LibKey32Set.Set objects) internal _allObjects;
-    IInstance internal _instance; // store instance address -> more flexible, instance may not be registered during ObjectSet initialization
+    address internal _instanceAddress;
 
     /// @dev This initializer needs to be called from the instance itself.
-    function initialize() 
+    function initialize(address authority, address registry) 
         external
         initializer()
     {
-        _instance = IInstance(msg.sender);
-        __Cloneable_init(_instance.authority(), address(_instance.getRegistry()));
+        _instanceAddress = msg.sender;
+        __Cloneable_init(authority, registry);
         
-        emit LogObjectSetInitialized(address(_instance));
+        emit LogObjectSetInitialized(address(_instanceAddress));
     }
 
-    function getInstance() external view returns (IInstance) {
-        return _instance;
+    function getInstanceAddress() external view returns (address) {
+        return _instanceAddress;
     }
 
     function _add(NftId componentNftId, Key32 key) internal {

package/contracts/instance/base/ObjectSetHelperLib.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IBundle} from "../module/IBundle.sol";
+import {IInstance} from "../IInstance.sol";
+import {IRisk} from "../module/IRisk.sol";
+import {NftId} from "../../type/NftId.sol";
+import {RiskId} from "../../type/RiskId.sol";
+
+
+library ObjectSetHelperLib {
+
+    function getRiskInfo(address instanceAddress, RiskId riskId) public view returns (IRisk.RiskInfo memory) {
+
+        return IInstance(instanceAddress).getInstanceReader().getRiskInfo(riskId);
+    }
+
+    function getProductNftId(address instanceAddress, RiskId riskId) public view returns (NftId) {
+        return getRiskInfo(instanceAddress, riskId).productNftId;
+    }
+
+    function getBundleInfo(address instanceAddress, NftId bundleNftId) public view returns (IBundle.BundleInfo memory) {
+        return IInstance(instanceAddress).getInstanceReader().getBundleInfo(bundleNftId);
+    }
+
+    function getPoolNftId(address instanceAddress, NftId bundleNftId) public view returns (NftId) {
+        return getBundleInfo(instanceAddress, bundleNftId).poolNftId;
+    }
+
+}

package/contracts/instance/module/IBundle.sol

@@ -1,20 +1,21 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../../type/Amount.sol";
 import {NftId} from "../../type/NftId.sol";
 import {Fee} from "../../type/Fee.sol";
-import {Seconds} from "../../type/Seconds.sol";
 import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IBundle {
 
     struct BundleInfo {
-        NftId poolNftId;
-        Fee fee; // bundle fee on net premium amounts
-        bytes filter; // required conditions for applications to be considered for collateralization by this bundle
+        // slot 0
         Timestamp activatedAt; 
         Timestamp expiredAt; // no new policies starting with this timestamp
         Timestamp closedAt; // no open policies, locked amount = 0
+        NftId poolNftId;
+        // slot 1
+        Fee fee; // bundle fee on net premium amounts
+        // slot 2
+        bytes filter; // required conditions for applications to be considered for collateralization by this bundle
     }
 }

package/contracts/instance/module/IComponents.sol

@@ -1,25 +1,25 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
 import {Amount} from "../../type/Amount.sol";
 import {Fee} from "../../type/Fee.sol";
 import {NftId} from "../../type/NftId.sol";
-import {RoleId} from "../../type/RoleId.sol";
 import {TokenHandler} from "../../shared/TokenHandler.sol";
 import {UFixed} from "../../type/UFixed.sol";
 
 interface IComponents {
 
     struct ComponentInfo {
+        // slot 0
         string name; // component name (needs to be unique per instance)
-        IERC20Metadata token;
+        // slot 1
         TokenHandler tokenHandler;
+        // slot 2
         bytes data; // will hold component type specific additional info (eg encoded pool info)
     }
 
     struct ProductInfo {
+        // slot 0
         bool isProcessingFundedClaims; // custom logic to react to pool events for funded claims
         bool isInterceptingPolicyTransfers; // custom logic for policy nft transfers
         bool hasDistribution; // flag to indicate if distribution is enabled
@@ -27,24 +27,36 @@ interface IComponents {
         uint8 numberOfOracles; // actual number of oracles
         NftId poolNftId; // mandatory
         NftId distributionNftId; // 0..1 (optional)
+        // slot 1
         NftId [] oracleNftId; // 0..n (optional)
+    }
+
+    struct FeeInfo {
+        // slot 0
         Fee productFee; // product fee on net premium
+        // slot 1
         Fee processingFee; // product fee on payout amounts        
+        // slot 2
         Fee distributionFee; // distribution fee for sales that do not include commissions
+        // slot 3
         Fee minDistributionOwnerFee; // min fee required by distribution owner (not including commissions for distributors)
+        // slot 4
         Fee poolFee; // pool fee on net premium
+        // slot 5
         Fee stakingFee; // pool fee on staked capital from investor
+        // slot 6
         Fee performanceFee; // pool fee on profits from capital investors
     }
 
-
     struct PoolInfo {
+        // slot 0
         Amount maxBalanceAmount; // max balance amount allowed for pool
+        UFixed collateralizationLevel; // factor to calculate collateral for sum insurance (default 100%)
+        // slot 1
+        UFixed retentionLevel; // amount of collateral held in pool (default 100%)
         bool isInterceptingBundleTransfers; // custom logic for bundle nft transfers
         bool isProcessingConfirmedClaims; // custom logic for claims confirmation
         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%)
     }
 }

package/contracts/instance/module/IDistribution.sol

@@ -1,40 +1,53 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Amount} from "../../type/Amount.sol";
 import {DistributorType} from "../../type/DistributorType.sol";
 import {NftId} from "../../type/NftId.sol";
+import {Seconds} from "../../type/Seconds.sol";
 import {Timestamp} from "../../type/Timestamp.sol";
 import {UFixed} from "../../type/UFixed.sol";
 
 interface IDistribution {
 
     struct DistributorTypeInfo {
-        string name;
+        // slot 0
         UFixed minDiscountPercentage;
+        NftId distributionNftId;
+        // slot 1
         UFixed maxDiscountPercentage;
-        UFixed commissionPercentage;
         uint32 maxReferralCount;
-        uint32 maxReferralLifetime;
+        Seconds maxReferralLifetime;
         bool allowSelfReferrals;
         bool allowRenewals;
+        // slot 2
+        UFixed commissionPercentage;
+        // slot 3
+        string name;                
+        // slot 4
         bytes data;
     }
 
     struct DistributorInfo {
+        // slot 0
         DistributorType distributorType;
         bool active;
-        bytes data;
         uint32 numPoliciesSold;
+        // slot 1
+        bytes data;
     }
 
-    struct ReferralInfo {   
+    struct ReferralInfo {
+        // slot 0
+        NftId distributionNftId;
         NftId distributorNftId;
-        string referralCode;
-        UFixed discountPercentage;
         uint32 maxReferrals;
         uint32 usedReferrals;
+        // slot 1
+        UFixed discountPercentage;
         Timestamp expiryAt;
+        // slot 2
+        string referralCode;
+        // slot 3
         bytes data;
     }
 

package/contracts/instance/module/IPolicy.sol

@@ -12,29 +12,38 @@ import {Timestamp} from "../../type/Timestamp.sol";
 interface IPolicy {
 
     struct PremiumInfo {
+        // slot 0
         // premium splitting per target wallet
         Amount productFeeAmount;
         Amount distributionFeeAndCommissionAmount;
+        // slot 1
         Amount poolPremiumAndFeeAmount;
 
         // detailed positions
         // this is the net premium calculated by the product 
         Amount netPremiumAmount;
+        // slot 2
         // fullPremium = netPremium + all fixed amounts + all variable amounts (excl commission and minDistribtuionOwnerFee variable part)
         Amount fullPremiumAmount;
         // effective premium = fullPremium - discount 
         Amount premiumAmount;
+        // slot 3
         Amount productFeeFixAmount;
         Amount poolFeeFixAmount;
+        // slot 4
         Amount bundleFeeFixAmount;
         Amount distributionFeeFixAmount;
+        // slot 5
         Amount productFeeVarAmount;
         Amount poolFeeVarAmount;
+        // slot 6
         Amount bundleFeeVarAmount;
         Amount distributionFeeVarAmount;
+        // slot 7
         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)
         Amount distributionOwnerFeeVarAmount;
+        // slot 8
         // this value is based on distributor type referenced in the referral 
         Amount commissionAmount;
         // this is based on referral used
@@ -43,43 +52,54 @@ interface IPolicy {
 
     /// @dev policy data for the full policy lifecycle
     struct PolicyInfo {
-        // application data, no changes after applying for a policy
+        // slot 0
         NftId productNftId;
         NftId bundleNftId;
-        ReferralId referralId;
         RiskId riskId;
+        // slot 1
         Amount sumInsuredAmount;
         Amount premiumAmount; // expected premium at application time
-        Seconds lifetime;
-        bytes applicationData;
-        // policy data that may change during the lifecycle
-        bytes processData;
+        ReferralId referralId;
+        // slot 2
         uint16 claimsCount;
         uint16 openClaimsCount;
         Amount claimAmount; // sum of confirmed claim amounts (max = sum insured amount)
         Amount payoutAmount; // sum of payouts (max = sum confirmed claim amountst)
+        // slot 3
         Timestamp activatedAt; // time of underwriting
+        Seconds lifetime;
         Timestamp expiredAt; // no new claims (activatedAt + lifetime)
         Timestamp closedAt; // no locked capital (or declinedAt)
+        // slot 4
+        bytes applicationData;
+        // slot 5
+        bytes processData;
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct ClaimInfo {
+        // slot 0
         Amount claimAmount;
         Amount paidAmount;
+        Timestamp closedAt; // payment of confirmed claim amount (or declinedAt)
         uint24 payoutsCount;
+        // slot 1
         uint24 openPayoutsCount;
+        // slot 2
         bytes submissionData; // use case specific claim submission data, no changes after submitting the claim
+        // slot 3
         bytes processData; // use case specific data that may include information supporting confirm or decline
-        Timestamp closedAt; // payment of confirmed claim amount (or declinedAt)
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct PayoutInfo {
+        // slot 0
         ClaimId claimId;
         Amount amount;
+        Timestamp paidAt; // timestamp for actual payout
+        // slot 1
         address beneficiary; // for address(0) beneficiary is policy nft owner
+        // slot 2
         bytes data; // use case specific supporting data
-        Timestamp paidAt; // timestamp for actual payout
     }
 }

package/contracts/instance/module/IRisk.sol

@@ -2,11 +2,15 @@
 pragma solidity ^0.8.20;
 
 import {NftId} from "../../type/NftId.sol";
+import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IRisk {
 
     struct RiskInfo {
+        // slot 0
         NftId productNftId;
+        Timestamp createdAt;
+        // slot 1
         bytes data;
     }
 }

package/contracts/oracle/BasicOracle.sol

@@ -27,8 +27,7 @@ contract BasicOracle is
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         internal
         virtual
@@ -41,7 +40,6 @@ contract BasicOracle is
             authorization,
             initialOwner,
             name,
-            token,
             "");
     }
 }

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -15,18 +15,9 @@ contract BasicOracleAuthorization
 {
 
      constructor(string memory componentName)
-          Authorization(componentName)
+          Authorization(componentName, ORACLE(), true, false)
      {}
 
-     function _setupTargets()
-          internal
-          virtual override
-     {
-          // basic component target
-          _addComponentTargetWithRole(ORACLE()); 
-     }
-
-
      function _setupTargetAuthorizations()
           internal
           virtual override
@@ -34,12 +25,12 @@ contract BasicOracleAuthorization
           IAccess.FunctionInfo[] storage functions;
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), getServiceRole(ORACLE()));
+          functions = _authorizeForTarget(getMainTargetName(), getServiceRole(ORACLE()));
           _authorize(functions, IOracle.request.selector, "request");
           _authorize(functions, IOracle.cancel.selector, "cancel");
 
           // authorize public role (open access to any account, only allows to lock target)
-          functions = _authorizeForTarget(getTargetName(), PUBLIC_ROLE());
+          functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
           _authorize(functions, BasicOracle.respond.selector, "respond");
      }
 }

package/contracts/oracle/IOracle.sol

@@ -9,14 +9,19 @@ import {Timestamp} from "../type/Timestamp.sol";
 interface IOracle {
 
     struct RequestInfo {
+        // slot 0
         NftId requesterNftId; // originator of the request
-        string callbackMethodName; // callback function of the requestor to call to provide response data
         NftId oracleNftId; // responsible oracle component
-        bytes requestData; 
-        bytes responseData; 
+        bool isCancelled;
         Timestamp respondedAt; // response timestamp
+        // slot 1
         Timestamp expiredAt; // expiry timestamp
-        bool isCancelled;
+        // slot 2
+        string callbackMethodName; // callback function of the requestor to call to provide response data
+        // slot 3
+        bytes requestData; 
+        // slot 4
+        bytes responseData; 
     }
 
 

package/contracts/oracle/Oracle.sol

@@ -69,7 +69,7 @@ abstract contract Oracle is
         override(IInstanceLinkedComponent, InstanceLinkedComponent)
         onlyOwner()
         restricted()
-        returns (Amount withdrawnAmount)
+        returns (Amount)
     {
         revert ErrorOracleNotImplemented("withdrawFees");
     }
@@ -81,7 +81,6 @@ abstract contract Oracle is
         IAuthorization authorization,
         address initialOwner,
         string memory name,
-        address token,
         bytes memory componentData // component specifidc data 
     )
         internal
@@ -92,7 +91,6 @@ abstract contract Oracle is
             registry, 
             productNftId, 
             name, 
-            token, 
             ORACLE(), 
             authorization,
             true,