Sonic Logo
Mantle

Contract Functions

IPaymaster

Interface for a Paymaster contract.

Version 5.5.4

IPaymaster Contract

The `IPaymaster` interface defines the functions required for a contract to act as a paymaster in the context of a Gas Station Network (GSN). A paymaster is responsible for covering the gas costs of transactions submitted through GSN, enabling users to perform transactions without having to pay gas upfront.

Functions

The `IPaymaster` interface includes the following functions:

  • post: This function is called by the GSN Relay to verify and pay for a transaction on behalf of a user. If the paymaster approves the transaction, it should return true, otherwise false.
  • postTransaction: This function is called by the GSN Relay after a successful transaction to allow the paymaster to perform any post-transaction actions, such as updating its internal state.
  • preRelayedCall: This function is called by the GSN Relay before the transaction is relayed to the destination contract. The paymaster can use this function to perform checks and modify the transaction parameters.
  • version: This function allows clients to retrieve the current version of the paymaster implementation.

    • Usage

    To use a paymaster contract with a GSN Relay, the user needs to specify the address of the paymaster contract in the transaction request. The GSN Relay will then interact with the paymaster contract to verify and pay for the transaction.

    Security Considerations

    Paymaster contracts should be carefully audited to ensure they are secure and do not introduce vulnerabilities that could be exploited by malicious actors.

    Functions

    post

    post(bytes calldata, address, bytes calldata, uint256, uint256, bytes calldata, uint256)

    postTransaction

    postTransaction(bytes calldata, address, bytes calldata, uint256, bytes calldata)

    preRelayedCall

    preRelayedCall(bytes calldata, address, bytes calldata, uint256, uint256, bytes calldata, uint256)
    Ask about contract functions, security, or implementation details

    Press Enter to send your query

    Resources

    IPaymaster Interface on EtherscanEIP-2938: Paymaster APIEIP-4337: Account AbstractionAccount Abstraction with Paymasters: A Beginner's GuideBuilding a Paymaster: Implementing the IPaymaster InterfacePaymaster Example on GithubEIP-2938: Paymaster API Discussion on Ethereum Magicians

    Source Code

    1