NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
github-actions
2025-01-22 04:00:10 +00:00
parent edf6031131
commit 0dda004024
124 changed files with 8439 additions and 1170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/modules/api/pages/interfaces.adoc
View File

@ -215,7 +215,7 @@ are useful to interact with third party contracts that implement them.
[.contract]
[[IERC20Errors]]
=== `++IERC20Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC20Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -284,7 +284,7 @@ Indicates a failure with the `spender` to be approved. Used in approvals.
[.contract]
[[IERC721Errors]]
=== `++IERC721Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC721Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -367,7 +367,7 @@ Indicates a failure with the `operator` to be approved. Used in approvals.
[.contract]
[[IERC1155Errors]]
=== `++IERC1155Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC1155Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -437,7 +437,7 @@ Used in batch transfers.
[.contract]
[[IERC1271]]
=== `++IERC1271++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1271.sol[{github-icon},role=heading-link]
=== `++IERC1271++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1271.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -469,7 +469,7 @@ Should return whether the signature provided is valid for the provided data
[.contract]
[[IERC1363]]
=== `++IERC1363++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1363.sol[{github-icon},role=heading-link]
=== `++IERC1363++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1363.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -566,7 +566,7 @@ caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`
[.contract]
[[IERC1363Receiver]]
=== `++IERC1363Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1363Receiver.sol[{github-icon},role=heading-link]
=== `++IERC1363Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1363Receiver.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -598,7 +598,7 @@ NOTE: To accept the transfer, this must return
[.contract]
[[IERC1363Spender]]
=== `++IERC1363Spender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1363Spender.sol[{github-icon},role=heading-link]
=== `++IERC1363Spender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1363Spender.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -630,7 +630,7 @@ NOTE: To accept the approval, this must return
[.contract]
[[IERC1820Implementer]]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1820Implementer.sol[{github-icon},role=heading-link]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1820Implementer.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -671,7 +671,7 @@ See {IERC1820Registry-setInterfaceImplementer}.
[.contract]
[[IERC1820Registry]]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC1820Registry.sol[{github-icon},role=heading-link]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC1820Registry.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -804,7 +804,7 @@ https://eips.ethereum.org/EIPS/eip-1820#interface-name[section of the ERC].
[.contract]
[[IERC1822Proxiable]]
=== `++IERC1822Proxiable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/draft-IERC1822.sol[{github-icon},role=heading-link]
=== `++IERC1822Proxiable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/draft-IERC1822.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -834,7 +834,7 @@ function revert if invoked through a proxy.
[.contract]
[[IERC2612]]
=== `++IERC2612++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC2612.sol[{github-icon},role=heading-link]
=== `++IERC2612++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC2612.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -857,7 +857,7 @@ import "@openzeppelin/contracts/interfaces/IERC2612.sol";
[.contract]
[[IERC2981]]
=== `++IERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC2981.sol[{github-icon},role=heading-link]
=== `++IERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC2981.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -896,7 +896,7 @@ royalty receiver and 0 tokens to the seller. Contracts dealing with royalty shou
[.contract]
[[IERC3156FlashLender]]
=== `++IERC3156FlashLender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC3156FlashLender.sol[{github-icon},role=heading-link]
=== `++IERC3156FlashLender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC3156FlashLender.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -937,7 +937,7 @@ Initiate a flash loan.
[.contract]
[[IERC3156FlashBorrower]]
=== `++IERC3156FlashBorrower++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC3156FlashBorrower.sol[{github-icon},role=heading-link]
=== `++IERC3156FlashBorrower++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC3156FlashBorrower.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -981,7 +981,7 @@ Receive a flash loan.
[.contract]
[[IERC4626]]
=== `++IERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC4626.sol[{github-icon},role=heading-link]
=== `++IERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC4626.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1279,7 +1279,7 @@ Those methods should be performed separately.
[.contract]
[[IERC5313]]
=== `++IERC5313++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC5313.sol[{github-icon},role=heading-link]
=== `++IERC5313++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC5313.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1308,7 +1308,7 @@ Gets the address of the owner.
[.contract]
[[IERC5267]]
=== `++IERC5267++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC5267.sol[{github-icon},role=heading-link]
=== `++IERC5267++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC5267.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1344,7 +1344,7 @@ MAY be emitted to signal that the domain could have changed.
[.contract]
[[IERC5805]]
=== `++IERC5805++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC5805.sol[{github-icon},role=heading-link]
=== `++IERC5805++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC5805.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1403,7 +1403,7 @@ import "@openzeppelin/contracts/interfaces/IERC5805.sol";
[.contract]
[[IERC6372]]
=== `++IERC6372++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/IERC6372.sol[{github-icon},role=heading-link]
=== `++IERC6372++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/IERC6372.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1434,7 +1434,7 @@ Description of the clock
[.contract]
[[IERC7674]]
=== `++IERC7674++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.1.0/contracts/interfaces/draft-IERC7674.sol[{github-icon},role=heading-link]
=== `++IERC7674++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.2.0/contracts/interfaces/draft-IERC7674.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity