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
2023-12-07 21:55:12 +00:00
parent 57dd5968a7
commit 18704d1879
20 changed files with 134 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -201,7 +201,7 @@ are useful to interact with third party contracts that implement them.
[.contract]
[[IERC20Errors]]
=== `++IERC20Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC20Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -270,7 +270,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.0.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC721Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -353,7 +353,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.0.0/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
=== `++IERC1155Errors++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/draft-IERC6093.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -423,7 +423,7 @@ Used in batch transfers.
[.contract]
[[IERC1271]]
=== `++IERC1271++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC1271.sol[{github-icon},role=heading-link]
=== `++IERC1271++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1271.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -455,7 +455,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.0.0/contracts/interfaces/IERC1363.sol[{github-icon},role=heading-link]
=== `++IERC1363++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1363.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -549,7 +549,7 @@ and then call `onApprovalReceived` on spender.
[.contract]
[[IERC1363Receiver]]
=== `++IERC1363Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC1363Receiver.sol[{github-icon},role=heading-link]
=== `++IERC1363Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1363Receiver.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -580,7 +580,7 @@ Note: the token contract address is always the message sender.
[.contract]
[[IERC1363Spender]]
=== `++IERC1363Spender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC1363Spender.sol[{github-icon},role=heading-link]
=== `++IERC1363Spender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1363Spender.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -611,7 +611,7 @@ Note: the token contract address is always the message sender.
[.contract]
[[IERC1820Implementer]]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC1820Implementer.sol[{github-icon},role=heading-link]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1820Implementer.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -652,7 +652,7 @@ See {IERC1820Registry-setInterfaceImplementer}.
[.contract]
[[IERC1820Registry]]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC1820Registry.sol[{github-icon},role=heading-link]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC1820Registry.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -785,7 +785,7 @@ https://eips.ethereum.org/EIPS/eip-1820#interface-name[section of the EIP].
[.contract]
[[IERC1822Proxiable]]
=== `++IERC1822Proxiable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/draft-IERC1822.sol[{github-icon},role=heading-link]
=== `++IERC1822Proxiable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/draft-IERC1822.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -815,7 +815,7 @@ function revert if invoked through a proxy.
[.contract]
[[IERC2612]]
=== `++IERC2612++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC2612.sol[{github-icon},role=heading-link]
=== `++IERC2612++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC2612.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -838,7 +838,7 @@ import "@openzeppelin/contracts/interfaces/IERC2612.sol";
[.contract]
[[IERC2981]]
=== `++IERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC2981.sol[{github-icon},role=heading-link]
=== `++IERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC2981.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -874,7 +874,7 @@ exchange. The royalty amount is denominated and should be paid in that same unit
[.contract]
[[IERC3156FlashLender]]
=== `++IERC3156FlashLender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC3156FlashLender.sol[{github-icon},role=heading-link]
=== `++IERC3156FlashLender++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC3156FlashLender.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -915,7 +915,7 @@ Initiate a flash loan.
[.contract]
[[IERC3156FlashBorrower]]
=== `++IERC3156FlashBorrower++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC3156FlashBorrower.sol[{github-icon},role=heading-link]
=== `++IERC3156FlashBorrower++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC3156FlashBorrower.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -959,7 +959,7 @@ Receive a flash loan.
[.contract]
[[IERC4626]]
=== `++IERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC4626.sol[{github-icon},role=heading-link]
=== `++IERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC4626.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1257,7 +1257,7 @@ Those methods should be performed separately.
[.contract]
[[IERC5313]]
=== `++IERC5313++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC5313.sol[{github-icon},role=heading-link]
=== `++IERC5313++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC5313.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1286,7 +1286,7 @@ Gets the address of the owner.
[.contract]
[[IERC5267]]
=== `++IERC5267++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC5267.sol[{github-icon},role=heading-link]
=== `++IERC5267++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC5267.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1322,7 +1322,7 @@ MAY be emitted to signal that the domain could have changed.
[.contract]
[[IERC5805]]
=== `++IERC5805++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC5805.sol[{github-icon},role=heading-link]
=== `++IERC5805++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC5805.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1381,7 +1381,7 @@ import "@openzeppelin/contracts/interfaces/IERC5805.sol";
[.contract]
[[IERC6372]]
=== `++IERC6372++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/interfaces/IERC6372.sol[{github-icon},role=heading-link]
=== `++IERC6372++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/interfaces/IERC6372.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity