@etherisc/gif-next 3.0.0-db9ffbc-172 → 3.0.0-dcde6c5-549

package/contracts/examples/crop/CropProduct.sol

@@ -0,0 +1,513 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IComponents} from "../../instance/module/IComponents.sol";
+import {IPolicy} from "../../instance/module/IPolicy.sol";
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {ClaimId} from "../../type/ClaimId.sol";
+import {FeeLib} from "../../type/Fee.sol";
+import {InstanceReader} from "../../instance/InstanceReader.sol";
+import {Location, LocationLib} from "./Location.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} from "../../type/RiskId.sol";
+import {RequestId} from "../../type/RequestId.sol";
+import {Seconds, SecondsLib} from "../../type/Seconds.sol";
+import {Str, StrLib} from "../../type/String.sol";
+import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
+import {UFixed, UFixedLib} from "../../type/UFixed.sol";
+
+
+/// @dev CropProduct implements the crop insurance product.
+contract CropProduct is
+    Product
+{
+
+    // Events
+    event LogCropPolicyCreated(NftId policyNftId);
+
+    // Custom errors
+    error ErrorInvalidId(string id);
+    error ErrorRecordAlreadyExists(string id);
+
+    error ErrorInvalidYear(uint16 year);
+    error ErrorInvalidSeasonStart(string seasonStart);
+    error ErrorInvalidSeasonEnd(string seasonEnd);
+    error ErrorInvalidSeasonDays(uint16 seasonDays);
+
+    error ErrorInvalidSeasonEndAt(Timestamp seasonEndAt);
+
+    error ErrorInvalidSeasonId(string seasonId);
+    error ErrorInvalidLocation(string locationId);
+    error ErrorInvalidCrop(string crop);
+
+    error ErrorInvalidPolicyHolder(); 
+    error ErrorInvalidRiskId(RiskId riskId);
+    error ErrorInvalidActivateAt(Timestamp activateAt);
+    error ErrorInvalidSumInsured(Amount sumInsuredAmount);
+    error ErrorInvalidPremium(Amount premiumAmount);
+
+    error ErrorUndefinedRiskPayout(RiskId riskId);
+
+    // solhint-disable var-name-mixedcase
+    Amount public MIN_PREMIUM;
+    Amount public MAX_PREMIUM;
+    Amount public MIN_SUM_INSURED;
+    Amount public MAX_SUM_INSURED;
+    uint8 public MAX_POLICIES_TO_PROCESS = 1;
+    // solhint-enable var-name-mixedcase
+
+    // Crop insurance specifics
+    uint16 public constant GRACE_PERIOD_DAYS = 60;
+
+    struct Season {
+        uint16 year;
+        Str name;
+        Str seasonStart; // ISO 8601 date
+        Str seasonEnd; // ISO 8601 date
+        uint16 seasonDays;
+    }
+
+    struct CropRisk {
+        Str seasonId;
+        Str locationId;
+        Str crop;
+        Timestamp seasonEndAt;
+        UFixed payoutFactor;
+        bool payoutDefined;
+    }
+
+    // Seasons
+    mapping (Str seasonId => Season season) internal _season;
+    Str [] internal _seasons;
+
+    // Locations
+    mapping(Str locationId => Location location) internal _location;
+
+    // Crop names
+    mapping(Str cropName => bool isValid) internal _validCrop;
+    Str [] internal _crops;
+
+    mapping(Str id => RiskId riskId) internal _riskId;
+
+    // GIF V3 specifics
+    NftId internal _defaultBundleNftId;
+
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        string memory componentName,
+        IAuthorization authorization
+    )
+    {
+        address initialOwner = msg.sender;
+
+        _initialize(
+            registry,
+            instanceNftId,
+            componentName,
+            authorization,
+            initialOwner);
+    }
+
+
+    //--- external risk relatee functions -----------------------------------//
+
+    function createSeason(
+        Str seasonId,
+        uint16 year,
+        Str name,
+        Str seasonStart, // ISO 8601 date, eg "2025-02-18"
+        Str seasonEnd,
+        uint16 seasonDays
+    )
+        external
+        restricted()
+    {
+        // validate input
+        if (seasonId.length() == 0) { revert ErrorInvalidId(seasonId.toString()); }
+        if (_season[seasonId].year > 0) { revert ErrorRecordAlreadyExists(seasonId.toString()); }
+        if (year < 2023 || year > 2035 ) { revert ErrorInvalidYear(year); }
+        if (seasonStart.length() != 10 ) { revert ErrorInvalidSeasonStart(seasonStart.toString()); }
+        if (seasonEnd.length() != 10 ) { revert ErrorInvalidSeasonEnd(seasonEnd.toString()); }
+        if (seasonDays < 50 || seasonDays > 250 ) { revert ErrorInvalidSeasonDays(seasonDays); }
+
+        _seasons.push(seasonId);
+        _season[seasonId] = Season({
+            year: year,
+            name: name,
+            seasonStart: seasonStart,
+            seasonEnd: seasonEnd,
+            seasonDays: seasonDays
+        });
+    }
+
+    function createLocation(
+        Str locationId,
+        int32 latitude,
+        int32 longitude
+    )
+        external
+        restricted()
+        returns (Location location)
+    {
+        // validate input
+        if (locationId.length() == 0) { revert ErrorInvalidId(locationId.toString()); }
+        // TODO add function location.isUndefined()
+        // if (!_location[locationId].isUndefined()) { revert ErrorRecordAlreadyExists(locationId.toString()); }
+
+        location = LocationLib.toLocation(latitude, longitude);
+        _location[locationId] = location;
+    }
+
+    function createCrop(Str cropName) external restricted() {
+        if (cropName.length() == 0) { revert ErrorInvalidId(cropName.toString()); }
+        if (_validCrop[cropName]) { revert ErrorRecordAlreadyExists(cropName.toString()); }
+
+        _crops.push(cropName);
+        _validCrop[cropName] = true;
+    }
+
+    function createRisk(
+        Str id,
+        Str seasonId,
+        Str locationId,
+        Str crop,
+        Timestamp seasonEndAt
+    )
+        external
+        restricted()
+        returns (RiskId riskId)
+    {
+        // validate input
+        if (id.length() == 0) { revert ErrorInvalidId(id.toString()); }
+        if (_season[seasonId].year == 0) { revert ErrorInvalidSeasonId(seasonId.toString()); }
+        // TODO add function location.isUndefined()
+        // if (_locations[locationId].isUndefined()) { revert ErrorInvalidLocation(locationId.toString()); }
+        if (!_validCrop[crop]) { revert ErrorInvalidCrop(crop.toString()); }
+        if (seasonEndAt < TimestampLib.current()) { revert ErrorInvalidSeasonEndAt(seasonEndAt); }
+
+        // create risk, if new
+        bytes32 riskKey = keccak256(abi.encode(id));
+        CropRisk memory cropRisk = CropRisk({
+            seasonId: seasonId,
+            locationId: locationId,
+            crop: crop,
+            seasonEndAt: seasonEndAt,
+            payoutFactor: UFixedLib.zero(),
+            payoutDefined: false
+        });
+
+        riskId = _createRisk(riskKey, abi.encode(cropRisk));
+        _riskId[id] = riskId;
+    }
+
+
+    function updatePayoutFactor(
+        RiskId riskId,
+        UFixed payoutFactor
+    )
+        external
+        restricted()
+    {
+        (bool exists, CropRisk memory cropRisk) = getRisk(riskId);
+        if (!exists) { revert ErrorInvalidRiskId(riskId); }
+
+        cropRisk.payoutFactor = payoutFactor;
+        cropRisk.payoutDefined = true;
+
+        _updateRisk(riskId, abi.encode(cropRisk));
+    }
+
+    //--- external policy related functions ---------------------------------//
+
+    /// @dev Creates a policy.
+    function createPolicy(
+        address policyHolder,
+        RiskId riskId,
+        Timestamp activateAt,
+        Amount sumInsuredAmount,
+        Amount premiumAmount
+    )
+        external
+        virtual
+        restricted()
+        returns (NftId policyNftId)
+    {
+        // validate input
+        if (policyHolder == address(0)) { revert ErrorInvalidPolicyHolder(); }
+
+        (bool exists, CropRisk memory cropRisk) = getRisk(riskId);
+        if (!exists) { revert ErrorInvalidRiskId(riskId); }
+
+        if (activateAt < TimestampLib.current()) { revert ErrorInvalidActivateAt(activateAt); }
+        if (activateAt > cropRisk.seasonEndAt) { revert ErrorInvalidActivateAt(activateAt); }
+        if (sumInsuredAmount < MIN_SUM_INSURED || sumInsuredAmount > MAX_SUM_INSURED) { revert ErrorInvalidSumInsured(sumInsuredAmount); }
+        if (premiumAmount < MIN_PREMIUM || premiumAmount > MAX_PREMIUM) { revert ErrorInvalidPremium(premiumAmount); }
+
+        // calculate policy lifetime
+        uint96 seasonDays = _season[cropRisk.seasonId].seasonDays;
+        Seconds lifetime = SecondsLib.toSeconds((seasonDays + GRACE_PERIOD_DAYS) * 24 * 3600);
+
+        // create application
+        policyNftId = _createApplication(
+            policyHolder, 
+            riskId, 
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            _defaultBundleNftId, 
+            ReferralLib.zero(), 
+            abi.encode(premiumAmount)); // application data: premium amount, see calculateNetPremium
+
+        // underwrite and activate policy
+        _createPolicy(
+            policyNftId, 
+            activateAt, 
+            premiumAmount); // max premium amount
+
+        _collectPremium(
+            policyNftId, 
+            TimestampLib.zero()); // keep activation timestamp
+        
+        emit LogCropPolicyCreated(policyNftId);
+    }
+
+
+    function processPolicy(NftId policyNftId)
+        external
+        restricted()
+    {
+        _processPolicy(policyNftId);
+    }
+
+    function processPoliciesForRisk(
+        RiskId riskId, 
+        uint256 maxPoliciesToProcess
+    )
+        external
+        virtual
+        returns (
+            bool success,
+            bool riskExists, 
+            bool payoutDefined,
+            uint256 policiesProcessed
+        )
+    {
+        // determine numbers of policies to process
+        CropRisk memory cropRisk;
+        (riskExists, cropRisk) = getRisk(riskId);
+
+        // return if risk does not exist or payout is not defined yet
+        if (!riskExists) { return (false, false, false, 0); }
+        if (!cropRisk.payoutDefined)  { return (false, true, false, 0); }
+
+        InstanceReader reader = _getInstanceReader();
+        uint256 policiesToProcess = reader.policiesForRisk(riskId);
+        policiesProcessed = policiesToProcess < maxPoliciesToProcess ? policiesToProcess : maxPoliciesToProcess;
+
+        // go through policies
+        for (uint256 i = 0; i < policiesProcessed; i++) {
+            NftId policyNftId = reader.getPolicyForRisk(riskId, i);
+            _processPolicy(policyNftId);
+        }
+
+        return (true, true, true, policiesProcessed);
+    }
+
+
+    //--- owner functions ---------------------------------------------------//
+
+    /// @dev Call after product registration with the instance
+    /// when the product token/tokenhandler is available
+    function setConstants(
+        Amount minPremium,
+        Amount maxPremium,
+        Amount minSumInsured,
+        Amount maxSumInsured,
+        uint8 maxPoliciesToProcess
+    )
+        external
+        virtual
+        restricted()
+        onlyOwner()
+    {
+        MIN_PREMIUM = minPremium; 
+        MAX_PREMIUM = maxPremium; 
+        MIN_SUM_INSURED = minSumInsured;
+        MAX_SUM_INSURED = maxSumInsured;
+        MAX_POLICIES_TO_PROCESS = maxPoliciesToProcess;
+    }
+
+    function setDefaultBundle(NftId bundleNftId) external restricted() onlyOwner() { _defaultBundleNftId = bundleNftId; }
+
+    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); }
+
+    //--- unpermissioned functions ------------------------------------------//
+
+    //--- view functions ----------------------------------------------------//
+
+    function getSeason(Str seasonId) public view returns (Season memory season) { return _season[seasonId]; }
+    function getLocation(Str locationId) public view returns (Location location) { return _location[locationId]; }
+
+    function seasons() public view returns (Str [] memory) { return _seasons; }
+    function crops() public view returns (Str [] memory) { return _crops; }
+
+    function getRiskId(Str id)
+        external
+        view
+        returns (RiskId riskId)
+    { 
+        return _riskId[id]; 
+    }
+
+    function getRisk(RiskId riskId)
+        public
+        view
+        returns (
+            bool exists,
+            CropRisk memory cropRisk
+        )
+    {
+        // check if risk exists
+        InstanceReader reader = _getInstanceReader();
+        exists = reader.isProductRisk(getNftId(), riskId);
+
+        // get risk data if risk exists
+        if (exists) {
+            cropRisk = abi.decode(
+                reader.getRiskInfo(riskId).data, 
+                (CropRisk));
+        }
+    }
+
+    function calculateNetPremium(
+        Amount, // sumInsuredAmount: not used in this product
+        RiskId, // riskId: not used in this product
+        Seconds, // lifetime: not used in this product, a flight is a one time risk
+        bytes memory applicationData // holds the premium amount the customer is willing to pay
+    )
+        external
+        virtual override
+        view 
+        returns (Amount netPremiumAmount)
+    {
+        (netPremiumAmount) = abi.decode(applicationData, (Amount));
+    }
+
+
+    function calculatePayout(
+        IPolicy.PolicyInfo memory info,
+        CropRisk memory cropRisk
+    )
+        public
+        pure
+        returns (Amount payoutAmount)
+    {
+        Amount sumInsuredAmount = info.sumInsuredAmount;
+        UFixed payoutFactor = cropRisk.payoutFactor;
+
+        if (payoutFactor.eqz()) {
+            return AmountLib.zero();
+        }
+
+        return sumInsuredAmount.multiplyWith(payoutFactor);
+    }
+
+    function toStr(string memory str) public pure returns (Str) {
+        return StrLib.toStr(str);
+    }
+
+    function toString(Str str) public pure returns (string memory) {
+        return StrLib.toString(str);
+    }
+
+    //--- internal functions ------------------------------------------------//
+
+
+    function _processPolicy(NftId policyNftId)
+        internal
+        virtual
+    {
+        IPolicy.PolicyInfo memory info = _getInstanceReader().getPolicyInfo(policyNftId);
+        (bool exists, CropRisk memory cropRisk) = getRisk(info.riskId);
+        if (!exists) { revert ErrorInvalidRiskId(info.riskId); }
+        if (!cropRisk.payoutDefined) { revert ErrorUndefinedRiskPayout(info.riskId); }
+
+        // create claim/payout (if applicable), then expire and close policy
+        _handlePayout(policyNftId, info, cropRisk); 
+        _expire(policyNftId, TimestampLib.current());
+        _close(policyNftId);
+    }
+
+
+    function _handlePayout(
+        NftId policyNftId,
+        IPolicy.PolicyInfo memory info,
+        CropRisk memory cropRisk
+    )
+        internal
+    {
+        Amount payoutAmount = calculatePayout(info, cropRisk);
+
+        // if payout amount > 0: create and process claim and payout
+        if (payoutAmount.eqz()) {
+            return;
+        }
+
+        // create confirmed claim
+        ClaimId claimId = _submitClaim(policyNftId, payoutAmount, "");
+        _confirmClaim(policyNftId, claimId, payoutAmount, "");
+
+        // create and execute payout
+        PayoutId payoutId = _createPayout(policyNftId, claimId, payoutAmount, "");
+        _processPayout(policyNftId, payoutId);
+    }
+
+
+    function _initialize(
+        address registry,
+        NftId instanceNftId,
+        string memory componentName,
+        IAuthorization authorization,
+        address initialOwner
+    )
+        internal
+        initializer()
+    {
+        __Product_init(
+            registry,
+            instanceNftId,
+            componentName,
+            IComponents.ProductInfo({
+                isProcessingFundedClaims: false,
+                isInterceptingPolicyTransfers: false,
+                hasDistribution: false,
+                expectedNumberOfOracles: 0,
+                numberOfOracles: 0,
+                poolNftId: NftIdLib.zero(),
+                distributionNftId: NftIdLib.zero(),
+                oracleNftId: new NftId[](0)
+            }), 
+            IComponents.FeeInfo({
+                productFee: FeeLib.zero(),
+                processingFee: FeeLib.zero(),
+                distributionFee: FeeLib.zero(),
+                minDistributionOwnerFee: FeeLib.zero(),
+                poolFee: FeeLib.zero(),
+                stakingFee: FeeLib.zero(),
+                performanceFee: FeeLib.zero()
+            }),
+            authorization,
+            initialOwner);
+    }
+}

package/contracts/examples/crop/CropProductAuthorization.sol

@@ -0,0 +1,69 @@
+// SPDX-License-Identifier: Apache-2.0
+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 {CropProduct} from "./CropProduct.sol";
+import {RoleId, ADMIN_ROLE, PUBLIC_ROLE} from "../../../contracts/type/RoleId.sol";
+
+
+contract CropProductAuthorization
+    is BasicProductAuthorization
+{
+
+    uint64 public constant PRODUCT_OPERATOR_ROLE_IDX = 1; // 1st custom role for flight product
+    string public constant PRODUCT_OPERATOR_ROLE_NAME = "ProductOperatorRole";
+    // solhint-disable-next-line var-name-mixedcase
+    RoleId public PRODUCT_OPERATOR_ROLE;
+
+
+    constructor(string memory productName)
+        BasicProductAuthorization(productName)
+    { }
+
+
+    function _setupRoles()
+        internal
+        override
+    {
+        PRODUCT_OPERATOR_ROLE = AccessAdminLib.getCustomRoleId(PRODUCT_OPERATOR_ROLE_IDX);
+
+        _addRole(
+            PRODUCT_OPERATOR_ROLE,
+            AccessAdminLib.roleInfo(
+                ADMIN_ROLE(),
+                TargetType.Custom,
+                100, // max member count
+                PRODUCT_OPERATOR_ROLE_NAME));
+    }
+
+
+    function _setupTargetAuthorizations()
+        internal
+        virtual override
+    {
+        super._setupTargetAuthorizations();
+        IAccess.FunctionInfo[] storage functions;
+
+        // authorize product operator role 
+        functions = _authorizeForTarget(getMainTargetName(), PRODUCT_OPERATOR_ROLE);
+        _authorize(functions, CropProduct.createSeason.selector, "createSeason");
+        _authorize(functions, CropProduct.createLocation.selector, "createLocation");
+        _authorize(functions, CropProduct.createCrop.selector, "createCrop");
+        _authorize(functions, CropProduct.createRisk.selector, "createRisk");
+        _authorize(functions, CropProduct.createPolicy.selector, "createPolicy");
+        _authorize(functions, CropProduct.updatePayoutFactor.selector, "updatePayoutFactor"); 
+        _authorize(functions, CropProduct.processPolicy.selector, "processPolicy");
+
+        // authorize public role (additional authz via onlyOwner)
+        functions = _authorizeForTarget(getMainTargetName(), PUBLIC_ROLE());
+        _authorize(functions, CropProduct.setDefaultBundle.selector, "setDefaultBundle");
+        _authorize(functions, CropProduct.setConstants.selector, "setConstants");
+        _authorize(functions, CropProduct.approveTokenHandler.selector, "approveTokenHandler");
+        _authorize(functions, CropProduct.setLocked.selector, "setLocked");
+        _authorize(functions, CropProduct.setWallet.selector, "setWallet");
+    }
+}
+

package/contracts/examples/crop/Location.sol

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+type Location is uint64;
+
+using {
+    LocationLib.latitude,
+    LocationLib.longitude
+} for Location global;
+
+library LocationLib {
+
+    error ErrorLatitudeInvalid(int32 amount);
+    error ErrorLongitudeInvalid(int32 amount);
+
+    int32 public constant LATITUDE_MIN = -90000000;
+    int32 public constant LATITUDE_MAX = 90000000;
+    int32 public constant LONGITUDE_MIN = -180000000;
+    int32 public constant LONGITUDE_MAX = 180000000;
+
+    // Constants for bit manipulation
+    int64 public constant LATITUDE_MASK = int64(0x7FFFFFF);
+    int64 public constant LONGITUDE_MASK = int64(0xFFFFFFF);
+
+    function zero() public pure returns (Location) {
+        return Location.wrap(0);
+    }
+
+    function toLocation(int32 latitude, int32 longitude) public pure returns (Location) {
+        if (latitude < LATITUDE_MIN || latitude > LATITUDE_MAX) revert ErrorLatitudeInvalid(latitude);
+        if (longitude < LONGITUDE_MIN || longitude > LONGITUDE_MAX) revert ErrorLongitudeInvalid(longitude);
+        
+        uint32 latPacked = uint32(latitude);
+        uint32 longPacked = uint32(longitude);   
+        // uint64 packed = (uint64(latPacked) << 32) | uint64(longPacked);
+        return Location.wrap((uint64(latPacked) << 32) | uint64(longPacked));
+    }
+
+    function latitude(Location location) public pure returns (int32) {
+        return int32(uint32(Location.unwrap(location) >> 32));
+    }
+
+    function longitude(Location location) public pure returns (int32) {
+        return int32(uint32(Location.unwrap(location) & 0xFFFFFFFF));
+    }
+
+    function decimals() public pure returns (uint8) {
+        return uint8(6);
+    }
+}