d864228624
* Improve IRelayRecipient docs * Fix link * Update IRelayHub docs to the docsite format * Update IRelayRecipient docs to the dociste format * Fix typo * Improve GSN readme * Fix link * Update GSNRecipient docs * Apply suggestions from code review Co-Authored-By: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com> * Apply suggestions from code review Co-Authored-By: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com> * Apply suggestions from code review Co-Authored-By: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>
51 lines
1.5 KiB
Plaintext
51 lines
1.5 KiB
Plaintext
= ERC 20
|
|
|
|
This set of interfaces, contracts, and utilities are all related to the https://eips.ethereum.org/EIPS/eip-20[ERC20 Token Standard].
|
|
|
|
TIP: For an overview of ERC20 tokens and a walkthrough on how to create a token contract read our xref:ROOT:tokens.adoc#ERC20[ERC20 guide].
|
|
|
|
There a few core contracts that implement the behavior specified in the EIP:
|
|
|
|
* {IERC20}: the interface all ERC20 implementations should conform to
|
|
* {ERC20}: the base implementation of the ERC20 interface
|
|
* {ERC20Detailed}: includes the <<ERC20Detailed-name,`name`>>,
|
|
<<ERC20Detailed-symbol,`symbol`>> and <<ERC20Detailed-decimals,`decimals`>>
|
|
optional standard extension to the base interface
|
|
|
|
Additionally there are multiple custom extensions, including:
|
|
|
|
* designation of addresses that can create token supply ({ERC20Mintable}), with an optional maximum cap ({ERC20Capped})
|
|
* destruction of own tokens ({ERC20Burnable})
|
|
* designation of addresses that can pause token operations for all users ({ERC20Pausable}).
|
|
|
|
Finally, there are some utilities to interact with ERC20 contracts in various ways.
|
|
|
|
* {SafeERC20} is a wrapper around the interface that eliminates the need to handle boolean return values.
|
|
* {TokenTimelock} can hold tokens for a beneficiary until a specified time.
|
|
|
|
NOTE: This page is incomplete. We're working to improve it for the next release. Stay tuned!
|
|
|
|
== Core
|
|
|
|
{{IERC20}}
|
|
|
|
{{ERC20}}
|
|
|
|
{{ERC20Detailed}}
|
|
|
|
== Extensions
|
|
|
|
{{ERC20Mintable}}
|
|
|
|
{{ERC20Burnable}}
|
|
|
|
{{ERC20Pausable}}
|
|
|
|
{{ERC20Capped}}
|
|
|
|
== Utilities
|
|
|
|
{{SafeERC20}}
|
|
|
|
{{TokenTimelock}}
|