CharmToken

{{
  "language": "Solidity",
  "sources": {
    "src/CharmToken.sol": {
      "content": "// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.19;

// oz imports
import { ERC20, IERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";

// local imports
import { IUniswapV2Router02 } from "./interfaces/IUniswapV2Router02.sol";
import { IUniswapV2Factory } from "./interfaces/IUniswapV2Factory.sol";

/**
 * @title CharmToken
 * @notice ERC-20 contract for $Charm token. This contract does contain a taxing mechanism on buys, sells, & transfers.
 */
contract CharmToken is ERC20, Ownable {

    // ---------------
    // State Variables
    // ---------------

    /// @notice Amount of accumulated $Charm royalties needed to distribute royalties.
    uint256 public swapTokensAtAmount;

    /// @notice If true, `account` is excluded from fees (aka whitelisted).
    mapping(address account => bool) public isExcludedFromFees;

    /// @notice If true, `pair` is a verified pair/pool.
    mapping(address pair => bool) public automatedMarketMakerPairs;

    /// @notice Stores the contract reference to the local Uniswap V2 Router contract.
    IUniswapV2Router02 public uniswapV2Router;
    
    /// @notice Stores the address to the Charm/WETH Uniswap pair.
    address public uniswapV2Pair;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver1;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver2;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver3;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver4;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver5;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver6;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver7;

    /// @notice Stores the address of a tax beneficiary.
    address public taxReceiver8;

    /// @notice Fee allocation for `taxReceiver1`.
    uint8 public fee1;

    /// @notice Fee allocation for `taxReceiver2`.
    uint8 public fee2;

    /// @notice Fee allocation for `taxReceiver3`.
    uint8 public fee3;

    /// @notice Fee allocation for `taxReceiver4`.
    uint8 public fee4;

    /// @notice Fee allocation for `taxReceiver5`.
    uint8 public fee5;

    /// @notice Fee allocation for `taxReceiver6`.
    uint8 public fee6;

    /// @notice Fee allocation for `taxReceiver7`.
    uint8 public fee7;

    /// @notice Fee allocation for `taxReceiver8`.
    uint8 public fee8;

    /// @notice Total fee taken. `fee1` + `fee2` + `fee3` + `fee4` + `fee5` + `fee6` + `fee7` + `fee8`.
    uint8 public totalFees;

    /// @notice Used to prevent re-entrancy during royalty distribution.
    bool private swapping;

    /// @notice If true, trading is active.
    bool public tradingActive;

    /// @notice If true, a `totalFee` fee is taken from traders.
    bool public feesEnabled;

    /// @notice Maximum amount of tokens allowed in a tx.
    uint256 public maxTxAmount;

    /// @notice Max amount to sell on royalty handling.
    uint256 public swapTokensUpperLimit;


    // ------
    // Events
    // ------

    /**
     * @notice This event is emitted when `excludeFromFees` is executed.
     * @param account Address that was (or was not) excluded from fees.
     * @param isExcluded If true, `account` is excluded from fees. Otherwise, false.
     */
    event ExcludedFromFees(address indexed account, bool isExcluded);

    /**
     * @notice This event is emitted when `automatedMarketMakerPairs` is modified.
     * @param pair Pair contract address.
     * @param value If true, `pair` is a verified pair address or pool. Otherwise, false.
     */
    event SetAutomatedMarketMakerPair(address indexed pair, bool value);

    /**
     * @notice This event is emitted when `updateFees` is executed.
     */
    event FeesUpdated(uint256 totalFee, uint8 fee1, uint8 fee2, uint8 fee3, uint8 fee4, uint8 fee5, uint8 fee6, uint8 fee7, uint8 fee8);

    /**
     * @notice This event is emitted when a tax receiver address is updated.
     */
    event TaxReceiverAddressUpdated(uint8 id, address newAccount);

    /**
     * @notice This event is emitted when fees are distributed.
     */
    event FeesDistributed(uint256 totalAmountETH);

    /**
     * @notice This event is emitted when trading is enabled.
     */
    event TradingEnabled();


    // ------
    // Errors
    // ------

    /**
     * @notice This error is emitted from an invalid address(0) input.
     */
    error ZeroAddress();


    // ---------
    // Modifiers
    // ---------

    modifier lockSwap() {
        swapping = true;
        _;
        swapping = false;
    }


    // -----------
    // Constructor
    // -----------

    /**
     * @notice This initializes CharmToken.
     * @param _admin Initial default admin address.
     * @param _router Local Uniswap v2 router address.
     */
    constructor(address _admin, address _router) ERC20("CHRMTEST", "CHRMTEST") Ownable(_admin) {
        taxReceiver1 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver2 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver3 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver4 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver5 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver6 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver7 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;
        taxReceiver8 = 0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8;

        fee1 = 3;
        fee2 = 2;
        fee3 = 1;
        fee4 = 1;
        fee5 = 1;
        fee6 = 1;
        fee7 = 1;
        fee8 = 1;

        totalFees = fee1 + fee2 + fee3 + fee4 + fee5 + fee6 + fee7 + fee8;

        isExcludedFromFees[0x7382aa07a9C825f96CeAA794183cdEA72F000Ca8] = true;
        isExcludedFromFees[address(this)] = true;
        isExcludedFromFees[_admin] = true;
        isExcludedFromFees[address(0)] = true;

        if (_router != address(0)) {
            uniswapV2Router = IUniswapV2Router02(_router);
            uniswapV2Pair = IUniswapV2Factory(uniswapV2Router.factory()).createPair(address(this), uniswapV2Router.WETH());
            _setAutomatedMarketMakerPair(uniswapV2Pair, true);
        }

        swapTokensAtAmount   =  1_000_000 ether; // $100 at init price ($0.0001)
        swapTokensUpperLimit = 10_000_000 ether; // $1000 at init price ($0.0001)

        uint256 supply = 1_000_000_000 ether;
        maxTxAmount    = supply; // MAX by default
        
        _mint(_admin, supply);
    }


    // -------
    // Methods
    // -------

    /// @dev Allows address(this) to receive ETH.
    receive() external payable {}

    function enableTrading() external onlyOwner {
        tradingActive = true;
        feesEnabled = true;

        emit TradingEnabled();
    }

    function toggleFees() external onlyOwner {
        feesEnabled = !feesEnabled;
    }
    
    function manualSwapAndSend() external {
        require(!swapping, "royalty dist in progress");

        uint256 amount = balanceOf(address(this));
        require(amount != 0, "insufficient balance");

        _handleRoyalties(amount);
    }

    function manualSend() external {
        require(address(this).balance != 0, "insufficient balance");
        _distributeETH();
    }

    function extractTokens(address _token) external onlyOwner {
        uint256 bal = IERC20(_token).balanceOf(address(this));
        require(bal != 0, "insufficient balance");
        IERC20(_token).transfer(msg.sender, bal);
    }

    /**
     * @notice This method allows a permissioned admin to update the fees.
     * @dev If fees are being set to 0 -> It's preferred to just disable feesEnabled.
     *      Otherwise, make sure ETH balance in contract is 0 first.
     */
    function updateFees(uint8 _fee1, uint8 _fee2, uint8 _fee3, uint8 _fee4, uint8 _fee5, uint8 _fee6, uint8 _fee7, uint8 _fee8) external onlyOwner {
        totalFees = _fee1 + _fee2 + _fee3 + _fee4 + _fee5 + _fee6 + _fee7 + _fee8;

        require(totalFees <= 20, "sum of fees cannot exceed 20");
        
        fee1 = _fee1;
        fee2 = _fee2;
        fee3 = _fee3;
        fee4 = _fee4;
        fee5 = _fee5;
        fee6 = _fee6;
        fee7 = _fee7;
        fee8 = _fee8;

        emit FeesUpdated(totalFees, _fee1, _fee2, _fee3, _fee4, _fee5, _fee6, _fee7, _fee8);
    }

    function updateTaxReceiver1(address _account) external onlyOwner {
        require(taxReceiver1 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(1, _account);

        taxReceiver1 = _account;
        _excludeFromFees(taxReceiver1, true);
    }

    function updateTaxReceiver2(address _account) external onlyOwner {
        require(taxReceiver2 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(2, _account);
        
        taxReceiver2 = _account;
        _excludeFromFees(taxReceiver2, true);
    }

    function updateTaxReceiver3(address _account) external onlyOwner {
        require(taxReceiver3 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(3, _account);
        
        taxReceiver3 = _account;
        _excludeFromFees(taxReceiver3, true);
    }

    function updateTaxReceiver4(address _account) external onlyOwner {
        require(taxReceiver4 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(4, _account);
        
        taxReceiver4 = _account;
        _excludeFromFees(taxReceiver4, true);
    }

    function updateTaxReceiver5(address _account) external onlyOwner {
        require(taxReceiver5 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(5, _account);
        
        taxReceiver5 = _account;
        _excludeFromFees(taxReceiver5, true);
    }

    function updateTaxReceiver6(address _account) external onlyOwner {
        require(taxReceiver6 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(6, _account);
        
        taxReceiver6 = _account;
        _excludeFromFees(taxReceiver6, true);
    }

    function updateTaxReceiver7(address _account) external onlyOwner {
        require(taxReceiver7 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(7, _account);
        
        taxReceiver7 = _account;
        _excludeFromFees(taxReceiver7, true);
    }

    function updateTaxReceiver8(address _account) external onlyOwner {
        require(taxReceiver8 != _account, "value already set");
        if (_account == address(0)) revert ZeroAddress();

        emit TaxReceiverAddressUpdated(8, _account);
        
        taxReceiver8 = _account;
        _excludeFromFees(taxReceiver8, true);
    }

    function setMaxTxAmount(uint256 _maxTxAmount) external onlyOwner {
        maxTxAmount = _maxTxAmount;
    }

    /**
     * @notice This method allows a permissioned admin to update the `uniswapV2Pair` var.
     * @dev Used in the event the pool has to be created post deployment.
     * @param pair Pair Address -> Should be Charm/WETH.
     */
    function setUniswapV2Pair(address pair) external onlyOwner {
        if (pair == address(0)) revert ZeroAddress();
        uniswapV2Pair = pair;
        _setAutomatedMarketMakerPair(pair, true);
    }

    /**
     * @notice This method allows a permissioned admin to set a new automated market maker pair.
     * @param pair Pair contract address.
     * @param value If true, `pair` is a verified pair address or pool. Otherwise, false.
     */
    function setAutomatedMarketMakerPair(address pair, bool value) external onlyOwner {
        if (pair == address(0)) revert ZeroAddress();
        _setAutomatedMarketMakerPair(pair, value);
    }

    /**
     * @notice This method allows a permissioned admin to modify whitelisted addresses.
     * @dev Whitelisted addresses are excluded from fees.
     * @param account Address that is (or is not) excluded from fees.
     * @param excluded If true, `account` is excluded from fees. Otherwise, false.
     */
    function excludeFromFees(address account, bool excluded) external onlyOwner {
        _excludeFromFees(account, excluded);
    }

    /**
     * @notice This method allows a permissioned admin to set the new royalty balance threshold to trigger distribution.
     * @param swapAmount New amount of tokens to accumulate before distributing.
     */
    function setSwapTokensAtAmount(uint256 swapAmount) onlyOwner external {
        swapTokensAtAmount = swapAmount;
    }

    /**
     * @notice This method allows a permissioned admin to set the upper limit of royalty balance that can be distributed.
     * @param upperLimit The max amount of royalties that can be sold on sell/transfer.
     */
    function setSwapTokensUpperLimit(uint256 upperLimit) onlyOwner external {
        require(upperLimit >= swapTokensAtAmount, "must be >= swapTokensAtAmount");
        swapTokensUpperLimit = upperLimit;
    }

    
    // ----------------
    // Internal Methods
    // ----------------

    /**
     * @notice Transfers an `amount` amount of tokens from `from` to `to`.
     * @dev This overrides `_update` from ERC20.`
     *      Unless `from` or `to` is excluded, there will be a tax on the transfer.
     * @param from Address balance decreasing.
     * @param to Address balance increasing.
     * @param amount Amount of tokens being transferred.
     */
    function _update(address from, address to, uint256 amount) internal override {

        // note: if automatedMarketMakerPairs[from] == true -> BUY
        // note: if automatedMarketMakerPairs[to] == true   -> SELL

        if (tradingActive) {

            bool excludedAccount = isExcludedFromFees[from] || isExcludedFromFees[to];

            // if not whitelisted, handle royalties and check for limits
            if (!excludedAccount) {

                // if buy or sell, check maxTx amount
                if (automatedMarketMakerPairs[from] || automatedMarketMakerPairs[to]) {
                    require(amount <= maxTxAmount, "Max Tx Amount exceeded");
                }

                // if not buy, distribute royalties and perform swap & distributions
                if (!automatedMarketMakerPairs[from]) {
                
                    // take contract balance of royalty tokens
                    uint256 contractTokenBalance = balanceOf(address(this));

                    // if the contract balance is greater than swapTokensAtAmount, we swap
                    bool canSwap = contractTokenBalance >= swapTokensAtAmount;
                    
                    if (!swapping && canSwap) {
                        // if contract balance is greater than swapTokensUpperLimit, set to swapTokensUpperLimit
                        if (contractTokenBalance > swapTokensUpperLimit) {
                            contractTokenBalance = swapTokensUpperLimit;
                        }
                        _handleRoyalties(contractTokenBalance);
                    }
                }
            }

            bool takeFee = !swapping && !excludedAccount && feesEnabled;

            // `takeFee` == true if no distribution && non-WL && fees enabled
            if(takeFee) {
                uint256 fees;

                fees = (amount * totalFees) / 100;        
                amount -= fees;

                super._update(from, address(this), fees);
            }
        }

        super._update(from, to, amount);
    }

    function _handleRoyalties(uint256 amount) internal {
        _swapTokensForETH(amount);
        if (address(this).balance > 0) {
            _distributeETH();
        }
    }

    /**
     * @notice This internal method takes `tokenAmount` of tokens and swaps it for ETH.
     * @param tokenAmount Amount of $Charm tokens being swapped/sold for ETH.
     */
    function _swapTokensForETH(uint256 tokenAmount) internal lockSwap {
        // generate the uniswap pair path of token -> weth
        address[] memory path = new address[](2);
        path[0] = address(this);
        path[1] = uniswapV2Router.WETH();

        _approve(address(this), address(uniswapV2Router), tokenAmount);

        // make the swap
        uniswapV2Router.swapExactTokensForETH(
            tokenAmount,
            0, // accept any amount of ETH
            path,
            address(this),
            block.timestamp + 300
        );
    }

    function _distributeETH() internal {
        uint256 amount = address(this).balance;
        bool sent;

        (sent,) = taxReceiver1.call{value: amount * fee1 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 1");

        (sent,) = taxReceiver2.call{value: amount * fee2 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 2");

        (sent,) = taxReceiver3.call{value: amount * fee3 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 3");

        (sent,) = taxReceiver4.call{value: amount * fee4 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 4");

        (sent,) = taxReceiver5.call{value: amount * fee5 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 5");

        (sent,) = taxReceiver6.call{value: amount * fee6 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 6");

        (sent,) = taxReceiver7.call{value: amount * fee7 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 7");

        (sent,) = taxReceiver8.call{value: amount * fee8 / totalFees}("");
        require(sent, "Failed to send Ether to recipient 8");

        emit FeesDistributed(amount);
    }

    /**
     * @notice This internal method updates the `automatedMarketMakerPairs` mapping.
     * @param pair Pair contract address.
     * @param value If true, address is set as an AMM pair. Otherwise, false.
     */
    function _setAutomatedMarketMakerPair(address pair, bool value) internal {
        require(automatedMarketMakerPairs[pair] != value, "Already set");

        automatedMarketMakerPairs[pair] = value;
        emit SetAutomatedMarketMakerPair(pair, value);
    }

    /**
     * @notice This method allows a permissioned admin to modify whitelisted addresses.
     * @dev Whitelisted addresses are excluded from fees.
     * @param account Address that is (or is not) excluded from fees.
     * @param excluded If true, `account` is excluded from fees. Otherwise, false.
     */
    function _excludeFromFees(address account, bool excluded) internal {
        if (isExcludedFromFees[account] != excluded) {
            isExcludedFromFees[account] = excluded;
            emit ExcludedFromFees(account, excluded);
        }
    }

    /**
     * @dev Extends the Ownable::_transferOwnership function to allow the parent contract to
     * exclude the new owner from fees.
     */
    function _transferOwnership(address newOwner) internal override {
        _excludeFromFees(newOwner, true);
        super._transferOwnership(newOwner);
    }
}"
    },
    "lib/openzeppelin-contracts/contracts/token/ERC20/ERC20.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/ERC20.sol)

pragma solidity ^0.8.20;

import {IERC20} from "./IERC20.sol";
import {IERC20Metadata} from "./extensions/IERC20Metadata.sol";
import {Context} from "../../utils/Context.sol";
import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol";

/**
 * @dev Implementation of the {IERC20} interface.
 *
 * This implementation is agnostic to the way tokens are created. This means
 * that a supply mechanism has to be added in a derived contract using {_mint}.
 *
 * TIP: For a detailed writeup see our guide
 * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
 * to implement supply mechanisms].
 *
 * The default value of {decimals} is 18. To change this, you should override
 * this function so it returns a different value.
 *
 * We have followed general OpenZeppelin Contracts guidelines: functions revert
 * instead returning `false` on failure. This behavior is nonetheless
 * conventional and does not conflict with the expectations of ERC20
 * applications.
 *
 * Additionally, an {Approval} event is emitted on calls to {transferFrom}.
 * This allows applications to reconstruct the allowance for all accounts just
 * by listening to said events. Other implementations of the EIP may not emit
 * these events, as it isn't required by the specification.
 */
abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
    mapping(address account => uint256) private _balances;

    mapping(address account => mapping(address spender => uint256)) private _allowances;

    uint256 private _totalSupply;

    string private _name;
    string private _symbol;

    /**
     * @dev Sets the values for {name} and {symbol}.
     *
     * All two of these values are immutable: they can only be set once during
     * construction.
     */
    constructor(string memory name_, string memory symbol_) {
        _name = name_;
        _symbol = symbol_;
    }

    /**
     * @dev Returns the name of the token.
     */
    function name() public view virtual returns (string memory) {
        return _name;
    }

    /**
     * @dev Returns the symbol of the token, usually a shorter version of the
     * name.
     */
    function symbol() public view virtual returns (string memory) {
        return _symbol;
    }

    /**
     * @dev Returns the number of decimals used to get its user representation.
     * For example, if `decimals` equals `2`, a balance of `505` tokens should
     * be displayed to a user as `5.05` (`505 / 10 ** 2`).
     *
     * Tokens usually opt for a value of 18, imitating the relationship between
     * Ether and Wei. This is the default value returned by this function, unless
     * it's overridden.
     *
     * NOTE: This information is only used for _display_ purposes: it in
     * no way affects any of the arithmetic of the contract, including
     * {IERC20-balanceOf} and {IERC20-transfer}.
     */
    function decimals() public view virtual returns (uint8) {
        return 18;
    }

    /**
     * @dev See {IERC20-totalSupply}.
     */
    function totalSupply() public view virtual returns (uint256) {
        return _totalSupply;
    }

    /**
     * @dev See {IERC20-balanceOf}.
     */
    function balanceOf(address account) public view virtual returns (uint256) {
        return _balances[account];
    }

    /**
     * @dev See {IERC20-transfer}.
     *
     * Requirements:
     *
     * - `to` cannot be the zero address.
     * - the caller must have a balance of at least `value`.
     */
    function transfer(address to, uint256 value) public virtual returns (bool) {
        address owner = _msgSender();
        _transfer(owner, to, value);
        return true;
    }

    /**
     * @dev See {IERC20-allowance}.
     */
    function allowance(address owner, address spender) public view virtual returns (uint256) {
        return _allowances[owner][spender];
    }

    /**
     * @dev See {IERC20-approve}.
     *
     * NOTE: If `value` is the maximum `uint256`, the allowance is not updated on
     * `transferFrom`. This is semantically equivalent to an infinite approval.
     *
     * Requirements:
     *
     * - `spender` cannot be the zero address.
     */
    function approve(address spender, uint256 value) public virtual returns (bool) {
        address owner = _msgSender();
        _approve(owner, spender, value);
        return true;
    }

    /**
     * @dev See {IERC20-transferFrom}.
     *
     * Emits an {Approval} event indicating the updated allowance. This is not
     * required by the EIP. See the note at the beginning of {ERC20}.
     *
     * NOTE: Does not update the allowance if the current allowance
     * is the maximum `uint256`.
     *
     * Requirements:
     *
     * - `from` and `to` cannot be the zero address.
     * - `from` must have a balance of at least `value`.
     * - the caller must have allowance for ``from``'s tokens of at least
     * `value`.
     */
    function transferFrom(address from, address to, uint256 value) public virtual returns (bool) {
        address spender = _msgSender();
        _spendAllowance(from, spender, value);
        _transfer(from, to, value);
        return true;
    }

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to`.
     *
     * This internal function is equivalent to {transfer}, and can be used to
     * e.g. implement automatic token fees, slashing mechanisms, etc.
     *
     * Emits a {Transfer} event.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead.
     */
    function _transfer(address from, address to, uint256 value) internal {
        if (from == address(0)) {
            revert ERC20InvalidSender(address(0));
        }
        if (to == address(0)) {
            revert ERC20InvalidReceiver(address(0));
        }
        _update(from, to, value);
    }

    /**
     * @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from`
     * (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding
     * this function.
     *
     * Emits a {Transfer} event.
     */
    function _update(address from, address to, uint256 value) internal virtual {
        if (from == address(0)) {
            // Overflow check required: The rest of the code assumes that totalSupply never overflows
            _totalSupply += value;
        } else {
            uint256 fromBalance = _balances[from];
            if (fromBalance < value) {
                revert ERC20InsufficientBalance(from, fromBalance, value);
            }
            unchecked {
                // Overflow not possible: value <= fromBalance <= totalSupply.
                _balances[from] = fromBalance - value;
            }
        }

        if (to == address(0)) {
            unchecked {
                // Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply.
                _totalSupply -= value;
            }
        } else {
            unchecked {
                // Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256.
                _balances[to] += value;
            }
        }

        emit Transfer(from, to, value);
    }

    /**
     * @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0).
     * Relies on the `_update` mechanism
     *
     * Emits a {Transfer} event with `from` set to the zero address.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead.
     */
    function _mint(address account, uint256 value) internal {
        if (account == address(0)) {
            revert ERC20InvalidReceiver(address(0));
        }
        _update(address(0), account, value);
    }

    /**
     * @dev Destroys a `value` amount of tokens from `account`, lowering the total supply.
     * Relies on the `_update` mechanism.
     *
     * Emits a {Transfer} event with `to` set to the zero address.
     *
     * NOTE: This function is not virtual, {_update} should be overridden instead
     */
    function _burn(address account, uint256 value) internal {
        if (account == address(0)) {
            revert ERC20InvalidSender(address(0));
        }
        _update(account, address(0), value);
    }

    /**
     * @dev Sets `value` as the allowance of `spender` over the `owner` s tokens.
     *
     * This internal function is equivalent to `approve`, and can be used to
     * e.g. set automatic allowances for certain subsystems, etc.
     *
     * Emits an {Approval} event.
     *
     * Requirements:
     *
     * - `owner` cannot be the zero address.
     * - `spender` cannot be the zero address.
     *
     * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument.
     */
    function _approve(address owner, address spender, uint256 value) internal {
        _approve(owner, spender, value, true);
    }

    /**
     * @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event.
     *
     * By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by
     * `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any
     * `Approval` event during `transferFrom` operations.
     *
     * Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to
     * true using the following override:
     * ```
     * function _approve(address owner, address spender, uint256 value, bool) internal virtual override {
     *     super._approve(owner, spender, value, true);
     * }
     * ```
     *
     * Requirements are the same as {_approve}.
     */
    function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual {
        if (owner == address(0)) {
            revert ERC20InvalidApprover(address(0));
        }
        if (spender == address(0)) {
            revert ERC20InvalidSpender(address(0));
        }
        _allowances[owner][spender] = value;
        if (emitEvent) {
            emit Approval(owner, spender, value);
        }
    }

    /**
     * @dev Updates `owner` s allowance for `spender` based on spent `value`.
     *
     * Does not update the allowance value in case of infinite allowance.
     * Revert if not enough allowance is available.
     *
     * Does not emit an {Approval} event.
     */
    function _spendAllowance(address owner, address spender, uint256 value) internal virtual {
        uint256 currentAllowance = allowance(owner, spender);
        if (currentAllowance != type(uint256).max) {
            if (currentAllowance < value) {
                revert ERC20InsufficientAllowance(spender, currentAllowance, value);
            }
            unchecked {
                _approve(owner, spender, currentAllowance - value, false);
            }
        }
    }
}
"
    },
    "lib/openzeppelin-contracts/contracts/access/Ownable.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol)

pragma solidity ^0.8.20;

import {Context} from "../utils/Context.sol";

/**
 * @dev Contract module which provides a basic access control mechanism, where
 * there is an account (an owner) that can be granted exclusive access to
 * specific functions.
 *
 * The initial owner is set to the address provided by the deployer. This can
 * later be changed with {transferOwnership}.
 *
 * This module is used through inheritance. It will make available the modifier
 * `onlyOwner`, which can be applied to your functions to restrict their use to
 * the owner.
 */
abstract contract Ownable is Context {
    address private _owner;

    /**
     * @dev The caller account is not authorized to perform an operation.
     */
    error OwnableUnauthorizedAccount(address account);

    /**
     * @dev The owner is not a valid owner account. (eg. `address(0)`)
     */
    error OwnableInvalidOwner(address owner);

    event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);

    /**
     * @dev Initializes the contract setting the address provided by the deployer as the initial owner.
     */
    constructor(address initialOwner) {
        if (initialOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(initialOwner);
    }

    /**
     * @dev Throws if called by any account other than the owner.
     */
    modifier onlyOwner() {
        _checkOwner();
        _;
    }

    /**
     * @dev Returns the address of the current owner.
     */
    function owner() public view virtual returns (address) {
        return _owner;
    }

    /**
     * @dev Throws if the sender is not the owner.
     */
    function _checkOwner() internal view virtual {
        if (owner() != _msgSender()) {
            revert OwnableUnauthorizedAccount(_msgSender());
        }
    }

    /**
     * @dev Leaves the contract without owner. It will not be possible to call
     * `onlyOwner` functions. Can only be called by the current owner.
     *
     * NOTE: Renouncing ownership will leave the contract without an owner,
     * thereby disabling any functionality that is only available to the owner.
     */
    function renounceOwnership() public virtual onlyOwner {
        _transferOwnership(address(0));
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Can only be called by the current owner.
     */
    function transferOwnership(address newOwner) public virtual onlyOwner {
        if (newOwner == address(0)) {
            revert OwnableInvalidOwner(address(0));
        }
        _transferOwnership(newOwner);
    }

    /**
     * @dev Transfers ownership of the contract to a new account (`newOwner`).
     * Internal function without access restriction.
     */
    function _transferOwnership(address newOwner) internal virtual {
        address oldOwner = _owner;
        _owner = newOwner;
        emit OwnershipTransferred(oldOwner, newOwner);
    }
}
"
    },
    "src/interfaces/IUniswapV2Router02.sol": {
      "content": "pragma solidity >=0.6.2;

import './IUniswapV2Router01.sol';

interface IUniswapV2Router02 is IUniswapV2Router01 {
    function removeLiquidityETHSupportingFeeOnTransferTokens(
        address token,
        uint liquidity,
        uint amountTokenMin,
        uint amountETHMin,
        address to,
        uint deadline
    ) external returns (uint amountETH);
    function removeLiquidityETHWithPermitSupportingFeeOnTransferTokens(
        address token,
        uint liquidity,
        uint amountTokenMin,
        uint amountETHMin,
        address to,
        uint deadline,
        bool approveMax, uint8 v, bytes32 r, bytes32 s
    ) external returns (uint amountETH);

    function swapExactTokensForTokensSupportingFeeOnTransferTokens(
        uint amountIn,
        uint amountOutMin,
        address[] calldata path,
        address to,
        uint deadline
    ) external;
    function swapExactETHForTokensSupportingFeeOnTransferTokens(
        uint amountOutMin,
        address[] calldata path,
        address to,
        uint deadline
    ) external payable;
    function swapExactTokensForETHSupportingFeeOnTransferTokens(
        uint amountIn,
        uint amountOutMin,
        address[] calldata path,
        address to,
        uint deadline
    ) external;
}"
    },
    "src/interfaces/IUniswapV2Factory.sol": {
      "content": "pragma solidity >=0.5.0;

interface IUniswapV2Factory {
    event PairCreated(address indexed token0, address indexed token1, address pair, uint);

    function feeTo() external view returns (address);
    function feeToSetter() external view returns (address);

    function getPair(address tokenA, address tokenB) external view returns (address pair);
    function allPairs(uint) external view returns (address pair);
    function allPairsLength() external view returns (uint);

    function createPair(address tokenA, address tokenB) external returns (address pair);

    function setFeeTo(address) external;
    function setFeeToSetter(address) external;
}"
    },
    "lib/openzeppelin-contracts/contracts/token/ERC20/IERC20.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)

pragma solidity ^0.8.20;

/**
 * @dev Interface of the ERC20 standard as defined in the EIP.
 */
interface IERC20 {
    /**
     * @dev Emitted when `value` tokens are moved from one account (`from`) to
     * another (`to`).
     *
     * Note that `value` may be zero.
     */
    event Transfer(address indexed from, address indexed to, uint256 value);

    /**
     * @dev Emitted when the allowance of a `spender` for an `owner` is set by
     * a call to {approve}. `value` is the new allowance.
     */
    event Approval(address indexed owner, address indexed spender, uint256 value);

    /**
     * @dev Returns the value of tokens in existence.
     */
    function totalSupply() external view returns (uint256);

    /**
     * @dev Returns the value of tokens owned by `account`.
     */
    function balanceOf(address account) external view returns (uint256);

    /**
     * @dev Moves a `value` amount of tokens from the caller's account to `to`.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transfer(address to, uint256 value) external returns (bool);

    /**
     * @dev Returns the remaining number of tokens that `spender` will be
     * allowed to spend on behalf of `owner` through {transferFrom}. This is
     * zero by default.
     *
     * This value changes when {approve} or {transferFrom} are called.
     */
    function allowance(address owner, address spender) external view returns (uint256);

    /**
     * @dev Sets a `value` amount of tokens as the allowance of `spender` over the
     * caller's tokens.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * IMPORTANT: Beware that changing an allowance with this method brings the risk
     * that someone may use both the old and the new allowance by unfortunate
     * transaction ordering. One possible solution to mitigate this race
     * condition is to first reduce the spender's allowance to 0 and set the
     * desired value afterwards:
     * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
     *
     * Emits an {Approval} event.
     */
    function approve(address spender, uint256 value) external returns (bool);

    /**
     * @dev Moves a `value` amount of tokens from `from` to `to` using the
     * allowance mechanism. `value` is then deducted from the caller's
     * allowance.
     *
     * Returns a boolean value indicating whether the operation succeeded.
     *
     * Emits a {Transfer} event.
     */
    function transferFrom(address from, address to, uint256 value) external returns (bool);
}
"
    },
    "lib/openzeppelin-contracts/contracts/token/ERC20/extensions/IERC20Metadata.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol)

pragma solidity ^0.8.20;

import {IERC20} from "../IERC20.sol";

/**
 * @dev Interface for the optional metadata functions from the ERC20 standard.
 */
interface IERC20Metadata is IERC20 {
    /**
     * @dev Returns the name of the token.
     */
    function name() external view returns (string memory);

    /**
     * @dev Returns the symbol of the token.
     */
    function symbol() external view returns (string memory);

    /**
     * @dev Returns the decimals places of the token.
     */
    function decimals() external view returns (uint8);
}
"
    },
    "lib/openzeppelin-contracts/contracts/utils/Context.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)

pragma solidity ^0.8.20;

/**
 * @dev Provides information about the current execution context, including the
 * sender of the transaction and its data. While these are generally available
 * via msg.sender and msg.data, they should not be accessed in such a direct
 * manner, since when dealing with meta-transactions the account sending and
 * paying for execution may not be the actual sender (as far as an application
 * is concerned).
 *
 * This contract is only required for intermediate, library-like contracts.
 */
abstract contract Context {
    function _msgSender() internal view virtual returns (address) {
        return msg.sender;
    }

    function _msgData() internal view virtual returns (bytes calldata) {
        return msg.data;
    }

    function _contextSuffixLength() internal view virtual returns (uint256) {
        return 0;
    }
}
"
    },
    "lib/openzeppelin-contracts/contracts/interfaces/draft-IERC6093.sol": {
      "content": "// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;

/**
 * @dev Standard ERC20 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens.
 */
interface IERC20Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC20InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC20InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     * @param allowance Amount of tokens a `spender` is allowed to operate with.
     * @param needed Minimum amount required to perform a transfer.
     */
    error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC20InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `spender` to be approved. Used in approvals.
     * @param spender Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC20InvalidSpender(address spender);
}

/**
 * @dev Standard ERC721 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens.
 */
interface IERC721Errors {
    /**
     * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-20.
     * Used in balance queries.
     * @param owner Address of the current owner of a token.
     */
    error ERC721InvalidOwner(address owner);

    /**
     * @dev Indicates a `tokenId` whose `owner` is the zero address.
     * @param tokenId Identifier number of a token.
     */
    error ERC721NonexistentToken(uint256 tokenId);

    /**
     * @dev Indicates an error related to the ownership over a particular token. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param tokenId Identifier number of a token.
     * @param owner Address of the current owner of a token.
     */
    error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC721InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC721InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param tokenId Identifier number of a token.
     */
    error ERC721InsufficientApproval(address operator, uint256 tokenId);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC721InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC721InvalidOperator(address operator);
}

/**
 * @dev Standard ERC1155 Errors
 * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 tokens.
 */
interface IERC1155Errors {
    /**
     * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     * @param balance Current balance for the interacting account.
     * @param needed Minimum amount required to perform a transfer.
     * @param tokenId Identifier number of a token.
     */
    error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId);

    /**
     * @dev Indicates a failure with the token `sender`. Used in transfers.
     * @param sender Address whose tokens are being transferred.
     */
    error ERC1155InvalidSender(address sender);

    /**
     * @dev Indicates a failure with the token `receiver`. Used in transfers.
     * @param receiver Address to which tokens are being transferred.
     */
    error ERC1155InvalidReceiver(address receiver);

    /**
     * @dev Indicates a failure with the `operator`’s approval. Used in transfers.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     * @param owner Address of the current owner of a token.
     */
    error ERC1155MissingApprovalForAll(address operator, address owner);

    /**
     * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals.
     * @param approver Address initiating an approval operation.
     */
    error ERC1155InvalidApprover(address approver);

    /**
     * @dev Indicates a failure with the `operator` to be approved. Used in approvals.
     * @param operator Address that may be allowed to operate on tokens without being their owner.
     */
    error ERC1155InvalidOperator(address operator);

    /**
     * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation.
     * Used in batch transfers.
     * @param idsLength Length of the array of token identifiers
     * @param valuesLength Length of the array of token amounts
     */
    error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength);
}
"
    },
    "src/interfaces/IUniswapV2Router01.sol": {
      "content": "pragma solidity >=0.6.2;

interface IUniswapV2Router01 {
    function factory() external pure returns (address);
    function WETH() external pure returns (address);

    function addLiquidity(
        address tokenA,
        address tokenB,
        uint amountADesired,
        uint amountBDesired,
        uint amountAMin,
        uint amountBMin,
        address to,
        uint deadline
    ) external returns (uint amountA, uint amountB, uint liquidity);
    function addLiquidityETH(
        address token,
        uint amountTokenDesired,
        uint amountTokenMin,
        uint amountETHMin,
        address to,
        uint deadline
    ) external payable returns (uint amountToken, uint amountETH, uint liquidity);
    function removeLiquidity(
        address tokenA,
        address tokenB,
        uint liquidity,
        uint amountAMin,
        uint amountBMin,
        address to,
        uint deadline
    ) external returns (uint amountA, uint amountB);
    function removeLiquidityETH(
        address token,
        uint liquidity,
        uint amountTokenMin,
        uint amountETHMin,
        address to,
        uint deadline
    ) external returns (uint amountToken, uint amountETH);
    function removeLiquidityWithPermit(
        address tokenA,
        address tokenB,
        uint liquidity,
        uint amountAMin,
        uint amountBMin,
        address to,
        uint deadline,
        bool approveMax, uint8 v, bytes32 r, bytes32 s
    ) external returns (uint amountA, uint amountB);
    function removeLiquidityETHWithPermit(
        address token,
        uint liquidity,
        uint amountTokenMin,
        uint amountETHMin,
        address to,
        uint deadline,
        bool approveMax, uint8 v, bytes32 r, bytes32 s
    ) external returns (uint amountToken, uint amountETH);
    function swapExactTokensForTokens(
        uint amountIn,
        uint amountOutMin,
        address[] calldata path,
        address to,
        uint deadline
    ) external returns (uint[] memory amounts);
    function swapTokensForExactTokens(
        uint amountOut,
        uint amountInMax,
        address[] calldata path,
        address to,
        uint deadline
    ) external returns (uint[] memory amounts);
    function swapExactETHForTokens(uint amountOutMin, address[] calldata path, address to, uint deadline)
        external
        payable
        returns (uint[] memory amounts);
    function swapTokensForExactETH(uint amountOut, uint amountInMax, address[] calldata path, address to, uint deadline)
        external
        returns (uint[] memory amounts);
    function swapExactTokensForETH(uint amountIn, uint amountOutMin, address[] calldata path, address to, uint deadline)
        external
        returns (uint[] memory amounts);
    function swapETHForExactTokens(uint amountOut, address[] calldata path, address to, uint deadline)
        external
        payable
        returns (uint[] memory amounts);

    function quote(uint amountA, uint reserveA, uint reserveB) external pure returns (uint amountB);
    function getAmountOut(uint amountIn, uint reserveIn, uint reserveOut) external pure returns (uint amountOut);
    function getAmountIn(uint amountOut, uint reserveIn, uint reserveOut) external pure returns (uint amountIn);
    function getAmountsOut(uint amountIn, address[] calldata path) external view returns (uint[] memory amounts);
    function getAmountsIn(uint amountOut, address[] calldata path) external view returns (uint[] memory amounts);
}"
    }
  },
  "settings": {
    "remappings": [
      "@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
      "@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
      "ds-test/=lib/openzeppelin-contracts-upgradeable/lib/forge-std/lib/ds-test/src/",
      "erc4626-tests/=lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/",
      "forge-std/=lib/forge-std/src/",
      "openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/",
      "openzeppelin-contracts/=lib/openzeppelin-contracts/"
    ],
    "optimizer": {
      "enabled": false,
      "runs": 200
    },
    "metadata": {
      "useLiteralContent": false,
      "bytecodeHash": "ipfs",
      "appendCBOR": true
    },
    "outputSelection": {
      "*": {
        "*": [
          "evm.bytecode",
          "evm.deployedBytecode",
          "devdoc",
          "userdoc",
          "metadata",
          "abi"
        ]
      }
    },
    "evmVersion": "shanghai",
    "viaIR": false
  }
}}