# Paymaster The `CandidePaymaster` class interacts with Candide's ERC-4337 Paymaster API. **Supports:** * Gas sponsorship through Gas Policies * ERC-20 Token Sponsorship * Multi-EntryPoint ## Usage[​](#usage "Direct link to Usage") ### Import[​](#import "Direct link to Import") ``` import { CandidePaymaster } from "abstractionkit"; ``` ### How to Use[​](#how-to-use "Direct link to How to Use") Initialize a Paymaster with your RPC URL. Get an API key from the [dashboard](https://dashboard.candide.dev). paymaster.ts ``` import { CandidePaymaster } from "abstractionkit"; const paymasterRpc = "https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); ``` Then consume Paymaster methods: ``` const supportedEntryPoints = await paymaster.getSupportedEntrypoints(); ``` ## Methods[​](#methods "Direct link to Methods") ### createSponsorPaymasterUserOperation[​](#createsponsorpaymasteruseroperation "Direct link to createSponsorPaymasterUserOperation") Returns the paymaster data if the the userOperation has a Gas Policy. Otherwise it returns an error message. 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. #### Usage[​](#usage-1 "Direct link to Usage") * example.ts * Param Type * Return Type example.ts ``` import { CandidePaymaster } from "abstractionkit"; const paymasterRpc = "https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const sponsorshipPolicyId = '1234'; // Use createUserOperation() to help you construct a userOp const userOperation = smartAccount.createUserOperation(..) const [sponsoredUserOperation, sponsorMetadata] = await paymaster.createSponsorPaymasterUserOperation( userOperation, bundlerUrl, sponsorshipPolicyId, // optional ); ``` | key | type | description | | :-------------------- | :----------------------------------- | :----------------------------------------------------------- | | `userOperation` | `UserOperationV6 \| UserOperationV7` | UserOperation to Sponsor. Supports EntryPoint v0.6 and v0.7 | | `bundlerUrl` | `string` | Bundler URL to estimate the gas | | `sponsorshipPolicyId` | `string?` | Optional sponsorship policy id if using a Private Gas Policy | | key | type | description | | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------- | | `userOperation` | `UserOperationV6 \| UserOperationV7` | UserOperation with paymaster data included | | `sponsorMetadata` | `key type descriptionname string Name of Sponsor who is sponsoring the Gas Policy description string A short description of the sponsor url string Website of the Sponsor icons string[] Logos or Icons that the Sponsor is using to promote their Gas Policy` | Information about the Gas Policy Sponsor | #### Source code[​](#source-code "Direct link to Source code") [createSponsorPaymasterUserOperation](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L607) ### fetchSupportedERC20TokensAndPaymasterMetadata[​](#fetchsupportederc20tokensandpaymastermetadata "Direct link to fetchSupportedERC20TokensAndPaymasterMetadata") Returns a promise with the supported erc20 tokens and their exchange rate, along with the paymaster metadata #### Usage[​](#usage-2 "Direct link to Usage") * example.ts * Param Types * Response Type example.ts ``` import { CandidePaymaster, SafeAccountV0_3_0 as SafeAccount } from "abstractionkit"; const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const paymaster = new CandidePaymaster(paymasterRPC); const supportedERC20Tokens = await paymaster.fetchSupportedERC20TokensAndPaymasterMetadata(SafeAccount.DEFAULT_ENTRYPOINT_ADDRESS); ``` | key | type | description | | :----------- | :-------- | :----------------------------------- | | `entrypoint` | `string?` | EntryPoint Address. Defaults to V0.7 | | key | type | description | | :------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ | | `SupportedERC20TokensAndMetadataWithExchangeRate` | `Promise` | A promise with the list of supported erc20 tokens and their exchange rate | SupportedERC20TokensAndMetadataV7WithExchangeRate | key | type | description | | :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------- | | `paymasterMetadata` | `key type descriptionname string The name of the Paymaster. description string A brief description of the Paymaster. icons string[] An array of icon URLs representing the Paymaster's brand or logo. address string The contract address of the Paymaster. sponsoredEventTopic string The event topic that will be emitted when a UserOperation is sponsored by the Paymaster. dummyPaymasterAndData key type descriptionpaymaster string The address of the Paymaster. paymasterVerificationGasLimit bigint The amount of gas allocated for the Paymaster verification step. paymasterPostOpGasLimit bigint The amount of gas allocated for the Paymaster post-operation step. paymasterData string Encoded data for the Paymaster. Dummy Paymaster data used for gas estimation.` | The Paymaster metadata | | `tokens` | `key type descriptionname string The name of the ERC20 token. symbol string The symbol representing the ERC20 token. address string The contract address of the ERC20 token. decimal number The number of decimal places for the token. exchangeRate bigint The exchange rate of the token.` | Supported erc20 tokens with Exchange Rate | SupportedERC20TokensAndMetadataV6WithExchangeRate | key | type | description | | :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------- | | `paymasterMetadata` | `key type descriptionname string The name of the Paymaster. description string A brief description of the Paymaster. icons string[] An array of icon URLs representing the Paymaster's brand or logo. address string The contract address of the Paymaster. sponsoredEventTopic string The event topic that will be emitted when a UserOperation is sponsored by the Paymaster. dummyPaymasterAndData string Dummy Paymaster data used for gas estimation.` | The Paymaster metadata | | `tokens` | `key type descriptionname string The name of the ERC20 token. symbol string The symbol representing the ERC20 token. address string The contract address of the ERC20 token. decimal number The number of decimal places for the token. exchangeRate bigint The exchange rate of the token.` | Supported erc20 tokens with Exchange Rate | Example Response ``` { tokens: [ { name: 'USD Coin', symbol: 'USDC', address: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831', decimals: 6, exchangeRate: 123n }, { name: 'Tether USDT', symbol: 'USDT', address: '0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9', decimals: 6, exchangeRate: 123n }, { name: 'Dai Stablecoin', symbol: 'DAI', address: '0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1', decimals: 18, exchangeRate: 123n } ], paymasterMetadata: { name: 'CANDIDE Paymaster', description: 'CANDIDE Paymaster a fast, secure and feature-rich 4337 Paymaster', icons: [], address: '0x8b1f6cb5d062aa2ce8d581942bbb960420d875ba', sponsoredEventTopic: '0xa050a122b4c0e369e3385eb6b7cccd8019638b2764de67bec0af99130ddf8471', dummyPaymasterAndData: { paymaster: '0x8b1f6cb5d062aa2ce8d581942bbb960420d875ba', paymasterVerificationGasLimit: '0xffff', paymasterPostOpGasLimit: '0xffff', paymasterData: '0x00010000000000ffff000000000000000000000000000000000000000000000000000000000000ffff010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101011c' } } } ``` ### createTokenPaymasterUserOperation[​](#createtokenpaymasteruseroperation "Direct link to createTokenPaymasterUserOperation") Estimates gas limits and returns the user operation with the paymaster data for ERC-20 Token sponsorship. #### Usage[​](#usage-3 "Direct link to Usage") * example.ts * Param Types * Response Type ``` import { SafeAccountV0_3_0 as SafeAccount, CandidePaymaster } from "abstractionkit"; const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const erc20TokenAddress = "0xFa5854FBf9964330d761961F46565AB7326e5a3b"; // CTT test token const bundlerRPC = "https://api.candide.dev/public/v3/sepolia"; const ownerPublicAddress = "0x2Ef844456580b6e1E22e1D584EBbC2467D9298B2" const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]) // Use createUserOperation() to help you construct a userOp let userOperation = smartAccount.createUserOperation(..); const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); userOperation = await paymaster.createTokenPaymasterUserOperation( smartAccount, userOperation, erc20TokenAddress, bundlerRPC, ); ``` | key | type | description | | :-------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ | | `smartAccount` | `(callData: string, tokenAddress: string, paymasterAddress: string, approveAmount: bigint) => string` | The SmartAccount object that created the target userOperation | | `userOperation` | `UserOperationV6 \| UserOperationV7` | The userOperation to sponsor gas with erc-20 paymaster | | `tokenAddress` | `string` | The address of the token to approve. | | `bundlerRpc` | `string` | The Bundler RPC to estimate the gas | | `overrides` | `key type descriptioncallGasLimit bigint Set the callGasLimit instead of estimating gas using the bundler. verificationGasLimit bigint Set the verificationGasLimit instead of estimating gas using the bundler. preVerificationGas bigint Set the preVerificationGas instead of estimating gas using the bundler. callGasLimitPercentageMultiplier number Set the callGasLimitPercentageMultiplier instead of estimating gas using the bundler. verificationGasLimitPercentageMultiplier number Set the verificationGasLimitPercentageMultiplier instead of estimating gas using the bundler. preVerificationGasPercentageMultiplier number Set the preVerificationGasPercentageMultiplier instead of estimating gas using the bundler. stateOverrideSetType key type description[address: string] key type descriptionbalance bigint Override the balance of the address nonce bigint Override the nonce of the address code string Override the code of the address state Dictionary Override the storage slots of the address stateDiff Dictionary Apply state differences to the storage slots of the address Overrides for a specific address Pass state overrides for gas estimation, including balance, nonce, code, and state or stateDiff for the account at each address.` | Overrides for the default values | | key | type | description | | :-------------- | :-------------------------------------------- | :----------------------------------------------------- | | `userOperation` | `Promise` | The userOperation to sponsor gas with erc-20 paymaster | Example Response ``` { sender: '0xb8741a449d50ed0dcfe395287f85be152884c8d9', nonce: 10n, initCode: '0x', callData: '0x541d63c800000000000000000000000038869bf66a61cf6bdb996a6ae40d5853fd43b52600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000001e48d80ff0a0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000018b009a7af758ae5d7b6aae84fe4c5ba67c041dfe5336000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000246a627842000000000000000000000000b8741a449d50ed0dcfe395287f85be152884c8d9009a7af758ae5d7b6aae84fe4c5ba67c041dfe5336000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000246a627842000000000000000000000000b8741a449d50ed0dcfe395287f85be152884c8d900fa5854fbf9964330d761961f46565ab7326e5a3b00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000044095ea7b30000000000000000000000003fe285dcd76bcce4ac92d38a6f2f8e964041e02000000000000000000000000000000000000000000000000000a1d1b51fe47c5c00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000', callGasLimit: 116807n, verificationGasLimit: 75441n, preVerificationGas: 50444n, maxFeePerGas: 66195658616n, maxPriorityFeePerGas: 120000n, paymasterAndData: '0x3fE285DcD76BCcE4Ac92d38A6F2F8E964041e020Fa5854FBf9964330d761961F46565AB7326e5a3b00000065bcd7fc00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000de84cb0d94beb10a4658077bd4ad19f4fdf94425ec730f342b8115d9907f6072f40bcea6a95bce74c29b84a7d4ee9fa67f4efb39e25a2e39a2ecb110b9a0af6b6a9589bfef7ec431b', signature: '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff' } ``` #### Source code[​](#source-code-1 "Direct link to Source code") [createTokenPaymasterUserOperation](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L654) ### calculateUserOperationErc20TokenMaxGasCost[​](#calculateuseroperationerc20tokenmaxgascost "Direct link to calculateUserOperationErc20TokenMaxGasCost") Calculates the maximum gas cost in ERC-20 tokens for a given userOperation #### Usage[​](#usage-4 "Direct link to Usage") * example.ts * Param Types * Return Types ``` import { CandidePaymaster } from "abstractionkit"; const erc20TokenAddress = "0xFa5854FBf9964330d761961F46565AB7326e5a3b"; // CTT test token // Use createUserOperation() to help you construct a userOp const userOperation = smartAccount.createUserOperation(..) const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const cost = await paymaster.calculateUserOperationErc20TokenMaxGasCost( userOperation, erc20TokenAddress, ); ``` | key | type | description | | :------------------ | :----------------------------------- | :---------------------------------------------------------- | | `userOperation` | `UserOperationV6 \| UserOperationV7` | UserOperation to Sponsor. Supports EntryPoint v0.6 and v0.7 | | `erc20TokenAddress` | `string` | ERC-20 Token Address | | key | type | description | | :----- | :---------------- | :---------------------------------------------------------------------- | | `cost` | `Promise` | Returns maximum amount that the operation will cost in the erc-20 token | Example Response ``` 3391931975665260 ``` #### Source code[​](#source-code-2 "Direct link to Source code") [calculateUserOperationErc20TokenMaxGasCost](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L732) ## Advanced Methods[​](#advanced-methods "Direct link to Advanced Methods") ### getPaymasterMetaData[​](#getpaymastermetadata "Direct link to getPaymasterMetaData") Returns the metadata associated with the Paymaster, along with dummyPaymasterAndData useful for gas estimates #### Usage[​](#usage-5 "Direct link to Usage") * example.ts * Param Type * Return Type example.ts ``` import { CandidePaymaster, SafeAccountV0_3_0 as SafeAccount } from "abstractionkit"; const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const paymasterResult = await paymaster.getPaymasterMetaData(SafeAccount.DEFAULT_ENTRYPOINT_ADDRESS); ``` | key | type | description | | :----------- | :------- | :--------------------------------- | | `entrypoint` | `string` | Target EntryPoint Contract Address | | key | type | description | | :------------------ | :------------------------------------------------------------ | :---------------------------------------------------------------------------------- | | `paymastermetadata` | `Promise` | Returns a promise with the paymaster metadata associated with the target entrypoint | PaymasterMetadataV7 | key | type | description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- | | `name` | `string` | The name of the Paymaster. | | `description` | `string` | A brief description of the Paymaster. | | `icons` | `string[]` | An array of icon URLs representing the Paymaster's brand or logo. | | `address` | `string` | The contract address of the Paymaster. | | `sponsoredEventTopic` | `string` | The event topic that will be emitted when a UserOperation is sponsored by the Paymaster. | | `dummyPaymasterAndData` | `key type descriptionpaymaster string The address of the Paymaster. paymasterVerificationGasLimit bigint The amount of gas allocated for the Paymaster verification step. paymasterPostOpGasLimit bigint The amount of gas allocated for the Paymaster post-operation step. paymasterData string Encoded data for the Paymaster.` | Dummy Paymaster data used for gas estimation. | PaymasterMetadataV6 | key | type | description | | :---------------------- | :--------- | :--------------------------------------------------------------------------------------- | | `name` | `string` | The name of the Paymaster. | | `description` | `string` | A brief description of the Paymaster. | | `icons` | `string[]` | An array of icon URLs representing the Paymaster's brand or logo. | | `address` | `string` | The contract address of the Paymaster. | | `sponsoredEventTopic` | `string` | The event topic that will be emitted when a UserOperation is sponsored by the Paymaster. | | `dummyPaymasterAndData` | `string` | Dummy Paymaster data used for gas estimation. | Example Response ``` { name: 'CANDIDE Paymaster', description: 'CANDIDE Paymaster a fast, secure and feature-rich 4337 Paymaster', icons: [], address: '0x8b1f6cb5d062aa2ce8d581942bbb960420d875ba', sponsoredEventTopic: '0xa050a122b4c0e369e3385eb6b7cccd8019638b2764de67bec0af99130ddf8471', dummyPaymasterAndData: { paymaster: '0x8b1f6cb5d062aa2ce8d581942bbb960420d875ba', paymasterVerificationGasLimit: '0xffff', paymasterPostOpGasLimit: '0xffff', paymasterData: '0x00010000000000ffff000000000000000000000000000000000000000000000000000000000000ffff010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101011c' } } ``` #### source code[​](#source-code-3 "Direct link to source code") [getPaymasterMetaData](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L227) ### getSupportedEntrypoints[​](#getsupportedentrypoints "Direct link to getSupportedEntrypoints") Returns the supported Entrypoints by the paymaster #### Usage[​](#usage-6 "Direct link to Usage") * example.ts * Return Type example.ts ``` import { CandidePaymaster } from "abstractionkit"; const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const paymasterResult = await paymaster.getSupportedEntrypoints(); ``` | key | type | description | | :--------------------- | :------------------ | :------------------------------------------- | | `entrypoint addresses` | `Promise` | A promise of a list of entrypoints addresses | Example Response ``` [ '0x0000000071727De22E5E9d8BAf0edAc6f37da032', '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789' ] ``` #### source code[​](#source-code-4 "Direct link to source code") [getSupportedEntrypoints](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L213) ### isSupportedERC20Token[​](#issupportederc20token "Direct link to isSupportedERC20Token") Checks if a particular ERC-20 token is accepted as gas payment by the paymaster. Returns a boolean #### Usage[​](#usage-7 "Direct link to Usage") * example.ts * Param Types * Response Type example.ts ``` import { CandidePaymaster } from "abstractionkit"; const paymasterRPC="https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const erc20TokenAddress = "0xFa5854FBf9964330d761961F46565AB7326e5a3b"; // CTT on sepolia testnet const isSupported = await paymaster.isSupportedERC20Token(erc20TokenAddress); ``` | key | type | description | | :------------------ | :------- | :---------------------------------------------------- | | `erc20TokenAddress` | `string` | ERC-20 Token Address | | `entrypoint?` | `string` | Target EntryPoint Address. Defaults to ENTRYPOINT\_V7 | | key | type | description | | :------------ | :-------- | :------------------------------------------- | | `isSupported` | `boolean` | Returns true if the erc20 token is supported | Example Response ``` true ``` #### Source[​](#source "Direct link to Source") [isSupportedERC20Token](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L249) ### getSupportedERC20TokenData[​](#getsupportederc20tokendata "Direct link to getSupportedERC20TokenData") Returns the token data given an erc20 address #### Usage[​](#usage-8 "Direct link to Usage") * example.ts * Param Types * Return Type example.ts ``` import { CandidePaymaster } from "abstractionkit"; const paymasterRpc = "https://api.candide.dev/public/v3/sepolia"; const erc20TokenAddress = "0xFa5854FBf9964330d761961F46565AB7326e5a3b"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); const erc20TokenData = await paymaster.getSupportedERC20TokenData(erc20TokenAddress); ``` | key | type | description | | :------------------ | :------- | :---------------------------------------------------- | | `erc20TokenAddress` | `string` | ERC-20 Token Address | | `entrypoint?` | `string` | Target EntryPoint Address. Defaults to ENTRYPOINT\_V7 | | key | type | description | | :----------- | :---------------------------- | :----------- | | `ERC20Token` | `Promise` | ERC-20 Token | | key | type | description | | :-------- | :------- | :------------------------------------------ | | `name` | `string` | The name of the ERC20 token. | | `symbol` | `string` | The symbol representing the ERC20 token. | | `address` | `string` | The contract address of the ERC20 token. | | `decimal` | `number` | The number of decimal places for the token. | Example Response ``` { name: 'Candide Test Token', symbol: 'CTT', address: '0xFa5854FBf9964330d761961F46565AB7326e5a3b', decimal: 18, fee: 0n, exchangeRate: 1001219705870085130n } ``` #### Source code[​](#source-code-5 "Direct link to Source code") [getSupportedERC20TokenData](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L270) ### createPaymasterUserOperation[​](#createpaymasteruseroperation "Direct link to createPaymasterUserOperation") Estimates gas limits and set paymaster data. Returns a complete userOperation and the sponsor metadata if defined #### Usage[​](#usage-9 "Direct link to Usage") * example.ts * Param Types * Return Types ``` import { CandidePaymaster } from "abstractionkit"; const bundlerRPC = "https://api.candide.dev/public/v3/sepolia"; const paymasterRpc = "https://api.candide.dev/public/v3/sepolia"; const paymaster: CandidePaymaster = new CandidePaymaster(paymasterRPC); // Use createUserOperation() to help you construct a userOp const userOperation = smartAccount.createUserOperation(..) const [sponsoredUserOp, sponsorMetadata] = paymaster.createPaymasterUserOperation(userOperation, bundlerRPC); console.log(sponsoredUserOp); console.log(sponsorMetadata); ``` | key | type | description | | :-------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------- | | `userOperationInput` | `UserOperationV6 \| UserOperationV7` | UserOperation to Sponsor. Supports EntryPoint v0.6 and v0.7 | | `bundlerRpc` | `string` | Bundler URL to estimate the gas | | `context?` | `key type descriptiontoken string? ERC20 token address, if paying gas in erc-20 tokens (optional) sponsorshipPolicyId string? Sponsorship Policy ID if using a private gas policy (optional)` | Paymaster context data | | `CreatePaymasterUserOperationOverrides` | `key type descriptioncallGasLimit bigint Set the callGasLimit instead of estimating gas using the bundler. verificationGasLimit bigint Set the verificationGasLimit instead of estimating gas using the bundler. preVerificationGas bigint Set the preVerificationGas instead of estimating gas using the bundler. callGasLimitPercentageMultiplier number Set the callGasLimitPercentageMultiplier instead of estimating gas using the bundler. verificationGasLimitPercentageMultiplier number Set the verificationGasLimitPercentageMultiplier instead of estimating gas using the bundler. preVerificationGasPercentageMultiplier number Set the preVerificationGasPercentageMultiplier instead of estimating gas using the bundler. stateOverrideSetType key type description[address: string] key type descriptionbalance bigint Override the balance of the address nonce bigint Override the nonce of the address code string Override the code of the address state Dictionary Override the storage slots of the address stateDiff Dictionary Apply state differences to the storage slots of the address Overrides for a specific address Pass state overrides for gas estimation, including balance, nonce, code, and state or stateDiff for the account at each address.` | Bundler URL to estimate the gas | | key | type | description | | :-------------- | :-------------------------------------------------------------------------- | :----------------------------------------- | | `userOperation` | `Promise` | UserOperation with paymaster data included | `UserOperationV7` | key | type | description | | :------------------------------ | :------- | :------------------------------------------------------------------------------ | | `sender` | `string` | The account making the operation | | `nonce` | `string` | Anti-replay parameter (see “Semi-abstracted Nonce Support” ) | | `factory` | `string` | account factory, only for new accounts | | `factoryData` | `string` | data for account factory (only if account factory exists) | | `callData` | `string` | The data to pass to the sender during the main execution call | | `callGasLimit` | `bigint` | The amount of gas to allocate the main execution call | | `verificationGasLimit` | `bigint` | The amount of gas to allocate for the verification step | | `preVerificationGas` | `bigint` | Extra gas to pay the bunder | | `maxFeePerGas` | `bigint` | Maximum fee per gas (similar to EIP-1559 max\_fee\_per\_gas) | | `maxPriorityFeePerGas` | `bigint` | Maximum priority fee per gas (similar to EIP-1559 max\_priority\_fee\_per\_gas) | | `paymaster` | `string` | Address of paymaster contract, (or empty, if account pays for itself) | | `paymasterVerificationGasLimit` | `string` | The amount of gas to allocate for the paymaster post-operation code | | `paymasterPostOpGasLimit` | `string` | The amount of gas to allocate for the paymaster post-operation code | | `paymasterData` | `string` | Data for paymaster (only if paymaster exists) | | `signature` | `string` | Data passed into the account to verify authorization | `UserOperationV6` | key | type | description | | :--------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `sender` | `string` | The account making the operation | | `nonce` | `string` | Anti-replay parameter (see “Semi-abstracted Nonce Support” ) | | `initCode` | `string` | The initCode of the account (needed if and only if the account is not yet on-chain and needs to be created) | | `callData` | `string` | The data to pass to the sender during the main execution call | | `callGasLimit` | `bigint` | The amount of gas to allocate the main execution call | | `verificationGasLimit` | `bigint` | The amount of gas to allocate for the verification step | | `preVerificationGas` | `bigint` | The amount of gas to pay for to compensate the bundler for pre-verification execution and calldata | | `maxFeePerGas` | `bigint` | Maximum fee per gas (similar to EIP-1559 max\_fee\_per\_gas) | | `maxPriorityFeePerGas` | `bigint` | Maximum priority fee per gas (similar to EIP-1559 max\_priority\_fee\_per\_gas) | | `paymasterAndData` | `string` | Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster (empty for self-sponsored transaction). Revolves to '0x' if not using a paymaster, and a paymasterDummyData when estimating gas | | `signature` | `string` | The signature for the userOperation. It is the data passed into the account along with the nonce during the verification step. Resolves to '0x' when the user did not provide their signature yet | `SponsorMetadata` | key | type | description | | :------------ | :--------- | :------------------------------------------------------------------- | | `name` | `string` | Name of Sponsor who is sponsoring the Gas Policy | | `description` | `string` | A short description of the sponsor | | `url` | `string` | Website of the Sponsor | | `icons` | `string[]` | Logos or Icons that the Sponsor is using to promote their Gas Policy | Example Response ``` { sender: '0xb5ba83cd38f6d7302fda5c0213aaa1483f8ec6f5', nonce: 0n, callData: '0x541d63c800000000000000000000000038869bf66a61cf6bdb996a6ae40d5853fd43b52600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000001448d80ff0a000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000f2009a7af758ae5d7b6aae84fe4c5ba67c041dfe5336000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000246a627842000000000000000000000000b5ba83cd38f6d7302fda5c0213aaa1483f8ec6f5009a7af758ae5d7b6aae84fe4c5ba67c041dfe5336000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000246a627842000000000000000000000000b5ba83cd38f6d7302fda5c0213aaa1483f8ec6f5000000000000000000000000000000000000000000000000000000000000000000000000000000000000', callGasLimit: 126318n, verificationGasLimit: 895372n, preVerificationGas: 59404n, maxFeePerGas: 22056449241n, maxPriorityFeePerGas: 21053883366n, signature: '0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0000000000000000000000000000000000000000000000000000000000000041ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff', factory: '0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67', factoryData: '0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c7620000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001e4b63e800d000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000010000000000000000000000002dd68b007b46fbe91b9a7c3eda5a7a1063cb5b47000000000000000000000000000000000000000000000000000000000000014000000000000000000000000075cf11467937ce3f2f357ce24ffc3dbf8fd5c22600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000008e35fa6431ac9e2680991d7822df3df47b1f6a1000000000000000000000000000000000000000000000000000000000000000648d0dc49f0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000100000000000000000000000075cf11467937ce3f2f357ce24ffc3dbf8fd5c2260000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000', paymaster: '0x8b1f6cb5d062aa2ce8d581942bbb960420d875ba', paymasterVerificationGasLimit: 100000n, paymasterPostOpGasLimit: 45000n, paymasterData: '0x0200000066ec5650b403073db5c06bf3aa8171b902d0efc451d1ae1ac8f6c832fe24eb6407805d2506d0f34ebb9637864d9612b7f9eee7293e1d8a6d9d9d0cc90b621abbfc448e981c' } { name: 'Candide', description: 'Developers from across the globe use Candide to build on Safe Accounts and tap into a network of third-party gas sponsorship to ultimately supercharge their user growth', url: 'https://candide.dev', icons: [ 'https://docs.candide.dev/img/logo-dark.png' ] } ``` #### Source code[​](#source-code-6 "Direct link to Source code") [createPaymasterUserOperation](https://github.com/candidelabs/abstractionkit/blob/98853f30861382a534abf667ced83d47b6c9da0b/src/paymaster/CandidePaymaster.ts#L327)