`symbol()` is not a part of the ERC-20 standard

In the development of ERC-20 tokens, functions like symbol() and name() are often included to provide human-readable details about the token. However, it is crucial to understand that these functions are not part of the original ERC-20 standard. Including such functions can be beneficial for user interfaces and integrations but may lead to inconsistencies with systems that strictly adhere to the ERC-20 specification.

Problem

While symbol() and name() are useful for providing additional metadata about a token, their absence in the ERC-20 standard means that some tools and contracts might not recognize these functions. This can cause issues when interacting with systems that only expect the core ERC-20 functionality.

Solution

Despite not being part of the ERC-20 standard, it is common practice to implement symbol() and name() for better user experience. Developers should ensure these functions are implemented in a way that does not interfere with the core functionality of the token. They should also document these functions clearly to avoid confusion.

Example Code

pragma solidity ^0.8.0;

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

contract MyToken is ERC20 {
    uint8 private _decimals;

    constructor(uint256 initialSupply, uint8 decimals_) ERC20("MyToken", "MTK") {
        _mint(msg.sender, initialSupply);
        _decimals = decimals_;
    }

    // Overriding the decimals function for convenience
    function decimals() public view returns (uint8) {
        return _decimals;
    }

    // Overriding the symbol function for convenience, though it's not part of the ERC-20 standard
    function symbol() public view returns (string memory) {
        return "MTK";
    }

    // Overriding the name function for convenience, though it's not part of the ERC-20 standard
    function name() public view returns (string memory) {
        return "MyToken";
    }
}

Conclusion

Although symbol() and name() are not part of the ERC-20 standard, they are commonly included in token contracts to improve usability and integration with user interfaces. Developers should be aware of the distinction between core ERC-20 functions and additional metadata functions, ensuring that their inclusion does not disrupt the token's primary functionality. Clear documentation and a thorough understanding of the ERC-20 standard are essential for maintaining compatibility and interoperability within the Ethereum ecosystem.