@etherisc/gif-next 0.0.2-efef0ea-320 → 0.0.2-f00a368-815

package/contracts/components/Product.sol

@@ -1,227 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRisk} from "../instance/module/risk/IRisk.sol";
-import {ITreasury} from "../instance/module/treasury/ITreasury.sol";
-import {IProductService} from "../instance/service/IProductService.sol";
-import {IProductComponent} from "./IProductComponent.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType, PRODUCT} from "../types/ObjectType.sol";
-import {ReferralId} from "../types/ReferralId.sol";
-import {RiskId, RiskIdLib} from "../types/RiskId.sol";
-import {StateId} from "../types/StateId.sol";
-import {Timestamp} from "../types/Timestamp.sol";
-import {Fee} from "../types/Fee.sol";
-import {BaseComponent} from "./BaseComponent.sol";
-
-contract Product is BaseComponent, IProductComponent {
-    IProductService internal _productService;
-    address internal _pool;
-    address internal _distribution;
-    Fee internal _initialProductFee;
-    Fee internal _initialProcessingFee;
-
-    constructor(
-        address registry,
-        NftId instanceNftid,
-        address token,
-        address pool,
-        address distribution,
-        Fee memory productFee,
-        Fee memory processingFee
-    ) BaseComponent(registry, instanceNftid, token) {
-        // TODO add validation
-        _productService = _instance.getProductService();
-        _pool = pool;
-        _distribution = distribution;
-        _initialProductFee = productFee;
-        _initialProcessingFee = processingFee;        
-    }
-
-
-    function calculatePremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        uint256 lifetime,
-        bytes memory applicationData,
-        ReferralId referralId,
-        NftId bundleNftId
-    )
-        external 
-        view 
-        override 
-        returns (uint256 premiumAmount)
-    {
-        (premiumAmount,,,,) = _productService.calculatePremium(
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-    }
-
-
-    function calculateNetPremium(
-        uint256 sumInsuredAmount,
-        RiskId riskId,
-        uint256 lifetime,
-        bytes memory applicationData
-    )
-        external
-        view
-        virtual override
-        returns (uint256 netPremiumAmount)
-    {
-        // default 10% of sum insured
-        return sumInsuredAmount / 10;
-    }
-
-    function _toRiskId(string memory riskName) internal pure returns (RiskId riskId) {
-        return RiskIdLib.toRiskId(riskName);
-    }
-
-    function _createRisk(
-        RiskId id,
-        bytes memory data
-    ) internal {
-        _productService.createRisk(
-            id,
-            data
-        );
-    }
-
-    function _setRiskInfo(
-        RiskId id,
-        IRisk.RiskInfo memory info
-    ) internal {
-        _productService.setRiskInfo(
-            id,
-            info
-        );
-    }
-
-    function _updateRiskState(
-        RiskId id,
-        StateId state
-    ) internal {
-        _productService.updateRiskState(
-            id,
-            state
-        );
-    }
-
-    function _getRiskInfo(RiskId id) internal view returns (IRisk.RiskInfo memory info) {
-        return _instance.getRiskInfo(id);
-    }
-
-    function _createApplication(
-        address applicationOwner,
-        RiskId riskId,
-        uint256 sumInsuredAmount,
-        uint256 lifetime,
-        bytes memory applicationData,
-        NftId bundleNftId,
-        ReferralId referralId
-    ) internal returns (NftId nftId) {
-        nftId = _productService.createApplication(
-            applicationOwner,
-            riskId,
-            sumInsuredAmount,
-            lifetime,
-            applicationData,
-            bundleNftId,
-            referralId
-        );
-    }
-
-    function _underwrite(
-        NftId policyNftId,
-        bool requirePremiumPayment,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.underwrite(
-            policyNftId, 
-            requirePremiumPayment, 
-            activateAt);
-    }
-
-    function _collectPremium(
-        NftId policyNftId,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.collectPremium(
-            policyNftId, 
-            activateAt);
-    }
-
-    function _activate(
-        NftId policyNftId,
-        Timestamp activateAt
-    )
-        internal
-    {
-        _productService.activate(
-            policyNftId, 
-            activateAt);
-    }
-
-    function getPoolNftId() external view override returns (NftId poolNftId) {
-        return _registry.getNftId(_pool);
-    }
-
-    function getDistributionNftId() external view override returns (NftId distributionNftId) {
-        return _registry.getNftId(_distribution);
-    }
-
-    // from product component
-    function setFees(
-        Fee memory productFee,
-        Fee memory processingFee
-    )
-        external
-        onlyOwner
-        override
-    {
-        _productService.setFees(productFee, processingFee);
-    }
-
-
-    function getProductFee()
-        external
-        view
-        override
-        returns (Fee memory productFee)
-    {
-        NftId productNftId = getNftId();
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).productFee;
-        } else {
-            return _initialProductFee;
-        }
-    }
-
-    function getProcessingFee()
-        external
-        view
-        override
-        returns (Fee memory processingFee)
-    {
-        NftId productNftId = getNftId();
-        if (_instance.hasTreasuryInfo(productNftId)) {
-            return _instance.getTreasuryInfo(productNftId).processingFee;
-        } else {
-            return _initialProcessingFee;
-        }
-    }
-
-    // from registerable
-    function getType() public pure override returns (ObjectType) {
-        return PRODUCT();
-    }
-}

package/contracts/experiment/errors/Require.sol

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-contract Require {
-    error AsmallerThanB_S();
-    error AsmallerThanB_M(uint a);
-    error AsmallerThanB_L(uint a, uint b);
-
-    uint256 private _b;
-
-    constructor() {
-        _b = 42;
-    }
-
-    function isAlargerThanBRequire_S(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-001");
-
-        return true;
-    }
-
-    function isAlargerThanBRequire_M(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-002:A_IS_SMALLER");
-
-        return true;
-    }
-
-    function isAlargerThanBRequire_L(
-        uint a
-    ) external view returns (bool isLarger) {
-        require(a > _b, "ERROR:ABC-003:A_IS_SMALLER_THAN_B");
-
-        return true;
-    }
-}

package/contracts/experiment/errors/Revert.sol

@@ -1,44 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-contract Revert {
-    error AsmallerThanB_S();
-    error AsmallerThanB_M(uint a);
-    error AsmallerThanB_L(uint a, uint b);
-
-    uint256 private _b;
-
-    constructor() {
-        _b = 42;
-    }
-
-    function isAlargerThanBRevert_S(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_S();
-        }
-
-        return true;
-    }
-
-    function isAlargerThanBRevert_M(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_M(a);
-        }
-
-        return true;
-    }
-
-    function isAlargerThanBRevert_L(
-        uint a
-    ) external view returns (bool isLarger) {
-        if (a <= _b) {
-            revert AsmallerThanB_L(a, _b);
-        }
-
-        return true;
-    }
-}

package/contracts/experiment/inheritance/A.sol

@@ -1,53 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IA, ISharedA} from "./IA.sol";
-import {B} from "./B.sol";
-import {C} from "./C.sol";
-
-/* 
-
-# dependency graph
-
-   B <...+
-   ^     |
-   |     |
-   A --> C
-
-   - A is the main contract
-   - A provides functionality implemented by modules B and C
-   - B and C rely on functionality shared by A
-   - C accesses functionality of module B
-
-# chisel session
-
-import {A} from "./contracts/experiment/A.sol";
-A a = new A();
-uint(a.getA())
-uint(a.getB()))
-uint(a.getC())
-uint(a.getAfromB())
-uint(a.getAfromC())
-uint(a.getBfromC())
-a.setA(100);
-a.setB(10);
-a.setC(20);
- */
-
-contract AShared is ISharedA {
-    uint256 private _x;
-
-    constructor() {
-        _x = 42;
-    }
-
-    function getA() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setA(uint256 newA) external override {
-        _x = newA;
-    }
-}
-
-contract A is AShared, B, C, IA {}

package/contracts/experiment/inheritance/B.sol

@@ -1,28 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-
-abstract contract B is ISharedA, IB {
-    // names of private variables can be re-used in inheritance
-    uint256 private _x;
-
-    constructor() {
-        _x = 1;
-    }
-
-    // access own state
-    function getB() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setB(uint256 newB) external override {
-        _x = newB;
-    }
-
-    // access state from parent contract A
-    function getAfromB() external view override returns (uint256) {
-        return this.getA();
-    }
-}

package/contracts/experiment/inheritance/C.sol

@@ -1,34 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ISharedA} from "./IA.sol";
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-abstract contract C is ISharedA, IC {
-    uint256 private _x;
-
-    constructor() {
-        _x = 2;
-    }
-
-    // access own state
-    function getC() external view override returns (uint256) {
-        return _x;
-    }
-
-    function setC(uint256 newC) external override {
-        _x = newC;
-    }
-
-    // access state from parent contract A
-    function getAfromC() external view override returns (uint256) {
-        return this.getA();
-    }
-
-    // access state from other module B
-    function getBfromC() external view override returns (uint256) {
-        IB b = IB(address(this));
-        return b.getB();
-    }
-}

package/contracts/experiment/inheritance/IA.sol

@@ -1,13 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IB} from "./IB.sol";
-import {IC} from "./IC.sol";
-
-interface ISharedA {
-    function getA() external view returns (uint256);
-
-    function setA(uint256 newA) external;
-}
-
-interface IA is ISharedA, IB, IC {}

package/contracts/experiment/inheritance/IB.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IB {
-    function getAfromB() external view returns (uint256);
-
-    function getB() external view returns (uint256);
-
-    function setB(uint256 newA) external;
-}

package/contracts/experiment/inheritance/IC.sol

@@ -1,12 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface IC {
-    function getAfromC() external view returns (uint256);
-
-    function getBfromC() external view returns (uint256);
-
-    function getC() external view returns (uint256);
-
-    function setC(uint256 newA) external;
-}

package/contracts/experiment/statemachine/Dummy.sol

@@ -1,27 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-
-contract LifeCycleModule {
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    function getInitialState(
-        ObjectType objectType
-    ) external view returns (StateId) {
-        return _initialState[objectType];
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) external view returns (bool) {
-        return _isValidTransition[objectType][fromId][toId];
-    }
-}

package/contracts/experiment/statemachine/ISM.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId} from "../../types/StateId.sol";
-
-interface ISMEE {
-    error ErrorInitialStateUndefined();
-    error ErrorStartStateUndefined();
-    error ErrorNextStateUndefined();
-    error ErrorStateChangeInvalid(StateId currentStateId, StateId newStateId);
-
-    event LogInitialStateSet(StateId initialStateId);
-    event LogStateChanged(StateId oldStateId, StateId newStateId);
-}
-
-interface ISM is ISMEE {
-    function changeToState(StateId newStateId) external;
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view returns (bool isValid);
-
-    function getState() external view returns (StateId currentStateId);
-}

package/contracts/experiment/statemachine/README.md

@@ -1,112 +0,0 @@
-# State Machines
-
-Most GIF objects have a life cycle defined by a state machine.
-
-For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
-
-## Object Types without States
-
-* Protocol
-* Chains
-* Registries (both chain and main registry)
-
-## Object Types with States
-
-* Tokens
-* Instances
-* Products
-* Oracles
-* Pools
-* Bundles
-* Policies
-* Claim (non-NFT)
-* Payout (non-NFT)
-
-### Simple State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Archived (final state)
-
-Valid state transitions:
-
-* Active -> Paused
-* Paused -> Active
-* Paused -> Archived
-
-
-Candidate object types for simple state machine
-
-* Token
-* Instance
-* Product
-* Oracle
-* Pool
-
-To discuss: 
-
-* Archived is final state
-* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
-* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
-
-### Bundle State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A bundle is expired for block.timestamp >= expiredAt
-
-### Policy State Machine
-
-Valid states
-
-* Applied (initial state)
-* Revoked (final state)
-* Declined (final state)
-* Active
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A policy is expired for block.timestamp >= expiredAt
-
-To discuss: 
-
-* Should 'Closed' be less explicit using a closedAt state variable? 
-* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
-
-Valid state transitions:
-
-* Applied -> Revoked
-* Applied -> Declined
-* Applied -> Active
-* Active -> Closed (needs to be expired)
-
-### Claim State Machine
-
-Valid states
-* Applied (initial state)
-* Confirmed
-* Declined (final state)
-* Closed (final state)
-
-Valid state transitions:
-* Applied -> Confirmed
-* Applied -> Declined
-* Confirmed -> Closed
-
-### Payout State Machine
-
-Valid states
-* Expected
-* PaidOut
-
-Valid state transitions:
-* Expected -> PaidOut

package/contracts/experiment/statemachine/SM.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-import {ISM} from "./ISM.sol";
-
-contract SM is ISM {
-    mapping(StateId currentState => mapping(StateId newState => bool isValid))
-        private _isValidTransition;
-
-    StateId internal _state;
-
-    function setInitialState(StateId initialStateId) internal {
-        if (initialStateId == zeroStateId()) {
-            revert ErrorInitialStateUndefined();
-        }
-
-        _state = initialStateId;
-    }
-
-    function addTransition(
-        StateId currentStateId,
-        StateId nextStateId
-    ) internal {
-        if (currentStateId == zeroStateId()) {
-            revert ErrorStartStateUndefined();
-        }
-
-        if (nextStateId == zeroStateId()) {
-            revert ErrorNextStateUndefined();
-        }
-
-        _isValidTransition[currentStateId][nextStateId] = true;
-    }
-
-    function changeToState(StateId newStateId) external override {
-        if (!_isValidTransition[_state][newStateId]) {
-            revert ErrorStateChangeInvalid(_state, newStateId);
-        }
-
-        StateId stateOld = _state;
-        _state = newStateId;
-
-        emit LogStateChanged(stateOld, _state);
-    }
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view override returns (bool isValid) {
-        return _isValidTransition[currentStateId][newStateId];
-    }
-
-    function getState() external view override returns (StateId state) {
-        return _state;
-    }
-}