@etherisc/gif-next 0.0.2-9620cae-586 → 0.0.2-9628b30-648

package/contracts/instance/module/IPolicy.sol

@@ -11,74 +11,95 @@ import {Timestamp} from "../../type/Timestamp.sol";
 
 interface IPolicy {
 
-    struct Premium {
+    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 
-        uint256 netPremiumAmount;
+        Amount netPremiumAmount;
+        // slot 2
         // 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;
+        // 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)
-        uint256 distributionOwnerFeeVarAmount;
+        Amount distributionOwnerFeeVarAmount;
+        // slot 8
         // 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
     struct PolicyInfo {
+        // slot 0
         NftId productNftId;
         NftId bundleNftId;
-        ReferralId referralId;
         RiskId riskId;
+        // slot 1
         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;
-        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;
-        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
         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
     }
 
     // claimId neeeds to be encoded policyNftId:claimId combination
     struct PayoutInfo {
+        // slot 0
         ClaimId claimId;
         Amount amount;
-        bytes data;
-        Timestamp paidAt; // payoment of confirmed claim amount (or declinedAt)
+        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
     }
 }

package/contracts/instance/module/IRisk.sol

@@ -2,10 +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/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/BasicOracle.sol

@@ -27,22 +27,19 @@ contract BasicOracle is
         NftId instanceNftId,
         IAuthorization authorization,
         address initialOwner,
-        string memory name,
-        address token
+        string memory name
     )
         internal
         virtual
         onlyInitializing()
     {
 
-        _initializeOracle(
+        __Oracle_init(
             registry,
             instanceNftId,
             authorization,
             initialOwner,
             name,
-            token,
-            "",
             "");
     }
 }

package/contracts/oracle/BasicOracleAuthorization.sol

@@ -14,19 +14,25 @@ contract BasicOracleAuthorization
      is Authorization
 {
 
-     constructor(string memory componentName)
-          Authorization(componentName)
+     constructor(
+          string memory componentName
+     )
+          Authorization(
+               componentName, 
+               ORACLE(), 
+               3, 
+               COMMIT_HASH,
+               true, 
+               false)
      {}
 
-     function _setupTargets()
+     function _setupServiceTargets()
           internal
           virtual override
      {
-          // basic component target
-          _addComponentTargetWithRole(ORACLE()); 
+          _authorizeServiceDomain(ORACLE(), address(15));
      }
 
-
      function _setupTargetAuthorizations()
           internal
           virtual override
@@ -34,12 +40,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/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/IOracleService.sol

@@ -3,6 +3,7 @@ pragma solidity ^0.8.20;
 
 import {IService} from "../shared/IService.sol";
 import {NftId} from "../type/NftId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
 import {RequestId} from "../type/RequestId.sol";
 import {StateId} from "../type/StateId.sol";
 import {Timestamp} from "../type/Timestamp.sol";
@@ -17,7 +18,7 @@ interface IOracleService is IService {
     event LogOracleServiceRequestCancelled(RequestId requestId, NftId requesterNftId);
 
     // create request
-    error ErrorOracleServiceInstanceMismatch(NftId expectedInstanceNftId, NftId oracleInstanceNftId);
+    error ErrorOracleServiceProductMismatch(ObjectType callerObjectType, NftId productNft, NftId oracleParentNftId);
     error ErrorOracleServiceExpiryInThePast(Timestamp blockTimestamp, Timestamp expiryAt);
     error ErrorOracleServiceCallbackMethodNameEmpty();
 
@@ -40,26 +41,26 @@ interface IOracleService is IService {
         string calldata callbackMethodName
     ) external returns (RequestId requestId);
 
-    /// @dev respond to oracle request by oracle compnent.
-    /// the response data is amende in the request info stored with the instance.
-    /// the request state changes to FULFILLED (when calling the callback method of the requester is successful)
+    /// @dev Respond to oracle request by oracle compnent.
+    /// The response data is amended in the request info stored with the instance.
+    /// The request state changes to FULFILLED (when calling the callback method of the requester is successful)
     /// or to FAILED when calling the requester is not succesful.
-    /// the function returns true iff the state changes to FULFILLED.
-    /// permissioned: only the oracle component linked to the request id may call this method
+    /// The function returns true iff the state changes to FULFILLED.
+    /// Permissioned: only the receiving oracle component may call this method
     function respond(
         RequestId requestId,
         bytes calldata responseData
     ) external returns (bool success);
 
-    /// @dev re send a failed response to the requester.
-    /// only requests in state FAILED may be re sent.
-    /// the request state changes to FULFILLED when calling the callback method of the requester is successful.
-    /// permissioned: only the requester may resend a request
+    /// @dev Resend a failed response to the requester.
+    /// Only requests in state FAILED may be resent.
+    /// The request state changes to FULFILLED when calling the callback method of the requester is successful.
+    /// Permissioned: only the receiving oracle may resend a request
     function resend(RequestId requestId) external;
 
-    /// @dev notify the oracle component that the specified request has become invalid.
-    /// only requests in state ACTIVE may be cancelled.
-    /// permissioned: only the requester may cancel a request
+    /// @dev Notify the oracle component that the specified request has become invalid.
+    /// Only requests in state ACTIVE may be cancelled.
+    /// Permissioned: only the requester may cancel a request
     function cancel(RequestId requestId) external;
 
 }

package/contracts/oracle/Oracle.sol

@@ -1,19 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {COMPONENT, ORACLE} from "../type/ObjectType.sol";
+import {Amount} from "../type/Amount.sol";
+import {COMPONENT, PRODUCT, 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
@@ -29,15 +27,6 @@ abstract contract Oracle is
     }
 
 
-    function register()
-        external
-        virtual
-        onlyOwner()
-    {
-        _getOracleStorage()._componentService.registerOracle();
-    }
-
-
     function request(
         RequestId requestId,
         NftId requesterId,
@@ -73,38 +62,46 @@ 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)
+    {
+        revert ErrorOracleNotImplemented("withdrawFees");
+    }
+
 
-    function _initializeOracle(
+    function __Oracle_init(
         address registry,
-        NftId instanceNftId,
+        NftId productNftId,
         IAuthorization authorization,
         address initialOwner,
         string memory name,
-        address token,
-        bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // component specifidc data 
     )
         internal
         virtual
         onlyInitializing()
     {
-        _initializeInstanceLinkedComponent(
+        __InstanceLinkedComponent_init(
             registry, 
-            instanceNftId, 
+            productNftId, 
             name, 
-            token, 
             ORACLE(), 
             authorization,
             true, 
             initialOwner, 
-            registryData, 
             componentData);
 
         OracleStorage storage $ = _getOracleStorage();
-        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
         $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
+        $._oracleService = IOracleService(_getServiceAddress(ORACLE())); 
 
-        registerInterface(type(IOracleComponent).interfaceId);
+        _registerInterface(type(IOracleComponent).interfaceId);
     }