From 0c667ca32ab4384c09ce6cc062f5d9b7f95778ec Mon Sep 17 00:00:00 2001 From: "Julian M. Rodriguez" <56316686+julianmrodri@users.noreply.github.com> Date: Tue, 21 Jul 2020 19:04:21 -0300 Subject: [PATCH] docs: add note explaining opinionated presets (#2313) * docs: add notes explaining presets * fix links for mint function Co-authored-by: Francisco Giordano Co-authored-by: Francisco Giordano --- contracts/token/ERC1155/README.adoc | 2 ++ contracts/token/ERC20/README.adoc | 2 ++ contracts/token/ERC721/README.adoc | 3 +++ 3 files changed, 7 insertions(+) diff --git a/contracts/token/ERC1155/README.adoc b/contracts/token/ERC1155/README.adoc index fbd04b53b..e80474695 100644 --- a/contracts/token/ERC1155/README.adoc +++ b/contracts/token/ERC1155/README.adoc @@ -14,6 +14,8 @@ Additionally there are multiple custom extensions, including: * designation of addresses that can pause token transfers for all users ({ERC1155Pausable}). * destruction of own tokens ({ERC1155Burnable}). +NOTE: This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC1155 (such as <>) and expose them as external functions in the way they prefer. On the other hand, xref:ROOT:erc1155.adoc#Presets[ERC1155 Presets] (such as {ERC1155PresetMinterPauser}) are designed using opinionated patterns to provide developers with ready to use, deployable contracts. + == Core {{IERC1155}} diff --git a/contracts/token/ERC20/README.adoc b/contracts/token/ERC20/README.adoc index dfeff863c..e12e57621 100644 --- a/contracts/token/ERC20/README.adoc +++ b/contracts/token/ERC20/README.adoc @@ -24,6 +24,8 @@ Finally, there are some utilities to interact with ERC20 contracts in various wa * {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 core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC20 (such as <>) and expose them as external functions in the way they prefer. On the other hand, xref:ROOT:erc20.adoc#Presets[ERC20 Presets] (such as {ERC20PresetMinterPauser}) are designed using opinionated patterns to provide developers with ready to use, deployable contracts. + == Core {{IERC20}} diff --git a/contracts/token/ERC721/README.adoc b/contracts/token/ERC721/README.adoc index ce54a3d5e..69191ab30 100644 --- a/contracts/token/ERC721/README.adoc +++ b/contracts/token/ERC721/README.adoc @@ -16,6 +16,9 @@ Additionally there are multiple custom extensions, including: * designation of addresses that can pause token transfers for all users ({ERC721Pausable}). * destruction of own tokens ({ERC721Burnable}). +NOTE: This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC721 (such as <>) and expose them as external functions in the way they prefer. On the other hand, xref:ROOT:erc721.adoc#Presets[ERC721 Presets] (such as {ERC721PresetMinterPauserAutoId}) are designed using opinionated patterns to provide developers with ready to use, deployable contracts. + + == Core {{IERC721}}