Class PaymasterClient

Paymaster client for gas sponsorship

Index

Constructors

Methods

getPaymasterData estimatePaymasterGas willSponsor

Constructors

constructor

new PaymasterClient(config: PaymasterConfig): PaymasterClient
Creates a new PaymasterClient instance
Parameters
- config: PaymasterConfig
  Paymaster configuration including type, address, and optional URL
Returns PaymasterClient
- Defined in mechanisms/evm/src/erc4337/paymaster.ts:52

Methods

getPaymasterData

getPaymasterData(
    userOp: Partial<UserOperation>,
    chainId: number,
    entryPoint: `0x${string}`,
    context?: Record<string, unknown>,
): Promise<PaymasterData>
Get paymaster data for a UserOperation
Parameters
- userOp: Partial<UserOperation>
  Partial UserOperation to get paymaster data for
- chainId: number
  The chain ID for the operation
- entryPoint: `0x${string}`
  The EntryPoint contract address
- Optionalcontext: Record<string, unknown>
  Optional context data for the paymaster
Returns Promise<PaymasterData>
Paymaster data including address and gas limits
- Defined in mechanisms/evm/src/erc4337/paymaster.ts:65

estimatePaymasterGas

estimatePaymasterGas(
_userOp: Partial<UserOperation>,
_chainId: number,
): Promise<GasEstimate>
Get gas estimates including paymaster gas
Parameters
- _userOp: Partial<UserOperation>
  Partial UserOperation to estimate gas for (reserved for future use)
- _chainId: number
  The chain ID for the operation (reserved for future use)
Returns Promise<GasEstimate>
Gas estimates including paymaster verification and postOp gas
- Defined in mechanisms/evm/src/erc4337/paymaster.ts:90

willSponsor

willSponsor(
    userOp: Partial<UserOperation>,
    chainId: number,
    entryPoint: `0x${string}`,
    context?: Record<string, unknown>,
): Promise<boolean>
Check if the paymaster will sponsor this operation
Parameters
- userOp: Partial<UserOperation>
  Partial UserOperation to check sponsorship for
- chainId: number
  The chain ID for the operation
- entryPoint: `0x${string}`
  The EntryPoint contract address
- Optionalcontext: Record<string, unknown>
  Optional context data for policy validation
Returns Promise<boolean>
True if the paymaster will sponsor the operation
- Defined in mechanisms/evm/src/erc4337/paymaster.ts:114