Skip to main content

Paymaster API RPC Methods: EntryPoint v0.7

This page documents the Paymaster API for accounts on EntryPoint v0.7. If you are starting a new integration, use the main Paymaster API reference, which covers EntryPoint v0.9 and v0.8. The reference for EntryPoint v0.6 is on its own page.

Endpoints at a Glance​

MethodParamsReturnsSpec
pm_getPaymasterStubData[userOperation: object, entrypoint: string, chainId: string, context: object]{ paymaster, paymasterData, paymasterVerificationGasLimit, paymasterPostOpGasLimit, sponsor?, isFinal }ERC-7677
pm_getPaymasterData[userOperation: object, entrypoint: string, chainId: string, context: object]{ paymaster, paymasterData, paymasterVerificationGasLimit, paymasterPostOpGasLimit, sponsor? }ERC-7677
pm_sponsorUserOperation[userOperation: object, entrypoint: string, context: object]{ paymaster, paymasterData, paymasterVerificationGasLimit, paymasterPostOpGasLimit, callGasLimit?, verificationGasLimit?, preVerificationGas?, maxFeePerGas?, maxPriorityFeePerGas?, sponsorMetadata? }Candide
pm_supportedERC20Tokens[entrypoint: string]{ paymasterMetadata, tokens[] }Candide
pm_supportedEntryPoints[]string[]Candide
pm_chainId[]stringCandide

Entrypoint V0.7​

pm_getPaymasterStubData​

ERC-7677 compatible method. Equivalent to Candide's pm_sponsorUserOperation. It always returns isFinal: false: call pm_getPaymasterData afterwards to get the final paymaster data.

It receives a userOperation for off-chain verification. If approved, it will return the paymasterData. Unlike pm_sponsorUserOperation, it does not return gas overrides: the gas fields of the UserOperation are used as sent.

Supports two types of Gas Policies:

  • Public Gas Policies: These are gas policies provided by third parties, which do not require a sponsorship policy ID.
  • Private Gas Policies: These require a sponsorship policy ID and can be used if no public gas policy matches the user operation.

If the paymaster rejects the UserOperation, it returns a standard JSON-RPC error with the reason

Invocation​

{ "method": "pm_getPaymasterStubData", "params": [userOperation: object, entrypoint: string, chainId: string, context: object] }

Return​

{
"result": {
paymaster: string,
paymasterData: string,
paymasterVerificationGasLimit: string,
paymasterPostOpGasLimit: string,
sponsor?: {
name: string,
icon: string,
},
isFinal: boolean
}
}
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_getPaymasterStubData",
"params": [
{
"sender": "0x2c298CcaFF..c236fCC66dB2",
"nonce": "0x17",
"factory": "0x..",
"factoryData": "0xf3....0000",
"callData": "0xf3....0000",
"callGasLimit": "0x12a87",
"verificationGasLimit": "0x1a332",
"preVerificationGas": "0xe95c",
"maxFeePerGas": "0x5f4ecdc0",
"maxPriorityFeePerGas": "0x59682f00",
"paymaster": "0x..",
"paymasterVerificationGasLimit": "0x..",
"paymasterPostOpGasLimit": "0x..",
"paymasterData": "0x",
"signature": "0x",
},
"0x0000000071727De22E5E9d8BAf0edAc6f37da032",
"0x01",
{ "sponsorshipPolicyId" : "1234" } // sponsorshipPolicyId is required for a private gas policy and optional for public gas policies.
]
}

pm_getPaymasterData​

ERC-7677 compatible method. Equivalent to Candide's pm_sponsorUserOperation.

It receives a userOperation for off-chain verification. If approved, it will return the paymasterData. Unlike pm_sponsorUserOperation, it does not return gas overrides: the gas fields of the UserOperation are used as sent.

Supports two types of Gas Policies:

  • Public Gas Policies: These are gas policies provided by third parties, which do not require a sponsorship policy ID.
  • Private Gas Policies: These require a sponsorship policy ID and can be used if no public gas policy matches the user operation.

If the paymaster rejects the UserOperation, it returns a standard JSON-RPC error with the reason

Invocation​

{ "method": "pm_getPaymasterData", "params": [userOperation: object, entrypoint: string, chainId: string, context: object] }

Return​

{
"result": {
paymaster: string,
paymasterData: string,
paymasterVerificationGasLimit: string,
paymasterPostOpGasLimit: string,
sponsor?: {
name: string,
icon: string,
}
}
}
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_getPaymasterData",
"params": [
{
"sender": "0x2c298CcaFF..c236fCC66dB2",
"nonce": "0x17",
"factory": "0x..",
"factoryData": "0xf3....0000",
"callData": "0xf3....0000",
"callGasLimit": "0x12a87",
"verificationGasLimit": "0x1a332",
"preVerificationGas": "0xe95c",
"maxFeePerGas": "0x5f4ecdc0",
"maxPriorityFeePerGas": "0x59682f00",
"paymaster": "0x..",
"paymasterVerificationGasLimit": "0x..",
"paymasterPostOpGasLimit": "0x..",
"paymasterData": "0x",
"signature": "0x",
},
"0x0000000071727De22E5E9d8BAf0edAc6f37da032",
"0x01",
{ "sponsorshipPolicyId" : "1234" } // sponsorshipPolicyId is required for a private gas policy and optional for public gas policies.
]
}

pm_sponsorUserOperation​

Sends a UserOperation to a paymaster for off-chain verification. If approved, it will return the paymasterData. It will also return gas overrides when the mode for gas sponsorship uses a Gas Policy.

  • ERC-20 Gas Payments: No gas overrides are returned.
  • Gas Policies: Mandatory callGasLimit, verificationGasLimit, preVerificationGas, maxFeePerGas, and maxPriorityFeePerGas fields are returned.

Supports two types of Gas Policies:

  • Public Gas Policies: These are gas policies provided by third parties, which do not require a sponsorship policy ID.
  • Private Gas Policies: These require a sponsorship policy ID and can be used if no public gas policy matches the user operation.

If the paymaster rejects the UserOperation, it returns a standard JSON-RPC error with the reason.

Invocation​

{ "method": "pm_sponsorUserOperation", "params": [userOperation: object, entrypoint: string, context: object] }

Return​

{
"result": {
paymaster: string,
paymasterData: string,
paymasterVerificationGasLimit: string,
paymasterPostOpGasLimit: string,
callGasLimit?: string,
verificationGasLimit?: string,
preVerificationGas?: string,
maxFeePerGas?: string,
maxPriorityFeePerGas?: string,
sponsorMetadata?: {
name: string,
description: string,
url: string,
icons: string[],
}
}
}
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_sponsorUserOperation",
"params": [
{
"sender": "0x2c298CcaFF..c236fCC66dB2",
"nonce": "0x17",
"factory": "0x..",
"factoryData": "0xf3....0000",
"callData": "0xf3....0000",
"callGasLimit": "0x12a87",
"verificationGasLimit": "0x1a332",
"preVerificationGas": "0xe95c",
"maxFeePerGas": "0x5f4ecdc0",
"maxPriorityFeePerGas": "0x59682f00",
"paymaster": "0x..",
"paymasterVerificationGasLimit": "0x..",
"paymasterPostOpGasLimit": "0x..",
"paymasterData": "0x",
"signature": "0x",
},
"0x0000000071727De22E5E9d8BAf0edAc6f37da032",
{ "sponsorshipPolicyId" : "1234" } // sponsorshipPolicyId is required for a private gas policy and optional for public gas policies.
]
}

pm_supportedERC20Tokens​

Gets supported ERC-20 Tokens for gas payments, along side the paymaster metadata

Invocation​

{ "method": "pm_supportedERC20Tokens", "params": [entrypoint: string] }

Return​

{
"result": {
paymasterMetadata: {
name: string,
description: string,
icons: string[],
address: string,
sponsoredEventTopic: string,
dummyPaymasterAndData: {
paymaster: string,
paymasterData: string,
paymasterVerificationGasLimit: string,
paymasterPostOpGasLimit: string
},
},
tokens: [{
name: string,
symbol: string,
address: string,
decimals: string, // hex-encoded, for example "0x12" for 18
exchangeRate: string,
}]
}
}
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_supportedERC20Tokens",
"params": ["0x0000000071727De22E5E9d8BAf0edAc6f37da032"]
}

pm_supportedEntryPoints​

Returns the entryPoint addresses supported by the paymaster.

Invocation​

{ "method": "pm_supportedEntryPoints", "params": [] }

Return​

{ "result": string[] }
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_supportedEntryPoints",
"params": []
}

pm_chainId​

Get Chain ID asks the paymaster service to return the chain_id it currently supports

Invocation​

{ "method": "pm_chainId", "params": [] }

Return​

{ "result": string }
{
"jsonrpc": "2.0",
"id": 0,
"method": "pm_chainId",
"params": []
}