EeseePaymaster
EeseePaymaster
A paymaster allowing addresses holding ESE tokens to pay for a GSN transaction.
ESE
contract IERC20 ESEESE token this contract uses.
nonces
mapping(address => uint256) noncesNonces for each address.
SIGNER_ROLE
bytes32 SIGNER_ROLESigner role in {accessManager}.
approvedContracts
mapping(address => bool) approvedContractsContracts approved for use.
Refilled
event Refilled(address sender, uint256 eth)TokensCharged
event TokensCharged(address payer, uint256 nonce, uint256 gasUseWithPost, uint256 tokenActualCharge, uint256 ethActualCharge, uint256 actualDiscount)Withdrawn
event Withdrawn(address to, uint256 amount)ApproveContract
event ApproveContract(address _contract)RevokeContractApproval
event RevokeContractApproval(address _contract)InvalidESE
error InvalidESE()ExpiredDeadline
error ExpiredDeadline()InvalidSender
error InvalidSender()InvalidSignature
error InvalidSignature()ActualChargeHigher
error ActualChargeHigher()AddressNotApproved
error AddressNotApproved()AlreadyApproved
error AlreadyApproved()withdrawTokens
function withdrawTokens(address target) external returns (uint256 amount)Withdraws ESE collected from users.
Parameters
target
address
- Recipient address.
Return Values
amount
uint256
- amount of ESE transfered to {target}.
Note: This function can only be called by ADMIN_ROLE.
approveContract
function approveContract(address _address) externalApproves contract for use. Emits {ApproveContract} event.
Parameters
_address
address
- New approvedContract.
Note: This function can only be called by ADMIN_ROLE.
revokeContractApproval
function revokeContractApproval(address _address) external_Revokes contract approval from {address}. Emits {RevokeContractApproval} event.
Parameters
_address
address
- Address to revoke approval from.
Note: This function can only be called by ADMIN_ROLE.
versionPaymaster
function versionPaymaster() external pure returns (string)Return Values
[0]
string
version The SemVer string of this Paymaster's version.
getGasAndDataLimits
function getGasAndDataLimits() public pure returns (struct IPaymaster.GasAndDataLimits limits)Return the Gas Limits for Paymaster's functions and maximum msg.data length values for this Paymaster. This function allows different paymasters to have different properties without changes to the RelayHub.
Return Values
limits
struct IPaymaster.GasAndDataLimits
An instance of the GasAndDataLimits struct ##### acceptanceBudget If the transactions consumes more than acceptanceBudget this Paymaster will be charged for gas no matter what. Transaction that gets rejected after consuming more than acceptanceBudget gas is on this Paymaster's expense. Should be set to an amount gas this Paymaster expects to spend deciding whether to accept or reject a request. This includes gas consumed by calculations in the preRelayedCall, Forwarder and the recipient contract. ⚠️ Warning ⚠️ As long this value is above preRelayedCallGasLimit (see defaults in BasePaymaster), the Paymaster is guaranteed it will never pay for rejected transactions. If this value is below preRelayedCallGasLimit, it might might make Paymaster open to a "griefing" attack. The relayers should prefer lower acceptanceBudget, as it improves their chances of being compensated. From a Relay's point of view, this is the highest gas value a bad Paymaster may cost the relay, since the paymaster will pay anything above that value regardless of whether the transaction succeeds or reverts. Specifying value too high might make the call rejected by relayers (see maxAcceptanceBudget in server config). ##### preRelayedCallGasLimit The max gas usage of preRelayedCall. Any revert of the preRelayedCall is a request rejection by the paymaster. As long as acceptanceBudget is above preRelayedCallGasLimit, any such revert is not payed by the paymaster. ##### postRelayedCallGasLimit The max gas usage of postRelayedCall. The Paymaster is not charged for the maximum, only for actually used gas. Note that an OOG will revert the inner transaction, but the paymaster will be charged for it anyway.
Inherited from EeseeRoleHandler
Inherited from EIP712
eip712Domain
function eip712Domain() public view virtual returns (bytes1 fields, string name, string version, uint256 chainId, address verifyingContract, bytes32 salt, uint256[] extensions)_See {EIP-5267}.
Available since v4.9._
Inherited from IERC5267
EIP712DomainChanged
event EIP712DomainChanged()MAY be emitted to signal that the domain could have changed.
Inherited from BasePaymaster
getRelayHub
function getRelayHub() public view returns (address)Return Values
[0]
address
supportsInterface
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool)_Returns true if this contract implements the interface defined by interfaceId. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] to learn more about how these ids are created.
This function call must use less than 30 000 gas._
setRelayHub
function setRelayHub(contract IRelayHub hub) publicThe owner of the Paymaster can change the instance of the RelayHub this Paymaster works with. ⚠️ Warning ⚠️ The deposit on the previous RelayHub must be withdrawn first.
setTrustedForwarder
function setTrustedForwarder(address forwarder) public virtualThe owner of the Paymaster can change the instance of the Forwarder this Paymaster works with. the Recipients must trust this Forwarder as well in order for the configuration to remain functional.
getTrustedForwarder
function getTrustedForwarder() public view virtual returns (address)⚠️ Warning ⚠️ using incorrect Forwarder may cause the Paymaster to agreeing to pay for invalid transactions.
Return Values
[0]
address
withdrawRelayHubDepositTo
function withdrawRelayHubDepositTo(uint256 amount, address payable target) publicWithdraw deposit from the RelayHub.
Parameters
amount
uint256
The amount to be subtracted from the sender.
target
address payable
The target to which the amount will be transferred.
preRelayedCall
function preRelayedCall(struct GsnTypes.RelayRequest relayRequest, bytes signature, bytes approvalData, uint256 maxPossibleGas) external returns (bytes, bool)Called by the Relay in view mode and later by the RelayHub on-chain to validate that the Paymaster agrees to pay for this call.
The request is considered to be rejected by the Paymaster in one of the following conditions:
preRelayedCall()method revertsthe
Forwarderreverts because of nonce or signature errorthe
PaymasterreturnedrejectOnRecipientRevert: trueand the recipient contract reverted (and all that did not consume more thanacceptanceBudgetgas).
In any of the above cases, all Paymaster calls and the recipient call are reverted. In any other case the Paymaster will pay for the gas cost of the transaction. Note that even if postRelayedCall is reverted the Paymaster will be charged.
Parameters
relayRequest
struct GsnTypes.RelayRequest
- the full relay request structure
signature
bytes
- user's EIP712-compatible signature of the relayRequest. Note that in most cases the paymaster shouldn't try use it at all. It is always checked by the forwarder immediately after preRelayedCall returns.
approvalData
bytes
- extra dapp-specific data (e.g. signature from trusted party)
maxPossibleGas
uint256
- based on values returned from getGasAndDataLimits the RelayHub will calculate the maximum possible amount of gas the user may be charged for. In order to convert this value to wei, the Paymaster has to call "relayHub.calculateCharge()"
Return Values
[0]
bytes
[1]
bool
postRelayedCall
function postRelayedCall(bytes context, bool success, uint256 gasUseWithoutPost, struct GsnTypes.RelayData relayData) externalThis method is called after the actual relayed function call. It may be used to record the transaction (e.g. charge the caller by some contract logic) for this call.
Revert in this functions causes a revert of the client's relayed call (and preRelayedCall(), but the Paymaster is still committed to pay the relay for the entire transaction.
Parameters
context
bytes
The call context, as returned by the preRelayedCall
success
bool
true if the relayed call succeeded, false if it reverted
gasUseWithoutPost
uint256
The actual amount of gas used by the entire transaction, EXCEPT the gas used by the postRelayedCall itself.
relayData
struct GsnTypes.RelayData
The relay params of the request. can be used by relayHub.calculateCharge()
Inherited from Ownable
owner
function owner() public view virtual returns (address)Returns the address of the current owner.
renounceOwnership
function renounceOwnership() public virtual_Leaves the contract without owner. It will not be possible to call onlyOwner functions. Can only be called by the current owner.
NOTE: Renouncing ownership will leave the contract without an owner, thereby disabling any functionality that is only available to the owner._
transferOwnership
function transferOwnership(address newOwner) public virtualTransfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.
OwnershipTransferred
event OwnershipTransferred(address previousOwner, address newOwner)Last updated