@etherisc/gif-next 0.0.2-d63a6a1-078 → 0.0.2-d6609af-567

package/contracts/examples/unpermissioned/SimplePool.sol

@@ -0,0 +1,76 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {BasicPool} from "../../pool/BasicPool.sol";
+import {BasicPoolAuthorization} from "../../pool/BasicPoolAuthorization.sol";
+import {Fee} from "../../type/Fee.sol";
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {NftId} from "../../type/NftId.sol";
+import {Seconds} from "../../type/Timestamp.sol";
+import {UFixed} from "../../type/UFixed.sol";
+
+contract SimplePool is
+    BasicPool
+{
+    
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        address token,
+        IAuthorization authorization,
+        address initialOwner
+    ) 
+    {
+        initialize(
+            registry,
+            instanceNftId,
+            token,
+            authorization,
+            initialOwner
+        );
+    }
+
+    function initialize(
+        address registry,
+        NftId instanceNftId,
+        address token,
+        IAuthorization authorization,
+        address initialOwner
+    )
+        public
+        virtual
+        initializer()
+    {
+        _initializeBasicPool(
+            registry,
+            instanceNftId,
+            authorization,
+            token,
+            "SimplePool",
+            initialOwner);
+    }
+
+    function createBundle(
+        Fee memory fee,
+        uint256 initialAmount,
+        Seconds lifetime,
+        bytes calldata filter
+    )
+        external
+        virtual 
+        returns(NftId bundleNftId, uint256 netStakedAmountInt)
+    {
+        address owner = msg.sender;
+        Amount netStakedAmount;
+        bundleNftId = _createBundle(
+            owner,
+            fee,
+            lifetime,
+            filter
+        );
+        netStakedAmount = _stake(bundleNftId, AmountLib.toAmount(initialAmount));
+        netStakedAmountInt = netStakedAmount.toInt();
+    }
+
+}

package/contracts/examples/unpermissioned/SimpleProduct.sol

@@ -0,0 +1,351 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Amount, AmountLib} from "../../type/Amount.sol";
+import {BasicProduct} from "../../product/BasicProduct.sol";
+import {ClaimId} from "../../type/ClaimId.sol";
+import {IAuthorization} from "../../authorization/IAuthorization.sol";
+import {IOracleService} from "../../oracle/IOracleService.sol";
+import {ORACLE} from "../../type/ObjectType.sol";
+import {NftId} from "../../type/NftId.sol";
+import {PayoutId} from "../../type/PayoutId.sol";
+import {ReferralId} from "../../type/Referral.sol";
+import {RequestId} from "../../type/RequestId.sol";
+import {RiskId} from "../../type/RiskId.sol";
+import {Seconds} from "../../type/Seconds.sol";
+import {SimpleOracle} from "./SimpleOracle.sol";
+import {StateId} from "../../type/StateId.sol";
+import {Timestamp, TimestampLib} from "../../type/Timestamp.sol";
+
+uint64 constant SPECIAL_ROLE_INT = 11111;
+
+contract SimpleProduct is 
+    BasicProduct
+{
+
+    event LogSimpleProductRequestAsyncFulfilled(RequestId requestId, string responseText, uint256 responseDataLength);
+    event LogSimpleProductRequestSyncFulfilled(RequestId requestId, string responseText, uint256 responseDataLength);
+
+    error ErrorSimpleProductRevertedWhileProcessingResponse(RequestId requestId);
+
+    IOracleService private _oracleService;
+
+    constructor(
+        address registry,
+        NftId instanceNftid,
+        IAuthorization authorization,
+        address initialOwner,
+        address token,
+        bool isInterceptor,
+        address pool,
+        address distribution
+    )
+    {
+        initialize(
+            registry,
+            instanceNftid,
+            authorization,
+            initialOwner,
+            "SimpleProduct",
+            token,
+            isInterceptor,
+            pool,
+            distribution); 
+    }
+
+
+    function initialize(
+        address registry,
+        NftId instanceNftid,
+        IAuthorization authorization,
+        address initialOwner,
+        string memory name,
+        address token,
+        bool isInterceptor,
+        address pool,
+        address distribution
+    )
+        public
+        virtual
+        initializer()
+    {
+        _initializeBasicProduct(
+            registry,
+            instanceNftid,
+            authorization,
+            initialOwner,
+            name,
+            token,
+            isInterceptor,
+            pool,
+            distribution); 
+
+        _oracleService = IOracleService(_getServiceAddress(ORACLE()));
+    }
+
+    function createRisk(
+        RiskId id,
+        bytes memory data
+    ) public {
+        _createRisk(
+            id,
+            data
+        );
+    }
+
+    function updateRisk(
+        RiskId id,
+        bytes memory data
+    ) public {
+        _updateRisk(
+            id,
+            data
+        );
+    }
+
+    function updateRiskState(
+        RiskId id,
+        StateId state
+    ) public {
+        _updateRiskState(
+            id,
+            state
+        );
+    }
+
+    function createApplication(
+        address applicationOwner,
+        RiskId riskId,
+        uint256 sumInsured,
+        Seconds lifetime,
+        bytes memory applicationData,
+        NftId bundleNftId,
+        ReferralId referralId
+    )
+        public
+        returns (NftId nftId)
+    {
+        Amount sumInsuredAmount = AmountLib.toAmount(sumInsured);
+        Amount premiumAmount = calculatePremium(
+            sumInsuredAmount,
+            riskId,
+            lifetime,
+            applicationData,
+            bundleNftId,
+            referralId);
+
+        return _createApplication(
+            applicationOwner,
+            riskId,
+            sumInsuredAmount,
+            premiumAmount,
+            lifetime,
+            bundleNftId,
+            referralId,
+            applicationData
+        );
+    }
+
+    function createPolicy(
+        NftId applicationNftId,
+        bool requirePremiumPayment,
+        Timestamp activateAt
+    ) public {
+        _createPolicy(applicationNftId, activateAt);
+        if (requirePremiumPayment == true) {
+            _collectPremium(applicationNftId, activateAt);
+        }
+    }
+
+    function decline(
+        NftId policyNftId
+    ) public {
+        _decline(policyNftId);
+    }
+
+    function expire(
+        NftId policyNftId,
+        Timestamp expireAt
+    ) 
+        public 
+        returns (Timestamp)
+    {
+        return _expire(policyNftId, expireAt);
+    }
+
+    function collectPremium(
+        NftId policyNftId,
+        Timestamp activateAt
+    ) public {
+        _collectPremium(policyNftId, activateAt);
+    }
+
+    function activate(
+        NftId policyNftId,
+        Timestamp activateAt
+    ) public {
+        _activate(policyNftId, activateAt);
+    }
+
+    function close(
+        NftId policyNftId
+    ) public {
+        _close(policyNftId);
+    }
+
+    function submitClaim(
+        NftId policyNftId,
+        Amount claimAmount,
+        bytes memory submissionData
+    ) public returns (ClaimId) {
+        return _submitClaim(policyNftId, claimAmount, submissionData);
+    }
+
+    function confirmClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount confirmedAmount,
+        bytes memory processData
+    ) public {
+        _confirmClaim(policyNftId, claimId, confirmedAmount, processData);
+    }
+
+    function declineClaim(
+        NftId policyNftId,
+        ClaimId claimId,
+        bytes memory processData
+    ) public {
+        _declineClaim(policyNftId, claimId, processData);
+    }
+
+    function closeClaim(
+        NftId policyNftId,
+        ClaimId claimId
+    ) public {
+        _closeClaim(policyNftId, claimId);
+    }
+
+    function createPayout(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        bytes memory data
+    ) public returns (PayoutId) {
+        return _createPayout(policyNftId, claimId, amount, data);
+    }
+
+    // TODO add test
+    function createPayoutForBeneficiary(
+        NftId policyNftId,
+        ClaimId claimId,
+        Amount amount,
+        address beneficiary,
+        bytes memory data
+    ) public returns (PayoutId) {
+        return _createPayoutForBeneficiary(policyNftId, claimId, amount, beneficiary, data);
+    }
+
+    function processPayout(
+        NftId policyNftId,
+        PayoutId payoutId
+    ) public {
+        _processPayout(policyNftId, payoutId);
+    }
+
+    function createOracleRequest(
+        NftId oracleNftId,
+        string memory requestText,
+        Timestamp expiryAt,
+        bool synchronous
+    )
+        public
+        // restricted()
+        returns (RequestId)
+    {
+        bytes memory requestData = abi.encode(SimpleOracle.SimpleRequest(
+            synchronous,
+            requestText));
+
+        if (synchronous) {
+            return _oracleService.request(
+                oracleNftId, 
+                requestData, 
+                expiryAt, 
+                "fulfillOracleRequestSync");
+        } else {
+            return _oracleService.request(
+                oracleNftId, 
+                requestData, 
+                expiryAt, 
+                "fulfillOracleRequestAsync");
+        }
+    }
+
+    function cancelOracleRequest(
+        RequestId requestId
+    )
+        public
+        // restricted() // 
+    {
+        _oracleService.cancel(requestId);
+    }
+
+    function fulfillOracleRequestSync(
+        RequestId requestId,
+        bytes memory responseData
+    )
+        public
+        // restricted() // only oracle service
+    {
+        string memory responseText = abi.decode(responseData, (string));
+        emit LogSimpleProductRequestSyncFulfilled(requestId, responseText, bytes(responseText).length);
+    }
+
+    function fulfillOracleRequestAsync(
+        RequestId requestId,
+        bytes memory responseData
+    )
+        public
+        // restricted() // only oracle service
+    {
+        SimpleOracle.SimpleResponse memory response = abi.decode(
+            responseData, (SimpleOracle.SimpleResponse));
+
+        if (response.revertInCall && response.revertUntil >= TimestampLib.blockTimestamp()) {
+            revert ErrorSimpleProductRevertedWhileProcessingResponse(requestId);
+        }
+
+        emit LogSimpleProductRequestAsyncFulfilled(requestId, response.text, bytes(response.text).length);
+    }
+
+
+    function resend(
+        RequestId requestId
+    )
+        public
+        // restricted() // 
+    {
+        _oracleService.resend(requestId);
+    }
+
+
+    function doSomethingSpecial() 
+        public 
+        restricted()
+        returns (bool) 
+    {
+        return true;
+    }
+
+    function doWhenNotLocked() 
+        public 
+        restricted()
+        returns (bool) 
+    {
+        return true;
+    }
+
+    function getOracleService() public view returns (IOracleService) {
+        return _oracleService;
+    }
+}

package/contracts/instance/BundleSet.sol

@@ -0,0 +1,126 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IInstance} from "./IInstance.sol";
+import {INSTANCE} from "../type/ObjectType.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {IPolicy} from "../instance/module/IPolicy.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {LibNftIdSet} from "../type/NftIdSet.sol";
+import {NftId} from "../type/NftId.sol";
+import {TimestampLib} from "../type/Timestamp.sol";
+
+import {ObjectSet} from "./base/ObjectSet.sol";
+
+contract BundleSet is 
+    ObjectSet
+{
+
+    event LogBundleSetPolicyLinked(NftId bundleNftId, NftId policyNftId);
+    event LogBundleSetPolicyUnlinked(NftId bundleNftId, NftId policyNftId);
+
+    event LogBundleSetBundleAdded(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleUnlocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleLocked(NftId poolNftId, NftId bundleNftId);
+    event LogBundleSetBundleClosed(NftId poolNftId, NftId bundleNftId);
+
+    error ErrorBundleSetPolicyAlreadyActivated(NftId policyNftId);
+    error ErrorBundleSetBundleLocked(NftId bundleNftId, NftId policyNftId);
+    error ErrorBundleSetPolicyWithOpenClaims(NftId policyNftId, uint256 openClaimsCount);
+    error ErrorBundleSetPolicyNotCloseable(NftId policyNftId);
+    error ErrorBundleSetBundleUnknown(NftId bundleNftId);
+    error ErrorBundleSetBundleNotRegistered(NftId bundleNftId);
+
+    mapping(NftId bundleNftId => LibNftIdSet.Set policies) internal _activePolicies;
+
+    /// @dev links a policy to its bundle
+    // to link a policy it MUST NOT yet have been linked
+    function linkPolicy(NftId policyNftId) external restricted() {
+        NftId bundleNftId = _instance.getInstanceReader().getPolicyInfo(policyNftId).bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is unlocked (in active set) and registered with this instance
+        if (!_isActive(poolNftId, bundleNftId)) {
+            revert ErrorBundleSetBundleLocked(bundleNftId, policyNftId);
+        }
+
+        LibNftIdSet.add(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleSetPolicyLinked(bundleNftId, policyNftId);
+    }
+
+
+    /// @dev unlinks a policy from its bundle
+    // to unlink a policy it must closable, ie. meet one of the following criterias
+    // - the policy MUST be past its expiry period and it MUST NOT have any open claims
+    // - the policy's payoutAmount MUST be equal to its sumInsuredAmount and MUST NOT have any open claims
+    function unlinkPolicy(NftId policyNftId) external restricted() {
+        IPolicy.PolicyInfo memory policyInfo = _instance.getInstanceReader().getPolicyInfo(policyNftId);
+
+        NftId bundleNftId = policyInfo.bundleNftId;
+        // decision will likely depend on the decision what to check here and what in the service
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure bundle is registered with this instance
+        if (!_contains(poolNftId, bundleNftId)) {
+            revert ErrorBundleSetBundleUnknown(bundleNftId);
+        }
+
+        LibNftIdSet.remove(_activePolicies[bundleNftId], policyNftId);
+        emit LogBundleSetPolicyUnlinked(policyInfo.bundleNftId, policyNftId);
+    }
+
+
+    /// @dev add a new bundle to a pool registerd with this instance
+    // the corresponding pool is fetched via instance reader
+    function add(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+
+        // ensure pool is registered with instance
+        if(poolNftId.eqz()) {
+            revert ErrorBundleSetBundleNotRegistered(bundleNftId);
+        }
+
+        _add(poolNftId, bundleNftId);
+        emit LogBundleSetBundleAdded(poolNftId, bundleNftId);
+    }
+
+
+    /// @dev unlocked (active) bundles are available to collateralize new policies
+    function unlock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _activate(poolNftId, bundleNftId);
+        emit LogBundleSetBundleUnlocked(poolNftId, bundleNftId);
+    }
+
+    /// @dev locked (deactivated) bundles may not collateralize any new policies
+    function lock(NftId bundleNftId) external restricted() {
+        NftId poolNftId = _instance.getInstanceReader().getBundleInfo(bundleNftId).poolNftId;
+        _deactivate(poolNftId, bundleNftId);
+        emit LogBundleSetBundleLocked(poolNftId, bundleNftId);
+    }
+
+    function bundles(NftId poolNftId) external view returns(uint256) {
+        return _objects(poolNftId);
+    }
+
+    function getBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getObject(poolNftId, idx);
+    }
+
+    function activeBundles(NftId poolNftId) external view returns(uint256) {
+        return _activeObjs(poolNftId);
+    }
+
+    function getActiveBundleNftId(NftId poolNftId, uint256 idx) external view returns(NftId bundleNftId) {
+        return _getActiveObject(poolNftId, idx);
+    }
+
+    function activePolicies(NftId bundleNftId) external view returns(uint256) {
+        return LibNftIdSet.size(_activePolicies[bundleNftId]);
+    }
+
+    function getActivePolicy(NftId bundleNftId, uint256 idx) external view returns(NftId policyNftId) {
+        return LibNftIdSet.getElementAt(_activePolicies[bundleNftId], idx);
+    }
+}

package/contracts/instance/IInstance.sol

@@ -1,28 +1,63 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
+import {Amount} from "../type/Amount.sol";
+import {BundleSet} from "./BundleSet.sol";
+import {InstanceAdmin} from "./InstanceAdmin.sol";
 import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceStore} from "./InstanceStore.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ITransferInterceptor} from "../registry/ITransferInterceptor.sol";
+import {RoleId} from "../type/RoleId.sol";
+import {Seconds} from "../type/Seconds.sol";
+import {UFixed} from "../type/UFixed.sol";
+import {VersionPart} from "../type/Version.sol";
 
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
-import {IDistributionService} from "./service/IDistributionService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {ISetup} from "./module/ISetup.sol";
-import {NftId} from "../types/NftId.sol";
 
-interface IInstance is IERC165 {
+interface IInstance is 
+    IRegisterable, 
+    ITransferInterceptor, 
+    IAccessManaged
+{
+    error ErrorInstanceInstanceAdminZero();
+    error ErrorInstanceInstanceAdminAlreadySet(address InstanceAdmin);
+    error ErrorInstanceInstanceAdminAuthorityMismatch(address instanceAuthority);
 
-    function getComponentOwnerService() external view returns (IComponentOwnerService);
-    // TODO: renable these when we have the services
-    // function getDistributionService() external view returns (IDistributionService);
-    // function getProductService() external view returns (IProductService);
-    // function getPoolService() external view returns (IPoolService);
+    error ErrorInstanceBundleSetAlreadySet(address instanceBundleSet);
+    error ErrorInstanceBundleSetInstanceMismatch(address instance);
+    error ErrorInstanceBundleSetAuthorityMismatch(address instanceAuthority);
 
-    function createProductSetup(NftId productNftId, ISetup.ProductSetupInfo memory setup) external;
-    function createDistributionSetup(NftId distributionNftId, ISetup.DistributionSetupInfo memory setup) external;
-    function createPoolSetup(NftId distributionNftId, ISetup.PoolSetupInfo memory setup) external;
+    error ErrorInstanceInstanceReaderInstanceMismatch(address instanceAuthority);
 
+    error ErrorInstanceInstanceStoreAlreadySet(address instanceStore);
+    error ErrorInstanceInstanceStoreAuthorityMismatch(address instanceAuthority);
+
+    struct InstanceInfo {
+        uint64 requestsCount;
+    }
+
+    function createRole(string memory roleName, string memory adminName) external returns (RoleId roleId, RoleId admin);
+    function grantRole(RoleId roleId, address account) external;
+    function revokeRole(RoleId roleId, address account) external;
+
+    function createTarget(address target, string memory name) external;
+    function setTargetFunctionRole(string memory targetName, bytes4[] calldata selectors, RoleId roleId) external;
+    function setTargetLocked(address target, bool locked) external;
+
+    function setStakingLockingPeriod(Seconds stakeLockingPeriod) external;
+    function setStakingRewardRate(UFixed rewardRate) external;
+    function refillStakingRewardReserves(Amount dipAmount) external;
+
+    /// @dev Defunds the staking reward reserves for the specified target.
+    /// Permissioned: only the target owner may call this function.
+    function withdrawStakingRewardReserves(Amount dipAmount) external returns (Amount newBalance);
+
+    // get instance release and supporting contracts
+    function getMajorVersion() external pure returns (VersionPart majorVersion);
     function getInstanceReader() external view returns (InstanceReader);
+    function getBundleSet() external view returns (BundleSet);
+    function getInstanceAdmin() external view returns (InstanceAdmin);
+    function getInstanceStore() external view returns (InstanceStore);
 }