TypeScript

React

Engine
Contracts

Chain List Wei Converter Hex Converter Account API Keys CLI

Support Site Contact Sales

Changelog

Wallet SDK

AwsKmsWallet
AwsSecretsManagerWallet
GcpKmsWallet
LocalWalletNode
PrivateKeyWallet
BloctoWallet
Coin98Wallet
CoinbaseWallet
CoreWallet
CryptoDefiWallet
EmbeddedWallet
EngineWallet
EthersWallet
FrameWallet
LocalWallet
MagicEdenWallet
MagicLink
MetaMaskWallet
OKXWallet
OneKeyWallet
PhantomWallet
RabbyWallet
RainbowWallet
SafeWallet
SmartWallet
TokenBoundSmartWallet
TrustWallet
WalletConnect
XDEFIWallet
ZerionWallet
AbstractClientWallet
AbstractWallet
ImTokenWallet
AwsSigner
Connector
EmbeddedWalletSdk
EngineSigner
LocalStorage
PaymasterAPI
WagmiAdapter
WagmiConnector
WalletConnectHandler
WalletConnectV2Handler
checkContractWalletSignature
getAllSigners
getAllSmartWallets
getInjectedOneKeyProvider
getSmartWalletAddress
getUserOpReceipt
isSmartWalletDeployed
isWalletAnalyticsEnabled
isZkSyncChain
setWalletAnalyticsEnabled
DEFAULT_FACTORY_ADDRESS
supportedSmsCountries
walletIds
AwsSecretsManagerWalletOptions
AsyncStorage
BaseApiParams
DAppMetaData
EVMWallet
GenericAuthWallet
IWalletConnectReceiver
ProviderConfig
SafeConnectionArgs
SyncStorage
TransactionOptions
UserOpOptions
UserOpResult
WalletEvents
AccessibleSmartWallets
AccountContractInfo
AuthAndWalletRpcReturnType
AuthDetails
AuthLoginReturnType
AuthParams
AuthResult
AuthStoredTokenWithCookieReturnType
BatchData
BloctoOptions
Chain
Coin98AdditionalOptions
Coin98Options
CoinbaseWalletOptions
ConnectParams
ContractInfo
ContractInfoInput
CoreWalletAdditionalOptions
CoreWalletOptions
CreateAsyncStorage
CryptoDefiWalletAdditionalOptions
CryptoDefiWalletOptions
EmbeddedWalletAdditionalOptions
EmbeddedWalletConnectionArgs
EmbeddedWalletConstructorType
EmbeddedWalletOauthStrategy
EmbeddedWalletOptions
EstimateUserOpGasRawResult
EstimateUserOpGasResult
FactoryContractInfo
GetUser
GetUserWalletStatusRpcReturnType
ImTokenWalletOptions
InitializedUser
LocalWalletConnectionArgs
LocalWalletDecryptOptions
LocalWalletEncryptOptions
LocalWalletExportOptions
LocalWalletImportOptions
LocalWalletLoadOptions
LocalWalletLoadOrCreateOptions
LocalWalletOptions
LocalWalletSaveOptions
LogoutReturnType
MagicEdenOptions
MagicLinkAdditionalOptions
MagicLinkConnectOptions
MagicLinkOptions
MagicOAuthProvider
MetamaskAdditionalOptions
MetamaskWalletOptions
OKXWalletOptions
OneKeyOptions
PaperWalletAdditionalOptions
PaperWalletOptions
PaymasterResult
RabbyOptions
RainbowWalletOptions
SafeWalletOptions
SendEmailOtpReturnType
SetUpWalletRpcReturnType
SignMessageReturnType
SignTransactionReturnType
SignedTypedDataReturnType
SignerWalletAdditionalOptions
SignerWalletConnectionArgs
SmartWalletConfig
SmartWalletConnectionArgs
SmartWalletOptions
StoredTokenType
TrustWalletOptions
UserOperationStruct
WC2_QRModalOptions
WCErrorResponse
WCEvent
WCJsonRpcError
WCJsonRpcResult
WCMetadata
WCPeer
WCProposal
WCProposerMetadata
WCRequest
WCSession
WalletConnectMetadata
WalletConnectOptions
WalletConnectReceiverConfig
WalletData
WalletOptions
XDEFIOptions
ZkTransactionInput
AuthProvider
RecoveryShareManagement
UserWalletStatus

References
PaymasterAPI

PaymasterAPI

Defined in

an API to external a UserOperation with paymaster info


class PaymasterAPI {}


function constructor(): PaymasterAPI;

Returns


let returnType: PaymasterAPI;

Methods

Defined in


function getPaymasterAndData(
  userOp: Partial<UserOperationStruct>,
): Promise<PaymasterResult>;

Parameters

a partially-filled UserOperation (without signature and paymasterAndData note that the "preVerificationGas" is incomplete: it can't account for the paymasterAndData value, which will only be returned by this method..

Type


let userOp: Partial<UserOperationStruct>;

Returns


let returnType: Promise<PaymasterResult>;

the value to put into the PaymasterAndData, undefined to leave it empty

Was this page helpful?

Need help?
Visit our support site
Watch our
Video Tutorials
View our
Changelog

Subscribe for the latest dev updates

On this page

PaymasterAPI

Signature

Constructor

Signature

Returns

Return Type

Methods

getPaymasterAndData

Signature

Parameters

userOp

Type

Returns

Return Type