@etherisc/gif-next 0.0.2-f99f1d2-109 → 0.0.2-fa85e58-736

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/ObjectType.sol

@@ -1,107 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// uint96 allows for chain ids up to 13 digits
-type ObjectType is uint8;
-
-// type bindings
-using {
-    eqObjectType as ==,
-    neObjectType as !=,
-    ObjectTypeLib.toInt
-} for ObjectType global;
-
-// general pure free functions
-
-function PROTOCOL() pure returns (ObjectType) {
-    return toObjectType(10);
-}
-
-function CHAIN() pure returns (ObjectType) {
-    return toObjectType(20);
-}
-
-function REGISTRY() pure returns (ObjectType) {
-    return toObjectType(30);
-}
-
-function TOKEN() pure returns (ObjectType) {
-    return toObjectType(40);
-}
-
-function INSTANCE() pure returns (ObjectType) {
-    return toObjectType(50);
-}
-
-function PRODUCT() pure returns (ObjectType) {
-    return toObjectType(60);
-}
-
-function ORACLE() pure returns (ObjectType) {
-    return toObjectType(70);
-}
-
-function POOL() pure returns (ObjectType) {
-    return toObjectType(80);
-}
-
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(81);
-}
-
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(90);
-}
-
-function CLAIM() pure returns (ObjectType) {
-    return toObjectType(91);
-}
-
-function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(92);
-}
-
-/// @dev Converts the uint8 to a ObjectType.
-function toObjectType(uint256 objectType) pure returns (ObjectType) {
-    return ObjectType.wrap(uint8(objectType));
-}
-
-/// @dev Return the ObjectType zero (0)
-function zeroObjectType() pure returns (ObjectType) {
-    return ObjectType.wrap(0);
-}
-
-// pure free functions for operators
-function eqObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
-    return ObjectType.unwrap(a) == ObjectType.unwrap(b);
-}
-
-function neObjectType(
-    ObjectType a,
-    ObjectType b
-) pure returns (bool isDifferent) {
-    return ObjectType.unwrap(a) != ObjectType.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library ObjectTypeLib {
-    /// @dev Converts the NftId to a uint256.
-    function toInt(ObjectType objectType) public pure returns (uint96) {
-        return uint96(ObjectType.unwrap(objectType));
-    }
-
-    /// @dev Returns true if the value is non-zero (> 0).
-    function gtz(ObjectType a) public pure returns (bool) {
-        return ObjectType.unwrap(a) > 0;
-    }
-
-    /// @dev Returns true if the value is zero (== 0).
-    function eqz(ObjectType a) public pure returns (bool) {
-        return ObjectType.unwrap(a) == 0;
-    }
-
-    /// @dev Returns true if the values are equal (==).
-    function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
-        return eqObjectType(a, b);
-    }
-}