Update docs

This commit is contained in:
github-actions
2022-05-11 21:14:33 +00:00
parent 2226bb0f34
commit 0627757030
19 changed files with 86 additions and 64 deletions

View File

@ -2388,7 +2388,7 @@ Amount of token already released
Release the native token (ether) that have already vested.
Emits a {TokensReleased} event.
Emits a {EtherReleased} event.
[.contract-item]
[[VestingWallet-release-address-]]
@ -2396,7 +2396,7 @@ Emits a {TokensReleased} event.
Release the tokens that have already vested.
Emits a {TokensReleased} event.
Emits a {ERC20Released} event.
[.contract-item]
[[VestingWallet-vestedAmount-uint64-]]

View File

@ -2372,7 +2372,7 @@ Emits a {VoteCast} event.
Cast a vote with a reason and additional encoded parameters
Emits a {VoteCast} event.
Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
[.contract-item]
[[IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-]]
@ -2388,7 +2388,7 @@ Emits a {VoteCast} event.
Cast a vote with a reason and additional encoded parameters using the user's cryptographic signature.
Emits a {VoteCast} event.
Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.
[.contract-item]
@ -2698,7 +2698,7 @@ Get the voting weight of `account` at a specific `blockNumber`, for a vote as de
[[Governor-_countVote-uint256-address-uint8-uint256-bytes-]]
==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes params)++` [.item-kind]#internal#
Register a vote with a given support and voting weight.
Register a vote for `proposalId` by `account` with a given `support`, voting `weight` and voting `params`.
Note: Support is generic and can represent various things depending on the voting system used.

View File

@ -2293,7 +2293,7 @@ implementation behind the proxy.
Initializes the upgradeable proxy with an initial implementation specified by `_logic`.
If `_data` is nonempty, it's used as data in a delegate call to `_logic`. This will typically be an encoded
function call, and allows initializating the storage of the proxy like a Solidity constructor.
function call, and allows initializing the storage of the proxy like a Solidity constructor.
[.contract-item]
[[ERC1967Proxy-_implementation--]]
@ -2748,7 +2748,7 @@ Requirements:
import "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol";
```
This contract implements a proxy that gets the implementation address for each call from a {UpgradeableBeacon}.
This contract implements a proxy that gets the implementation address for each call from an {UpgradeableBeacon}.
The beacon address is stored in storage slot `uint256(keccak256('eip1967.proxy.beacon')) - 1`, so that it doesn't
conflict with the storage layout of the implementation behind the proxy.
@ -2808,7 +2808,7 @@ _Available since v3.4._
Initializes the proxy with `beacon`.
If `data` is nonempty, it's used as data in a delegate call to the implementation returned by the beacon. This
will typically be an encoded function call, and allows initializating the storage of the proxy like a Solidity
will typically be an encoded function call, and allows initializing the storage of the proxy like a Solidity
constructor.
Requirements:

View File

@ -2564,6 +2564,8 @@ acceptance magic value.
xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_mint}.
Emits a {TransferBatch} event.
Requirements:
- `ids` and `amounts` must have the same length.
@ -2576,6 +2578,8 @@ acceptance magic value.
Destroys `amount` tokens of token type `id` from `from`
Emits a {TransferSingle} event.
Requirements:
- `from` cannot be the zero address.
@ -2587,6 +2591,8 @@ Requirements:
xref:ROOT:erc1155.adoc#batch-operations[Batched] version of {_burn}.
Emits a {TransferBatch} event.
Requirements:
- `ids` and `amounts` must have the same length.
@ -2597,7 +2603,7 @@ Requirements:
Approve `operator` to operate on all of `owner` tokens
Emits a {ApprovalForAll} event.
Emits an {ApprovalForAll} event.
[.contract-item]
[[ERC1155-_beforeTokenTransfer-address-address-address-uint256---uint256---bytes-]]
@ -2607,7 +2613,7 @@ Hook that is called before any token transfer. This includes minting
and burning, as well as batched variants.
The same hook is called on both single and batched variants. For single
transfers, the length of the `id` and `amount` arrays will be 1.
transfers, the length of the `ids` and `amounts` arrays will be 1.
Calling conditions (for each `id` and `amount` pair):

View File

@ -2553,7 +2553,7 @@ Requirements:
[[ERC20-_transfer-address-address-uint256-]]
==== `[.contract-item-name]#++_transfer++#++(address from, address to, uint256 amount)++` [.item-kind]#internal#
Moves `amount` of tokens from `sender` to `recipient`.
Moves `amount` of tokens from `from` to `to`.
This internal function is equivalent to {transfer}, and can be used to
e.g. implement automatic token fees, slashing mechanisms, etc.

View File

@ -2524,12 +2524,12 @@ the Metadata extension, but not including the Enumerable extension, which is ava
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_burn-uint256-}[`++_burn(tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
@ -2665,18 +2665,18 @@ See {IERC721-safeTransferFrom}.
[.contract-item]
[[ERC721-safeTransferFrom-address-address-uint256-bytes-]]
==== `[.contract-item-name]#++safeTransferFrom++#++(address from, address to, uint256 tokenId, bytes _data)++` [.item-kind]#public#
==== `[.contract-item-name]#++safeTransferFrom++#++(address from, address to, uint256 tokenId, bytes data)++` [.item-kind]#public#
See {IERC721-safeTransferFrom}.
[.contract-item]
[[ERC721-_safeTransfer-address-address-uint256-bytes-]]
==== `[.contract-item-name]#++_safeTransfer++#++(address from, address to, uint256 tokenId, bytes _data)++` [.item-kind]#internal#
==== `[.contract-item-name]#++_safeTransfer++#++(address from, address to, uint256 tokenId, bytes data)++` [.item-kind]#internal#
Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
are aware of the ERC721 protocol to prevent tokens from being forever locked.
`_data` is additional data, it has no specified format and it is sent in call to `to`.
`data` is additional data, it has no specified format and it is sent in call to `to`.
This internal function is equivalent to {safeTransferFrom}, and can be used to e.g.
implement alternative mechanisms to perform token transfer, such as signature-based.
@ -2726,7 +2726,7 @@ Emits a {Transfer} event.
[.contract-item]
[[ERC721-_safeMint-address-uint256-bytes-]]
==== `[.contract-item-name]#++_safeMint++#++(address to, uint256 tokenId, bytes _data)++` [.item-kind]#internal#
==== `[.contract-item-name]#++_safeMint++#++(address to, uint256 tokenId, bytes data)++` [.item-kind]#internal#
Same as {xref-ERC721-_safeMint-address-uint256-}[`_safeMint`], with an additional `data` parameter which is
forwarded in {IERC721Receiver-onERC721Received} to contract recipients.
@ -2779,7 +2779,7 @@ Emits a {Transfer} event.
Approve `to` to operate on `tokenId`
Emits a {Approval} event.
Emits an {Approval} event.
[.contract-item]
[[ERC721-_setApprovalForAll-address-address-bool-]]
@ -2787,7 +2787,7 @@ Emits a {Approval} event.
Approve `operator` to operate on all of `owner` tokens
Emits a {ApprovalForAll} event.
Emits an {ApprovalForAll} event.
[.contract-item]
[[ERC721-_beforeTokenTransfer-address-address-uint256-]]
@ -2871,12 +2871,12 @@ account.
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_burn-uint256-}[`++_burn(tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
@ -3062,12 +3062,12 @@ event of a large bug.
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_burn-uint256-}[`++_burn(tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
@ -3171,12 +3171,12 @@ ERC721 Token that can be irreversibly burned (destroyed).
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_burn-uint256-}[`++_burn(tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
@ -3279,12 +3279,12 @@ ERC721 token with storage based token URI management.
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
* {xref-ERC721-_approve-address-uint256-}[`++_approve(to, tokenId)++`]
@ -3431,12 +3431,12 @@ _Available since v4.5._
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_burn-uint256-}[`++_burn(tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
@ -3564,12 +3564,12 @@ _Available since v4.5._
* {xref-ERC721-isApprovedForAll-address-address-}[`++isApprovedForAll(owner, operator)++`]
* {xref-ERC721-transferFrom-address-address-uint256-}[`++transferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-}[`++safeTransferFrom(from, to, tokenId)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, _data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, _data)++`]
* {xref-ERC721-safeTransferFrom-address-address-uint256-bytes-}[`++safeTransferFrom(from, to, tokenId, data)++`]
* {xref-ERC721-_safeTransfer-address-address-uint256-bytes-}[`++_safeTransfer(from, to, tokenId, data)++`]
* {xref-ERC721-_exists-uint256-}[`++_exists(tokenId)++`]
* {xref-ERC721-_isApprovedOrOwner-address-uint256-}[`++_isApprovedOrOwner(spender, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-}[`++_safeMint(to, tokenId)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, _data)++`]
* {xref-ERC721-_safeMint-address-uint256-bytes-}[`++_safeMint(to, tokenId, data)++`]
* {xref-ERC721-_mint-address-uint256-}[`++_mint(to, tokenId)++`]
* {xref-ERC721-_transfer-address-address-uint256-}[`++_transfer(from, to, tokenId)++`]
* {xref-ERC721-_approve-address-uint256-}[`++_approve(to, tokenId)++`]

View File

@ -2630,7 +2630,8 @@ Creates `amount` tokens and assigns them to `account`, increasing
the total supply.
If a send hook is registered for `account`, the corresponding function
will be called with `operator`, `data` and `operatorData`.
will be called with the caller address as the `operator` and with
`userData` and `operatorData`.
See {IERC777Sender} and {IERC777Recipient}.