ERC20Detailed.sol
Optional functions from the ERC20 standard.
Methods
allowance(address,address)
function allowance(address owner, address spender) external view returns (uint256)
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.
Parameters
Name | Type | Description |
---|---|---|
owner | address | undefined |
spender | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
approve(address,uint256)
function approve(address spender, uint256 amount) external nonpayable returns (bool)
Sets amount
as the allowance of spender
over the caller's tokens. Returns a boolean value indicating whether the operation succeeded. > 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.
Parameters
Name | Type | Description |
---|---|---|
spender | address | undefined |
amount | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
balanceOf(address)
function balanceOf(address account) external view returns (uint256)
Returns the amount of tokens owned by account
.
Parameters
Name | Type | Description |
---|---|---|
account | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
decimals()
function decimals() external view returns (uint8)
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. > Note that 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
.
Returns
Name | Type | Description |
---|---|---|
_0 | uint8 | undefined |
name()
function name() external view returns (string)
Returns the name of the token.
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
symbol()
function symbol() external view returns (string)
Returns the symbol of the token, usually a shorter version of the name.
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
totalSupply()
function totalSupply() external view returns (uint256)
Returns the amount of tokens in existence.
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
transfer(address,uint256)
function transfer(address recipient, uint256 amount) external nonpayable returns (bool)
Moves amount
tokens from the caller's account to recipient
. Returns a boolean value indicating whether the operation succeeded. Emits a Transfer
event.
Parameters
Name | Type | Description |
---|---|---|
recipient | address | undefined |
amount | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
transferFrom(address,address,uint256)
function transferFrom(address sender, address recipient, uint256 amount) external nonpayable returns (bool)
Moves amount
tokens from sender
to recipient
using the allowance mechanism. amount
is then deducted from the caller's allowance. Returns a boolean value indicating whether the operation succeeded. Emits a Transfer
event.
Parameters
Name | Type | Description |
---|---|---|
sender | address | undefined |
recipient | address | undefined |
amount | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
Events
Approval
event Approval(address indexed owner, address indexed spender, uint256 value)
Parameters
Name | Type | Description |
---|---|---|
owner indexed | address | undefined |
spender indexed | address | undefined |
value | uint256 | undefined |
Transfer
event Transfer(address indexed from, address indexed to, uint256 value)
Parameters
Name | Type | Description |
---|---|---|
from indexed | address | undefined |
to indexed | address | undefined |
value | uint256 | undefined |