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:30 +00:00
parent 37afdc8910
commit 57dd5968a7
9 changed files with 135 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,6 +4,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-ERC2771Forwarder-constructor-string-: xref:metatx.adoc#ERC2771Forwarder-constructor-string-
:xref-ERC2771Forwarder-verify-struct-ERC2771Forwarder-ForwardRequestData-: xref:metatx.adoc#ERC2771Forwarder-verify-struct-ERC2771Forwarder-ForwardRequestData-
@ -41,6 +42,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]]
@ -59,6 +61,10 @@ specification adding the address size in bytes (20) to the calldata size. An exa
behavior could be an unintended fallback (or another function) invocation while trying to invoke the `receive`
function only accessible if `msg.data.length == 0`.
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
--
@ -67,6 +73,7 @@ function only accessible if `msg.data.length == 0`.
* {xref-ERC2771Context-isTrustedForwarder-address-}[`++isTrustedForwarder(forwarder)++`]
* {xref-ERC2771Context-_msgSender--}[`++_msgSender()++`]
* {xref-ERC2771Context-_msgData--}[`++_msgData()++`]
* {xref-ERC2771Context-_contextSuffixLength--}[`++_contextSuffixLength()++`]
--
@ -88,7 +95,7 @@ Indicates whether any particular address is the trusted forwarder.
[.contract-item]
[[ERC2771Context-_msgSender--]]
==== `[.contract-item-name]#++_msgSender++#++() → address sender++` [.item-kind]#internal#
==== `[.contract-item-name]#++_msgSender++#++() → address++` [.item-kind]#internal#
Override for `msg.sender`. Defaults to the original `msg.sender` whenever
a call is not performed by the trusted forwarder or the calldata length is less than
@ -102,6 +109,12 @@ Override for `msg.data`. Defaults to the original `msg.data` whenever
a call is not performed by the trusted forwarder or the calldata length is less than
20 bytes (an address length).
[.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
:ForwardRequestData: pass:normal[xref:#ERC2771Forwarder-ForwardRequestData[`++ForwardRequestData++`]]

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

@ -334,6 +334,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
@ -4482,6 +4483,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.
[.contract-index]
.Functions
--