diff --git a/contracts/GSN/README.adoc b/contracts/GSN/README.adoc index 30c57dd16..cba87cf2b 100644 --- a/contracts/GSN/README.adoc +++ b/contracts/GSN/README.adoc @@ -1,5 +1,8 @@ = Gas Station Network (GSN) +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/gsn + This set of contracts provide all the tools required to make a contract callable via the https://gsn.openzeppelin.com[Gas Station Network]. TIP: If you're new to the GSN, head over to our xref:learn::sending-gasless-transactions.adoc[overview of the system] and basic guide to xref:ROOT:gsn.adoc[creating a GSN-capable contract]. diff --git a/contracts/access/README.adoc b/contracts/access/README.adoc index 1eac5239c..42e658463 100644 --- a/contracts/access/README.adoc +++ b/contracts/access/README.adoc @@ -1,5 +1,8 @@ = Access +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/access + Contract modules for authorization and access control mechanisms. == Contracts diff --git a/contracts/cryptography/README.adoc b/contracts/cryptography/README.adoc index 2adc27f0e..996e9dadb 100644 --- a/contracts/cryptography/README.adoc +++ b/contracts/cryptography/README.adoc @@ -1,5 +1,8 @@ = Cryptography +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/cryptography + This collection of libraries provides simple and safe ways to use different cryptographic primitives. == Libraries diff --git a/contracts/introspection/README.adoc b/contracts/introspection/README.adoc index e1c52d6e0..38bd78281 100644 --- a/contracts/introspection/README.adoc +++ b/contracts/introspection/README.adoc @@ -1,5 +1,8 @@ = Introspection +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/introspection + This set of interfaces and contracts deal with https://en.wikipedia.org/wiki/Type_introspection[type introspection] of contracts, that is, examining which functions can be called on them. This is usually referred to as a contract's _interface_. Ethereum contracts have no native concept of an interface, so applications must usually simply trust they are not making an incorrect call. For trusted setups this is a non-issue, but often unknown and untrusted third-party addresses need to be interacted with. There may even not be any direct calls to them! (e.g. `ERC20` tokens may be sent to a contract that lacks a way to transfer them out of it, locking them forever). In these cases, a contract _declaring_ its interface can be very helpful in preventing errors. diff --git a/contracts/math/README.adoc b/contracts/math/README.adoc index 38d1b9724..b03d441ba 100644 --- a/contracts/math/README.adoc +++ b/contracts/math/README.adoc @@ -1,5 +1,8 @@ = Math +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/math + These are math-related utilities. == Libraries diff --git a/contracts/payment/README.adoc b/contracts/payment/README.adoc index 56a9f80f4..7d6151d90 100644 --- a/contracts/payment/README.adoc +++ b/contracts/payment/README.adoc @@ -1,5 +1,8 @@ = Payment +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/payment + Utilities related to sending and receiving payments. Examples are {PullPayment}, which implements the best security practices when sending funds to third parties, and {PaymentSplitter} to receive incoming payments among a number of beneficiaries. TIP: When transferring funds to and from untrusted third parties, there is always a security risk of reentrancy. If you would like to learn more about this and ways to protect against it, check out our blog post https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul]. diff --git a/contracts/presets/README.adoc b/contracts/presets/README.adoc index 160aeae09..df2941907 100644 --- a/contracts/presets/README.adoc +++ b/contracts/presets/README.adoc @@ -1,5 +1,8 @@ = Presets +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/presets + These contracts integrate different Ethereum standards (ERCs) with custom extensions and modules, showcasing common configurations that are ready to deploy **without having to write any Solidity code**. They can be used as-is for quick prototyping and testing, but are **also suitable for production environments**. diff --git a/contracts/token/ERC1155/README.adoc b/contracts/token/ERC1155/README.adoc index ff3ea6246..fbd04b53b 100644 --- a/contracts/token/ERC1155/README.adoc +++ b/contracts/token/ERC1155/README.adoc @@ -1,5 +1,8 @@ = ERC 1155 +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc1155 + This set of interfaces and contracts are all related to the https://eips.ethereum.org/EIPS/eip-1155[ERC1155 Multi Token Standard]. The EIP consists of three interfaces which fulfill different roles, found here as {IERC1155}, {IERC1155MetadataURI} and {IERC1155Receiver}. diff --git a/contracts/token/ERC20/README.adoc b/contracts/token/ERC20/README.adoc index edbd1567e..dfeff863c 100644 --- a/contracts/token/ERC20/README.adoc +++ b/contracts/token/ERC20/README.adoc @@ -1,5 +1,8 @@ = ERC 20 +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc20 + 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:erc20.adoc[ERC20 guide]. diff --git a/contracts/token/ERC721/README.adoc b/contracts/token/ERC721/README.adoc index a774ebed2..ce54a3d5e 100644 --- a/contracts/token/ERC721/README.adoc +++ b/contracts/token/ERC721/README.adoc @@ -1,5 +1,8 @@ = ERC 721 +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc721 + This set of interfaces, contracts, and utilities are all related to the https://eips.ethereum.org/EIPS/eip-721[ERC721 Non-Fungible Token Standard]. TIP: For a walkthrough on how to create an ERC721 token read our xref:ROOT:erc721.adoc[ERC721 guide]. diff --git a/contracts/token/ERC777/README.adoc b/contracts/token/ERC777/README.adoc index f3cd3e010..e078f86ec 100644 --- a/contracts/token/ERC777/README.adoc +++ b/contracts/token/ERC777/README.adoc @@ -1,4 +1,8 @@ = ERC 777 + +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc777 + This set of interfaces and contracts are all related to the [ERC777 token standard](https://eips.ethereum.org/EIPS/eip-777). TIP: For an overview of ERC777 tokens and a walkthrough on how to create a token contract read our xref:ROOT:erc777.adoc[ERC777 guide]. diff --git a/contracts/utils/README.adoc b/contracts/utils/README.adoc index 1f0dcf0b1..8995a1858 100644 --- a/contracts/utils/README.adoc +++ b/contracts/utils/README.adoc @@ -1,5 +1,8 @@ = Utilities +[.readme-notice] +NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/utils + Miscellaneous contracts and libraries containing utility functions you can use to improve security, work with new data types, or safely use low-level primitives. Security tools include: