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:51:22 +00:00
parent 97ff40e0f7
commit ecb25dea0d
9 changed files with 134 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/modules/api/pages/metatx.adoc
View File

@ -3,6 +3,7 @@
:xref-ERC2771Context-isTrustedForwarder-address-: xref:metatx.adoc#ERC2771Context-isTrustedForwarder-address-
:xref-ERC2771Context-_msgSender--: xref:metatx.adoc#ERC2771Context-_msgSender--
:xref-ERC2771Context-_msgData--: xref:metatx.adoc#ERC2771Context-_msgData--
:xref-ERC2771Context-_contextSuffixLength--: xref:metatx.adoc#ERC2771Context-_contextSuffixLength--
:ERC2771Context: pass:normal[xref:metatx.adoc#ERC2771Context[`ERC2771Context`]]
:xref-MinimalForwarder-constructor--: xref:metatx.adoc#MinimalForwarder-constructor--
:xref-MinimalForwarder-getNonce-address-: xref:metatx.adoc#MinimalForwarder-getNonce-address-
@ -23,6 +24,7 @@ NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/
:isTrustedForwarder: pass:normal[xref:#ERC2771Context-isTrustedForwarder-address-[`++isTrustedForwarder++`]]
:_msgSender: pass:normal[xref:#ERC2771Context-_msgSender--[`++_msgSender++`]]
:_msgData: pass:normal[xref:#ERC2771Context-_msgData--[`++_msgData++`]]
:_contextSuffixLength: pass:normal[xref:#ERC2771Context-_contextSuffixLength--[`++_contextSuffixLength++`]]
[.contract]
[[ERC2771Context]]
@ -35,6 +37,10 @@ import "@openzeppelin/contracts/metatx/ERC2771Context.sol";
Context variant with ERC2771 support.
WARNING: The usage of `delegatecall` in this contract is dangerous and may result in context corruption.
Any forwarded request to this contract triggering a `delegatecall` to itself will result in an invalid {_msgSender}
recovery.
[.contract-index]
.Functions
--
@ -42,6 +48,7 @@ Context variant with ERC2771 support.
* {xref-ERC2771Context-isTrustedForwarder-address-}[`++isTrustedForwarder(forwarder)++`]
* {xref-ERC2771Context-_msgSender--}[`++_msgSender()++`]
* {xref-ERC2771Context-_msgData--}[`++_msgData()++`]
* {xref-ERC2771Context-_contextSuffixLength--}[`++_contextSuffixLength()++`]
--
@ -55,12 +62,18 @@ Context variant with ERC2771 support.
[.contract-item]
[[ERC2771Context-_msgSender--]]
==== `[.contract-item-name]#++_msgSender++#++() → address sender++` [.item-kind]#internal#
==== `[.contract-item-name]#++_msgSender++#++() → address++` [.item-kind]#internal#
[.contract-item]
[[ERC2771Context-_msgData--]]
==== `[.contract-item-name]#++_msgData++#++() → bytes++` [.item-kind]#internal#
[.contract-item]
[[ERC2771Context-_contextSuffixLength--]]
==== `[.contract-item-name]#++_contextSuffixLength++#++() → uint256++` [.item-kind]#internal#
ERC-2771 specifies the context as being a single address (20 bytes).
== Utils
:ForwardRequest: pass:normal[xref:#MinimalForwarder-ForwardRequest[`++ForwardRequest++`]]

10
docs/modules/api/pages/utils.adoc
View File

@ -393,6 +393,7 @@
:xref-StorageSlot-getStringSlot-string-: xref:utils.adoc#StorageSlot-getStringSlot-string-
:xref-StorageSlot-getBytesSlot-bytes32-: xref:utils.adoc#StorageSlot-getBytesSlot-bytes32-
:xref-StorageSlot-getBytesSlot-bytes-: xref:utils.adoc#StorageSlot-getBytesSlot-bytes-
:ERC2771Context: pass:normal[xref:metatx.adoc#ERC2771Context[`ERC2771Context`]]
:xref-Multicall-multicall-bytes---: xref:utils.adoc#Multicall-multicall-bytes---
= Utilities
@ -5102,6 +5103,15 @@ import "@openzeppelin/contracts/utils/Multicall.sol";
Provides a function to batch together multiple calls in a single external call.
Consider any assumption about calldata validation performed by the sender may be violated if it's not especially
careful about sending transactions invoking {multicall}. For example, a relay address that filters function
selectors won't filter calls nested within a {multicall} operation.
NOTE: Since 5.0.1 and 4.9.4, this contract identifies non-canonical contexts (i.e. `msg.sender` is not {_msgSender}).
If a non-canonical context is identified, the following self `delegatecall` appends the last bytes of `msg.data`
to the subcall. This makes it safe to use with {ERC2771Context}. Contexts that don't affect the resolution of
{_msgSender} are not propagated to subcalls.
_Available since v4.1._
[.contract-index]