Skip to content

UserClientConfig.md

Latest commit

 

History

History
167 lines (88 loc) · 5.4 KB

UserClientConfig.md

File metadata and controls

167 lines (88 loc) · 5.4 KB
Raw

Defined in: packages/enduser/src/UserClient.ts:6

Base configuration for all L2 Business Clients

Extends

Properties

accountAddress

accountAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:7

bundlerClient?

optional bundlerClient: any

Defined in: packages/enduser/src/UserClient.ts:14

client

client: WalletClient

Defined in: packages/core/src/clients/types.ts:12

Viem WalletClient for write operations. Must have an account attached.

Inherited from

ClientConfig.client

entryPointAddress?

optional entryPointAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:9

Overrides

ClientConfig.entryPointAddress

ethUsdPriceFeedAddress?

optional ethUsdPriceFeedAddress: `0x${string}`

Defined in: packages/core/src/clients/types.ts:46

Inherited from

ClientConfig.ethUsdPriceFeedAddress

gTokenAddress?

optional gTokenAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:13

GToken contract address. Required for operations involving token approvals and transfers.

Overrides

ClientConfig.gTokenAddress

gTokenStakingAddress?

optional gTokenStakingAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:11

GTokenStaking contract address. Required for role registration that involves staking.

Overrides

ClientConfig.gTokenStakingAddress

paymasterFactoryAddress?

optional paymasterFactoryAddress: `0x${string}`

Defined in: packages/core/src/clients/types.ts:44

PaymasterFactory contract address. Required for deploying new PaymasterV4 instances.

Inherited from

ClientConfig.paymasterFactoryAddress

publicClient?

optional publicClient: PublicClient

Defined in: packages/core/src/clients/types.ts:20

Optional PublicClient for read operations. If not provided, one will be derived from the WalletClient or created internally if possible (but usually explicit is better). Currently L1 actions use PublicClient | WalletClient, so WalletClient is enough for both if it has a provider. However, explicitly accepting PublicClient encourages separation.

Inherited from

ClientConfig.publicClient

registryAddress?

optional registryAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:12

Registry contract address. Essential for looking up other contracts if not provided explicitly.

Overrides

ClientConfig.registryAddress

sbtAddress?

optional sbtAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:8

superPaymasterAddress?

optional superPaymasterAddress: `0x${string}`

Defined in: packages/enduser/src/UserClient.ts:10

xpntsFactoryAddress?

optional xpntsFactoryAddress: `0x${string}`

Defined in: packages/core/src/clients/types.ts:45

Inherited from

ClientConfig.xpntsFactoryAddress