pm_getPaymasterData | Pimlico Docs
Skip to content

pm_getPaymasterData

This method returns values to be used in paymaster-related fields of a signed user operation. The context parameter can be an object with either a token field (for ERC-20 mode) or a sponsorshipPolicyId field (for sponsorship mode), or null.

EntryPoint v0.7

Usage

{
  "jsonrpc": "2.0",
  "method": "pm_getPaymasterData",
  "params": [
    {
      "sender": "0x5a6b47F4131bf1feAFA56A05573314BcF44C9149",
      "nonce": "0x845ADB2C711129D4F3966735ED98A9F09FC4CE5700000000000000000000",
      "factory": "0xd703aaE79538628d27099B8c4f621bE4CCd142d5",
      "factoryData": "0xc5265d5d0000000000000000...",
      "callData": "0xe9ae5c53",
      "callGasLimit": "0x13880",
      "verificationGasLimit": "0x60B01",
      "preVerificationGas": "0xD3E3",
      "maxPriorityFeePerGas": "0x3B9ACA00",
      "maxFeePerGas": "0x7A5CF70D5",
      "paymaster": null,
      "paymasterVerificationGasLimit": null,
      "paymasterPostOpGasLimit": null,
      "paymasterData": null,
      "eip7702Auth": {
        "address": "0x1234567890123456789012345678901234567890",
        "chainId": "0x1",
        "nonce": "0x1",
        "r": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "s": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "v": "0x1b",
        "yParity": "0x1"
      }
    },
    "0x0000000071727De22E5E9d8BAf0edAc6f37da032",
    "0x1",
    {
      "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
      // Or alternatively: "sponsorshipPolicyId": "policy-123456"
    }
  ],
  "id": 4337
}

Parameters

The method accepts an array with the following parameters:

  1. userOperation - Object: The user operation object containing the following fields:

    • sender - Address: The account making the operation.

    • nonce - HexString: Unique identifier for the request from this sender.

    • factory - Address (optional): The factory contract address.

    • factoryData - HexData (optional): The factory data for account creation.

    • callData - HexData: The data to pass to the sender during the main execution call.

    • callGasLimit - HexNumber: The amount of gas to allocate the main execution call.

    • verificationGasLimit - HexNumber: The amount of gas to allocate for the verification step.

    • preVerificationGas - HexNumber: The amount of gas to pay for to compensate the bundler for pre-verification execution and calldata.

    • maxFeePerGas - HexNumber: Maximum fee per gas (similar to EIP-1559 max_fee_per_gas).

    • maxPriorityFeePerGas - HexNumber: Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas).

    • paymaster - Address (optional): Address of paymaster sponsoring the transaction, or null if none.

    • paymasterVerificationGasLimit - HexNumber (optional): The amount of gas to allocate for the verification step of the paymaster, or null if no paymaster.

    • paymasterPostOpGasLimit - HexNumber (optional): The amount of gas to allocate for the post-operation step of the paymaster, or null if no paymaster.

    • paymasterData - HexData (optional): The data to pass to the paymaster during the verification step, or null if no paymaster.

    • eip7702Auth - Object (optional): EIP-7702 authorization data, can be null. This can be a dummy authorization. Contains the following fields:

      • address - Address: The contract address that signed the authorization.
      • chainId - HexNumber: The chain ID as a hex string.
      • nonce - HexNumber: The nonce as a hex string.
      • r - HexData32: The r component of the signature.
      • s - HexData32: The s component of the signature.
      • v - HexNumber: The v component of the signature.
      • yParity - HexNumber: The y-parity of the signature.
  2. entryPoint - Address: The entry point contract address.

  3. chainId - HexNumber: The chain ID in hexadecimal format.

  4. context - Object | null: Additional context information. Can be one of:

    • An object with token - Address: The ERC-20 token address to use for payment.
    • An object with sponsorshipPolicyId - String: The ID of the sponsorship policy to use.
    • null: No additional context.

Returns

The method returns an object containing paymaster-related fields for EntryPoint v0.7.

{
  "jsonrpc": "2.0",
  "id": 4337,
  "result": {
    "paymaster": "0x0000000000000039cd5e8aE05257CE51C473ddd1",
    "paymasterData": "0x01000066d1a1a4000000000000036cbd53842c5426634e7929541ec2318f3dcf7e0000000000000000000000000000c350000000000000000000000000000000000000000000000000000000009666598f0b846603deb0a8e59b78ba3dce9c3466394ccf07795d38ecf7925dfe12c07a022c27bb199099fa54de2f5e3e87dd9c581df52e9d3d199166a31124cc1227a9921b"
  }
}

Return Fields

The response includes the following fields:

  • paymaster - Address: The address of the paymaster contract.

  • paymasterData - HexData: The data to be used in the paymasterData field of the user operation.

EntryPoint v0.6

Usage

{
  "jsonrpc": "2.0",
  "method": "pm_getPaymasterData",
  "params": [
    {
      "sender": "0xb341FEAFaF71b09089d03B7D114599f8F491EE45",
      "nonce": "0x0",
      "initCode": "0x5de4839a76cf55d0c90e2061ef4386d962E15ae3296601cd000000...",
      "callData": "0x51945447",
      "eip7702Auth": {
        "address": "0x1234567890123456789012345678901234567890",
        "chainId": "0x1",
        "nonce": "0x1",
        "r": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "s": "0x1234567890123456789012345678901234567890123456789012345678901234",
        "v": "0x1b",
        "yParity": "0x1"
      },
      "callGasLimit": "0x115b5c0",
      "verificationGasLimit": "0x249f0",
      "preVerificationGas": "0xeb11",
      "maxPriorityFeePerGas": "0x12a05f200",
      "maxFeePerGas": "0x5b08082fa"
    },
    "0x0000000071727De22E5E9d8BAf0edAc6f37da032",
    "0x1",
    {
      "token": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
      // Or alternatively: "sponsorshipPolicyId": "policy-123456"
    }
  ],
  "id": 4337
}

Returns

The method returns an object containing paymaster-related fields for EntryPoint v0.6.

{
  "jsonrpc": "2.0",
  "id": 4337,
  "result": {
    "paymasterAndData": "0x0000000000000039cd5e8aE05257CE51C473ddd101000066d1a1a4000000000000036cbd53842c5426634e7929541ec2318f3dcf7e0000000000000000000000000000c350000000000000000000000000000000000000000000000000000000009666598f0b846603deb0a8e59b78ba3dce9c3466394ccf07795d38ecf7925dfe12c07a022c27bb199099fa54de2f5e3e87dd9c581df52e9d3d199166a31124cc1227a9921b",
    "preVerificationGas": "0x350f7",
    "verificationGasLimit": "0x501ab",
    "callGasLimit": "0x212df"
  }
}

Parameters

The method accepts an array with the following parameters:

  1. userOperation - Object: The user operation object containing the following fields:

    • sender - Address: The account making the operation.

    • nonce - HexString: Unique identifier for the request from this sender.

    • initCode - HexData: The initialization code for the smart account if it doesn't exist yet.

    • callData - HexData: The data to pass to the sender during the main execution call.

    • callGasLimit - HexNumber: The amount of gas to allocate the main execution call.

    • verificationGasLimit - HexNumber: The amount of gas to allocate for the verification step.

    • preVerificationGas - HexNumber: The amount of gas to pay for to compensate the bundler for pre-verification execution and calldata.

    • maxFeePerGas - HexNumber: Maximum fee per gas (similar to EIP-1559 max_fee_per_gas).

    • maxPriorityFeePerGas - HexNumber: Maximum priority fee per gas (similar to EIP-1559 max_priority_fee_per_gas).

    • eip7702Auth - Object (optional): EIP-7702 authorization data, can be null. This can be a dummy authorization. Contains the following fields:

      • address - Address: The contract address that signed the authorization.
      • chainId - HexNumber: The chain ID as a hex string.
      • nonce - HexNumber: The nonce as a hex string.
      • r - HexData32: The r component of the signature.
      • s - HexData32: The s component of the signature.
      • v - HexNumber: The v component of the signature.
      • yParity - HexNumber: The y-parity of the signature.
  2. entryPoint - Address: The entry point contract address.

  3. chainId - HexNumber: The chain ID in hexadecimal format.

  4. context - Object | null: Additional context information. Can be one of:

    • An object with token - Address: The ERC-20 token address to use for payment.
    • An object with sponsorshipPolicyId - String: The ID of the sponsorship policy to use.
    • null: No additional context.

Return Fields

The response includes the following fields:

  • paymasterAndData - HexData: The combined paymaster address and data to be used in the user operation.

  • preVerificationGas - HexNumber: The updated preVerificationGas value to use in the user operation.

  • verificationGasLimit - HexNumber: The updated verificationGasLimit value to use in the user operation.

  • callGasLimit - HexNumber: The updated callGasLimit value to use in the user operation.