/**
** Account-Abstraction (EIP-4337) singleton EntryPoint implementation.
** Only one instance required on each chain.
**/// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;/* solhint-disable avoid-low-level-calls *//* solhint-disable no-inline-assembly */import"../interfaces/IAccount.sol";
import"../interfaces/IPaymaster.sol";
import"../interfaces/IEntryPoint.sol";
import"../utils/Exec.sol";
import"./StakeManager.sol";
import"./SenderCreator.sol";
import"./Helpers.sol";
import"./NonceManager.sol";
import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
contractEntryPointisIEntryPoint, StakeManager, NonceManager, ReentrancyGuard{
usingUserOperationLibforUserOperation;
SenderCreator privateimmutable senderCreator =new SenderCreator();
// internal value used during simulation: need to query aggregator.addressprivateconstant SIMULATE_FIND_AGGREGATOR =address(1);
// marker for inner call revert on out of gasbytes32privateconstant INNER_OUT_OF_GAS =hex'deaddead';
uint256privateconstant REVERT_REASON_MAX_LEN =2048;
/**
* for simulation purposes, validateUserOp (and validatePaymasterUserOp) must return this value
* in case of signature failure, instead of revert.
*/uint256publicconstant SIG_VALIDATION_FAILED =1;
/**
* compensate the caller's beneficiary address with the collected fees of all UserOperations.
* @param beneficiary the address to receive the fees
* @param amount amount to transfer.
*/function_compensate(addresspayable beneficiary, uint256 amount) internal{
require(beneficiary !=address(0), "AA90 invalid beneficiary");
(bool success,) = beneficiary.call{value : amount}("");
require(success, "AA91 failed send to beneficiary");
}
/**
* execute a user op
* @param opIndex index into the opInfo array
* @param userOp the userOp to execute
* @param opInfo the opInfo filled by validatePrepayment for this userOp.
* @return collected the total amount this userOp paid.
*/function_executeUserOp(uint256 opIndex, UserOperation calldata userOp, UserOpInfo memory opInfo) privatereturns (uint256 collected) {
uint256 preGas =gasleft();
bytesmemory context = getMemoryBytesFromOffset(opInfo.contextOffset);
trythis.innerHandleOp(userOp.callData, opInfo, context) returns (uint256 _actualGasCost) {
collected = _actualGasCost;
} catch {
bytes32 innerRevertCode;
assembly {
returndatacopy(0, 0, 32)
innerRevertCode :=mload(0)
}
// handleOps was called with gas limit too low. abort entire bundle.if (innerRevertCode == INNER_OUT_OF_GAS) {
//report paymaster, since if it is not deliberately caused by the bundler,// it must be a revert caused by paymaster.revert FailedOp(opIndex, "AA95 out of gas");
}
uint256 actualGas = preGas -gasleft() + opInfo.preOpGas;
collected = _handlePostOp(opIndex, IPaymaster.PostOpMode.postOpReverted, opInfo, context, actualGas);
}
}
/**
* Execute a batch of UserOperations.
* no signature aggregator is used.
* if any account requires an aggregator (that is, it returned an aggregator when
* performing simulateValidation), then handleAggregatedOps() must be used instead.
* @param ops the operations to execute
* @param beneficiary the address to receive the fees
*/functionhandleOps(UserOperation[] calldata ops, addresspayable beneficiary) publicnonReentrant{
uint256 opslen = ops.length;
UserOpInfo[] memory opInfos =new UserOpInfo[](opslen);
unchecked {
for (uint256 i =0; i < opslen; i++) {
UserOpInfo memory opInfo = opInfos[i];
(uint256 validationData, uint256 pmValidationData) = _validatePrepayment(i, ops[i], opInfo);
_validateAccountAndPaymasterValidationData(i, validationData, pmValidationData, address(0));
}
uint256 collected =0;
emit BeforeExecution();
for (uint256 i =0; i < opslen; i++) {
collected += _executeUserOp(i, ops[i], opInfos[i]);
}
_compensate(beneficiary, collected);
} //unchecked
}
/**
* Execute a batch of UserOperation with Aggregators
* @param opsPerAggregator the operations to execute, grouped by aggregator (or address(0) for no-aggregator accounts)
* @param beneficiary the address to receive the fees
*/functionhandleAggregatedOps(
UserOpsPerAggregator[] calldata opsPerAggregator,
addresspayable beneficiary
) publicnonReentrant{
uint256 opasLen = opsPerAggregator.length;
uint256 totalOps =0;
for (uint256 i =0; i < opasLen; i++) {
UserOpsPerAggregator calldata opa = opsPerAggregator[i];
UserOperation[] calldata ops = opa.userOps;
IAggregator aggregator = opa.aggregator;
//address(1) is special marker of "signature error"require(address(aggregator) !=address(1), "AA96 invalid aggregator");
if (address(aggregator) !=address(0)) {
// solhint-disable-next-line no-empty-blockstry aggregator.validateSignatures(ops, opa.signature) {}
catch {
revert SignatureValidationFailed(address(aggregator));
}
}
totalOps += ops.length;
}
UserOpInfo[] memory opInfos =new UserOpInfo[](totalOps);
emit BeforeExecution();
uint256 opIndex =0;
for (uint256 a =0; a < opasLen; a++) {
UserOpsPerAggregator calldata opa = opsPerAggregator[a];
UserOperation[] calldata ops = opa.userOps;
IAggregator aggregator = opa.aggregator;
uint256 opslen = ops.length;
for (uint256 i =0; i < opslen; i++) {
UserOpInfo memory opInfo = opInfos[opIndex];
(uint256 validationData, uint256 paymasterValidationData) = _validatePrepayment(opIndex, ops[i], opInfo);
_validateAccountAndPaymasterValidationData(i, validationData, paymasterValidationData, address(aggregator));
opIndex++;
}
}
uint256 collected =0;
opIndex =0;
for (uint256 a =0; a < opasLen; a++) {
UserOpsPerAggregator calldata opa = opsPerAggregator[a];
emit SignatureAggregatorChanged(address(opa.aggregator));
UserOperation[] calldata ops = opa.userOps;
uint256 opslen = ops.length;
for (uint256 i =0; i < opslen; i++) {
collected += _executeUserOp(opIndex, ops[i], opInfos[opIndex]);
opIndex++;
}
}
emit SignatureAggregatorChanged(address(0));
_compensate(beneficiary, collected);
}
/// @inheritdoc IEntryPointfunctionsimulateHandleOp(UserOperation calldata op, address target, bytescalldata targetCallData) externaloverride{
UserOpInfo memory opInfo;
_simulationOnlyValidations(op);
(uint256 validationData, uint256 paymasterValidationData) = _validatePrepayment(0, op, opInfo);
ValidationData memory data = _intersectTimeRange(validationData, paymasterValidationData);
numberMarker();
uint256 paid = _executeUserOp(0, op, opInfo);
numberMarker();
bool targetSuccess;
bytesmemory targetResult;
if (target !=address(0)) {
(targetSuccess, targetResult) = target.call(targetCallData);
}
revert ExecutionResult(opInfo.preOpGas, paid, data.validAfter, data.validUntil, targetSuccess, targetResult);
}
// A memory copy of UserOp static fields only.// Excluding: callData, initCode and signature. Replacing paymasterAndData with paymaster.structMemoryUserOp {
address sender;
uint256 nonce;
uint256 callGasLimit;
uint256 verificationGasLimit;
uint256 preVerificationGas;
address paymaster;
uint256 maxFeePerGas;
uint256 maxPriorityFeePerGas;
}
structUserOpInfo {
MemoryUserOp mUserOp;
bytes32 userOpHash;
uint256 prefund;
uint256 contextOffset;
uint256 preOpGas;
}
/**
* inner function to handle a UserOperation.
* Must be declared "external" to open a call context, but it can only be called by handleOps.
*/functioninnerHandleOp(bytesmemory callData, UserOpInfo memory opInfo, bytescalldata context) externalreturns (uint256 actualGasCost) {
uint256 preGas =gasleft();
require(msg.sender==address(this), "AA92 internal call only");
MemoryUserOp memory mUserOp = opInfo.mUserOp;
uint callGasLimit = mUserOp.callGasLimit;
unchecked {
// handleOps was called with gas limit too low. abort entire bundle.if (gasleft() < callGasLimit + mUserOp.verificationGasLimit +5000) {
assembly {
mstore(0, INNER_OUT_OF_GAS)
revert(0, 32)
}
}
}
IPaymaster.PostOpMode mode = IPaymaster.PostOpMode.opSucceeded;
if (callData.length>0) {
bool success = Exec.call(mUserOp.sender, 0, callData, callGasLimit);
if (!success) {
bytesmemory result = Exec.getReturnData(REVERT_REASON_MAX_LEN);
if (result.length>0) {
emit UserOperationRevertReason(opInfo.userOpHash, mUserOp.sender, mUserOp.nonce, result);
}
mode = IPaymaster.PostOpMode.opReverted;
}
}
unchecked {
uint256 actualGas = preGas -gasleft() + opInfo.preOpGas;
//note: opIndex is ignored (relevant only if mode==postOpReverted, which is only possible outside of innerHandleOp)return _handlePostOp(0, mode, opInfo, context, actualGas);
}
}
/**
* generate a request Id - unique identifier for this request.
* the request ID is a hash over the content of the userOp (except the signature), the entrypoint and the chainid.
*/functiongetUserOpHash(UserOperation calldata userOp) publicviewreturns (bytes32) {
returnkeccak256(abi.encode(userOp.hash(), address(this), block.chainid));
}
/**
* copy general fields from userOp into the memory opInfo structure.
*/function_copyUserOpToMemory(UserOperation calldata userOp, MemoryUserOp memory mUserOp) internalpure{
mUserOp.sender = userOp.sender;
mUserOp.nonce = userOp.nonce;
mUserOp.callGasLimit = userOp.callGasLimit;
mUserOp.verificationGasLimit = userOp.verificationGasLimit;
mUserOp.preVerificationGas = userOp.preVerificationGas;
mUserOp.maxFeePerGas = userOp.maxFeePerGas;
mUserOp.maxPriorityFeePerGas = userOp.maxPriorityFeePerGas;
bytescalldata paymasterAndData = userOp.paymasterAndData;
if (paymasterAndData.length>0) {
require(paymasterAndData.length>=20, "AA93 invalid paymasterAndData");
mUserOp.paymaster =address(bytes20(paymasterAndData[: 20]));
} else {
mUserOp.paymaster =address(0);
}
}
/**
* Simulate a call to account.validateUserOp and paymaster.validatePaymasterUserOp.
* @dev this method always revert. Successful result is ValidationResult error. other errors are failures.
* @dev The node must also verify it doesn't use banned opcodes, and that it doesn't reference storage outside the account's data.
* @param userOp the user operation to validate.
*/functionsimulateValidation(UserOperation calldata userOp) external{
UserOpInfo memory outOpInfo;
_simulationOnlyValidations(userOp);
(uint256 validationData, uint256 paymasterValidationData) = _validatePrepayment(0, userOp, outOpInfo);
StakeInfo memory paymasterInfo = _getStakeInfo(outOpInfo.mUserOp.paymaster);
StakeInfo memory senderInfo = _getStakeInfo(outOpInfo.mUserOp.sender);
StakeInfo memory factoryInfo;
{
bytescalldata initCode = userOp.initCode;
address factory = initCode.length>=20 ? address(bytes20(initCode[0 : 20])) : address(0);
factoryInfo = _getStakeInfo(factory);
}
ValidationData memory data = _intersectTimeRange(validationData, paymasterValidationData);
address aggregator = data.aggregator;
bool sigFailed = aggregator ==address(1);
ReturnInfo memory returnInfo = ReturnInfo(outOpInfo.preOpGas, outOpInfo.prefund,
sigFailed, data.validAfter, data.validUntil, getMemoryBytesFromOffset(outOpInfo.contextOffset));
if (aggregator !=address(0) && aggregator !=address(1)) {
AggregatorStakeInfo memory aggregatorInfo = AggregatorStakeInfo(aggregator, _getStakeInfo(aggregator));
revert ValidationResultWithAggregation(returnInfo, senderInfo, factoryInfo, paymasterInfo, aggregatorInfo);
}
revert ValidationResult(returnInfo, senderInfo, factoryInfo, paymasterInfo);
}
function_getRequiredPrefund(MemoryUserOp memory mUserOp) internalpurereturns (uint256 requiredPrefund) {
unchecked {
//when using a Paymaster, the verificationGasLimit is used also to as a limit for the postOp call.// our security model might call postOp eventually twiceuint256 mul = mUserOp.paymaster !=address(0) ? 3 : 1;
uint256 requiredGas = mUserOp.callGasLimit + mUserOp.verificationGasLimit * mul + mUserOp.preVerificationGas;
requiredPrefund = requiredGas * mUserOp.maxFeePerGas;
}
}
// create the sender's contract if needed.function_createSenderIfNeeded(uint256 opIndex, UserOpInfo memory opInfo, bytescalldata initCode) internal{
if (initCode.length!=0) {
address sender = opInfo.mUserOp.sender;
if (sender.code.length!=0) revert FailedOp(opIndex, "AA10 sender already constructed");
address sender1 = senderCreator.createSender{gas : opInfo.mUserOp.verificationGasLimit}(initCode);
if (sender1 ==address(0)) revert FailedOp(opIndex, "AA13 initCode failed or OOG");
if (sender1 != sender) revert FailedOp(opIndex, "AA14 initCode must return sender");
if (sender1.code.length==0) revert FailedOp(opIndex, "AA15 initCode must create sender");
address factory =address(bytes20(initCode[0 : 20]));
emit AccountDeployed(opInfo.userOpHash, sender, factory, opInfo.mUserOp.paymaster);
}
}
/**
* Get counterfactual sender address.
* Calculate the sender contract address that will be generated by the initCode and salt in the UserOperation.
* this method always revert, and returns the address in SenderAddressResult error
* @param initCode the constructor code to be passed into the UserOperation.
*/functiongetSenderAddress(bytescalldata initCode) public{
address sender = senderCreator.createSender(initCode);
revert SenderAddressResult(sender);
}
function_simulationOnlyValidations(UserOperation calldata userOp) internalview{
// solhint-disable-next-line no-empty-blockstrythis._validateSenderAndPaymaster(userOp.initCode, userOp.sender, userOp.paymasterAndData) {}
catchError(stringmemory revertReason) {
if (bytes(revertReason).length!=0) {
revert FailedOp(0, revertReason);
}
}
}
/**
* Called only during simulation.
* This function always reverts to prevent warm/cold storage differentiation in simulation vs execution.
*/function_validateSenderAndPaymaster(bytescalldata initCode, address sender, bytescalldata paymasterAndData) externalview{
if (initCode.length==0&& sender.code.length==0) {
// it would revert anyway. but give a meaningful messagerevert("AA20 account not deployed");
}
if (paymasterAndData.length>=20) {
address paymaster =address(bytes20(paymasterAndData[0 : 20]));
if (paymaster.code.length==0) {
// it would revert anyway. but give a meaningful messagerevert("AA30 paymaster not deployed");
}
}
// always revertrevert("");
}
/**
* call account.validateUserOp.
* revert (with FailedOp) in case validateUserOp reverts, or account didn't send required prefund.
* decrement account's deposit if needed
*/function_validateAccountPrepayment(uint256 opIndex, UserOperation calldata op, UserOpInfo memory opInfo, uint256 requiredPrefund)
internalreturns (uint256 gasUsedByValidateAccountPrepayment, uint256 validationData) {
unchecked {
uint256 preGas =gasleft();
MemoryUserOp memory mUserOp = opInfo.mUserOp;
address sender = mUserOp.sender;
_createSenderIfNeeded(opIndex, opInfo, op.initCode);
address paymaster = mUserOp.paymaster;
numberMarker();
uint256 missingAccountFunds =0;
if (paymaster ==address(0)) {
uint256 bal = balanceOf(sender);
missingAccountFunds = bal > requiredPrefund ? 0 : requiredPrefund - bal;
}
try IAccount(sender).validateUserOp{gas : mUserOp.verificationGasLimit}(op, opInfo.userOpHash, missingAccountFunds)
returns (uint256 _validationData) {
validationData = _validationData;
} catchError(stringmemory revertReason) {
revert FailedOp(opIndex, string.concat("AA23 reverted: ", revertReason));
} catch {
revert FailedOp(opIndex, "AA23 reverted (or OOG)");
}
if (paymaster ==address(0)) {
DepositInfo storage senderInfo = deposits[sender];
uint256 deposit = senderInfo.deposit;
if (requiredPrefund > deposit) {
revert FailedOp(opIndex, "AA21 didn't pay prefund");
}
senderInfo.deposit =uint112(deposit - requiredPrefund);
}
gasUsedByValidateAccountPrepayment = preGas -gasleft();
}
}
/**
* In case the request has a paymaster:
* Validate paymaster has enough deposit.
* Call paymaster.validatePaymasterUserOp.
* Revert with proper FailedOp in case paymaster reverts.
* Decrement paymaster's deposit
*/function_validatePaymasterPrepayment(uint256 opIndex, UserOperation calldata op, UserOpInfo memory opInfo, uint256 requiredPreFund, uint256 gasUsedByValidateAccountPrepayment)
internalreturns (bytesmemory context, uint256 validationData) {
unchecked {
MemoryUserOp memory mUserOp = opInfo.mUserOp;
uint256 verificationGasLimit = mUserOp.verificationGasLimit;
require(verificationGasLimit > gasUsedByValidateAccountPrepayment, "AA41 too little verificationGas");
uint256 gas = verificationGasLimit - gasUsedByValidateAccountPrepayment;
address paymaster = mUserOp.paymaster;
DepositInfo storage paymasterInfo = deposits[paymaster];
uint256 deposit = paymasterInfo.deposit;
if (deposit < requiredPreFund) {
revert FailedOp(opIndex, "AA31 paymaster deposit too low");
}
paymasterInfo.deposit =uint112(deposit - requiredPreFund);
try IPaymaster(paymaster).validatePaymasterUserOp{gas : gas}(op, opInfo.userOpHash, requiredPreFund) returns (bytesmemory _context, uint256 _validationData){
context = _context;
validationData = _validationData;
} catchError(stringmemory revertReason) {
revert FailedOp(opIndex, string.concat("AA33 reverted: ", revertReason));
} catch {
revert FailedOp(opIndex, "AA33 reverted (or OOG)");
}
}
}
/**
* revert if either account validationData or paymaster validationData is expired
*/function_validateAccountAndPaymasterValidationData(uint256 opIndex, uint256 validationData, uint256 paymasterValidationData, address expectedAggregator) internalview{
(address aggregator, bool outOfTimeRange) = _getValidationData(validationData);
if (expectedAggregator != aggregator) {
revert FailedOp(opIndex, "AA24 signature error");
}
if (outOfTimeRange) {
revert FailedOp(opIndex, "AA22 expired or not due");
}
//pmAggregator is not a real signature aggregator: we don't have logic to handle it as address.// non-zero address means that the paymaster fails due to some signature check (which is ok only during estimation)address pmAggregator;
(pmAggregator, outOfTimeRange) = _getValidationData(paymasterValidationData);
if (pmAggregator !=address(0)) {
revert FailedOp(opIndex, "AA34 signature error");
}
if (outOfTimeRange) {
revert FailedOp(opIndex, "AA32 paymaster expired or not due");
}
}
function_getValidationData(uint256 validationData) internalviewreturns (address aggregator, bool outOfTimeRange) {
if (validationData ==0) {
return (address(0), false);
}
ValidationData memory data = _parseValidationData(validationData);
// solhint-disable-next-line not-rely-on-time
outOfTimeRange =block.timestamp> data.validUntil ||block.timestamp< data.validAfter;
aggregator = data.aggregator;
}
/**
* validate account and paymaster (if defined).
* also make sure total validation doesn't exceed verificationGasLimit
* this method is called off-chain (simulateValidation()) and on-chain (from handleOps)
* @param opIndex the index of this userOp into the "opInfos" array
* @param userOp the userOp to validate
*/function_validatePrepayment(uint256 opIndex, UserOperation calldata userOp, UserOpInfo memory outOpInfo)
privatereturns (uint256 validationData, uint256 paymasterValidationData) {
uint256 preGas =gasleft();
MemoryUserOp memory mUserOp = outOpInfo.mUserOp;
_copyUserOpToMemory(userOp, mUserOp);
outOpInfo.userOpHash = getUserOpHash(userOp);
// validate all numeric values in userOp are well below 128 bit, so they can safely be added// and multiplied without causing overflowuint256 maxGasValues = mUserOp.preVerificationGas | mUserOp.verificationGasLimit | mUserOp.callGasLimit |
userOp.maxFeePerGas | userOp.maxPriorityFeePerGas;
require(maxGasValues <=type(uint120).max, "AA94 gas values overflow");
uint256 gasUsedByValidateAccountPrepayment;
(uint256 requiredPreFund) = _getRequiredPrefund(mUserOp);
(gasUsedByValidateAccountPrepayment, validationData) = _validateAccountPrepayment(opIndex, userOp, outOpInfo, requiredPreFund);
if (!_validateAndUpdateNonce(mUserOp.sender, mUserOp.nonce)) {
revert FailedOp(opIndex, "AA25 invalid account nonce");
}
//a "marker" where account opcode validation is done and paymaster opcode validation is about to start// (used only by off-chain simulateValidation)
numberMarker();
bytesmemory context;
if (mUserOp.paymaster !=address(0)) {
(context, paymasterValidationData) = _validatePaymasterPrepayment(opIndex, userOp, outOpInfo, requiredPreFund, gasUsedByValidateAccountPrepayment);
}
unchecked {
uint256 gasUsed = preGas -gasleft();
if (userOp.verificationGasLimit < gasUsed) {
revert FailedOp(opIndex, "AA40 over verificationGasLimit");
}
outOpInfo.prefund = requiredPreFund;
outOpInfo.contextOffset = getOffsetOfMemoryBytes(context);
outOpInfo.preOpGas = preGas -gasleft() + userOp.preVerificationGas;
}
}
/**
* process post-operation.
* called just after the callData is executed.
* if a paymaster is defined and its validation returned a non-empty context, its postOp is called.
* the excess amount is refunded to the account (or paymaster - if it was used in the request)
* @param opIndex index in the batch
* @param mode - whether is called from innerHandleOp, or outside (postOpReverted)
* @param opInfo userOp fields and info collected during validation
* @param context the context returned in validatePaymasterUserOp
* @param actualGas the gas used so far by this user operation
*/function_handlePostOp(uint256 opIndex, IPaymaster.PostOpMode mode, UserOpInfo memory opInfo, bytesmemory context, uint256 actualGas) privatereturns (uint256 actualGasCost) {
uint256 preGas =gasleft();
unchecked {
address refundAddress;
MemoryUserOp memory mUserOp = opInfo.mUserOp;
uint256 gasPrice = getUserOpGasPrice(mUserOp);
address paymaster = mUserOp.paymaster;
if (paymaster ==address(0)) {
refundAddress = mUserOp.sender;
} else {
refundAddress = paymaster;
if (context.length>0) {
actualGasCost = actualGas * gasPrice;
if (mode != IPaymaster.PostOpMode.postOpReverted) {
IPaymaster(paymaster).postOp{gas : mUserOp.verificationGasLimit}(mode, context, actualGasCost);
} else {
// solhint-disable-next-line no-empty-blockstry IPaymaster(paymaster).postOp{gas : mUserOp.verificationGasLimit}(mode, context, actualGasCost) {}
catchError(stringmemory reason) {
revert FailedOp(opIndex, string.concat("AA50 postOp reverted: ", reason));
}
catch {
revert FailedOp(opIndex, "AA50 postOp revert");
}
}
}
}
actualGas += preGas -gasleft();
actualGasCost = actualGas * gasPrice;
if (opInfo.prefund < actualGasCost) {
revert FailedOp(opIndex, "AA51 prefund below actualGasCost");
}
uint256 refund = opInfo.prefund - actualGasCost;
_incrementDeposit(refundAddress, refund);
bool success = mode == IPaymaster.PostOpMode.opSucceeded;
emit UserOperationEvent(opInfo.userOpHash, mUserOp.sender, mUserOp.paymaster, mUserOp.nonce, success, actualGasCost, actualGas);
} // unchecked
}
/**
* the gas price this UserOp agrees to pay.
* relayer/block builder might submit the TX with higher priorityFee, but the user should not
*/functiongetUserOpGasPrice(MemoryUserOp memory mUserOp) internalviewreturns (uint256) {
unchecked {
uint256 maxFeePerGas = mUserOp.maxFeePerGas;
uint256 maxPriorityFeePerGas = mUserOp.maxPriorityFeePerGas;
if (maxFeePerGas == maxPriorityFeePerGas) {
//legacy mode (for networks that don't support basefee opcode)return maxFeePerGas;
}
return min(maxFeePerGas, maxPriorityFeePerGas +block.basefee);
}
}
functionmin(uint256 a, uint256 b) internalpurereturns (uint256) {
return a < b ? a : b;
}
functiongetOffsetOfMemoryBytes(bytesmemory data) internalpurereturns (uint256 offset) {
assembly {offset := data}
}
functiongetMemoryBytesFromOffset(uint256 offset) internalpurereturns (bytesmemory data) {
assembly {data := offset}
}
//place the NUMBER opcode in the code.// this is used as a marker during simulation, as this OP is completely banned from the simulated code of the// account and paymaster.functionnumberMarker() internalview{
assembly {mstore(0, number())}
}
}
Contract Source Code
File 2 of 14: Exec.sol
// SPDX-License-Identifier: LGPL-3.0-onlypragmasolidity >=0.7.5 <0.9.0;// solhint-disable no-inline-assembly/**
* Utility functions helpful when making different kinds of contract calls in Solidity.
*/libraryExec{
functioncall(address to,
uint256 value,
bytesmemory data,
uint256 txGas
) internalreturns (bool success) {
assembly {
success :=call(txGas, to, value, add(data, 0x20), mload(data), 0, 0)
}
}
functionstaticcall(address to,
bytesmemory data,
uint256 txGas
) internalviewreturns (bool success) {
assembly {
success :=staticcall(txGas, to, add(data, 0x20), mload(data), 0, 0)
}
}
functiondelegateCall(address to,
bytesmemory data,
uint256 txGas
) internalreturns (bool success) {
assembly {
success :=delegatecall(txGas, to, add(data, 0x20), mload(data), 0, 0)
}
}
// get returned data from last call or calldelegatefunctiongetReturnData(uint256 maxLen) internalpurereturns (bytesmemory returnData) {
assembly {
let len :=returndatasize()
ifgt(len, maxLen) {
len := maxLen
}
let ptr :=mload(0x40)
mstore(0x40, add(ptr, add(len, 0x20)))
mstore(ptr, len)
returndatacopy(add(ptr, 0x20), 0, len)
returnData := ptr
}
}
// revert with explicit byte array (probably reverted info from call)functionrevertWithData(bytesmemory returnData) internalpure{
assembly {
revert(add(returnData, 32), mload(returnData))
}
}
functioncallAndRevert(address to, bytesmemory data, uint256 maxLen) internal{
bool success = call(to,0,data,gasleft());
if (!success) {
revertWithData(getReturnData(maxLen));
}
}
}
Contract Source Code
File 3 of 14: Helpers.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;/* solhint-disable no-inline-assembly *//**
* returned data from validateUserOp.
* validateUserOp returns a uint256, with is created by `_packedValidationData` and parsed by `_parseValidationData`
* @param aggregator - address(0) - the account validated the signature by itself.
* address(1) - the account failed to validate the signature.
* otherwise - this is an address of a signature aggregator that must be used to validate the signature.
* @param validAfter - this UserOp is valid only after this timestamp.
* @param validaUntil - this UserOp is valid only up to this timestamp.
*/structValidationData {
address aggregator;
uint48 validAfter;
uint48 validUntil;
}
//extract sigFailed, validAfter, validUntil.// also convert zero validUntil to type(uint48).maxfunction_parseValidationData(uint validationData) purereturns (ValidationData memory data) {
address aggregator =address(uint160(validationData));
uint48 validUntil =uint48(validationData >>160);
if (validUntil ==0) {
validUntil =type(uint48).max;
}
uint48 validAfter =uint48(validationData >> (48+160));
return ValidationData(aggregator, validAfter, validUntil);
}
// intersect account and paymaster ranges.function_intersectTimeRange(uint256 validationData, uint256 paymasterValidationData) purereturns (ValidationData memory) {
ValidationData memory accountValidationData = _parseValidationData(validationData);
ValidationData memory pmValidationData = _parseValidationData(paymasterValidationData);
address aggregator = accountValidationData.aggregator;
if (aggregator ==address(0)) {
aggregator = pmValidationData.aggregator;
}
uint48 validAfter = accountValidationData.validAfter;
uint48 validUntil = accountValidationData.validUntil;
uint48 pmValidAfter = pmValidationData.validAfter;
uint48 pmValidUntil = pmValidationData.validUntil;
if (validAfter < pmValidAfter) validAfter = pmValidAfter;
if (validUntil > pmValidUntil) validUntil = pmValidUntil;
return ValidationData(aggregator, validAfter, validUntil);
}
/**
* helper to pack the return value for validateUserOp
* @param data - the ValidationData to pack
*/function_packValidationData(ValidationData memory data) purereturns (uint256) {
returnuint160(data.aggregator) | (uint256(data.validUntil) <<160) | (uint256(data.validAfter) << (160+48));
}
/**
* helper to pack the return value for validateUserOp, when not using an aggregator
* @param sigFailed - true for signature failure, false for success
* @param validUntil last timestamp this UserOperation is valid (or zero for infinite)
* @param validAfter first timestamp this UserOperation is valid
*/function_packValidationData(bool sigFailed, uint48 validUntil, uint48 validAfter) purereturns (uint256) {
return (sigFailed ? 1 : 0) | (uint256(validUntil) <<160) | (uint256(validAfter) << (160+48));
}
/**
* keccak function over calldata.
* @dev copy calldata into memory, do keccak and drop allocated memory. Strangely, this is more efficient than letting solidity do it.
*/functioncalldataKeccak(bytescalldata data) purereturns (bytes32 ret) {
assembly {
let mem :=mload(0x40)
let len := data.lengthcalldatacopy(mem, data.offset, len)
ret :=keccak256(mem, len)
}
}
Contract Source Code
File 4 of 14: IAccount.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;import"./UserOperation.sol";
interfaceIAccount{
/**
* Validate user's signature and nonce
* the entryPoint will make the call to the recipient only if this validation call returns successfully.
* signature failure should be reported by returning SIG_VALIDATION_FAILED (1).
* This allows making a "simulation call" without a valid signature
* Other failures (e.g. nonce mismatch, or invalid signature format) should still revert to signal failure.
*
* @dev Must validate caller is the entryPoint.
* Must validate the signature and nonce
* @param userOp the operation that is about to be executed.
* @param userOpHash hash of the user's request data. can be used as the basis for signature.
* @param missingAccountFunds missing funds on the account's deposit in the entrypoint.
* This is the minimum amount to transfer to the sender(entryPoint) to be able to make the call.
* The excess is left as a deposit in the entrypoint, for future calls.
* can be withdrawn anytime using "entryPoint.withdrawTo()"
* In case there is a paymaster in the request (or the current deposit is high enough), this value will be zero.
* @return validationData packaged ValidationData structure. use `_packValidationData` and `_unpackValidationData` to encode and decode
* <20-byte> sigAuthorizer - 0 for valid signature, 1 to mark signature failure,
* otherwise, an address of an "authorizer" contract.
* <6-byte> validUntil - last timestamp this operation is valid. 0 for "indefinite"
* <6-byte> validAfter - first timestamp this operation is valid
* If an account doesn't use time-range, it is enough to return SIG_VALIDATION_FAILED value (1) for signature failure.
* Note that the validation code cannot use block.timestamp (or block.number) directly.
*/functionvalidateUserOp(UserOperation calldata userOp, bytes32 userOpHash, uint256 missingAccountFunds)
externalreturns (uint256 validationData);
}
Contract Source Code
File 5 of 14: IAggregator.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;import"./UserOperation.sol";
/**
* Aggregated Signatures validator.
*/interfaceIAggregator{
/**
* validate aggregated signature.
* revert if the aggregated signature does not match the given list of operations.
*/functionvalidateSignatures(UserOperation[] calldata userOps, bytescalldata signature) externalview;
/**
* validate signature of a single userOp
* This method is should be called by bundler after EntryPoint.simulateValidation() returns (reverts) with ValidationResultWithAggregation
* First it validates the signature over the userOp. Then it returns data to be used when creating the handleOps.
* @param userOp the userOperation received from the user.
* @return sigForUserOp the value to put into the signature field of the userOp when calling handleOps.
* (usually empty, unless account and aggregator support some kind of "multisig"
*/functionvalidateUserOpSignature(UserOperation calldata userOp)
externalviewreturns (bytesmemory sigForUserOp);
/**
* aggregate multiple signatures into a single value.
* This method is called off-chain to calculate the signature to pass with handleOps()
* bundler MAY use optimized custom code perform this aggregation
* @param userOps array of UserOperations to collect the signatures from.
* @return aggregatedSignature the aggregated signature
*/functionaggregateSignatures(UserOperation[] calldata userOps) externalviewreturns (bytesmemory aggregatedSignature);
}
Contract Source Code
File 6 of 14: IEntryPoint.sol
/**
** Account-Abstraction (EIP-4337) singleton EntryPoint implementation.
** Only one instance required on each chain.
**/// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;/* solhint-disable avoid-low-level-calls *//* solhint-disable no-inline-assembly *//* solhint-disable reason-string */import"./UserOperation.sol";
import"./IStakeManager.sol";
import"./IAggregator.sol";
import"./INonceManager.sol";
interfaceIEntryPointisIStakeManager, INonceManager{
/***
* An event emitted after each successful request
* @param userOpHash - unique identifier for the request (hash its entire content, except signature).
* @param sender - the account that generates this request.
* @param paymaster - if non-null, the paymaster that pays for this request.
* @param nonce - the nonce value from the request.
* @param success - true if the sender transaction succeeded, false if reverted.
* @param actualGasCost - actual amount paid (by account or paymaster) for this UserOperation.
* @param actualGasUsed - total gas used by this UserOperation (including preVerification, creation, validation and execution).
*/eventUserOperationEvent(bytes32indexed userOpHash, addressindexed sender, addressindexed paymaster, uint256 nonce, bool success, uint256 actualGasCost, uint256 actualGasUsed);
/**
* account "sender" was deployed.
* @param userOpHash the userOp that deployed this account. UserOperationEvent will follow.
* @param sender the account that is deployed
* @param factory the factory used to deploy this account (in the initCode)
* @param paymaster the paymaster used by this UserOp
*/eventAccountDeployed(bytes32indexed userOpHash, addressindexed sender, address factory, address paymaster);
/**
* An event emitted if the UserOperation "callData" reverted with non-zero length
* @param userOpHash the request unique identifier.
* @param sender the sender of this request
* @param nonce the nonce used in the request
* @param revertReason - the return bytes from the (reverted) call to "callData".
*/eventUserOperationRevertReason(bytes32indexed userOpHash, addressindexed sender, uint256 nonce, bytes revertReason);
/**
* an event emitted by handleOps(), before starting the execution loop.
* any event emitted before this event, is part of the validation.
*/eventBeforeExecution();
/**
* signature aggregator used by the following UserOperationEvents within this bundle.
*/eventSignatureAggregatorChanged(addressindexed aggregator);
/**
* a custom revert error of handleOps, to identify the offending op.
* NOTE: if simulateValidation passes successfully, there should be no reason for handleOps to fail on it.
* @param opIndex - index into the array of ops to the failed one (in simulateValidation, this is always zero)
* @param reason - revert reason
* The string starts with a unique code "AAmn", where "m" is "1" for factory, "2" for account and "3" for paymaster issues,
* so a failure can be attributed to the correct entity.
* Should be caught in off-chain handleOps simulation and not happen on-chain.
* Useful for mitigating DoS attempts against batchers or for troubleshooting of factory/account/paymaster reverts.
*/errorFailedOp(uint256 opIndex, string reason);
/**
* error case when a signature aggregator fails to verify the aggregated signature it had created.
*/errorSignatureValidationFailed(address aggregator);
/**
* Successful result from simulateValidation.
* @param returnInfo gas and time-range returned values
* @param senderInfo stake information about the sender
* @param factoryInfo stake information about the factory (if any)
* @param paymasterInfo stake information about the paymaster (if any)
*/errorValidationResult(ReturnInfo returnInfo,
StakeInfo senderInfo, StakeInfo factoryInfo, StakeInfo paymasterInfo);
/**
* Successful result from simulateValidation, if the account returns a signature aggregator
* @param returnInfo gas and time-range returned values
* @param senderInfo stake information about the sender
* @param factoryInfo stake information about the factory (if any)
* @param paymasterInfo stake information about the paymaster (if any)
* @param aggregatorInfo signature aggregation info (if the account requires signature aggregator)
* bundler MUST use it to verify the signature, or reject the UserOperation
*/errorValidationResultWithAggregation(ReturnInfo returnInfo,
StakeInfo senderInfo, StakeInfo factoryInfo, StakeInfo paymasterInfo,
AggregatorStakeInfo aggregatorInfo);
/**
* return value of getSenderAddress
*/errorSenderAddressResult(address sender);
/**
* return value of simulateHandleOp
*/errorExecutionResult(uint256 preOpGas, uint256 paid, uint48 validAfter, uint48 validUntil, bool targetSuccess, bytes targetResult);
//UserOps handled, per aggregatorstructUserOpsPerAggregator {
UserOperation[] userOps;
// aggregator address
IAggregator aggregator;
// aggregated signaturebytes signature;
}
/**
* Execute a batch of UserOperation.
* no signature aggregator is used.
* if any account requires an aggregator (that is, it returned an aggregator when
* performing simulateValidation), then handleAggregatedOps() must be used instead.
* @param ops the operations to execute
* @param beneficiary the address to receive the fees
*/functionhandleOps(UserOperation[] calldata ops, addresspayable beneficiary) external;
/**
* Execute a batch of UserOperation with Aggregators
* @param opsPerAggregator the operations to execute, grouped by aggregator (or address(0) for no-aggregator accounts)
* @param beneficiary the address to receive the fees
*/functionhandleAggregatedOps(
UserOpsPerAggregator[] calldata opsPerAggregator,
addresspayable beneficiary
) external;
/**
* generate a request Id - unique identifier for this request.
* the request ID is a hash over the content of the userOp (except the signature), the entrypoint and the chainid.
*/functiongetUserOpHash(UserOperation calldata userOp) externalviewreturns (bytes32);
/**
* Simulate a call to account.validateUserOp and paymaster.validatePaymasterUserOp.
* @dev this method always revert. Successful result is ValidationResult error. other errors are failures.
* @dev The node must also verify it doesn't use banned opcodes, and that it doesn't reference storage outside the account's data.
* @param userOp the user operation to validate.
*/functionsimulateValidation(UserOperation calldata userOp) external;
/**
* gas and return values during simulation
* @param preOpGas the gas used for validation (including preValidationGas)
* @param prefund the required prefund for this operation
* @param sigFailed validateUserOp's (or paymaster's) signature check failed
* @param validAfter - first timestamp this UserOp is valid (merging account and paymaster time-range)
* @param validUntil - last timestamp this UserOp is valid (merging account and paymaster time-range)
* @param paymasterContext returned by validatePaymasterUserOp (to be passed into postOp)
*/structReturnInfo {
uint256 preOpGas;
uint256 prefund;
bool sigFailed;
uint48 validAfter;
uint48 validUntil;
bytes paymasterContext;
}
/**
* returned aggregated signature info.
* the aggregator returned by the account, and its current stake.
*/structAggregatorStakeInfo {
address aggregator;
StakeInfo stakeInfo;
}
/**
* Get counterfactual sender address.
* Calculate the sender contract address that will be generated by the initCode and salt in the UserOperation.
* this method always revert, and returns the address in SenderAddressResult error
* @param initCode the constructor code to be passed into the UserOperation.
*/functiongetSenderAddress(bytesmemory initCode) external;
/**
* simulate full execution of a UserOperation (including both validation and target execution)
* this method will always revert with "ExecutionResult".
* it performs full validation of the UserOperation, but ignores signature error.
* an optional target address is called after the userop succeeds, and its value is returned
* (before the entire call is reverted)
* Note that in order to collect the the success/failure of the target call, it must be executed
* with trace enabled to track the emitted events.
* @param op the UserOperation to simulate
* @param target if nonzero, a target address to call after userop simulation. If called, the targetSuccess and targetResult
* are set to the return from that call.
* @param targetCallData callData to pass to target address
*/functionsimulateHandleOp(UserOperation calldata op, address target, bytescalldata targetCallData) external;
}
Contract Source Code
File 7 of 14: INonceManager.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;interfaceINonceManager{
/**
* Return the next nonce for this sender.
* Within a given key, the nonce values are sequenced (starting with zero, and incremented by one on each userop)
* But UserOp with different keys can come with arbitrary order.
*
* @param sender the account address
* @param key the high 192 bit of the nonce
* @return nonce a full nonce to pass for next UserOp with this sender.
*/functiongetNonce(address sender, uint192 key)
externalviewreturns (uint256 nonce);
/**
* Manually increment the nonce of the sender.
* This method is exposed just for completeness..
* Account does NOT need to call it, neither during validation, nor elsewhere,
* as the EntryPoint will update the nonce regardless.
* Possible use-case is call it with various keys to "initialize" their nonces to one, so that future
* UserOperations will not pay extra for the first transaction with a given key.
*/functionincrementNonce(uint192 key) external;
}
Contract Source Code
File 8 of 14: IPaymaster.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;import"./UserOperation.sol";
/**
* the interface exposed by a paymaster contract, who agrees to pay the gas for user's operations.
* a paymaster must hold a stake to cover the required entrypoint stake and also the gas for the transaction.
*/interfaceIPaymaster{
enumPostOpMode {
opSucceeded, // user op succeeded
opReverted, // user op reverted. still has to pay for gas.
postOpReverted //user op succeeded, but caused postOp to revert. Now it's a 2nd call, after user's op was deliberately reverted.
}
/**
* payment validation: check if paymaster agrees to pay.
* Must verify sender is the entryPoint.
* Revert to reject this request.
* Note that bundlers will reject this method if it changes the state, unless the paymaster is trusted (whitelisted)
* The paymaster pre-pays using its deposit, and receive back a refund after the postOp method returns.
* @param userOp the user operation
* @param userOpHash hash of the user's request data.
* @param maxCost the maximum cost of this transaction (based on maximum gas and gas price from userOp)
* @return context value to send to a postOp
* zero length to signify postOp is not required.
* @return validationData signature and time-range of this operation, encoded the same as the return value of validateUserOperation
* <20-byte> sigAuthorizer - 0 for valid signature, 1 to mark signature failure,
* otherwise, an address of an "authorizer" contract.
* <6-byte> validUntil - last timestamp this operation is valid. 0 for "indefinite"
* <6-byte> validAfter - first timestamp this operation is valid
* Note that the validation code cannot use block.timestamp (or block.number) directly.
*/functionvalidatePaymasterUserOp(UserOperation calldata userOp, bytes32 userOpHash, uint256 maxCost)
externalreturns (bytesmemory context, uint256 validationData);
/**
* post-operation handler.
* Must verify sender is the entryPoint
* @param mode enum with the following options:
* opSucceeded - user operation succeeded.
* opReverted - user op reverted. still has to pay for gas.
* postOpReverted - user op succeeded, but caused postOp (in mode=opSucceeded) to revert.
* Now this is the 2nd call, after user's op was deliberately reverted.
* @param context - the context value returned by validatePaymasterUserOp
* @param actualGasCost - actual gas used so far (without this postOp call).
*/functionpostOp(PostOpMode mode, bytescalldata context, uint256 actualGasCost) external;
}
Contract Source Code
File 9 of 14: IStakeManager.sol
// SPDX-License-Identifier: GPL-3.0-onlypragmasolidity ^0.8.12;/**
* manage deposits and stakes.
* deposit is just a balance used to pay for UserOperations (either by a paymaster or an account)
* stake is value locked for at least "unstakeDelay" by the staked entity.
*/interfaceIStakeManager{
eventDeposited(addressindexed account,
uint256 totalDeposit
);
eventWithdrawn(addressindexed account,
address withdrawAddress,
uint256 amount
);
/// Emitted when stake or unstake delay are modifiedeventStakeLocked(addressindexed account,
uint256 totalStaked,
uint256 unstakeDelaySec
);
/// Emitted once a stake is scheduled for withdrawaleventStakeUnlocked(addressindexed account,
uint256 withdrawTime
);
eventStakeWithdrawn(addressindexed account,
address withdrawAddress,
uint256 amount
);
/**
* @param deposit the entity's deposit
* @param staked true if this entity is staked.
* @param stake actual amount of ether staked for this entity.
* @param unstakeDelaySec minimum delay to withdraw the stake.
* @param withdrawTime - first block timestamp where 'withdrawStake' will be callable, or zero if already locked
* @dev sizes were chosen so that (deposit,staked, stake) fit into one cell (used during handleOps)
* and the rest fit into a 2nd cell.
* 112 bit allows for 10^15 eth
* 48 bit for full timestamp
* 32 bit allows 150 years for unstake delay
*/structDepositInfo {
uint112 deposit;
bool staked;
uint112 stake;
uint32 unstakeDelaySec;
uint48 withdrawTime;
}
//API struct used by getStakeInfo and simulateValidationstructStakeInfo {
uint256 stake;
uint256 unstakeDelaySec;
}
/// @return info - full deposit information of given accountfunctiongetDepositInfo(address account) externalviewreturns (DepositInfo memory info);
/// @return the deposit (for gas payment) of the accountfunctionbalanceOf(address account) externalviewreturns (uint256);
/**
* add to the deposit of the given account
*/functiondepositTo(address account) externalpayable;
/**
* add to the account's stake - amount and delay
* any pending unstake is first cancelled.
* @param _unstakeDelaySec the new lock duration before the deposit can be withdrawn.
*/functionaddStake(uint32 _unstakeDelaySec) externalpayable;
/**
* attempt to unlock the stake.
* the value can be withdrawn (using withdrawStake) after the unstake delay.
*/functionunlockStake() external;
/**
* withdraw from the (unlocked) stake.
* must first call unlockStake and wait for the unstakeDelay to pass
* @param withdrawAddress the address to send withdrawn value.
*/functionwithdrawStake(addresspayable withdrawAddress) external;
/**
* withdraw from the deposit.
* @param withdrawAddress the address to send withdrawn value.
* @param withdrawAmount the amount to withdraw.
*/functionwithdrawTo(addresspayable withdrawAddress, uint256 withdrawAmount) external;
}
Contract Source Code
File 10 of 14: NonceManager.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;import"../interfaces/IEntryPoint.sol";
/**
* nonce management functionality
*/contractNonceManagerisINonceManager{
/**
* The next valid sequence number for a given nonce key.
*/mapping(address=>mapping(uint192=>uint256)) public nonceSequenceNumber;
functiongetNonce(address sender, uint192 key)
publicviewoverridereturns (uint256 nonce) {
return nonceSequenceNumber[sender][key] | (uint256(key) <<64);
}
// allow an account to manually increment its own nonce.// (mainly so that during construction nonce can be made non-zero,// to "absorb" the gas cost of first nonce increment to 1st transaction (construction),// not to 2nd transaction)functionincrementNonce(uint192 key) publicoverride{
nonceSequenceNumber[msg.sender][key]++;
}
/**
* validate nonce uniqueness for this account.
* called just after validateUserOp()
*/function_validateAndUpdateNonce(address sender, uint256 nonce) internalreturns (bool) {
uint192 key =uint192(nonce >>64);
uint64 seq =uint64(nonce);
return nonceSequenceNumber[sender][key]++== seq;
}
}
Contract Source Code
File 11 of 14: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function_nonReentrantBefore() private{
// On the first call to nonReentrant, _status will be _NOT_ENTEREDrequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function_nonReentrantAfter() private{
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 12 of 14: SenderCreator.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;/**
* helper contract for EntryPoint, to call userOp.initCode from a "neutral" address,
* which is explicitly not the entryPoint itself.
*/contractSenderCreator{
/**
* call the "initCode" factory to create and return the sender account address
* @param initCode the initCode value from a UserOp. contains 20 bytes of factory address, followed by calldata
* @return sender the returned address of the created account, or zero address on failure.
*/functioncreateSender(bytescalldata initCode) externalreturns (address sender) {
address factory =address(bytes20(initCode[0 : 20]));
bytesmemory initCallData = initCode[20 :];
bool success;
/* solhint-disable no-inline-assembly */assembly {
success :=call(gas(), factory, 0, add(initCallData, 0x20), mload(initCallData), 0, 32)
sender :=mload(0)
}
if (!success) {
sender =address(0);
}
}
}
Contract Source Code
File 13 of 14: StakeManager.sol
// SPDX-License-Identifier: GPL-3.0-onlypragmasolidity ^0.8.12;import"../interfaces/IStakeManager.sol";
/* solhint-disable avoid-low-level-calls *//* solhint-disable not-rely-on-time *//**
* manage deposits and stakes.
* deposit is just a balance used to pay for UserOperations (either by a paymaster or an account)
* stake is value locked for at least "unstakeDelay" by a paymaster.
*/abstractcontractStakeManagerisIStakeManager{
/// maps paymaster to their deposits and stakesmapping(address=> DepositInfo) public deposits;
/// @inheritdoc IStakeManagerfunctiongetDepositInfo(address account) publicviewreturns (DepositInfo memory info) {
return deposits[account];
}
// internal method to return just the stake infofunction_getStakeInfo(address addr) internalviewreturns (StakeInfo memory info) {
DepositInfo storage depositInfo = deposits[addr];
info.stake = depositInfo.stake;
info.unstakeDelaySec = depositInfo.unstakeDelaySec;
}
/// return the deposit (for gas payment) of the accountfunctionbalanceOf(address account) publicviewreturns (uint256) {
return deposits[account].deposit;
}
receive() externalpayable{
depositTo(msg.sender);
}
function_incrementDeposit(address account, uint256 amount) internal{
DepositInfo storage info = deposits[account];
uint256 newAmount = info.deposit + amount;
require(newAmount <=type(uint112).max, "deposit overflow");
info.deposit =uint112(newAmount);
}
/**
* add to the deposit of the given account
*/functiondepositTo(address account) publicpayable{
_incrementDeposit(account, msg.value);
DepositInfo storage info = deposits[account];
emit Deposited(account, info.deposit);
}
/**
* add to the account's stake - amount and delay
* any pending unstake is first cancelled.
* @param unstakeDelaySec the new lock duration before the deposit can be withdrawn.
*/functionaddStake(uint32 unstakeDelaySec) publicpayable{
DepositInfo storage info = deposits[msg.sender];
require(unstakeDelaySec >0, "must specify unstake delay");
require(unstakeDelaySec >= info.unstakeDelaySec, "cannot decrease unstake time");
uint256 stake = info.stake +msg.value;
require(stake >0, "no stake specified");
require(stake <=type(uint112).max, "stake overflow");
deposits[msg.sender] = DepositInfo(
info.deposit,
true,
uint112(stake),
unstakeDelaySec,
0
);
emit StakeLocked(msg.sender, stake, unstakeDelaySec);
}
/**
* attempt to unlock the stake.
* the value can be withdrawn (using withdrawStake) after the unstake delay.
*/functionunlockStake() external{
DepositInfo storage info = deposits[msg.sender];
require(info.unstakeDelaySec !=0, "not staked");
require(info.staked, "already unstaking");
uint48 withdrawTime =uint48(block.timestamp) + info.unstakeDelaySec;
info.withdrawTime = withdrawTime;
info.staked =false;
emit StakeUnlocked(msg.sender, withdrawTime);
}
/**
* withdraw from the (unlocked) stake.
* must first call unlockStake and wait for the unstakeDelay to pass
* @param withdrawAddress the address to send withdrawn value.
*/functionwithdrawStake(addresspayable withdrawAddress) external{
DepositInfo storage info = deposits[msg.sender];
uint256 stake = info.stake;
require(stake >0, "No stake to withdraw");
require(info.withdrawTime >0, "must call unlockStake() first");
require(info.withdrawTime <=block.timestamp, "Stake withdrawal is not due");
info.unstakeDelaySec =0;
info.withdrawTime =0;
info.stake =0;
emit StakeWithdrawn(msg.sender, withdrawAddress, stake);
(bool success,) = withdrawAddress.call{value : stake}("");
require(success, "failed to withdraw stake");
}
/**
* withdraw from the deposit.
* @param withdrawAddress the address to send withdrawn value.
* @param withdrawAmount the amount to withdraw.
*/functionwithdrawTo(addresspayable withdrawAddress, uint256 withdrawAmount) external{
DepositInfo storage info = deposits[msg.sender];
require(withdrawAmount <= info.deposit, "Withdraw amount too large");
info.deposit =uint112(info.deposit - withdrawAmount);
emit Withdrawn(msg.sender, withdrawAddress, withdrawAmount);
(bool success,) = withdrawAddress.call{value : withdrawAmount}("");
require(success, "failed to withdraw");
}
}
Contract Source Code
File 14 of 14: UserOperation.sol
// SPDX-License-Identifier: GPL-3.0pragmasolidity ^0.8.12;/* solhint-disable no-inline-assembly */import {calldataKeccak} from"../core/Helpers.sol";
/**
* User Operation struct
* @param sender the sender account of this request.
* @param nonce unique value the sender uses to verify it is not a replay.
* @param initCode if set, the account contract will be created by this constructor/
* @param callData the method call to execute on this account.
* @param callGasLimit the gas limit passed to the callData method call.
* @param verificationGasLimit gas used for validateUserOp and validatePaymasterUserOp.
* @param preVerificationGas gas not calculated by the handleOps method, but added to the gas paid. Covers batch overhead.
* @param maxFeePerGas same as EIP-1559 gas parameter.
* @param maxPriorityFeePerGas same as EIP-1559 gas parameter.
* @param paymasterAndData if set, this field holds the paymaster address and paymaster-specific data. the paymaster will pay for the transaction instead of the sender.
* @param signature sender-verified signature over the entire request, the EntryPoint address and the chain ID.
*/structUserOperation {
address sender;
uint256 nonce;
bytes initCode;
bytes callData;
uint256 callGasLimit;
uint256 verificationGasLimit;
uint256 preVerificationGas;
uint256 maxFeePerGas;
uint256 maxPriorityFeePerGas;
bytes paymasterAndData;
bytes signature;
}
/**
* Utility functions helpful when working with UserOperation structs.
*/libraryUserOperationLib{
functiongetSender(UserOperation calldata userOp) internalpurereturns (address) {
address data;
//read sender from userOp, which is first userOp member (saves 800 gas...)assembly {data :=calldataload(userOp)}
returnaddress(uint160(data));
}
//relayer/block builder might submit the TX with higher priorityFee, but the user should not// pay above what he signed for.functiongasPrice(UserOperation calldata userOp) internalviewreturns (uint256) {
unchecked {
uint256 maxFeePerGas = userOp.maxFeePerGas;
uint256 maxPriorityFeePerGas = userOp.maxPriorityFeePerGas;
if (maxFeePerGas == maxPriorityFeePerGas) {
//legacy mode (for networks that don't support basefee opcode)return maxFeePerGas;
}
return min(maxFeePerGas, maxPriorityFeePerGas +block.basefee);
}
}
functionpack(UserOperation calldata userOp) internalpurereturns (bytesmemory ret) {
address sender = getSender(userOp);
uint256 nonce = userOp.nonce;
bytes32 hashInitCode = calldataKeccak(userOp.initCode);
bytes32 hashCallData = calldataKeccak(userOp.callData);
uint256 callGasLimit = userOp.callGasLimit;
uint256 verificationGasLimit = userOp.verificationGasLimit;
uint256 preVerificationGas = userOp.preVerificationGas;
uint256 maxFeePerGas = userOp.maxFeePerGas;
uint256 maxPriorityFeePerGas = userOp.maxPriorityFeePerGas;
bytes32 hashPaymasterAndData = calldataKeccak(userOp.paymasterAndData);
returnabi.encode(
sender, nonce,
hashInitCode, hashCallData,
callGasLimit, verificationGasLimit, preVerificationGas,
maxFeePerGas, maxPriorityFeePerGas,
hashPaymasterAndData
);
}
functionhash(UserOperation calldata userOp) internalpurereturns (bytes32) {
returnkeccak256(pack(userOp));
}
functionmin(uint256 a, uint256 b) internalpurereturns (uint256) {
return a < b ? a : b;
}
}