@tevm/voltaire / primitives/Paymaster

primitives/Paymaster

Type Aliases

PaymasterType

PaymasterType = Uint8Array & object

Defined in: src/primitives/Paymaster/PaymasterType.ts:13 Paymaster address type - ERC-4337 paymaster contract Paymasters sponsor gas fees for user operations, enabling gasless transactions or allowing users to pay gas in ERC-20 tokens.

Type Declaration

[brand]

readonly [brand]: "Paymaster"

See

https://eips.ethereum.org/EIPS/eip-4337
https://voltaire.tevm.sh/primitives/paymaster for Paymaster documentation

Since

0.0.0

Variables

Paymaster

const Paymaster: object

Defined in: src/primitives/Paymaster/index.ts:31

Type Declaration

equals()

equals: (paymaster1, paymaster2) => boolean

Parameters

paymaster1

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

paymaster2

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

boolean

from()

from: (value) => PaymasterType

Create Paymaster from address input

Parameters

value

Address value string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

PaymasterType Paymaster address

Throws

If address format is invalid

Example

const paymaster = Paymaster.from("0x742d35Cc6634C0532925a3b844Bc9e7595f251e3");

toHex()

toHex: (paymaster) => string

Parameters

paymaster

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

string

Functions

_equals()

_equals(a, b): boolean

Defined in: src/primitives/Paymaster/equals.js:15 Check if two Paymaster addresses are equal

Parameters

a

PaymasterType First Paymaster

b

PaymasterType Second Paymaster

Returns

boolean True if addresses are equal

Example

const isEqual = Paymaster.equals(paymaster1, paymaster2);

_toHex()

_toHex(paymaster): string

Defined in: src/primitives/Paymaster/toHex.js:15 Convert Paymaster to hex string

Parameters

paymaster

PaymasterType Paymaster address

Returns

string Hex string (0x-prefixed)

Example

const hex = Paymaster.toHex(paymaster);
console.log(hex); // "0x742d35cc6634c0532925a3b844bc9e7595f251e3"

equals()

equals(paymaster1, paymaster2): boolean

Defined in: src/primitives/Paymaster/index.ts:20

Parameters

paymaster1

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

paymaster2

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

boolean

from()

from(value): PaymasterType

Defined in: src/primitives/Paymaster/from.js:15 Create Paymaster from address input

Parameters

value

Address value string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

PaymasterType Paymaster address

Throws

If address format is invalid

Example

const paymaster = Paymaster.from("0x742d35Cc6634C0532925a3b844Bc9e7595f251e3");

toHex()

toHex(paymaster): string

Defined in: src/primitives/Paymaster/index.ts:14

Parameters

paymaster

string | number | bigint | Uint8Array<ArrayBufferLike> | AddressType

Returns

string

primitives/PackedUserOperation primitives/PeerId

​primitives/Paymaster

​Type Aliases

​PaymasterType

​Type Declaration

[brand]

​See

​Since

​Variables

​Paymaster

​Type Declaration

equals()

Parameters

paymaster1

paymaster2

Returns

from()

Parameters

value

Returns

Throws

Example

toHex()

Parameters

paymaster

Returns

​Functions

​_equals()

​Parameters

a

b

​Returns

​Example

​_toHex()

​Parameters

paymaster

​Returns

​Example

​equals()

​Parameters

paymaster1

paymaster2

​Returns

​from()

​Parameters

value

​Returns

​Throws

​Example

​toHex()

​Parameters

paymaster

​Returns

primitives/Paymaster

Type Aliases

PaymasterType

Type Declaration

See

Since

Variables

Paymaster

Type Declaration

Functions

_equals()

Parameters

Returns

Example

_toHex()

Parameters

Returns

Example

equals()

Parameters

Returns

from()

Parameters

Returns

Throws

Example

toHex()

Parameters

Returns