Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add native token spend limit plugin
- Loading branch information
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| // SPDX-License-Identifier: GPL-3.0 | ||
| pragma solidity ^0.8.25; | ||
|
|
||
| import {PackedUserOperation} from "@eth-infinitism/account-abstraction/interfaces/PackedUserOperation.sol"; | ||
| import {UserOperationLib} from "@eth-infinitism/account-abstraction/core/UserOperationLib.sol"; | ||
| import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol"; | ||
| import {IAccountExecute} from "@eth-infinitism/account-abstraction/interfaces/IAccountExecute.sol"; | ||
|
|
||
| import {PluginManifest, PluginMetadata} from "../interfaces/IPlugin.sol"; | ||
| import {IStandardExecutor, Call} from "../interfaces/IStandardExecutor.sol"; | ||
| import {IPlugin} from "../interfaces/IPlugin.sol"; | ||
| import {IExecutionHook} from "../interfaces/IExecutionHook.sol"; | ||
| import {IValidationHook} from "../interfaces/IValidationHook.sol"; | ||
| import {BasePlugin, IERC165} from "./BasePlugin.sol"; | ||
|
|
||
| /// @title Native Token Limit Plugin | ||
| /// @author ERC-6900 Authors | ||
| /// @notice This plugin supports a single total native token spend limit. | ||
| /// It tracks a total spend limit across UserOperation gas limits and native token transfers. | ||
| /// If a paymaster is used, UO gas would not cause the limit to decrease. | ||
| contract NativeTokenLimitPlugin is BasePlugin, IExecutionHook, IValidationHook { | ||
| using UserOperationLib for PackedUserOperation; | ||
| using EnumerableSet for EnumerableSet.Bytes32Set; | ||
|
|
||
| string public constant NAME = "Native Token Limit"; | ||
| string public constant VERSION = "1.0.0"; | ||
| string public constant AUTHOR = "ERC-6900 Authors"; | ||
|
|
||
| mapping(address account => uint256[] limits) public limits; | ||
|
|
||
| error ExceededNativeTokenLimit(); | ||
| error ExceededNumberOfEntities(); | ||
|
|
||
| function updateLimits(uint8 functionId, uint256 newLimit) external { | ||
| limits[msg.sender][functionId] = newLimit; | ||
| } | ||
|
|
||
| /// @inheritdoc IExecutionHook | ||
| function preExecutionHook(uint8 functionId, bytes calldata data) external override returns (bytes memory) { | ||
| bytes calldata callData; | ||
| bytes4 execSelector; | ||
|
|
||
| // TODO: plugins should never have to do these gymnastics | ||
| execSelector = bytes4(data[52:56]); | ||
| if (execSelector == IAccountExecute.executeUserOp.selector) { | ||
| callData = data[56:]; | ||
| execSelector = bytes4(callData); | ||
| } else { | ||
| callData = data[52:]; | ||
| } | ||
|
|
||
| uint256 value; | ||
| // Get value being sent | ||
| if (execSelector == IStandardExecutor.execute.selector) { | ||
| value = uint256(bytes32(callData[36:68])); | ||
| } else if (execSelector == IStandardExecutor.executeBatch.selector) { | ||
| Call[] memory calls = abi.decode(callData[4:], (Call[])); | ||
| for (uint256 i = 0; i < calls.length; i++) { | ||
| value += calls[i].value; | ||
| } | ||
| } | ||
|
|
||
| uint256 limit = limits[msg.sender][functionId]; | ||
| if (value > limit) { | ||
| revert ExceededNativeTokenLimit(); | ||
| } | ||
| limits[msg.sender][functionId] = limit - value; | ||
|
|
||
| return ""; | ||
| } | ||
|
|
||
| /// @inheritdoc IExecutionHook | ||
| function postExecutionHook(uint8, bytes calldata) external pure override { | ||
| revert NotImplemented(); | ||
| } | ||
|
|
||
| // No implementation, no revert | ||
| // Runtime spends no account gas, and we check native token spend limits in exec hooks | ||
| function preRuntimeValidationHook(uint8 functionId, address, uint256, bytes calldata) external pure override { | ||
| // silence warnings | ||
| (functionId); | ||
| } | ||
|
|
||
| /// @inheritdoc IValidationHook | ||
| function preUserOpValidationHook(uint8 functionId, PackedUserOperation calldata userOp, bytes32) | ||
| external | ||
| returns (uint256) | ||
| { | ||
| // Decrease limit only if no paymaster is used | ||
| if (userOp.paymasterAndData.length == 0) { | ||
| uint256 vgl = UserOperationLib.unpackVerificationGasLimit(userOp); | ||
| uint256 cgl = UserOperationLib.unpackCallGasLimit(userOp); | ||
| uint256 totalGas = userOp.preVerificationGas + vgl + cgl; | ||
| uint256 usage = totalGas * UserOperationLib.unpackMaxFeePerGas(userOp); | ||
|
|
||
| uint256 limit = limits[msg.sender][functionId]; | ||
| if (usage > limit) { | ||
| revert ExceededNativeTokenLimit(); | ||
| } | ||
| limits[msg.sender][functionId] = limit - usage; | ||
| } | ||
| return 0; | ||
| } | ||
|
|
||
| /// @inheritdoc IPlugin | ||
| function onInstall(bytes calldata data) external override { | ||
| uint256[] memory spendLimits = abi.decode(data, (uint256[])); | ||
|
|
||
| for (uint256 i = 0; i < spendLimits.length; i++) { | ||
| limits[msg.sender].push(spendLimits[i]); | ||
| } | ||
|
|
||
| if (limits[msg.sender].length > type(uint8).max) { | ||
| revert ExceededNumberOfEntities(); | ||
| } | ||
| } | ||
|
|
||
| /// @inheritdoc IPlugin | ||
| function onUninstall(bytes calldata data) external override { | ||
| uint8 functionId = abi.decode(data, (uint8)); | ||
| delete limits[msg.sender][functionId]; | ||
| } | ||
|
|
||
| /// @inheritdoc IPlugin | ||
| function pluginManifest() external pure override returns (PluginManifest memory) { | ||
| // silence warnings | ||
| PluginManifest memory manifest; | ||
| return manifest; | ||
| } | ||
|
|
||
| /// @inheritdoc IPlugin | ||
| function pluginMetadata() external pure virtual override returns (PluginMetadata memory) { | ||
| PluginMetadata memory metadata; | ||
| metadata.name = NAME; | ||
| metadata.version = VERSION; | ||
| metadata.author = AUTHOR; | ||
|
|
||
| metadata.permissionRequest = new string[](2); | ||
| metadata.permissionRequest[0] = "native-token-limit"; | ||
| metadata.permissionRequest[1] = "gas-limit"; | ||
| return metadata; | ||
| } | ||
|
|
||
| // ┏━━━━━━━━━━━━━━━┓ | ||
| // ┃ EIP-165 ┃ | ||
| // ┗━━━━━━━━━━━━━━━┛ | ||
|
|
||
| /// @inheritdoc BasePlugin | ||
| function supportsInterface(bytes4 interfaceId) public view override(BasePlugin, IERC165) returns (bool) { | ||
| return super.supportsInterface(interfaceId); | ||
| } | ||
| } | ||
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.