-
-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
♻️ Make
Multicall Module-Friendly (#232)
### 🕓 Changelog This PR refactors the `Multicall` contract to make it module-friendly and ready for the breaking `0.4.0` release. --------- Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
- Loading branch information
1 parent
d5a9c8d
commit a0c1145
Showing
6 changed files
with
140 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # pragma version ~=0.4.0b6 | ||
| """ | ||
| @title Multicall Module Reference Implementation | ||
| @custom:contract-name MulticallMock | ||
| @license GNU Affero General Public License v3.0 only | ||
| @author pcaversaccio | ||
| """ | ||
|
|
||
|
|
||
| # @dev We import the `Multicall` module. | ||
| # @notice Please note that the `Multicall` module | ||
| # is stateless and therefore does not require | ||
| # the `initializes` keyword for initialisation. | ||
| from .. import Multicall as mc | ||
|
|
||
|
|
||
| @deploy | ||
| @payable | ||
| def __init__(): | ||
| """ | ||
| @dev To omit the opcodes for checking the `msg.value` | ||
| in the creation-time EVM bytecode, the constructor | ||
| is declared as `payable`. | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| @external | ||
| def multicall(data: DynArray[mc.Batch, mc._DYNARRAY_BOUND]) -> DynArray[mc.Result, mc._DYNARRAY_BOUND]: | ||
| """ | ||
| @dev Aggregates function calls, ensuring that each | ||
| function returns successfully if required. | ||
| Since this function uses `CALL`, the `msg.sender` | ||
| will be the multicall contract itself. | ||
| @notice It is important to note that an external call | ||
| via `raw_call` does not perform an external code | ||
| size check on the target address. | ||
| @param data The array of `Batch` structs. | ||
| @return DynArray The array of `Result` structs. | ||
| """ | ||
| return mc._multicall(data) | ||
|
|
||
|
|
||
| @external | ||
| @payable | ||
| def multicall_value(data: DynArray[mc.BatchValue, mc._DYNARRAY_BOUND]) -> DynArray[mc.Result, mc._DYNARRAY_BOUND]: | ||
| """ | ||
| @dev Aggregates function calls with a `msg.value`, | ||
| ensuring that each function returns successfully | ||
| if required. Since this function uses `CALL`, | ||
| the `msg.sender` will be the multicall contract | ||
| itself. | ||
| @notice It is important to note that an external call | ||
| via `raw_call` does not perform an external code | ||
| size check on the target address. | ||
| @param data The array of `BatchValue` structs. | ||
| @return DynArray The array of `Result` structs. | ||
| """ | ||
| return mc._multicall_value(data) | ||
|
|
||
|
|
||
| @external | ||
| def multicall_self(data: DynArray[mc.BatchSelf, mc._DYNARRAY_BOUND]) -> DynArray[mc.Result, mc._DYNARRAY_BOUND]: | ||
| """ | ||
| @dev Aggregates function calls using `DELEGATECALL`, | ||
| ensuring that each function returns successfully | ||
| if required. Since this function uses `DELEGATECALL`, | ||
| the `msg.sender` remains the same account that | ||
| invoked the function `multicall_self` in the first place. | ||
| @notice Developers can include this function in their own | ||
| contract so that users can submit multiple function | ||
| calls in one transaction. Since the `msg.sender` is | ||
| preserved, it's equivalent to sending multiple transactions | ||
| from an EOA (externally-owned account, i.e. non-contract account). | ||
| Furthermore, it is important to note that an external | ||
| call via `raw_call` does not perform an external code | ||
| size check on the target address. | ||
| @param data The array of `BatchSelf` structs. | ||
| @return DynArray The array of `Result` structs. | ||
| """ | ||
| return mc._multicall_self(data) | ||
|
|
||
|
|
||
| @external | ||
| @view | ||
| def multistaticcall(data: DynArray[mc.Batch, mc._DYNARRAY_BOUND]) -> DynArray[mc.Result, mc._DYNARRAY_BOUND]: | ||
| """ | ||
| @dev Aggregates static function calls, ensuring that each | ||
| function returns successfully if required. | ||
| @notice It is important to note that an external call | ||
| via `raw_call` does not perform an external code | ||
| size check on the target address. | ||
| @param data The array of `Batch` structs. | ||
| @return DynArray The array of `Result` structs. | ||
| """ | ||
| return mc._multistaticcall(data) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters