Add readme notices with link to docs site (#2300)
* add readme notices * remove period after url
This commit is contained in:
committed by
GitHub
parent
32f0fe5d08
commit
ef3bbbcf40
@ -1,5 +1,8 @@
|
|||||||
= Gas Station Network (GSN)
|
= 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].
|
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].
|
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].
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Access
|
= 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.
|
Contract modules for authorization and access control mechanisms.
|
||||||
|
|
||||||
== Contracts
|
== Contracts
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Cryptography
|
= 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.
|
This collection of libraries provides simple and safe ways to use different cryptographic primitives.
|
||||||
|
|
||||||
== Libraries
|
== Libraries
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Introspection
|
= 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_.
|
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.
|
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.
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Math
|
= Math
|
||||||
|
|
||||||
|
[.readme-notice]
|
||||||
|
NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/math
|
||||||
|
|
||||||
These are math-related utilities.
|
These are math-related utilities.
|
||||||
|
|
||||||
== Libraries
|
== Libraries
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Payment
|
= 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.
|
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].
|
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].
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Presets
|
= 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**.
|
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**.
|
They can be used as-is for quick prototyping and testing, but are **also suitable for production environments**.
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= ERC 1155
|
= 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].
|
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}.
|
The EIP consists of three interfaces which fulfill different roles, found here as {IERC1155}, {IERC1155MetadataURI} and {IERC1155Receiver}.
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= ERC 20
|
= 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].
|
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].
|
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].
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= ERC 721
|
= 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].
|
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].
|
TIP: For a walkthrough on how to create an ERC721 token read our xref:ROOT:erc721.adoc[ERC721 guide].
|
||||||
|
|||||||
@ -1,4 +1,8 @@
|
|||||||
= ERC 777
|
= 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).
|
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].
|
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].
|
||||||
|
|||||||
@ -1,5 +1,8 @@
|
|||||||
= Utilities
|
= 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.
|
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:
|
Security tools include:
|
||||||
|
|||||||
Reference in New Issue
Block a user