ERC-6353: 慈善代币

// SPDX-License-Identifier: CC0-1.0
pragma solidity ^0.8.4;

///
/// @dev ERC20 Charity 兼容合约的必需接口。
///
interface IERC20charity is IERC165 {
    /// 此接口的 EIP-165 标识符为 0x557512b6

    
    /**
     * @dev 当 `toAdd` 慈善地址添加到 `whitelistedRate` 时发出。
     */
    event AddedToWhitelist (address toAdd);

    /**
     * @dev 当 `toRemove` 慈善地址从 `whitelistedRate` 中删除时发出。
     */
    event RemovedFromWhitelist (address toRemove);

    /**
     * @dev 当 `_defaultAddress` 慈善地址被修改并设置为 `whitelistedAddr` 时发出。
     */
    event DonnationAddressChanged (address whitelistedAddr);

    /**
     * @dev 当 `_defaultAddress` 慈善地址被修改并设置为 `whitelistedAddr` 
    * 并且 _donation 设置为 `rate` 时发出。
     */
    event DonnationAddressAndRateChanged (address whitelistedAddr,uint256 rate);

    /**
     * @dev 当 `whitelistedRate` 的 `whitelistedAddr` 被修改并设置为 `rate` 时发出。
     */
    event ModifiedCharityRate(address whitelistedAddr,uint256 rate);
    
    /**
    *@notice 调用慈善地址以确定合约是否将该地址列入白名单
    *以及是否分配了费率。
    *@param addr - 查询捐赠信息的慈善地址。
    *@return whitelisted - 如果合约将该地址列入白名单以接收捐赠，则为 true
    *@return defaultRate - 合约所有者默认定义的费率，允许的最低费率不同于 0
    */
    function charityInfo(
        address addr
    ) external view returns (
        bool whitelisted,
        uint256 defaultRate
    );

    /**
    *@notice 将地址添加到白名单并将费率设置为默认费率。
    * @dev 要求：
     *
     * - `toAdd` 不能是零地址。
     *
     * @param toAdd 要列入白名单的地址。
     */
    function addToWhitelist(address toAdd) external;

    /**
    *@notice 从白名单中删除地址并将费率设置为默认费率。
    * @dev 要求：
     *
     * - `toRemove` 不能是零地址。
     *
     * @param toRemove 要从白名单中删除的地址。
     */
    function deleteFromWhitelist(address toRemove) external;

    /**
    *@notice 获取所有已注册的慈善地址。
     */
    function getAllWhitelistedAddresses() external ;

    /**
    *@notice 向用户显示将接收捐赠的默认慈善地址的费率。
     */
    function getRate() external view returns (uint256);

    /**
    *@notice 在 {whitelistedRate} 中为慈善地址设置个性化费率。
    * @dev 要求：
     *
     * - `whitelistedAddr` 不能是零地址。
     * - `rate` 不能低于默认费率。
     *
     * @param whitelistedAddr 要设置为默认值的地址。
     * @param rate 捐赠的个性化费率。
     */
    function setSpecificRate(address whitelistedAddr , uint256 rate) external;

    /**
    *@notice 为用户设置将接收捐赠的默认慈善地址。
    * 将应用 {whitelistedRate} 中指定的默认费率。
    * @dev 要求：
     *
     * - `whitelistedAddr` 不能是零地址。
     *
     * @param whitelistedAddr 要设置为默认值的地址。
     */
    function setSpecificDefaultAddress(address whitelistedAddr) external;

    /**
    *@notice 为用户设置将接收捐赠的默认慈善地址。
    * 费率由用户指定。
    * @dev 要求：
     *
     * - `whitelistedAddr` 不能是零地址。
     * - `rate` 不能低于默认费率
     * 或此合约的所有者在 {whitelistedRate} 中指定的费率。
     *
     * @param whitelistedAddr 要设置为默认值的地址。
     * @param rate 捐赠的个性化费率。
     */
    function setSpecificDefaultAddressAndRate(address whitelistedAddr , uint256 rate) external;

    /**
    *@notice 向用户显示将接收捐赠的默认慈善地址。
    * 将应用 {whitelistedRate} 中指定的默认费率。
     */
    function specificDefaultAddress() external view returns (
        address defaultAddress
    );

    /**
    *@notice 删除默认地址并停用捐赠。
     */
    function deleteDefaultAddress() external;
}