EtherspotPaymaster | Etherspot Prime reference docs

Hierarchy

BaseContract
- EtherspotPaymaster

Index

Constructors

constructor

Properties

Constructors

constructor

new EtherspotPaymaster(addressOrName: string, contractInterface: ContractInterface, signerOrProvider?: Signer | Provider): EtherspotPaymaster

Inherited from Ownable.constructor

Parameters
- addressOrName: string
- contractInterface: ContractInterface
- Optional signerOrProvider: Signer | Provider
Returns EtherspotPaymaster

Properties

_deployedPromise

_deployedPromise: Promise<Contract>

_runningEvents

_runningEvents: {}

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

_wrappedEmits: {}

Type declaration

[eventTag: string]: (...args: Array<any>) => void
- - (...args: Array<any>): void
  - Parameters
    - Rest ...args: Array<any>
    Returns void

Readonly address

address: string

callStatic

callStatic: { addBatchToWhitelist: any; addStake: any; addToWhitelist: any; check: any; depositFunds: any; entryPoint: any; getDeposit: any; getHash: any; getSponsorBalance: any; owner: any; parsePaymasterAndData: any; postOp: any; removeBatchFromWhitelist: any; removeFromWhitelist: any; renounceOwnership: any; transferOwnership: any; unlockStake: any; validatePaymasterUserOp: any; withdrawFunds: any; withdrawStake: any }

Type declaration

addBatchToWhitelist: function
- addBatchToWhitelist(_accounts: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: CallOverrides
  Returns Promise<void>
addStake: function
- addStake(unstakeDelaySec: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>
- Parameters
  - unstakeDelaySec: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<void>
addToWhitelist: function
- addToWhitelist(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<void>
check: function
- check(_sponsor: PromiseOrValue<string>, _account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<boolean>
depositFunds: function
- depositFunds(overrides?: CallOverrides): Promise<void>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<void>
entryPoint: function
- entryPoint(overrides?: CallOverrides): Promise<string>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
getDeposit: function
- getDeposit(overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getHash: function
- getHash(userOp: UserOperationStruct, validUntil: PromiseOrValue<BigNumberish>, validAfter: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>
- Parameters
  - userOp: UserOperationStruct
  - validUntil: PromiseOrValue<BigNumberish>
  - validAfter: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<string>
getSponsorBalance: function
- getSponsorBalance(_sponsor: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
owner: function
- owner(overrides?: CallOverrides): Promise<string>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<string>
parsePaymasterAndData: function
- parsePaymasterAndData(paymasterAndData: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<[] & { signature: string; validAfter: number; validUntil: number }>
- Parameters
  - paymasterAndData: PromiseOrValue<BytesLike>
  - Optional overrides: CallOverrides
  Returns Promise<[] & { signature: string; validAfter: number; validUntil: number }>
postOp: function
- postOp(mode: PromiseOrValue<BigNumberish>, context: PromiseOrValue<BytesLike>, actualGasCost: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>
- Parameters
  - mode: PromiseOrValue<BigNumberish>
  - context: PromiseOrValue<BytesLike>
  - actualGasCost: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<void>
removeBatchFromWhitelist: function
- removeBatchFromWhitelist(_accounts: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: CallOverrides
  Returns Promise<void>
removeFromWhitelist: function
- removeFromWhitelist(_account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<void>
renounceOwnership: function
- renounceOwnership(overrides?: CallOverrides): Promise<void>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<void>
transferOwnership: function
- transferOwnership(newOwner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>
- Parameters
  - newOwner: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<void>
unlockStake: function
- unlockStake(overrides?: CallOverrides): Promise<void>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<void>
validatePaymasterUserOp: function
- validatePaymasterUserOp(userOp: UserOperationStruct, userOpHash: PromiseOrValue<BytesLike>, maxCost: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[] & { context: string; validationData: BigNumber }>
- Parameters
  - userOp: UserOperationStruct
  - userOpHash: PromiseOrValue<BytesLike>
  - maxCost: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<[] & { context: string; validationData: BigNumber }>
withdrawFunds: function
- withdrawFunds(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>
- Parameters
  - _amount: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<void>
withdrawStake: function
- withdrawStake(withdrawAddress: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>
- Parameters
  - withdrawAddress: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<void>

Readonly deployTransaction

deployTransaction: TransactionResponse

estimateGas

estimateGas: { addBatchToWhitelist: any; addStake: any; addToWhitelist: any; check: any; depositFunds: any; entryPoint: any; getDeposit: any; getHash: any; getSponsorBalance: any; owner: any; parsePaymasterAndData: any; postOp: any; removeBatchFromWhitelist: any; removeFromWhitelist: any; renounceOwnership: any; transferOwnership: any; unlockStake: any; validatePaymasterUserOp: any; withdrawFunds: any; withdrawStake: any }

Type declaration

addBatchToWhitelist: function
- addBatchToWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
addStake: function
- addStake(unstakeDelaySec: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - unstakeDelaySec: PromiseOrValue<BigNumberish>
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
addToWhitelist: function
- addToWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
check: function
- check(_sponsor: PromiseOrValue<string>, _account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
depositFunds: function
- depositFunds(overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
entryPoint: function
- entryPoint(overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getDeposit: function
- getDeposit(overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getHash: function
- getHash(userOp: UserOperationStruct, validUntil: PromiseOrValue<BigNumberish>, validAfter: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - userOp: UserOperationStruct
  - validUntil: PromiseOrValue<BigNumberish>
  - validAfter: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
getSponsorBalance: function
- getSponsorBalance(_sponsor: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
owner: function
- owner(overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
parsePaymasterAndData: function
- parsePaymasterAndData(paymasterAndData: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>
- Parameters
  - paymasterAndData: PromiseOrValue<BytesLike>
  - Optional overrides: CallOverrides
  Returns Promise<BigNumber>
postOp: function
- postOp(mode: PromiseOrValue<BigNumberish>, context: PromiseOrValue<BytesLike>, actualGasCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - mode: PromiseOrValue<BigNumberish>
  - context: PromiseOrValue<BytesLike>
  - actualGasCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
removeBatchFromWhitelist: function
- removeBatchFromWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
removeFromWhitelist: function
- removeFromWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
renounceOwnership: function
- renounceOwnership(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
transferOwnership: function
- transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - newOwner: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
unlockStake: function
- unlockStake(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
validatePaymasterUserOp: function
- validatePaymasterUserOp(userOp: UserOperationStruct, userOpHash: PromiseOrValue<BytesLike>, maxCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - userOp: UserOperationStruct
  - userOpHash: PromiseOrValue<BytesLike>
  - maxCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
withdrawFunds: function
- withdrawFunds(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - _amount: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>
withdrawStake: function
- withdrawStake(withdrawAddress: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<BigNumber>
- Parameters
  - withdrawAddress: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<BigNumber>

filters

filters: { AddedBatchToWhitelist: any; AddedBatchToWhitelist(address,address[]): any; AddedToWhitelist: any; AddedToWhitelist(address,address): any; OwnershipTransferred: any; OwnershipTransferred(address,address): any; RemovedBatchFromWhitelist: any; RemovedBatchFromWhitelist(address,address[]): any; RemovedFromWhitelist: any; RemovedFromWhitelist(address,address): any; SponsorSuccessful: any; SponsorSuccessful(address,address): any }

Type declaration

AddedBatchToWhitelist: function
- AddedBatchToWhitelist(paymaster?: PromiseOrValue<string> | null, accounts?: PromiseOrValue<string>[] | null): AddedBatchToWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional accounts: PromiseOrValue<string>[] | null
  Returns AddedBatchToWhitelistEventFilter
AddedBatchToWhitelist(address,address[]): function
- AddedBatchToWhitelist(address,address[])(paymaster?: PromiseOrValue<string> | null, accounts?: PromiseOrValue<string>[] | null): AddedBatchToWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional accounts: PromiseOrValue<string>[] | null
  Returns AddedBatchToWhitelistEventFilter
AddedToWhitelist: function
- AddedToWhitelist(paymaster?: PromiseOrValue<string> | null, account?: PromiseOrValue<string> | null): AddedToWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional account: PromiseOrValue<string> | null
  Returns AddedToWhitelistEventFilter
AddedToWhitelist(address,address): function
- AddedToWhitelist(address,address)(paymaster?: PromiseOrValue<string> | null, account?: PromiseOrValue<string> | null): AddedToWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional account: PromiseOrValue<string> | null
  Returns AddedToWhitelistEventFilter
OwnershipTransferred: function
- OwnershipTransferred(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter
- Parameters
  - Optional previousOwner: PromiseOrValue<string> | null
  - Optional newOwner: PromiseOrValue<string> | null
  Returns OwnershipTransferredEventFilter
OwnershipTransferred(address,address): function
- OwnershipTransferred(address,address)(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter
- Parameters
  - Optional previousOwner: PromiseOrValue<string> | null
  - Optional newOwner: PromiseOrValue<string> | null
  Returns OwnershipTransferredEventFilter
RemovedBatchFromWhitelist: function
- RemovedBatchFromWhitelist(paymaster?: PromiseOrValue<string> | null, accounts?: PromiseOrValue<string>[] | null): RemovedBatchFromWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional accounts: PromiseOrValue<string>[] | null
  Returns RemovedBatchFromWhitelistEventFilter
RemovedBatchFromWhitelist(address,address[]): function
- RemovedBatchFromWhitelist(address,address[])(paymaster?: PromiseOrValue<string> | null, accounts?: PromiseOrValue<string>[] | null): RemovedBatchFromWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional accounts: PromiseOrValue<string>[] | null
  Returns RemovedBatchFromWhitelistEventFilter
RemovedFromWhitelist: function
- RemovedFromWhitelist(paymaster?: PromiseOrValue<string> | null, account?: PromiseOrValue<string> | null): RemovedFromWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional account: PromiseOrValue<string> | null
  Returns RemovedFromWhitelistEventFilter
RemovedFromWhitelist(address,address): function
- RemovedFromWhitelist(address,address)(paymaster?: PromiseOrValue<string> | null, account?: PromiseOrValue<string> | null): RemovedFromWhitelistEventFilter
- Parameters
  - Optional paymaster: PromiseOrValue<string> | null
  - Optional account: PromiseOrValue<string> | null
  Returns RemovedFromWhitelistEventFilter
SponsorSuccessful: function
- SponsorSuccessful(paymaster?: null, sender?: null): SponsorSuccessfulEventFilter
- Parameters
  - Optional paymaster: null
  - Optional sender: null
  Returns SponsorSuccessfulEventFilter
SponsorSuccessful(address,address): function
- SponsorSuccessful(address,address)(paymaster?: null, sender?: null): SponsorSuccessfulEventFilter
- Parameters
  - Optional paymaster: null
  - Optional sender: null
  Returns SponsorSuccessfulEventFilter

functions

functions: { addBatchToWhitelist: any; addStake: any; addToWhitelist: any; check: any; depositFunds: any; entryPoint: any; getDeposit: any; getHash: any; getSponsorBalance: any; owner: any; parsePaymasterAndData: any; postOp: any; removeBatchFromWhitelist: any; removeFromWhitelist: any; renounceOwnership: any; transferOwnership: any; unlockStake: any; validatePaymasterUserOp: any; withdrawFunds: any; withdrawStake: any }

Type declaration

addBatchToWhitelist: function
- addBatchToWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
addStake: function
- addStake(unstakeDelaySec: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - unstakeDelaySec: PromiseOrValue<BigNumberish>
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
addToWhitelist: function
- addToWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
check: function
- check(_sponsor: PromiseOrValue<string>, _account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[]>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<[]>
depositFunds: function
- depositFunds(overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
entryPoint: function
- entryPoint(overrides?: CallOverrides): Promise<[]>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[]>
getDeposit: function
- getDeposit(overrides?: CallOverrides): Promise<[]>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[]>
getHash: function
- getHash(userOp: UserOperationStruct, validUntil: PromiseOrValue<BigNumberish>, validAfter: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[]>
- Parameters
  - userOp: UserOperationStruct
  - validUntil: PromiseOrValue<BigNumberish>
  - validAfter: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<[]>
getSponsorBalance: function
- getSponsorBalance(_sponsor: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[]>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<[]>
owner: function
- owner(overrides?: CallOverrides): Promise<[]>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<[]>
parsePaymasterAndData: function
- parsePaymasterAndData(paymasterAndData: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<[] & { signature: string; validAfter: number; validUntil: number }>
- Parameters
  - paymasterAndData: PromiseOrValue<BytesLike>
  - Optional overrides: CallOverrides
  Returns Promise<[] & { signature: string; validAfter: number; validUntil: number }>
postOp: function
- postOp(mode: PromiseOrValue<BigNumberish>, context: PromiseOrValue<BytesLike>, actualGasCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - mode: PromiseOrValue<BigNumberish>
  - context: PromiseOrValue<BytesLike>
  - actualGasCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
removeBatchFromWhitelist: function
- removeBatchFromWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
removeFromWhitelist: function
- removeFromWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
renounceOwnership: function
- renounceOwnership(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
transferOwnership: function
- transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - newOwner: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
unlockStake: function
- unlockStake(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
validatePaymasterUserOp: function
- validatePaymasterUserOp(userOp: UserOperationStruct, userOpHash: PromiseOrValue<BytesLike>, maxCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - userOp: UserOperationStruct
  - userOpHash: PromiseOrValue<BytesLike>
  - maxCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
withdrawFunds: function
- withdrawFunds(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - _amount: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>
withdrawStake: function
- withdrawStake(withdrawAddress: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>
- Parameters
  - withdrawAddress: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<ContractTransaction>

interface

interface: EtherspotPaymasterInterface

off

off: OnEvent<this>

on

on: OnEvent<this>

once

once: OnEvent<this>

populateTransaction

populateTransaction: { addBatchToWhitelist: any; addStake: any; addToWhitelist: any; check: any; depositFunds: any; entryPoint: any; getDeposit: any; getHash: any; getSponsorBalance: any; owner: any; parsePaymasterAndData: any; postOp: any; removeBatchFromWhitelist: any; removeFromWhitelist: any; renounceOwnership: any; transferOwnership: any; unlockStake: any; validatePaymasterUserOp: any; withdrawFunds: any; withdrawStake: any }

Type declaration

addBatchToWhitelist: function
- addBatchToWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
addStake: function
- addStake(unstakeDelaySec: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - unstakeDelaySec: PromiseOrValue<BigNumberish>
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
addToWhitelist: function
- addToWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
check: function
- check(_sponsor: PromiseOrValue<string>, _account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - _account: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
depositFunds: function
- depositFunds(overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
entryPoint: function
- entryPoint(overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getDeposit: function
- getDeposit(overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getHash: function
- getHash(userOp: UserOperationStruct, validUntil: PromiseOrValue<BigNumberish>, validAfter: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - userOp: UserOperationStruct
  - validUntil: PromiseOrValue<BigNumberish>
  - validAfter: PromiseOrValue<BigNumberish>
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
getSponsorBalance: function
- getSponsorBalance(_sponsor: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - _sponsor: PromiseOrValue<string>
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
owner: function
- owner(overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
parsePaymasterAndData: function
- parsePaymasterAndData(paymasterAndData: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>
- Parameters
  - paymasterAndData: PromiseOrValue<BytesLike>
  - Optional overrides: CallOverrides
  Returns Promise<PopulatedTransaction>
postOp: function
- postOp(mode: PromiseOrValue<BigNumberish>, context: PromiseOrValue<BytesLike>, actualGasCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - mode: PromiseOrValue<BigNumberish>
  - context: PromiseOrValue<BytesLike>
  - actualGasCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
removeBatchFromWhitelist: function
- removeBatchFromWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - _accounts: PromiseOrValue<string>[]
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
removeFromWhitelist: function
- removeFromWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - _account: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
renounceOwnership: function
- renounceOwnership(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
transferOwnership: function
- transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - newOwner: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
unlockStake: function
- unlockStake(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
validatePaymasterUserOp: function
- validatePaymasterUserOp(userOp: UserOperationStruct, userOpHash: PromiseOrValue<BytesLike>, maxCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - userOp: UserOperationStruct
  - userOpHash: PromiseOrValue<BytesLike>
  - maxCost: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
withdrawFunds: function
- withdrawFunds(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - _amount: PromiseOrValue<BigNumberish>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>
withdrawStake: function
- withdrawStake(withdrawAddress: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<PopulatedTransaction>
- Parameters
  - withdrawAddress: PromiseOrValue<string>
  - Optional overrides: Overrides & { from?: PromiseOrValue<string> }
  Returns Promise<PopulatedTransaction>

Readonly provider

provider: Provider

removeListener

removeListener: OnEvent<this>

Readonly resolvedAddress

resolvedAddress: Promise<string>

Readonly signer

signer: Signer

Methods

_checkRunningEvents

_checkRunningEvents(runningEvent: RunningEvent): void

Inherited from Ownable._checkRunningEvents

Parameters
- runningEvent: RunningEvent
Returns void

_deployed

_deployed(blockTag?: BlockTag): Promise<Contract>

Inherited from Ownable._deployed

Parameters
- Optional blockTag: BlockTag
Returns Promise<Contract>

_wrapEvent

_wrapEvent(runningEvent: RunningEvent, log: Log, listener: Listener): Event

Inherited from Ownable._wrapEvent

Parameters
- runningEvent: RunningEvent
- log: Log
- listener: Listener
Returns Event

addBatchToWhitelist

addBatchToWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- _accounts: PromiseOrValue<string>[]
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

addStake

addStake(unstakeDelaySec: PromiseOrValue<BigNumberish>, overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- unstakeDelaySec: PromiseOrValue<BigNumberish>
- Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

addToWhitelist

addToWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- _account: PromiseOrValue<string>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

attach

attach(addressOrName: string): this

Overrides BaseContract.attach

Parameters
- addressOrName: string
Returns this

check

check(_sponsor: PromiseOrValue<string>, _account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>

Parameters
- _sponsor: PromiseOrValue<string>
- _account: PromiseOrValue<string>
- Optional overrides: CallOverrides
Returns Promise<boolean>

connect

connect(signerOrProvider: Signer | Provider | string): this

Overrides BaseContract.connect

Parameters
- signerOrProvider: Signer | Provider | string
Returns this

deployed

deployed(): Promise<this>

Overrides BaseContract.deployed

Returns Promise<this>

depositFunds

depositFunds(overrides?: PayableOverrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- Optional overrides: PayableOverrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

emit

emit(eventName: EventFilter | string, ...args: Array<any>): boolean

Inherited from Ownable.emit

Parameters
- eventName: EventFilter | string
- Rest ...args: Array<any>
Returns boolean

entryPoint

entryPoint(overrides?: CallOverrides): Promise<string>

Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

fallback

fallback(overrides?: TransactionRequest): Promise<TransactionResponse>

Inherited from Ownable.fallback

Parameters
- Optional overrides: TransactionRequest
Returns Promise<TransactionResponse>

getDeposit

getDeposit(overrides?: CallOverrides): Promise<BigNumber>

Parameters
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

getHash

getHash(userOp: UserOperationStruct, validUntil: PromiseOrValue<BigNumberish>, validAfter: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>

Parameters
- userOp: UserOperationStruct
- validUntil: PromiseOrValue<BigNumberish>
- validAfter: PromiseOrValue<BigNumberish>
- Optional overrides: CallOverrides
Returns Promise<string>

getSponsorBalance

getSponsorBalance(_sponsor: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>

Parameters
- _sponsor: PromiseOrValue<string>
- Optional overrides: CallOverrides
Returns Promise<BigNumber>

listenerCount

listenerCount(eventName?: EventFilter | string): number

Inherited from Ownable.listenerCount

Parameters
- Optional eventName: EventFilter | string
Returns number

listeners

listeners<TEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>
listeners(eventName?: string): Array<Listener>

Overrides BaseContract.listeners

Type parameters
- TEvent: TypedEvent
Parameters
- Optional eventFilter: TypedEventFilter<TEvent>
Returns Array<TypedListener<TEvent>>
Overrides BaseContract.listeners

Parameters
- Optional eventName: string
Returns Array<Listener>

owner

owner(overrides?: CallOverrides): Promise<string>

Parameters
- Optional overrides: CallOverrides
Returns Promise<string>

parsePaymasterAndData

parsePaymasterAndData(paymasterAndData: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<[] & { signature: string; validAfter: number; validUntil: number }>

Parameters
- paymasterAndData: PromiseOrValue<BytesLike>
- Optional overrides: CallOverrides
Returns Promise<[] & { signature: string; validAfter: number; validUntil: number }>

postOp

postOp(mode: PromiseOrValue<BigNumberish>, context: PromiseOrValue<BytesLike>, actualGasCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- mode: PromiseOrValue<BigNumberish>
- context: PromiseOrValue<BytesLike>
- actualGasCost: PromiseOrValue<BigNumberish>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

queryFilter

queryFilter<TEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>

Overrides BaseContract.queryFilter

Type parameters
- TEvent: TypedEvent
Parameters
- event: TypedEventFilter<TEvent>
- Optional fromBlockOrBlockhash: string | number | undefined
- Optional toBlock: string | number | undefined
Returns Promise<Array<TEvent>>

removeAllListeners

removeAllListeners<TEvent>(eventFilter: TypedEventFilter<TEvent>): this
removeAllListeners(eventName?: string): this

Overrides BaseContract.removeAllListeners

Type parameters
- TEvent: TypedEvent
Parameters
- eventFilter: TypedEventFilter<TEvent>
Returns this
Overrides BaseContract.removeAllListeners

Parameters
- Optional eventName: string
Returns this

removeBatchFromWhitelist

removeBatchFromWhitelist(_accounts: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- _accounts: PromiseOrValue<string>[]
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

removeFromWhitelist

removeFromWhitelist(_account: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- _account: PromiseOrValue<string>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

renounceOwnership

renounceOwnership(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

transferOwnership

transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- newOwner: PromiseOrValue<string>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

unlockStake

unlockStake(overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

validatePaymasterUserOp

validatePaymasterUserOp(userOp: UserOperationStruct, userOpHash: PromiseOrValue<BytesLike>, maxCost: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- userOp: UserOperationStruct
- userOpHash: PromiseOrValue<BytesLike>
- maxCost: PromiseOrValue<BigNumberish>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

withdrawFunds

withdrawFunds(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- _amount: PromiseOrValue<BigNumberish>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

withdrawStake

withdrawStake(withdrawAddress: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string> }): Promise<ContractTransaction>

Parameters
- withdrawAddress: PromiseOrValue<string>
- Optional overrides: Overrides & { from?: PromiseOrValue<string> }
Returns Promise<ContractTransaction>

Static getContractAddress

getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

Inherited from Ownable.getContractAddress

Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

Static getInterface

getInterface(contractInterface: ContractInterface): Interface

Inherited from Ownable.getInterface

Parameters
- contractInterface: ContractInterface
Returns Interface

Static isIndexed

isIndexed(value: any): value is Indexed

Inherited from Ownable.isIndexed

Parameters
- value: any
Returns value is Indexed

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressOrName: string

contractInterface: ContractInterface

Optional signerOrProvider: Signer | Provider

Returns EtherspotPaymaster

Properties

_deployedPromise

_runningEvents

Type declaration

[eventTag: string]: RunningEvent

_wrappedEmits

Type declaration

[eventTag: string]: (...args: Array<any>) => void

Parameters

Rest ...args: Array<any>

Returns void

Readonly address

callStatic

Type declaration

addBatchToWhitelist: function

Parameters

_accounts: PromiseOrValue<string>[]

Optional overrides: CallOverrides

Returns Promise<void>

addStake: function

Parameters

unstakeDelaySec: PromiseOrValue<BigNumberish>

Optional overrides: CallOverrides

Returns Promise<void>

addToWhitelist: function

Parameters

_account: PromiseOrValue<string>

Optional overrides: CallOverrides

Returns Promise<void>

check: function

Parameters

_sponsor: PromiseOrValue<string>

_account: PromiseOrValue<string>

Optional overrides: CallOverrides

Returns Promise<boolean>

depositFunds: function

Parameters

Optional overrides: CallOverrides

Returns Promise<void>

entryPoint: function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

getDeposit: function

Parameters

Optional overrides: CallOverrides

Returns Promise<BigNumber>

getHash: function

Parameters

userOp: UserOperationStruct

validUntil: PromiseOrValue<BigNumberish>

validAfter: PromiseOrValue<BigNumberish>

Optional overrides: CallOverrides

Returns Promise<string>

getSponsorBalance: function

Parameters

_sponsor: PromiseOrValue<string>

Optional overrides: CallOverrides

Returns Promise<BigNumber>

owner: function

Parameters

Optional overrides: CallOverrides

Returns Promise<string>

parsePaymasterAndData: function

Parameters

paymasterAndData: PromiseOrValue<BytesLike>

Optional overrides: CallOverrides

Returns Promise<[] & { signature: string; validAfter: number; validUntil: number }>