BurnPool

{{
  "language": "Solidity",
  "sources": {
    "src/BurnPool.sol": {
      "content": "// SPDX-License-Identifier: MIT
pragma solidity >=0.8.28 <0.9.0;

import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

/**
 * @title BurnPool
 * @dev A burn pool that locks voluntarily burned tokens in this contract's address.
 *      The contract exposes no transfer-out or approval functionality, making tokens
 *      permanently inaccessible. Tracks the global total burned and per-account totals.
 */
contract BurnPool {
    /// @notice The ERC20 token to be burned (BlockRockToken)
    IERC20 public immutable token;

    /// @notice Total burned amount (cumulative tokens locked in this contract)
    uint256 public totalBurned;

    /// @notice Per-account burned amounts
    mapping(address => uint256) public burnedOf;

    /// @dev Emitted when `from` burns `amount` tokens
    event Burned(address indexed from, uint256 amount);

    /**
     * @param token_ Address of the BlockRockToken to burn
     */
    constructor(address token_) {
        require(token_ != address(0), "token address is zero");
        token = IERC20(token_);
    }

    /**
     * @notice Burn caller's tokens by locking them in this contract address.
     * @dev Caller must `approve(address(this), amount)` before calling.
     * @param amount The amount to burn
     */
    function burn(uint256 amount) external {
        require(amount > 0, "amount = 0");
        
        totalBurned += amount;
        burnedOf[msg.sender] += amount;
        
        token.transferFrom(msg.sender, address(this), amount);

        emit Burned(msg.sender, amount);
    }

    /**
     * @notice Burn tokens on behalf of `from` by locking them in this contract address.
     * @dev Requires sufficient allowance from `from` to this contract.
     * @param from The account whose tokens will be burned
     * @param amount The amount to burn
     */
    function burnFrom(address from, uint256 amount) external {
        require(from != address(0), "from = zero");
        require(amount > 0, "amount = 0");

        totalBurned += amount;
        burnedOf[from] += amount;

        token.transferFrom(from, address(this), amount);
        emit Burned(from, amount);
    }
}"
    },
    "node_modules/@openzeppelin/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);
}
"
    }
  },
  "settings": {
    "remappings": [
      "@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/",
      "forge-std/=node_modules/forge-std/"
    ],
    "optimizer": {
      "enabled": true,
      "runs": 10000
    },
    "metadata": {
      "useLiteralContent": false,
      "bytecodeHash": "none",
      "appendCBOR": true
    },
    "outputSelection": {
      "*": {
        "*": [
          "evm.bytecode",
          "evm.deployedBytecode",
          "devdoc",
          "userdoc",
          "metadata",
          "abi"
        ]
      }
    },
    "evmVersion": "shanghai",
    "viaIR": true
  }
}}