-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add simple executor * action as free level export
- Loading branch information
Showing
15 changed files
with
189 additions
and
92 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,16 +7,6 @@ pragma solidity ^0.8.8; | |
| /// @notice The interface required for DAOs within the Aragon App DAO framework. | ||
| /// @custom:security-contact [email protected] | ||
| interface IDAO { | ||
| /// @notice The action struct to be consumed by the DAO's `execute` function resulting in an external call. | ||
| /// @param to The address to call. | ||
| /// @param value The native token value to be sent with the call. | ||
| /// @param data The bytes-encoded function selector and calldata for the call. | ||
| struct Action { | ||
| address to; | ||
| uint256 value; | ||
| bytes data; | ||
| } | ||
|
|
||
| /// @notice Checks if an address has permission on a contract via a permission identifier and considers if `ANY_ADDRESS` was used in the granting process. | ||
| /// @param _where The address of the contract. | ||
| /// @param _who The address of a EOA or contract to give the permissions. | ||
|
|
@@ -38,35 +28,6 @@ interface IDAO { | |
| /// @param metadata The IPFS hash of the new metadata object. | ||
| event MetadataSet(bytes metadata); | ||
|
|
||
| /// @notice Executes a list of actions. If a zero allow-failure map is provided, a failing action reverts the entire execution. If a non-zero allow-failure map is provided, allowed actions can fail without the entire call being reverted. | ||
| /// @param _callId The ID of the call. The definition of the value of `callId` is up to the calling contract and can be used, e.g., as a nonce. | ||
| /// @param _actions The array of actions. | ||
| /// @param _allowFailureMap A bitmap allowing execution to succeed, even if individual actions might revert. If the bit at index `i` is 1, the execution succeeds even if the `i`th action reverts. A failure map value of 0 requires every action to not revert. | ||
| /// @return The array of results obtained from the executed actions in `bytes`. | ||
| /// @return The resulting failure map containing the actions have actually failed. | ||
| function execute( | ||
| bytes32 _callId, | ||
| Action[] memory _actions, | ||
| uint256 _allowFailureMap | ||
| ) external returns (bytes[] memory, uint256); | ||
|
|
||
| /// @notice Emitted when a proposal is executed. | ||
| /// @param actor The address of the caller. | ||
| /// @param callId The ID of the call. | ||
| /// @param actions The array of actions executed. | ||
| /// @param allowFailureMap The allow failure map encoding which actions are allowed to fail. | ||
| /// @param failureMap The failure map encoding which actions have failed. | ||
| /// @param execResults The array with the results of the executed actions. | ||
| /// @dev The value of `callId` is defined by the component/contract calling the execute function. A `Plugin` implementation can use it, for example, as a nonce. | ||
| event Executed( | ||
| address indexed actor, | ||
| bytes32 callId, | ||
| Action[] actions, | ||
| uint256 allowFailureMap, | ||
| uint256 failureMap, | ||
| bytes[] execResults | ||
| ); | ||
|
|
||
| /// @notice Emitted when a standard callback is registered. | ||
| /// @param interfaceId The ID of the interface. | ||
| /// @param callbackSelector The selector of the callback function. | ||
|
|
||
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,86 @@ | ||
| // SPDX-License-Identifier: AGPL-3.0-or-later | ||
|
|
||
| pragma solidity ^0.8.8; | ||
|
|
||
| import {IExecutor, Action} from "./IExecutor.sol"; | ||
| import {flipBit, hasBit} from "../utils/math/BitMap.sol"; | ||
|
|
||
| /// @notice Simple Executor that loops through the actions and executes them. | ||
| /// @dev Reverts in case enough gas was not provided for the last action. | ||
| contract Executor is IExecutor { | ||
| /// @notice The internal constant storing the maximal action array length. | ||
| uint256 internal constant MAX_ACTIONS = 256; | ||
|
|
||
| /// @notice Thrown if the action array length is larger than `MAX_ACTIONS`. | ||
| error TooManyActions(); | ||
|
|
||
| /// @notice Thrown if an action has insufficient gas left. | ||
| error InsufficientGas(); | ||
|
|
||
| /// @notice Thrown if action execution has failed. | ||
| /// @param index The index of the action in the action array that failed. | ||
| error ActionFailed(uint256 index); | ||
|
|
||
| /// @inheritdoc IExecutor | ||
| function execute( | ||
| bytes32 _callId, | ||
| Action[] memory _actions, | ||
| uint256 _allowFailureMap | ||
| ) public virtual override returns (bytes[] memory execResults, uint256 failureMap) { | ||
| // Check that the action array length is within bounds. | ||
| if (_actions.length > MAX_ACTIONS) { | ||
| revert TooManyActions(); | ||
| } | ||
|
|
||
| execResults = new bytes[](_actions.length); | ||
|
|
||
| uint256 gasBefore; | ||
| uint256 gasAfter; | ||
|
|
||
| for (uint256 i = 0; i < _actions.length; ) { | ||
| gasBefore = gasleft(); | ||
|
|
||
| (bool success, bytes memory data) = _actions[i].to.call{value: _actions[i].value}( | ||
| _actions[i].data | ||
| ); | ||
|
|
||
| gasAfter = gasleft(); | ||
|
|
||
| // Check if failure is allowed | ||
| if (!hasBit(_allowFailureMap, uint8(i))) { | ||
| // Check if the call failed. | ||
| if (!success) { | ||
| revert ActionFailed(i); | ||
| } | ||
| } else { | ||
| // Check if the call failed. | ||
| if (!success) { | ||
| // Make sure that the action call did not fail because 63/64 of `gasleft()` was insufficient to execute the external call `.to.call` (see [ERC-150](https://eips.ethereum.org/EIPS/eip-150)). | ||
| // In specific scenarios, i.e. proposal execution where the last action in the action array is allowed to fail, the account calling `execute` could force-fail this action by setting a gas limit | ||
| // where 63/64 is insufficient causing the `.to.call` to fail, but where the remaining 1/64 gas are sufficient to successfully finish the `execute` call. | ||
| if (gasAfter < gasBefore / 64) { | ||
| revert InsufficientGas(); | ||
| } | ||
|
|
||
| // Store that this action failed. | ||
| failureMap = flipBit(failureMap, uint8(i)); | ||
| } | ||
| } | ||
|
|
||
| execResults[i] = data; | ||
|
|
||
| unchecked { | ||
| ++i; | ||
| } | ||
| } | ||
|
|
||
| emit Executed({ | ||
| actor: msg.sender, | ||
| callId: _callId, | ||
| actions: _actions, | ||
| allowFailureMap: _allowFailureMap, | ||
| failureMap: failureMap, | ||
| execResults: execResults | ||
| }); | ||
| } | ||
| } |
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,50 @@ | ||
| // SPDX-License-Identifier: AGPL-3.0-or-later | ||
|
|
||
| pragma solidity ^0.8.8; | ||
|
|
||
| import {IDAO} from "../dao/IDAO.sol"; | ||
|
|
||
| /// @notice The action struct to be consumed by the DAO's `execute` function resulting in an external call. | ||
| /// @param to The address to call. | ||
| /// @param value The native token value to be sent with the call. | ||
| /// @param data The bytes-encoded function selector and calldata for the call. | ||
| struct Action { | ||
| address to; | ||
| uint256 value; | ||
| bytes data; | ||
| } | ||
|
|
||
| /// @title IDAO | ||
| /// @author Aragon X - 2022-2023 | ||
| /// @notice The interface required for Executors within the Aragon App DAO framework. | ||
| /// @custom:security-contact [email protected] | ||
| interface IExecutor { | ||
| /// @notice Emitted when a proposal is executed. | ||
| /// @param actor The address of the caller. | ||
| /// @param callId The ID of the call. | ||
| /// @param actions The array of actions executed. | ||
| /// @param allowFailureMap The allow failure map encoding which actions are allowed to fail. | ||
| /// @param failureMap The failure map encoding which actions have failed. | ||
| /// @param execResults The array with the results of the executed actions. | ||
| /// @dev The value of `callId` is defined by the component/contract calling the execute function. A `Plugin` implementation can use it, for example, as a nonce. | ||
| event Executed( | ||
| address indexed actor, | ||
| bytes32 callId, | ||
| Action[] actions, | ||
| uint256 allowFailureMap, | ||
| uint256 failureMap, | ||
| bytes[] execResults | ||
| ); | ||
|
|
||
| /// @notice Executes a list of actions. If a zero allow-failure map is provided, a failing action reverts the entire execution. If a non-zero allow-failure map is provided, allowed actions can fail without the entire call being reverted. | ||
| /// @param _callId The ID of the call. The definition of the value of `callId` is up to the calling contract and can be used, e.g., as a nonce. | ||
| /// @param _actions The array of actions. | ||
| /// @param _allowFailureMap A bitmap allowing execution to succeed, even if individual actions might revert. If the bit at index `i` is 1, the execution succeeds even if the `i`th action reverts. A failure map value of 0 requires every action to not revert. | ||
| /// @return The array of results obtained from the executed actions in `bytes`. | ||
| /// @return The resulting failure map containing the actions have actually failed. | ||
| function execute( | ||
| bytes32 _callId, | ||
| Action[] memory _actions, | ||
| uint256 _allowFailureMap | ||
| ) external returns (bytes[] memory, uint256); | ||
| } |
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
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
Oops, something went wrong.