Skip to main content

Documentation Index

Fetch the complete documentation index at: https://voltaire.tevm.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
Paymaster

Paymaster is a branded Address type representing an ERC-4337 paymaster contract. Paymasters sponsor gas fees for user operations, enabling gasless transactions or allowing users to pay gas in ERC-20 tokens.

​
Quick Start

import { Paymaster } from '@tevm/voltaire/primitives/Paymaster';

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

// Convert to hex
console.log(Paymaster.toHex(paymaster));
// "0x742d35cc6634c0532925a3b844bc9e7595f251e3"

// Compare addresses
const same = Paymaster.equals(paymaster, "0x742d35Cc...");

​
Type Definition

import type { AddressType } from '../Address/AddressType.js';
import type { brand } from '../../brand.js';

export type PaymasterType = AddressType & { readonly [brand]: "Paymaster" };

​
API Reference

​
from

Create Paymaster from address input. 
function from(
  value: number | bigint | string | Uint8Array | AddressType
): PaymasterType

​
toHex

Convert Paymaster to hex string. 
function toHex(
  paymaster: number | bigint | string | Uint8Array | AddressType
): string

​
equals

Check if two Paymaster addresses are equal. 
function equals(
  paymaster1: number | bigint | string | Uint8Array | AddressType,
  paymaster2: number | bigint | string | Uint8Array | AddressType
): boolean

​
Paymaster Functionality

Paymasters enable:
  1. Gasless transactions: Sponsor user gas fees completely
  2. Token payment: Users pay gas in ERC-20 tokens
  3. Conditional sponsorship: Rules-based gas sponsorship
  4. Rate limiting: Control spending per account/time period

​
Usage with User Operations

import { UserOperation } from '@tevm/voltaire/primitives/UserOperation';
import { Paymaster } from '@tevm/voltaire/primitives/Paymaster';

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

// paymasterAndData format: paymaster (20 bytes) + paymasterData (variable)
const paymasterAndData = new Uint8Array([
  ...paymasterAddr,
  // ...paymasterData (paymaster-specific data)
]);

const userOp = UserOperation.from({
  sender: "0x...",
  nonce: 0n,
  // ... other fields
  paymasterAndData,
  signature: "0x",
});

​
References