@etherisc/gif-next 0.0.2-e6ad61d-739 → 0.0.2-e802d97-713

package/contracts/instance/treasury/ITreasury.sol

@@ -1,91 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-
-import {IRegistryLinked} from "../../registry/IRegistry.sol";
-
-import {NftId} from "../../types/NftId.sol";
-import {UFixed} from "../../types/UFixed.sol";
-import {Fee} from "../../types/Fee.sol";
-
-import {TokenHandler} from "./TokenHandler.sol";
-
-interface ITreasury {
-    // TODO add events
-    // TODO add errors
-}
-
-interface ITreasuryModule is IRegistryLinked, ITreasury {
-    struct ProductSetup {
-        NftId productNftId;
-        NftId distributorNftId;
-        NftId poolNftId;
-        IERC20 token;
-        TokenHandler tokenHandler;
-        address wallet;
-        Fee policyFee;
-        Fee processingFee;
-    }
-
-    struct DistributorSetup {
-        NftId distributorNftId;
-        address wallet;
-        Fee commissionFees;
-    }
-
-    struct PoolSetup {
-        NftId poolNftId;
-        address wallet;
-        Fee stakingFee;
-        Fee performanceFee;
-    }
-
-    function registerProduct(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20 token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-
-    function setProductFees(
-        NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external;
-
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external;
-
-    function processPremium(NftId policyNftId, NftId productNftId) external;
-
-    function getTokenHandler(
-        NftId productNftId
-    ) external view returns (TokenHandler tokenHandler);
-
-    function getProductSetup(
-        NftId productNftId
-    ) external view returns (ProductSetup memory setup);
-
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view returns (PoolSetup memory setup);
-
-    function calculateFeeAmount(
-        uint256 amount,
-        Fee memory fee
-    ) external pure returns (uint256 feeAmount, uint256 netAmount);
-}

package/contracts/instance/treasury/TokenHandler.sol

@@ -1,24 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-
-contract TokenHandler {
-    // TODO use oz safeTransferFrom
-
-    IERC20 _token;
-
-    constructor(address token) {
-        _token = IERC20(token);
-    }
-
-    // TODO add logging
-    function transfer(
-        address from,
-        address to,
-        uint256 amount
-    ) external // TODO add authz (only treasury)
-    {
-        _token.transferFrom(from, to, amount);
-    }
-}

package/contracts/instance/treasury/TreasuryModule.sol

@@ -1,168 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-
-import {NftId} from "../../types/NftId.sol";
-import {Fee, feeIsZero} from "../../types/Fee.sol";
-import {UFixed, UFixedMathLib} from "../../types/UFixed.sol";
-import {IProductComponent} from "../../components/IProduct.sol";
-import {IPolicy, IPolicyModule} from "../policy/IPolicy.sol";
-import {TokenHandler} from "./TokenHandler.sol";
-import {ITreasuryModule} from "./ITreasury.sol";
-import {TokenHandler} from "./TokenHandler.sol";
-
-abstract contract TreasuryModule is ITreasuryModule {
-    mapping(NftId productNftId => ProductSetup setup) private _productSetup;
-    mapping(NftId distributorNftId => DistributorSetup setup)
-        private _distributorSetup;
-    mapping(NftId poolNftId => PoolSetup setup) private _poolSetup;
-
-    IPolicyModule private _policyModule;
-
-    constructor() {
-        _policyModule = IPolicyModule(address(this));
-    }
-
-    function registerProduct(
-        NftId productNftId,
-        NftId distributorNftId,
-        NftId poolNftId,
-        IERC20 token,
-        address wallet,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component module)
-    {
-        // TODO add validation
-
-        // deploy product specific handler contract
-        TokenHandler tokenHandler = new TokenHandler(address(token));
-
-        _productSetup[productNftId] = ProductSetup(
-            productNftId,
-            distributorNftId,
-            poolNftId,
-            token,
-            tokenHandler,
-            wallet,
-            policyFee,
-            processingFee
-        );
-
-        // TODO add logging
-    }
-
-    function setProductFees(
-        NftId productNftId,
-        Fee memory policyFee,
-        Fee memory processingFee
-    ) external override // TODO add authz (only component owner service)
-    {
-        // TODO add validation
-
-        ProductSetup storage setup = _productSetup[productNftId];
-        setup.policyFee = policyFee;
-        setup.processingFee = processingFee;
-
-        // TODO add logging
-    }
-
-    function registerPool(
-        NftId poolNftId,
-        address wallet,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component module)
-    {
-        // TODO add validation
-
-        _poolSetup[poolNftId] = PoolSetup(
-            poolNftId,
-            wallet,
-            stakingFee,
-            performanceFee
-        );
-
-        // TODO add logging
-    }
-
-    function setPoolFees(
-        NftId poolNftId,
-        Fee memory stakingFee,
-        Fee memory performanceFee
-    ) external override // TODO add authz (only component owner service)
-    {
-        // TODO add validation
-
-        PoolSetup storage setup = _poolSetup[poolNftId];
-        setup.stakingFee = stakingFee;
-        setup.performanceFee = performanceFee;
-
-        // TODO add logging
-    }
-
-    function getTokenHandler(
-        NftId productNftId
-    ) external view override returns (TokenHandler tokenHandler) {
-        return _productSetup[productNftId].tokenHandler;
-    }
-
-    function getProductSetup(
-        NftId productNftId
-    ) external view override returns (ProductSetup memory setup) {
-        return _productSetup[productNftId];
-    }
-
-    function getPoolSetup(
-        NftId poolNftId
-    ) external view override returns (PoolSetup memory setup) {
-        return _poolSetup[poolNftId];
-    }
-
-    function processPremium(
-        NftId policyNftId,
-        NftId productNftId
-    ) external override // TODO add authz (only product service)
-    {
-        IPolicy.PolicyInfo memory policyInfo = _policyModule.getPolicyInfo(
-            policyNftId
-        );
-        require(
-            policyInfo.nftId == policyNftId,
-            "ERROR:TRS-020:POLICY_UNKNOWN"
-        );
-
-        ProductSetup memory product = _productSetup[productNftId];
-        TokenHandler tokenHandler = product.tokenHandler;
-        address policyOwner = this.getRegistry().getOwner(policyNftId);
-        address poolWallet = _poolSetup[product.poolNftId].wallet;
-        // TODO add validation
-
-        if (feeIsZero(product.policyFee)) {
-            tokenHandler.transfer(
-                policyOwner,
-                poolWallet,
-                policyInfo.premiumAmount
-            );
-        } else {
-            (uint256 feeAmount, uint256 netAmount) = calculateFeeAmount(
-                policyInfo.premiumAmount,
-                product.policyFee
-            );
-
-            tokenHandler.transfer(policyOwner, product.wallet, feeAmount);
-            tokenHandler.transfer(policyOwner, poolWallet, netAmount);
-        }
-    }
-
-    function calculateFeeAmount(
-        uint256 amount,
-        Fee memory fee
-    ) public pure override returns (uint256 feeAmount, uint256 netAmount) {
-        UFixed fractionalAmount = UFixedMathLib.itof(amount) *
-            fee.fractionalFee;
-        feeAmount = UFixedMathLib.ftoi(fractionalAmount) + fee.fixedFee;
-        netAmount = amount - feeAmount;
-    }
-}

package/contracts/registry/IChainNft.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IERC721Enumerable} from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Enumerable.sol";
-
-interface IChainNft is IERC721Enumerable {
-    function mint(
-        address to,
-        string memory uri
-    ) external returns (uint256 tokenId);
-
-    function burn(uint256 tokenId) external;
-
-    function setURI(uint256 tokenId, string memory uri) external;
-
-    function exists(uint256 tokenId) external view returns (bool);
-
-    function totalMinted() external view returns (uint256);
-
-    function getRegistryAddress() external view returns (address registry);
-}

package/contracts/types/ChainId.sol

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-/// @dev bytes5 (uint40) allows for chain ids up to 13 digits
-type ChainId is bytes5;
-
-// type bindings
-using {eqChainId as ==, neChainId as !=, ChainIdLib.toInt} for ChainId global;
-
-// general pure free functions
-/// @dev Converts the uint256 to a ChainId.
-function toChainId(uint256 chainId) pure returns (ChainId) {
-    return ChainId.wrap(bytes5(uint40(chainId)));
-}
-
-/// @dev Return the ChainId for the chain the contract is deployed to
-function thisChainId() view returns (ChainId) {
-    return toChainId(block.chainid);
-}
-
-// pure free functions for operators
-/// @dev Returns true if the values are equal (==).
-function eqChainId(ChainId a, ChainId b) pure returns (bool isSame) {
-    return ChainId.unwrap(a) == ChainId.unwrap(b);
-}
-
-/// @dev Returns true if the values are not equal (!=).
-function neChainId(ChainId a, ChainId b) pure returns (bool isDifferent) {
-    return ChainId.unwrap(a) != ChainId.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library ChainIdLib {
-    /// @dev Converts the ChainId to a uint256.
-    function toInt(ChainId chainId) internal pure returns (uint256) {
-        return uint256(uint40(ChainId.unwrap(chainId)));
-    }
-}

package/contracts/types/Fee.sol

@@ -1,32 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {UFixed} from "./UFixed.sol";
-
-struct Fee {
-    UFixed fractionalFee;
-    uint256 fixedFee;
-}
-
-// general pure free functions
-/// @dev Converts the uint256 to a NftId.
-function toFee(
-    UFixed fractionalFee,
-    uint256 fixedFee
-) pure returns (Fee memory fee) {
-    return Fee(fractionalFee, fixedFee);
-}
-
-/// @dev Return the NftId zero (0)
-function zeroFee() pure returns (Fee memory fee) {
-    return Fee(UFixed.wrap(0), 0);
-}
-
-// pure free functions for operators
-function feeIsSame(Fee memory a, Fee memory b) pure returns (bool isSame) {
-    return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
-}
-
-function feeIsZero(Fee memory fee) pure returns (bool) {
-    return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
-}

package/contracts/types/NftId.sol

@@ -1,51 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// uint96 allows for chain ids up to 13 digits
-type NftId is uint96;
-
-// type bindings
-using {eqNftId as ==, neNftId as !=, NftIdLib.toInt} for NftId global;
-
-// general pure free functions
-/// @dev Converts the uint256 to a NftId.
-function toNftId(uint256 id) pure returns (NftId) {
-    return NftId.wrap(uint96(id));
-}
-
-/// @dev Return the NftId zero (0)
-function zeroNftId() pure returns (NftId) {
-    return NftId.wrap(0);
-}
-
-// pure free functions for operators
-function eqNftId(NftId a, NftId b) pure returns (bool isSame) {
-    return NftId.unwrap(a) == NftId.unwrap(b);
-}
-
-function neNftId(NftId a, NftId b) pure returns (bool isDifferent) {
-    return NftId.unwrap(a) != NftId.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library NftIdLib {
-    /// @dev Converts the NftId to a uint256.
-    function toInt(NftId nftId) public pure returns (uint96) {
-        return uint96(NftId.unwrap(nftId));
-    }
-
-    /// @dev Returns true if the value is non-zero (> 0).
-    function gtz(NftId a) public pure returns (bool) {
-        return NftId.unwrap(a) > 0;
-    }
-
-    /// @dev Returns true if the value is zero (== 0).
-    function eqz(NftId a) public pure returns (bool) {
-        return NftId.unwrap(a) == 0;
-    }
-
-    /// @dev Returns true if the values are equal (==).
-    function eq(NftId a, NftId b) public pure returns (bool isSame) {
-        return eqNftId(a, b);
-    }
-}

package/contracts/types/UFixed.sol

@@ -1,210 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
-
-/// @dev UFixed is a fixed point number with 18 decimals precision.
-type UFixed is uint256;
-
-using {
-    addUFixed as +,
-    subUFixed as -,
-    mulUFixed as *,
-    divUFixed as /,
-    gtUFixed as >,
-    gteUFixed as >=,
-    ltUFixed as <,
-    lteUFixed as <=,
-    eqUFixed as ==
-} for UFixed global;
-
-function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
-}
-
-function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
-    return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
-}
-
-function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    return
-        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
-}
-
-function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
-
-    return
-        UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
-}
-
-function gtUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
-    return UFixed.unwrap(a) > UFixed.unwrap(b);
-}
-
-function gteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
-    return UFixed.unwrap(a) >= UFixed.unwrap(b);
-}
-
-function ltUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
-    return UFixed.unwrap(a) < UFixed.unwrap(b);
-}
-
-function lteUFixed(UFixed a, UFixed b) pure returns (bool isGreaterThan) {
-    return UFixed.unwrap(a) <= UFixed.unwrap(b);
-}
-
-function eqUFixed(UFixed a, UFixed b) pure returns (bool isEqual) {
-    return UFixed.unwrap(a) == UFixed.unwrap(b);
-}
-
-function gtzUFixed(UFixed a) pure returns (bool isZero) {
-    return UFixed.unwrap(a) > 0;
-}
-
-function eqzUFixed(UFixed a) pure returns (bool isZero) {
-    return UFixed.unwrap(a) == 0;
-}
-
-function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    if (a > b) {
-        return a - b;
-    }
-
-    return b - a;
-}
-
-library UFixedMathLib {
-
-    int8 public constant EXP = 18;
-    uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
-    uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
-
-    /// @dev returns the rounding mode DOWN - 0.4 becomes 0, 0.5 becomes 0, 0.6 becomes 0
-    function ROUNDING_DOWN() public pure returns (uint8) {
-        return uint8(0);
-    }
-
-    /// @dev returns the rounding mode UP - 0.4 becomes 1, 0.5 becomes 1, 0.6 becomes 1
-    function ROUNDING_UP() public pure returns (uint8) {
-        return uint8(1);
-    }
-
-    /// @dev returns the rounding mode HALF_UP - 0.4 becomes 0, 0.5 becomes 1, 0.6 becomes 1
-    function ROUNDING_HALF_UP() public pure returns (uint8) {
-        return uint8(2);
-    }
-
-    /// @dev returns the decimals precision of the UFixed type
-    function decimals() public pure returns (uint256) {
-        return uint8(EXP);
-    }
-
-    /// @dev Converts the uint256 to a UFixed.
-    function itof(uint256 a) public pure returns (UFixed) {
-        return UFixed.wrap(a * MULTIPLIER);
-    }
-
-    // TODO rename to toUFixed
-    /// @dev Converts the uint256 to a UFixed with given exponent.
-    function itof(uint256 a, int8 exp) public pure returns (UFixed) {
-        require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
-        require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
-
-        return UFixed.wrap(a * 10 ** uint8(EXP + exp));
-    }
-
-    /// @dev Converts a UFixed to a uint256.
-    function ftoi(UFixed a) public pure returns (uint256) {
-        return ftoi(a, ROUNDING_HALF_UP());
-    }
-
-    /// @dev Converts a UFixed to a uint256 with given rounding mode.
-    function ftoi(UFixed a, uint8 rounding) public pure returns (uint256) {
-        if (rounding == ROUNDING_HALF_UP()) {
-            return
-                Math.mulDiv(
-                    UFixed.unwrap(a) + MULTIPLIER_HALF,
-                    1,
-                    MULTIPLIER,
-                    Math.Rounding.Down
-                );
-        } else if (rounding == ROUNDING_DOWN()) {
-            return
-                Math.mulDiv(
-                    UFixed.unwrap(a),
-                    1,
-                    MULTIPLIER,
-                    Math.Rounding.Down
-                );
-        } else {
-            return
-                Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
-        }
-    }
-
-    /// @dev adds two UFixed numbers
-    function add(UFixed a, UFixed b) public pure returns (UFixed) {
-        return addUFixed(a, b);
-    }
-
-    /// @dev subtracts two UFixed numbers
-    function sub(UFixed a, UFixed b) public pure returns (UFixed) {
-        return subUFixed(a, b);
-    }
-
-    /// @dev multiplies two UFixed numbers
-    function mul(UFixed a, UFixed b) public pure returns (UFixed) {
-        return mulUFixed(a, b);
-    }
-
-    /// @dev divides two UFixed numbers
-    function div(UFixed a, UFixed b) public pure returns (UFixed) {
-        return divUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is greater than UFixed b
-    function gt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
-        return gtUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is greater than or equal to UFixed b
-    function gte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
-        return gteUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is less than UFixed b
-    function lt(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
-        return ltUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is less than or equal to UFixed b
-    function lte(UFixed a, UFixed b) public pure returns (bool isGreaterThan) {
-        return lteUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is equal to UFixed b
-    function eq(UFixed a, UFixed b) public pure returns (bool isEqual) {
-        return eqUFixed(a, b);
-    }
-
-    /// @dev return true if UFixed a is not zero
-    function gtz(UFixed a) public pure returns (bool isZero) {
-        return gtzUFixed(a);
-    }
-
-    /// @dev return true if UFixed a is zero
-    function eqz(UFixed a) public pure returns (bool isZero) {
-        return eqzUFixed(a);
-    }
-
-    function zero() public pure returns (UFixed) {
-        return UFixed.wrap(0);
-    }
-
-    /// @dev return the absolute delta between two UFixed numbers
-    function delta(UFixed a, UFixed b) public pure returns (UFixed) {
-        return deltaUFixed(a, b);
-    }
-}