@etherisc/gif-next 3.0.0-b45deea-213 → 3.0.0-bd6db59-832

package/contracts/examples/flight/FlightProduct.sol

@@ -8,7 +8,6 @@ import {IAuthorization} from "../../authorization/IAuthorization.sol";
 import {IComponents} from "../../instance/module/IComponents.sol";
 
 import {Amount, AmountLib} from "../../type/Amount.sol";
-import {BasicProduct} from "../../product/BasicProduct.sol";
 import {ClaimId} from "../../type/ClaimId.sol";
 import {FeeLib} from "../../type/Fee.sol";
 import {FlightLib} from "./FlightLib.sol";
@@ -17,6 +16,7 @@ import {FlightOracle} from "./FlightOracle.sol";
 import {InstanceReader} from "../../instance/InstanceReader.sol";
 import {NftId, NftIdLib} from "../../type/NftId.sol";
 import {PayoutId} from "../../type/PayoutId.sol";
+import {Product} from "../../product/Product.sol";
 import {ReferralLib} from "../../type/Referral.sol";
 import {RiskId, RiskIdLib} from "../../type/RiskId.sol";
 import {RequestId} from "../../type/RequestId.sol";
@@ -27,16 +27,17 @@ import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
 
 /// @dev FlightProduct implements the flight delay product.
 contract FlightProduct is
-    BasicProduct
+    Product
 {
 
     event LogRequestFlightRatings(uint256 requestId, bytes32 carrierFlightNumber, uint256 departureTime, uint256 arrivalTime, bytes32 riskId);
     event LogRequestFlightStatus(uint256 requestId, uint256 arrivalTime, bytes32 carrierFlightNumber, bytes32 departureYearMonthDay);
     event LogPayoutTransferred(bytes32 bpKey, uint256 claimId, uint256 payoutId, uint256 amount);
     event LogFlightStatusProcessed(RequestId requestId, RiskId riskId, bytes1 status, int256 delayMinutes, uint8 payoutOption);
+    event LogFlightPoliciesProcessed(RiskId riskId, uint8 payoutOption, uint256 policiesProcessed, uint256 policiesRemaining);
 
     // TODO convert error logs to custom errors
-    event LogError(string error, uint256 index, uint256 stored, uint256 calculated);
+    // event LogError(string error, uint256 index, uint256 stored, uint256 calculated);
     event LogPolicyExpired(bytes32 bpKey);
 
     event LogErrorRiskInvalid(RequestId requestId, RiskId riskId);
@@ -85,41 +86,42 @@ contract FlightProduct is
     uint8[6] public WEIGHT_PATTERN = [0, 0, 0, 30, 50, 50];
     uint8 public constant MAX_WEIGHT = 50;
 
+    bool internal _testMode;
+
     // GIF V3 specifics
     NftId internal _defaultBundleNftId;
-
-    // TODO add product (base contract) functions
-    // - getOracleNftId(idx)
-    // - getDistributionNftId() 
-    // - getPoolNftId()
-    NftId internal _oracleNftId; // TODO refactor to getOracleNftId(0)
+    NftId internal _oracleNftId;
     // solhint-enable
 
-    FlightMessageVerifier internal _flightMessageVerifier;
-
 
     struct FlightRisk {
         Str flightData; // example: "LX 180 ZRH BKK 20241104"
         Timestamp departureTime;
+        // this field contains static data required by the frontend and is not directly used by the product
+        string departureTimeLocal; // example "2024-10-14T10:10:00.000 Asia/Seoul"
         Timestamp arrivalTime; 
+        // this field contains static data required by the frontend and is not directly used by the product
+        string arrivalTimeLocal; // example "2024-10-14T10:10:00.000 Asia/Seoul"
         Amount sumOfSumInsuredAmounts;
         // uint256 premiumMultiplier; // what is this? UFixed?
         // uint256 weight; // what is this? UFixed?
         bytes1 status; // 'L'ate, 'C'ancelled, 'D'iverted, ...
         int256 delayMinutes;
+        uint8 payoutOption;
+        Timestamp statusUpdatedAt;
     }
 
     struct ApplicationData {
         Str flightData;
         Timestamp departureTime;
+        string departureTimeLocal;
         Timestamp arrivalTime;
+        string arrivalTimeLocal;
         Amount premiumAmount;
         uint256[6] statistics;
-        uint8 v;
-        bytes32 r; 
-        bytes32 s;
     }
 
+
     struct PermitData {
         address owner;
         address spender;
@@ -135,8 +137,7 @@ contract FlightProduct is
         address registry,
         NftId instanceNftid,
         string memory componentName,
-        IAuthorization authorization,
-        FlightMessageVerifier messageVerifier
+        IAuthorization authorization
     )
     {
         address initialOwner = msg.sender;
@@ -147,8 +148,6 @@ contract FlightProduct is
             componentName,
             authorization,
             initialOwner);
-
-        _flightMessageVerifier = messageVerifier;
     }
 
     //--- external functions ------------------------------------------------//
@@ -197,62 +196,37 @@ contract FlightProduct is
         )
     {
         // process permit data
-        processPermit(permit);
+        _processPermit(permit);
 
         // create policy
         address policyHolder = permit.owner;
         (
             riskId,
             policyNftId
-        ) = createPolicy(
+        ) = _createPolicy(
             policyHolder,
             application.flightData,
             application.departureTime,
+            application.departureTimeLocal,
             application.arrivalTime,
+            application.arrivalTimeLocal,
             application.premiumAmount,
             application.statistics);
-            // application.v,
-            // application.r,
-            // application.s);
     }
 
 
-    function processPermit(
-        PermitData memory permit
-    )
-        public
-        virtual
-        restricted()
-    {
-        address tokenAddress = address(getToken());
-
-        // process permit data
-        ERC20Permit(tokenAddress).permit(
-            permit.owner, 
-            permit.spender, 
-            permit.value, 
-            permit.deadline, 
-            permit.v, 
-            permit.r, 
-            permit.s); 
-    }
-
-
-    function createPolicy(
+    function _createPolicy(
         address policyHolder,
         Str flightData, 
         Timestamp departureTime,
+        string memory departureTimeLocal,
         Timestamp arrivalTime,
+        string memory arrivalTimeLocal,
         Amount premiumAmount,
         uint256[6] memory statistics
-        // signature fields
-        // uint8 v, 
-        // bytes32 r, 
-        // bytes32 s
     )
-        public
+        internal
         virtual
-        restricted()
         returns (
             RiskId riskId,
             NftId policyNftId
@@ -260,20 +234,20 @@ contract FlightProduct is
     {
         // checks
         // disabled for now - using rbac for security
-        // FlightLib.checkApplicationDataAndSignature(
-        //     this,
-        //     flightData,
-        //     departureTime,
-        //     arrivalTime,
-        //     premiumAmount,
-        //     statistics,
-        //     v, r, s);
+        FlightLib.checkApplicationData(
+            this,
+            flightData,
+            departureTime,
+            arrivalTime,
+            premiumAmount);
 
         (riskId, policyNftId) = _prepareApplication(
             policyHolder, 
             flightData,
             departureTime,
+            departureTimeLocal,
             arrivalTime,
+            arrivalTimeLocal,
             premiumAmount,
             statistics);
 
@@ -301,49 +275,6 @@ contract FlightProduct is
     }
 
 
-    function _prepareApplication(
-        address policyHolder,
-        Str flightData, 
-        Timestamp departureTime,
-        Timestamp arrivalTime,
-        Amount premiumAmount,
-        uint256[6] memory statistics
-    )
-        internal
-        virtual
-        returns (
-            RiskId riskId,
-            NftId policyNftId
-        )
-    {
-        Amount[5] memory payoutAmounts;
-        Amount sumInsuredAmount;
-
-        (
-            riskId, 
-            payoutAmounts,
-            sumInsuredAmount
-        ) = _createRiskAndPayoutAmounts(
-            flightData,
-            departureTime,
-            arrivalTime,
-            premiumAmount,
-            statistics);
-
-        policyNftId = _createApplication(
-            policyHolder, 
-            riskId, 
-            sumInsuredAmount,
-            premiumAmount,
-            LIFETIME,
-            _defaultBundleNftId, 
-            ReferralLib.zero(), 
-            abi.encode(
-                premiumAmount,
-                payoutAmounts)); // application data
-    }
-
-
     /// @dev Callback for flight status oracle.
     /// Function may only be alled by oracle service.
     function flightStatusCallback(
@@ -387,9 +318,27 @@ contract FlightProduct is
             maxPoliciesToProcess);
     }    
 
+
+    /// @dev Manual fallback function for product owner.
+    function processPayoutsAndClosePolicies(
+        RiskId riskId, 
+        uint8 maxPoliciesToProcess
+    )
+        external
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        _processPayoutsAndClosePolicies(
+            riskId, 
+            maxPoliciesToProcess);
+    }
+
+
     //--- owner functions ---------------------------------------------------//
 
-    /// @dev Call after product registration with the instance, when the product token/tokenhandler is available
+    /// @dev Call after product registration with the instance
+    /// when the product token/tokenhandler is available
     function completeSetup()
         external
         virtual
@@ -407,6 +356,8 @@ contract FlightProduct is
 
 
     function setDefaultBundle(NftId bundleNftId) external restricted() onlyOwner() { _defaultBundleNftId = bundleNftId; }
+    function setTestMode(bool testMode) external restricted() onlyOwner() { _testMode = testMode; }
+
     function approveTokenHandler(IERC20Metadata token, Amount amount) external restricted() onlyOwner() { _approveTokenHandler(token, amount); }
     function setLocked(bool locked) external onlyOwner() { _setLocked(locked); }
     function setWallet(address newWallet) external restricted() onlyOwner() { _setWallet(newWallet); }
@@ -414,7 +365,6 @@ contract FlightProduct is
 
     //--- view functions ----------------------------------------------------//
 
-
     function calculateNetPremium(
         Amount, // sumInsuredAmount: not used in this product
         RiskId, // riskId: not used in this product
@@ -430,31 +380,87 @@ contract FlightProduct is
     }
 
 
-    function getFlightMessageVerifier()
-        external
-        view
-        returns (FlightMessageVerifier)
+    function getOracleNftId() public view returns (NftId oracleNftId) { return _oracleNftId; }
+    function isTestMode() public view returns (bool) { return _testMode; }
+    function decodeFlightRiskData(bytes memory data) public pure returns (FlightRisk memory) { return abi.decode(data, (FlightRisk)); }
+
+    //--- internal functions ------------------------------------------------//
+
+
+    function _processPermit(
+        PermitData memory permit
+    )
+        internal
+        virtual
+        restricted()
     {
-        return _flightMessageVerifier;
+        address tokenAddress = address(getToken());
+
+        // process permit data
+        ERC20Permit(tokenAddress).permit(
+            permit.owner, 
+            permit.spender, 
+            permit.value, 
+            permit.deadline, 
+            permit.v, 
+            permit.r, 
+            permit.s); 
     }
 
 
-    function getOracleNftId()
-        public
-        view
-        returns (NftId oracleNftId)
-    { 
-        return _oracleNftId;
-    }
+    function _prepareApplication(
+        address policyHolder,
+        Str flightData, 
+        Timestamp departureTime,
+        string memory departureTimeLocal,
+        Timestamp arrivalTime,
+        string memory arrivalTimeLocal,
+        Amount premiumAmount,
+        uint256[6] memory statistics
+    )
+        internal
+        virtual
+        returns (
+            RiskId riskId,
+            NftId policyNftId
+        )
+    {
+        Amount[5] memory payoutAmounts;
+        Amount sumInsuredAmount;
 
+        (
+            riskId, 
+            payoutAmounts,
+            sumInsuredAmount
+        ) = _createRiskAndPayoutAmounts(
+            flightData,
+            departureTime,
+            departureTimeLocal,
+            arrivalTime,
+            arrivalTimeLocal,
+            premiumAmount,
+            statistics);
 
-    //--- internal functions ------------------------------------------------//
+        policyNftId = _createApplication(
+            policyHolder, 
+            riskId, 
+            sumInsuredAmount,
+            premiumAmount,
+            LIFETIME,
+            _defaultBundleNftId, 
+            ReferralLib.zero(), 
+            abi.encode(
+                premiumAmount,
+                payoutAmounts)); // application data
+    }
 
 
     function _createRiskAndPayoutAmounts(
         Str flightData, 
         Timestamp departureTime,
+        string memory departureTimeLocal,
         Timestamp arrivalTime,
+        string memory arrivalTimeLocal,
         Amount premiumAmount,
         uint256[6] memory statistics
     )
@@ -480,7 +486,9 @@ contract FlightProduct is
         riskId = _checkAndUpdateFlightRisk(
             flightData,
             departureTime,
+            departureTimeLocal,
             arrivalTime,
+            arrivalTimeLocal,
             sumInsuredAmount,
             weight);
     }
@@ -489,7 +497,9 @@ contract FlightProduct is
     function _checkAndUpdateFlightRisk(
         Str flightData,
         Timestamp departureTime,
+        string memory departureTimeLocal,
         Timestamp arrivalTime,
+        string memory arrivalTimeLocal,
         Amount sumInsuredAmount,
         uint256 weight
     )
@@ -504,7 +514,9 @@ contract FlightProduct is
             getNftId(), 
             flightData, 
             departureTime, 
-            arrivalTime);
+            departureTimeLocal,
+            arrivalTime,
+            arrivalTimeLocal);
 
         // create risk, if new
         if (!exists) {
@@ -541,16 +553,25 @@ contract FlightProduct is
         ) = FlightLib.getFlightRisk(reader, getNftId(), riskId);
 
         if (!exists) {
+            // TODO decide to switch from log to error
             emit LogErrorRiskInvalid(requestId, riskId);
             return;
+        } else {
+            // update status, if not yet set
+            if (flightRisk.statusUpdatedAt.eqz()) {
+                flightRisk.status = status;
+                flightRisk.delayMinutes = delayMinutes;
+                flightRisk.payoutOption = FlightLib.checkAndGetPayoutOption(
+                    requestId, riskId, status, delayMinutes);
+                flightRisk.statusUpdatedAt = TimestampLib.current();
+
+                _updateRisk(riskId, abi.encode(flightRisk));
+            }
+            // TODO revert in else case?
         }
 
-        uint8 payoutOption = FlightLib.checkAndGetPayoutOption(
-            requestId, riskId, status, delayMinutes);
-
-        _processPayoutsAndClosePolicies(
+        (,, uint8 payoutOption) = _processPayoutsAndClosePolicies(
             riskId, 
-            payoutOption, 
             maxPoliciesToProcess);
 
         // logging
@@ -558,22 +579,32 @@ contract FlightProduct is
     }
 
 
-    // REMARK caller responsible to check that risk exists.
     function _processPayoutsAndClosePolicies(
         RiskId riskId, 
-        uint8 payoutOption,
         uint8 maxPoliciesToProcess
     )
         internal
         virtual
+        returns (
+            bool riskExists, 
+            bool statusAvailable,
+            uint8 payoutOption
+        )
     {
         // determine numbers of policies to process
         InstanceReader reader = _getInstanceReader();
+        (riskExists, statusAvailable, payoutOption) = FlightLib.getPayoutOption(reader, getNftId(), riskId);
+
+        // return with default values if risk does not exist or status is not yet available
+        if (!riskExists || !statusAvailable) {
+            return (riskExists, statusAvailable, payoutOption);
+        }
+
         uint256 policiesToProcess = reader.policiesForRisk(riskId);
-        policiesToProcess = policiesToProcess < maxPoliciesToProcess ? policiesToProcess : maxPoliciesToProcess;
+        uint256 policiesProcessed = policiesToProcess < maxPoliciesToProcess ? policiesToProcess : maxPoliciesToProcess;
 
         // go trough policies
-        for (uint256 i = 0; i < policiesToProcess; i++) {
+        for (uint256 i = 0; i < policiesProcessed; i++) {
             NftId policyNftId = reader.getPolicyForRisk(riskId, i);
 
             // create payout (if any)
@@ -592,6 +623,9 @@ contract FlightProduct is
             _expire(policyNftId, TimestampLib.current());
             _close(policyNftId);
         }
+
+        // logging
+        emit LogFlightPoliciesProcessed(riskId, payoutOption, policiesProcessed, policiesToProcess - policiesProcessed);
     }
 
 
@@ -622,7 +656,7 @@ contract FlightProduct is
         internal
         initializer
     {
-        _initializeBasicProduct(
+        __Product_init(
             registry,
             instanceNftId,
             componentName,

package/contracts/examples/flight/FlightProductAuthorization.sol

@@ -3,19 +3,42 @@ pragma solidity ^0.8.20;
 
 import {IAccess} from "../../../contracts/authorization/IAccess.sol";
 
+import {AccessAdminLib} from "../../authorization/AccessAdminLib.sol";
 import {BasicProductAuthorization} from "../../product/BasicProductAuthorization.sol";
 import {FlightProduct} from "./FlightProduct.sol";
 import {ORACLE} from "../../../contracts/type/ObjectType.sol";
-import {PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+import {RoleId, ADMIN_ROLE, PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
 
 
 contract FlightProductAuthorization
     is BasicProductAuthorization
 {
 
-    constructor(string memory poolName)
-        BasicProductAuthorization(poolName)
-    {}
+    uint64 public constant STATISTICS_PROVIDER_ROLE_IDX = 1; // 1st custom role for flight product
+    string public constant STATISTICS_PROVIDER_ROLE_NAME = "StatisticsProviderRole";
+    RoleId public STATISTICS_PROVIDER_ROLE;
+
+
+    constructor(string memory productName)
+        BasicProductAuthorization(productName)
+    { }
+
+
+    function _setupRoles()
+        internal
+        override
+    {
+        STATISTICS_PROVIDER_ROLE = AccessAdminLib.getCustomRoleId(STATISTICS_PROVIDER_ROLE_IDX);
+
+        _addRole(
+            STATISTICS_PROVIDER_ROLE,
+            AccessAdminLib.roleInfo(
+                ADMIN_ROLE(),
+                TargetType.Custom,
+                1, // max member count special case: instance nft owner is sole role owner
+                STATISTICS_PROVIDER_ROLE_NAME));
+    }
+
 
     function _setupTargetAuthorizations()
         internal
@@ -28,13 +51,14 @@ contract FlightProductAuthorization
         functions = _authorizeForTarget(getMainTargetName(), getServiceRole(ORACLE()));
         _authorize(functions, FlightProduct.flightStatusCallback.selector, "flightStatusCallback");
 
-        // authorize public role (open access to any account, only allows to lock target)
-        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
-        _authorize(functions, FlightProduct.createPolicy.selector, "createPolicy");
+        // authorize statistics provider role 
+        functions = _authorizeForTarget(getMainTargetName(), STATISTICS_PROVIDER_ROLE);
         _authorize(functions, FlightProduct.createPolicyWithPermit.selector, "createPolicyWithPermit");
 
-        // TODO: only owner
+        // authorize public role (additional authz via onlyOwner)
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
         _authorize(functions, FlightProduct.processFlightStatus.selector, "processFlightStatus");
+        _authorize(functions, FlightProduct.processPayoutsAndClosePolicies.selector, "processPayoutsAndClosePolicies");
         _authorize(functions, FlightProduct.completeSetup.selector, "completeSetup");
         _authorize(functions, FlightProduct.setDefaultBundle.selector, "setDefaultBundle");
         _authorize(functions, FlightProduct.approveTokenHandler.selector, "approveTokenHandler");

package/contracts/instance/InstanceAdmin.sol

@@ -130,7 +130,6 @@ contract InstanceAdmin is
         _createTarget(target, name, TargetType.Instance, true); 
     }
 
-
     /// @dev Initializes the authorization for the specified component.
     /// Important: The component MUST be registered.
     function initializeComponentAuthorization(

package/contracts/instance/InstanceReader.sol

@@ -466,6 +466,12 @@ contract InstanceReader {
     }
 
 
+    /// @dev Returns the role ID for the given index.
+    function getRoleForName(string memory name) public view returns (RoleId roleId, bool exists) {
+        return _instanceAdmin.getRoleForName(name);
+    }
+
+
     /// @dev Returns the role ID for the instance owner role.
     /// This role may be used as a "root" admin role for other custom roles defined for this instance.
     function getInstanceOwnerRole() public pure returns (RoleId roleId) {

package/contracts/registry/RegistryAdmin.sol

@@ -85,7 +85,13 @@ contract RegistryAdmin is
                 registry, 
                 release); 
 
-        _checkAuthorization(authorization, REGISTRY(), release, false, true);
+        AccessAdminLib.checkAuthorization(
+            address(_authorization),
+            authorization, 
+            REGISTRY(), 
+            release, 
+            false, // expectServiceAuthorization
+            false); // checkAlreadyInitialized);
 
         _registry = registry;
         _authorization = IAuthorization(authorization);

package/contracts/registry/ReleaseAdmin.sol

@@ -72,7 +72,14 @@ contract ReleaseAdmin is
                 release);
 
         IServiceAuthorization serviceAuthorization = IServiceAuthorization(authorization);
-        _checkAuthorization(address(serviceAuthorization), RELEASE(), release, true, true);
+        AccessAdminLib.checkAuthorization(
+            address(_authorization),
+            address(serviceAuthorization), 
+            RELEASE(), 
+            release, 
+            true, // expectServiceAuthorization
+            true); // checkAlreadyInitialized);
+
         _serviceAuthorization = serviceAuthorization;
 
         // link nft ownability to registry

package/contracts/shared/IAuthorizedComponent.sol

@@ -0,0 +1,15 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IComponent} from "../shared/IComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
+
+/// @dev component base class
+/// component examples are product, distribution, pool and oracle
+interface IAuthorizedComponent is 
+    IComponent
+{
+    /// @dev returns the initial component authorization specification.
+    function getAuthorization() external view returns (IAuthorization authorization);
+
+}

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.20;
 
 import {Amount} from "../type/Amount.sol";
-import {IComponent} from "../shared/IComponent.sol";
+import {IAuthorizedComponent} from "../shared/IAuthorizedComponent.sol";
 import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {NftId} from "../type/NftId.sol";
@@ -11,7 +11,7 @@ import {ObjectType} from "../type/ObjectType.sol";
 /// @dev component base class
 /// component examples are product, distribution, pool and oracle
 interface IInstanceLinkedComponent is 
-    IComponent
+    IAuthorizedComponent
 {
     error ErrorInstanceLinkedComponentTypeMismatch(ObjectType requiredType, ObjectType objectType);
     error ErrorInstanceLinkedComponentNotProduct(NftId nftId, ObjectType objectType);
@@ -24,7 +24,4 @@ interface IInstanceLinkedComponent is
     /// @dev defines the instance to which this component is linked to
     function getInstance() external view returns (IInstance instance);
 
-    /// @dev returns the initial component authorization specification.
-    function getAuthorization() external view returns (IAuthorization authorization);
-
 }