ERC20Upgradeable.sol

View Source: @openzeppelin\contracts-upgradeable\token\ERC20\ERC20Upgradeable.sol

↗ Extends: Initializable, ContextUpgradeable, IERC20Upgradeable, IERC20MetadataUpgradeable ↘ Derived Contracts: CustomToken

ERC20Upgradeable

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}. For a generic mechanism see {ERC20PresetMinterPauser}. TIP: For a detailed writeup see our guide https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How to implement supply mechanisms]. 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. Finally, the non-standard {decreaseAllowance} and {increaseAllowance} functions have been added to mitigate the well-known issues around setting allowances. See {IERC20-approve}.

Contract Members

Constants & Variables

mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
uint256[45] private __gap;

Functions

_ERC20_init(string name, string symbol_)
_ERC20_init_unchained(string name, string symbol_)
name()
symbol()
decimals()
totalSupply()
balanceOf(address account)
transfer(address to, uint256 amount)
allowance(address owner, address spender)
approve(address spender, uint256 amount)
transferFrom(address from, address to, uint256 amount)
increaseAllowance(address spender, uint256 addedValue)
decreaseAllowance(address spender, uint256 subtractedValue)
_transfer(address from, address to, uint256 amount)
_mint(address account, uint256 amount)
_burn(address account, uint256 amount)
_approve(address owner, address spender, uint256 amount)
_spendAllowance(address owner, address spender, uint256 amount)
_beforeTokenTransfer(address from, address to, uint256 amount)
_afterTokenTransfer(address from, address to, uint256 amount)

__ERC20_init

Sets the values for {name} and {symbol}. The default value of {decimals} is 18. To select a different value for {decimals} you should overload it. All two of these values are immutable: they can only be set once during construction.

function __ERC20_init(string name_, string symbol_) internal nonpayable onlyInitializing 

Arguments

Name	Type	Description
name_	string
symbol_	string

__ERC20_init_unchained

function __ERC20_init_unchained(string name_, string symbol_) internal nonpayable onlyInitializing 

Arguments

Name	Type	Description
name_	string
symbol_	string

name

Returns the name of the token.

function name() public view
returns(string)

Arguments

| Name | Type | Description | | ————- |————- | —–|

symbol

Returns the symbol of the token, usually a shorter version of the name.

function symbol() public view
returns(string)

Arguments

| Name | Type | Description | | ————- |————- | —–|

decimals

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 value {ERC20} uses, unless this function is 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
returns(uint8)

Arguments

| Name | Type | Description | | ————- |————- | —–|

totalSupply

See {IERC20-totalSupply}.

function totalSupply() public view
returns(uint256)

Arguments

| Name | Type | Description | | ————- |————- | —–|

balanceOf

See {IERC20-balanceOf}.

function balanceOf(address account) public view
returns(uint256)

Arguments

Name	Type	Description
account	address

transfer

See {IERC20-transfer}. Requirements:

to cannot be the zero address.
the caller must have a balance of at least amount.

function transfer(address to, uint256 amount) public nonpayable
returns(bool)

Arguments

Name	Type	Description
to	address
amount	uint256

allowance

See {IERC20-allowance}.

function allowance(address owner, address spender) public view
returns(uint256)

Arguments

Name	Type	Description
owner	address
spender	address

approve

See {IERC20-approve}. NOTE: If amount 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 amount) public nonpayable
returns(bool)

Arguments

Name	Type	Description
spender	address
amount	uint256

transferFrom

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 amount.
the caller must have allowance for from’s tokens of at least amount.

function transferFrom(address from, address to, uint256 amount) public nonpayable
returns(bool)

Arguments

Name	Type	Description
from	address
to	address
amount	uint256

increaseAllowance

Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements:

spender cannot be the zero address.

function increaseAllowance(address spender, uint256 addedValue) public nonpayable
returns(bool)

Arguments

Name	Type	Description
spender	address
addedValue	uint256

decreaseAllowance

Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements:

spender cannot be the zero address.
spender must have allowance for the caller of at least subtractedValue.

function decreaseAllowance(address spender, uint256 subtractedValue) public nonpayable
returns(bool)

Arguments

Name	Type	Description
spender	address
subtractedValue	uint256

_transfer

Moves amount of tokens from sender to recipient. 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. Requirements:

from cannot be the zero address.
to cannot be the zero address.
from must have a balance of at least amount.

function _transfer(address from, address to, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
from	address
to	address
amount	uint256

_mint

Creates amount tokens and assigns them to account, increasing the total supply. Emits a {Transfer} event with from set to the zero address. Requirements:

account cannot be the zero address.

function _mint(address account, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
account	address
amount	uint256

_burn

Destroys amount tokens from account, reducing the total supply. Emits a {Transfer} event with to set to the zero address. Requirements:

account cannot be the zero address.
account must have at least amount tokens.

function _burn(address account, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
account	address
amount	uint256

_approve

Sets amount 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.

function _approve(address owner, address spender, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
owner	address
spender	address
amount	uint256

_spendAllowance

Updates owner s allowance for spender based on spent amount. Does not update the allowance amount in case of infinite allowance. Revert if not enough allowance is available. Might emit an {Approval} event.

function _spendAllowance(address owner, address spender, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
owner	address
spender	address
amount	uint256

_beforeTokenTransfer

Hook that is called before any transfer of tokens. This includes minting and burning. Calling conditions:

when from and to are both non-zero, amount of from’s tokens will be transferred to to.
when from is zero, amount tokens will be minted for to.
when to is zero, amount of from’s tokens will be burned.
from and to are never both zero. To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].

function _beforeTokenTransfer(address from, address to, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
from	address
to	address
amount	uint256

_afterTokenTransfer

Hook that is called after any transfer of tokens. This includes minting and burning. Calling conditions:

when from and to are both non-zero, amount of from’s tokens has been transferred to to.
when from is zero, amount tokens have been minted for to.
when to is zero, amount of from’s tokens have been burned.
from and to are never both zero. To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].

function _afterTokenTransfer(address from, address to, uint256 amount) internal nonpayable

Arguments

Name	Type	Description
from	address
to	address
amount	uint256