InitiaERC20

GitHub: InitiaERC20

Overview

The InitiaERC20 contract is an implementation of the ERC20 token standard with additional functionalities such as access control, registry integration, and support for Cosmos blockchain interactions. This contract inherits from multiple contracts including IERC20, Ownable, ERC20Registry, ERC165, and ERC20ACL.

It can be used in two ways: via the ERC20Factory for standard tokens, or inherited directly for custom tokens with additional logic.

Inheritance

• IERC20: Interface for ERC20 standard functions.
• Ownable: Provides ownership control.
• ERC20Registry: Handles ERC20 registry functionalities.
• ERC165: Supports interface identification.
• ERC20ACL: Provides access control mechanisms.

Events

• Transfer: Emitted when tokens are transferred from one address to another.

• address indexed from: The address sending the tokens.

• address indexed to: The address receiving the tokens.

• uint256 value: The amount of tokens transferred.

• Approval: Emitted when an address approves another address to spend tokens on its behalf.

• address indexed owner: The address granting the approval.

• address indexed spender: The address receiving the approval.

• uint256 value: The amount of tokens approved.

State Variables

• mapping(address => uint256) public balanceOf: Tracks the balance of each address.
• mapping(address => mapping(address => uint256)) public allowance: Tracks the allowance each address has given to another address.
• string public name: The name of the token.
• string public symbol: The symbol of the token.
• uint8 public decimals: The number of decimals the token uses.
• uint256 public totalSupply: The total supply of the token.

Constructor

Initializes the contract with the token’s name, symbol, and decimals. The register_erc20 modifier registers the token with the ERC20 registry. InitiaERC20 is used for custom deployments only; factory-created tokens use the ERC20 contract.

constructor(string memory _name, string memory _symbol, uint8 _decimals) register_erc20 {
    name = _name;
    symbol = _symbol;
    decimals = _decimals;
}

Parameters

Name	Type	Description
_name	string memory	The name of the token.
_symbol	string memory	The symbol of the token.
_decimals	uint8	The number of decimals the token uses.

Functions

supportsInterface

Checks if the contract supports a given interface.

function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC165) returns (bool)

Parameters

Name	Type	Description
interfaceId	bytes4	The interface identifier.

Returns

Type	Description
bool	true if the interface is supported, false otherwise.

_transfer

Transfers tokens from one address to another and registers the recipient’s ERC20 store if necessary.

function _transfer(address sender, address recipient, uint256 amount) internal register_erc20_store(recipient)

Parameters

Name	Type	Description
sender	address	The address sending the tokens.
recipient	address	The address receiving the tokens.
amount	uint256	The amount of tokens to transfer.

_mint

Mints new tokens and assigns them to an address, registering the recipient’s ERC20 store if necessary.

function _mint(address to, uint256 amount) internal register_erc20_store(to)

Parameters

Name	Type	Description
to	address	The address receiving the tokens.
amount	uint256	The amount of tokens to mint.

_burn

Burns tokens from an address.

function _burn(address from, uint256 amount) internal

Parameters

Name	Type	Description
from	address	The address whose tokens will be burned.
amount	uint256	The amount of tokens to burn.

transfer

Transfers tokens to a recipient, ensuring the recipient is not a blocked address.

function transfer(address recipient, uint256 amount) external transferable(recipient) returns (bool)

Parameters

Name	Type	Description
recipient	address	The address receiving the tokens.
amount	uint256	The amount of tokens to transfer.

Returns

Type	Description
bool	true if the transfer was successful.

approve

Approves an address to spend a specified amount of tokens on behalf of the caller.

function approve(address spender, uint256 amount) external returns (bool)

Parameters

Name	Type	Description
spender	address	The address allowed to spend the tokens.
amount	uint256	The amount of tokens to approve.

Returns

Type	Description
bool	true if the approval was successful.

transferFrom

Transfers tokens from one address to another on behalf of the sender, ensuring the recipient is not a blocked address.

function transferFrom(address sender, address recipient, uint256 amount) external transferable(recipient) returns (bool)

Parameters

Name	Type	Description
sender	address	The address sending the tokens.
recipient	address	The address receiving the tokens.
amount	uint256	The amount of tokens to transfer.

Returns

Type	Description
bool	true if the transfer was successful.

mint

Mints new tokens to a specified address, ensuring the recipient is not a blocked address. This function can only be called by the owner.

function mint(address to, uint256 amount) external mintable(to) onlyOwner

Parameters

Name	Type	Description
to	address	The address receiving the tokens.
amount	uint256	The amount of tokens to mint.

burn

Burns tokens from the caller’s address, ensuring the sender is not a module address.

function burn(uint256 amount) external burnable(msg.sender)

Parameters

Name	Type	Description
amount	uint256	The amount of tokens to burn.

burnFrom

Burns tokens from a specified address on behalf of the caller, ensuring the address is not a module address. Requires prior allowance approval.

function burnFrom(address from, uint256 amount) external burnable(from) returns (bool)

Parameters

Name	Type	Description
from	address	The address whose tokens are burned.
amount	uint256	The amount of tokens to burn.

Returns

Type	Description
bool	true if the burn was successful.

sudoTransfer

Transfers tokens from one address to another, bypassing the usual access control checks. This function can only be called by the chain signer.

function sudoTransfer(address sender, address recipient, uint256 amount) external onlyChain

Parameters

Name	Type	Description
sender	address	The address sending the tokens.
recipient	address	The address receiving the tokens.
amount	uint256	The amount of tokens to transfer.