Skip to content

ProtocolClientConfig.md

Latest commit

 

History

History
159 lines (84 loc) · 4.41 KB

ProtocolClientConfig.md

File metadata and controls

159 lines (84 loc) · 4.41 KB
Raw

Defined in: operator/src/ProtocolClient.ts:5

Base configuration for all L2 Business Clients

Extends

Properties

blsAggregatorAddress?

optional blsAggregatorAddress: `0x${string}`

Defined in: operator/src/ProtocolClient.ts:7

client

client: WalletClient

Defined in: core/dist/clients/types.d.ts:11

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

Inherited from

ClientConfig.client

dvtValidatorAddress

dvtValidatorAddress: `0x${string}`

Defined in: operator/src/ProtocolClient.ts:6

entryPointAddress?

optional entryPointAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:41

Inherited from

ClientConfig.entryPointAddress

ethUsdPriceFeedAddress?

optional ethUsdPriceFeedAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:40

Inherited from

ClientConfig.ethUsdPriceFeedAddress

gTokenAddress?

optional gTokenAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:28

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

Inherited from

ClientConfig.gTokenAddress

gTokenStakingAddress?

optional gTokenStakingAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:33

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

Inherited from

ClientConfig.gTokenStakingAddress

paymasterFactoryAddress?

optional paymasterFactoryAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:38

PaymasterFactory contract address. Required for deploying new PaymasterV4 instances.

Inherited from

ClientConfig.paymasterFactoryAddress

publicClient?

optional publicClient: PublicClient

Defined in: core/dist/clients/types.d.ts:18

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: core/dist/clients/types.d.ts:23

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

Inherited from

ClientConfig.registryAddress

superPaymasterAddress?

optional superPaymasterAddress: `0x${string}`

Defined in: operator/src/ProtocolClient.ts:8

xpntsFactoryAddress?

optional xpntsFactoryAddress: `0x${string}`

Defined in: core/dist/clients/types.d.ts:39

Inherited from

ClientConfig.xpntsFactoryAddress