-
Notifications
You must be signed in to change notification settings - Fork 939
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove gasleft in setupModules, add erc4337 compatibility test
- Loading branch information
Showing
8 changed files
with
238 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
// SPDX-License-Identifier: LGPL-3.0-only | ||
pragma solidity >=0.7.0 <0.9.0; | ||
pragma abicoder v2; | ||
|
||
import "../../libraries/SafeStorage.sol"; | ||
|
||
struct UserOperation { | ||
address sender; | ||
uint256 nonce; | ||
bytes initCode; | ||
bytes callData; | ||
uint256 callGasLimit; | ||
uint256 verificationGasLimit; | ||
uint256 preVerificationGas; | ||
uint256 maxFeePerGas; | ||
uint256 maxPriorityFeePerGas; | ||
bytes paymasterAndData; | ||
bytes signature; | ||
} | ||
|
||
interface ISafe { | ||
function execTransactionFromModule(address to, uint256 value, bytes memory data, uint8 operation) external returns (bool success); | ||
} | ||
|
||
/// @dev A Dummy 4337 Module/Handler for testing purposes | ||
/// @dev DO NOT USE IN PRODUCTION | ||
contract Test4337ModuleAndHandler is SafeStorage { | ||
address public immutable myAddress; | ||
address public immutable entryPoint; | ||
|
||
address internal constant SENTINEL_MODULES = address(0x1); | ||
|
||
constructor(address entryPointAddress) { | ||
entryPoint = entryPointAddress; | ||
myAddress = address(this); | ||
} | ||
|
||
function validateUserOp(UserOperation calldata userOp, bytes32, uint256 missingAccountFunds) external returns (uint256 validationData) { | ||
address payable safeAddress = payable(userOp.sender); | ||
ISafe senderSafe = ISafe(safeAddress); | ||
|
||
if (missingAccountFunds != 0) { | ||
senderSafe.execTransactionFromModule(entryPoint, missingAccountFunds, "", 0); | ||
} | ||
|
||
return 0; | ||
} | ||
|
||
function execTransaction(address to, uint256 value, bytes calldata data) external payable { | ||
address payable safeAddress = payable(msg.sender); | ||
ISafe safe = ISafe(safeAddress); | ||
require(safe.execTransactionFromModule(to, value, data, 0), "tx failed"); | ||
} | ||
|
||
function enableMyself() public { | ||
require(myAddress != address(this), "You need to DELEGATECALL, sir"); | ||
|
||
// Module cannot be added twice. | ||
require(modules[myAddress] == address(0), "GS102"); | ||
modules[myAddress] = modules[SENTINEL_MODULES]; | ||
modules[SENTINEL_MODULES] = myAddress; | ||
} | ||
} |
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,133 @@ | ||
import hre from "hardhat"; | ||
import { expect } from "chai"; | ||
import { AddressZero } from "@ethersproject/constants"; | ||
import { hexConcat } from "ethers/lib/utils"; | ||
import { getFactoryContract, getSafeSingletonContract } from "../utils/setup"; | ||
import { calculateProxyAddress } from "../../src/utils/proxies"; | ||
|
||
const ERC4337_TEST_ENV_VARIABLES_DEFINED = | ||
typeof process.env.ERC4337_TEST_BUNDLER_URL !== "undefined" && | ||
typeof process.env.ERC4337_TEST_NODE_URL !== "undefined" && | ||
typeof process.env.ERC4337_TEST_SAFE_FACTORY_ADDRESS !== "undefined" && | ||
typeof process.env.ERC4337_TEST_SINGLETON_ADDRESS !== "undefined" && | ||
typeof process.env.MNEMONIC !== "undefined"; | ||
|
||
const itif = ERC4337_TEST_ENV_VARIABLES_DEFINED ? it : it.skip; | ||
const SAFE_FACTORY_ADDRESS = process.env.ERC4337_TEST_SAFE_FACTORY_ADDRESS; | ||
const SINGLETON_ADDRESS = process.env.ERC4337_TEST_SINGLETON_ADDRESS; | ||
const BUNDLER_URL = process.env.ERC4337_TEST_BUNDLER_URL; | ||
const NODE_URL = process.env.ERC4337_TEST_NODE_URL; | ||
const MNEMONIC = process.env.MNEMONIC; | ||
|
||
type UserOperation = { | ||
sender: string; | ||
nonce: string; | ||
initCode: string; | ||
callData: string; | ||
callGasLimit: string; | ||
verificationGasLimit: string; | ||
preVerificationGas: string; | ||
maxFeePerGas: string; | ||
maxPriorityFeePerGas: string; | ||
paymasterAndData: string; | ||
signature: string; | ||
}; | ||
|
||
const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)); | ||
|
||
describe("Safe.ERC4337", () => { | ||
const setupTests = async () => { | ||
const factory = await getFactoryContract(); | ||
const singleton = await getSafeSingletonContract(); | ||
const bundlerProvider = new hre.ethers.providers.JsonRpcProvider(BUNDLER_URL); | ||
const provider = new hre.ethers.providers.JsonRpcProvider(NODE_URL); | ||
const userWallet = hre.ethers.Wallet.fromMnemonic(MNEMONIC as string).connect(provider); | ||
|
||
const entryPoints = await bundlerProvider.send("eth_supportedEntryPoints", []); | ||
if (entryPoints.length === 0) { | ||
throw new Error("No entry points found"); | ||
} | ||
|
||
return { | ||
factory: factory.attach(SAFE_FACTORY_ADDRESS).connect(userWallet), | ||
singleton: singleton.attach(SINGLETON_ADDRESS).connect(provider), | ||
bundlerProvider, | ||
provider, | ||
userWallet, | ||
entryPoints, | ||
}; | ||
}; | ||
|
||
/** | ||
* This test verifies the ERC4337 based on gas estimation for a user operation | ||
* The user operation deploys a Safe with the ERC4337 module and a handler | ||
* and executes a transaction, thus verifying two things: | ||
* 1. Deployment of the Safe with the ERC4337 module and handler is possible | ||
* 2. Executing a transaction is possible | ||
*/ | ||
itif("should pass the ERC4337 validation", async () => { | ||
const { singleton, factory, provider, bundlerProvider, userWallet, entryPoints } = await setupTests(); | ||
const ENTRYPOINT_ADDRESS = entryPoints[0]; | ||
|
||
const erc4337ModuleAndHandlerFactory = (await hre.ethers.getContractFactory("Test4337ModuleAndHandler")).connect(userWallet); | ||
const erc4337ModuleAndHandler = await erc4337ModuleAndHandlerFactory.deploy(ENTRYPOINT_ADDRESS); | ||
// The bundler uses a different node, so we need to allow it sometime to sync | ||
await sleep(10000); | ||
|
||
const feeData = await provider.getFeeData(); | ||
const maxFeePerGas = feeData.maxFeePerGas.toHexString(); | ||
|
||
const maxPriorityFeePerGas = feeData.maxPriorityFeePerGas.toHexString(); | ||
|
||
const moduleInitializer = erc4337ModuleAndHandler.interface.encodeFunctionData("enableMyself", []); | ||
const encodedInitializer = singleton.interface.encodeFunctionData("setup", [ | ||
[userWallet.address], | ||
1, | ||
erc4337ModuleAndHandler.address, | ||
moduleInitializer, | ||
erc4337ModuleAndHandler.address, | ||
AddressZero, | ||
0, | ||
AddressZero, | ||
]); | ||
const deployedAddress = await calculateProxyAddress(factory, singleton.address, encodedInitializer, 73); | ||
|
||
// The initCode contains 20 bytes of the factory address and the rest is the calldata to be forwarded | ||
const initCode = hexConcat([ | ||
factory.address, | ||
factory.interface.encodeFunctionData("createProxyWithNonce", [singleton.address, encodedInitializer, 73]), | ||
]); | ||
const userOpCallData = erc4337ModuleAndHandler.interface.encodeFunctionData("execTransaction", [userWallet.address, 0, 0]); | ||
|
||
// Native tokens for the pre-fund 💸 | ||
await userWallet.sendTransaction({ to: deployedAddress, value: hre.ethers.utils.parseEther("0.001") }); | ||
// The bundler uses a different node, so we need to allow it sometime to sync | ||
await sleep(10000); | ||
|
||
const userOperation: UserOperation = { | ||
sender: deployedAddress, | ||
nonce: "0x0", | ||
initCode, | ||
callData: userOpCallData, | ||
callGasLimit: "0x7A120", | ||
verificationGasLimit: "0x7A120", | ||
preVerificationGas: "0x186A0", | ||
maxFeePerGas, | ||
maxPriorityFeePerGas, | ||
paymasterAndData: "0x", | ||
signature: "0x", | ||
}; | ||
|
||
const DEBUG_MESSAGE = ` | ||
Using entry point: ${ENTRYPOINT_ADDRESS} | ||
Deployed Safe address: ${deployedAddress} | ||
Module/Handler address: ${erc4337ModuleAndHandler.address} | ||
User operation: | ||
${JSON.stringify(userOperation, null, 2)} | ||
`; | ||
console.log(DEBUG_MESSAGE); | ||
|
||
const estimatedGas = await bundlerProvider.send("eth_estimateUserOperationGas", [userOperation, ENTRYPOINT_ADDRESS]); | ||
expect(estimatedGas).to.not.be.undefined; | ||
}); | ||
}); |
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