chore!: use single extended viem client (#13715)

Fixes #12254
Eliminates redundancy of passing 2 clients to a lot of classes, and just
passes one instead that can do both public & wallet actions.

---------

Co-authored-by: Santiago Palladino <[email protected]>

Author: spypsy

yarn-project/archiver/src/archiver/archiver.ts

@@ -7,7 +7,7 @@ import { RunningPromise, makeLoggingErrorHandler } from '@aztec/foundation/runni
 import { sleep } from '@aztec/foundation/sleep';
 import { count } from '@aztec/foundation/string';
 import { elapsed } from '@aztec/foundation/timer';
-import { InboxAbi } from '@aztec/l1-artifacts';
+import { InboxAbi, RollupAbi } from '@aztec/l1-artifacts';
 import {
   ContractClassRegisteredEvent,
   PrivateFunctionBroadcastedEvent,
@@ -531,7 +531,7 @@ export class Archiver extends EventEmitter implements ArchiveSource, Traceable {
 
       // TODO(md): Retrieve from blob sink then from consensus client, then from peers
       const retrievedBlocks = await retrieveBlocksFromRollup(
-        this.rollup.getContract(),
+        this.rollup.getContract() as GetContractReturnType<typeof RollupAbi, ViemPublicClient>,
         this.publicClient,
         this.blobSinkClient,
         searchStartBlock, // TODO(palla/reorg): If the L2 reorg was due to an L1 reorg, we need to start search earlier

yarn-project/aztec-faucet/src/faucet.ts

@@ -1,4 +1,4 @@
-import { type ViemPublicClient, type ViemWalletClient, createEthereumChain } from '@aztec/ethereum';
+import { type ExtendedViemWalletClient, createEthereumChain, createExtendedL1Client } from '@aztec/ethereum';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import { createLogger } from '@aztec/foundation/log';
 import { TestERC20Abi } from '@aztec/l1-artifacts';
@@ -10,12 +10,8 @@ import {
   type HttpTransport,
   type LocalAccount,
   type WalletClient,
-  createPublicClient,
-  createWalletClient,
-  fallback,
   getContract,
   parseEther,
-  http as viemHttp,
 } from 'viem';
 import { mnemonicToAccount } from 'viem/accounts';
 
@@ -27,8 +23,7 @@ type L1Asset = {
 };
 
 export class Faucet {
-  private walletClient: ViemWalletClient;
-  private publicClient: ViemPublicClient;
+  private l1Client: ExtendedViemWalletClient;
 
   private dripHistory = new Map<string, Map<string, number>>();
   private l1Assets = new Map<string, L1Asset>();
@@ -41,16 +36,7 @@ export class Faucet {
   ) {
     const chain = createEthereumChain(config.l1RpcUrls, config.l1ChainId);
 
-    this.walletClient = createWalletClient({
-      account: this.account,
-      chain: chain.chainInfo,
-      transport: fallback(chain.rpcUrls.map(url => viemHttp(url))),
-    });
-
-    this.publicClient = createPublicClient({
-      chain: chain.chainInfo,
-      transport: fallback(chain.rpcUrls.map(url => viemHttp(url))),
-    });
+    this.l1Client = createExtendedL1Client(config.l1RpcUrls, this.account, chain.chainInfo);
   }
 
   public static async create(config: FaucetConfig): Promise<Faucet> {
@@ -79,12 +65,12 @@ export class Faucet {
   public async sendEth(to: EthAddress): Promise<void> {
     this.checkThrottle(to, 'ETH');
 
-    const hash = await this.walletClient.sendTransaction({
+    const hash = await this.l1Client.sendTransaction({
       account: this.account,
       to: to.toString(),
       value: parseEther(this.config.ethAmount),
     });
-    await this.publicClient.waitForTransactionReceipt({ hash });
+    await this.l1Client.waitForTransactionReceipt({ hash });
 
     this.updateThrottle(to, 'ETH');
     this.log.info(`Sent ETH ${this.config.ethAmount} to ${to} in tx ${hash}`);
@@ -99,7 +85,7 @@ export class Faucet {
     this.checkThrottle(to, assetName);
 
     const hash = await asset.contract.write.mint([to.toString(), asset.amount]);
-    await this.publicClient.waitForTransactionReceipt({ hash });
+    await this.l1Client.waitForTransactionReceipt({ hash });
 
     this.updateThrottle(to, assetName);
 
@@ -110,7 +96,7 @@ export class Faucet {
     const contract = getContract({
       abi: TestERC20Abi,
       address: l1AssetConfig.address.toString(),
-      client: this.walletClient,
+      client: this.l1Client,
     });
 
     const [name, owner] = await Promise.all([contract.read.name(), contract.read.owner()]);

yarn-project/aztec.js/src/ethereum/portal_manager.ts

@@ -1,4 +1,4 @@
-import type { ViemPublicClient, ViemWalletClient } from '@aztec/ethereum';
+import type { ExtendedViemWalletClient, ViemContract } from '@aztec/ethereum';
 import { extractEvent } from '@aztec/ethereum/utils';
 import { sha256ToField } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
@@ -14,7 +14,7 @@ import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { computeSecretHash } from '@aztec/stdlib/hash';
 import type { PXE } from '@aztec/stdlib/interfaces/client';
 
-import { type GetContractReturnType, type Hex, getContract, toFunctionSelector } from 'viem';
+import { type Hex, getContract, toFunctionSelector } from 'viem';
 
 import type { Wallet } from '../index.js';
 
@@ -57,28 +57,27 @@ export async function generateClaimSecret(logger?: Logger): Promise<[Fr, Fr]> {
 
 /** Helper for managing an ERC20 on L1. */
 export class L1TokenManager {
-  private contract: GetContractReturnType<typeof TestERC20Abi, ViemWalletClient>;
-  private handler: GetContractReturnType<typeof FeeAssetHandlerAbi, ViemWalletClient> | undefined;
+  private contract: ViemContract<typeof TestERC20Abi>;
+  private handler: ViemContract<typeof FeeAssetHandlerAbi> | undefined;
 
   public constructor(
     /** Address of the ERC20 contract. */
     public readonly tokenAddress: EthAddress,
     /** Address of the handler/faucet contract. */
     public readonly handlerAddress: EthAddress | undefined,
-    private publicClient: ViemPublicClient,
-    private walletClient: ViemWalletClient,
+    private readonly extendedClient: ExtendedViemWalletClient,
     private logger: Logger,
   ) {
     this.contract = getContract({
       address: this.tokenAddress.toString(),
       abi: TestERC20Abi,
-      client: this.walletClient,
+      client: this.extendedClient,
     });
     if (this.handlerAddress) {
       this.handler = getContract({
         address: this.handlerAddress.toString(),
         abi: FeeAssetHandlerAbi,
-        client: this.walletClient,
+        client: this.extendedClient,
       });
     }
   }
@@ -124,7 +123,7 @@ export class L1TokenManager {
    */
   public async approve(amount: bigint, address: Hex, addressName = '') {
     this.logger.info(`Approving ${amount} tokens for ${stringifyEthAddress(address, addressName)}`);
-    await this.publicClient.waitForTransactionReceipt({
+    await this.extendedClient.waitForTransactionReceipt({
       hash: await this.contract.write.approve([address, amount]),
     });
   }
@@ -133,21 +132,20 @@ export class L1TokenManager {
 /** Helper for interacting with the FeeJuicePortal on L1. */
 export class L1FeeJuicePortalManager {
   private readonly tokenManager: L1TokenManager;
-  private readonly contract: GetContractReturnType<typeof FeeJuicePortalAbi, ViemWalletClient>;
+  private readonly contract: ViemContract<typeof FeeJuicePortalAbi>;
 
   constructor(
     portalAddress: EthAddress,
     tokenAddress: EthAddress,
     handlerAddress: EthAddress,
-    private readonly publicClient: ViemPublicClient,
-    private readonly walletClient: ViemWalletClient,
+    private readonly extendedClient: ExtendedViemWalletClient,
     private readonly logger: Logger,
   ) {
-    this.tokenManager = new L1TokenManager(tokenAddress, handlerAddress, publicClient, walletClient, logger);
+    this.tokenManager = new L1TokenManager(tokenAddress, handlerAddress, extendedClient, logger);
     this.contract = getContract({
       address: portalAddress.toString(),
       abi: FeeJuicePortalAbi,
-      client: this.walletClient,
+      client: extendedClient,
     });
   }
 
@@ -170,7 +168,7 @@ export class L1FeeJuicePortalManager {
       if (amountToBridge !== mintableAmount) {
         throw new Error(`Minting amount must be ${mintableAmount}`);
       }
-      await this.tokenManager.mint(this.walletClient.account.address);
+      await this.tokenManager.mint(this.extendedClient.account.address);
     }
 
     await this.tokenManager.approve(amountToBridge, this.contract.address, 'FeeJuice Portal');
@@ -180,7 +178,7 @@ export class L1FeeJuicePortalManager {
 
     await this.contract.simulate.depositToAztecPublic(args);
 
-    const txReceipt = await this.publicClient.waitForTransactionReceipt({
+    const txReceipt = await this.extendedClient.waitForTransactionReceipt({
       hash: await this.contract.write.depositToAztecPublic(args),
     });
 
@@ -210,14 +208,12 @@ export class L1FeeJuicePortalManager {
   /**
    * Creates a new instance
    * @param walletOrPxe - Wallet or PXE client used for retrieving the L1 contract addresses.
-   * @param publicClient - L1 public client.
-   * @param walletClient - L1 wallet client.
+   * @param extendedClient - Wallet client, extended with public actions.
    * @param logger - Logger.
    */
   public static async new(
     walletOrPxe: Wallet | PXE,
-    publicClient: ViemPublicClient,
-    walletClient: ViemWalletClient,
+    extendedClient: ExtendedViemWalletClient,
     logger: Logger,
   ): Promise<L1FeeJuicePortalManager> {
     const {
@@ -235,31 +231,29 @@ export class L1FeeJuicePortalManager {
       feeJuicePortalAddress,
       feeJuiceAddress,
       feeAssetHandlerAddress,
-      publicClient,
-      walletClient,
+      extendedClient,
       logger,
     );
   }
 }
 
 /** Helper for interacting with a test TokenPortal on L1 for sending tokens to L2. */
 export class L1ToL2TokenPortalManager {
-  protected readonly portal: GetContractReturnType<typeof TokenPortalAbi, ViemWalletClient>;
+  protected readonly portal: ViemContract<typeof TokenPortalAbi>;
   protected readonly tokenManager: L1TokenManager;
 
   constructor(
     portalAddress: EthAddress,
     tokenAddress: EthAddress,
     handlerAddress: EthAddress | undefined,
-    protected publicClient: ViemPublicClient,
-    protected walletClient: ViemWalletClient,
+    protected extendedClient: ExtendedViemWalletClient,
     protected logger: Logger,
   ) {
-    this.tokenManager = new L1TokenManager(tokenAddress, handlerAddress, publicClient, walletClient, logger);
+    this.tokenManager = new L1TokenManager(tokenAddress, handlerAddress, extendedClient, logger);
     this.portal = getContract({
       address: portalAddress.toString(),
       abi: TokenPortalAbi,
-      client: this.walletClient,
+      client: extendedClient,
     });
   }
 
@@ -284,8 +278,8 @@ export class L1ToL2TokenPortalManager {
       claimSecretHash.toString(),
     ]);
 
-    const txReceipt = await this.publicClient.waitForTransactionReceipt({
-      hash: await this.walletClient.writeContract(request),
+    const txReceipt = await this.extendedClient.waitForTransactionReceipt({
+      hash: await this.extendedClient.writeContract(request),
     });
 
     const log = extractEvent(
@@ -327,8 +321,8 @@ export class L1ToL2TokenPortalManager {
     this.logger.info('Sending L1 tokens to L2 to be claimed privately');
     const { request } = await this.portal.simulate.depositToAztecPrivate([amount, claimSecretHash.toString()]);
 
-    const txReceipt = await this.publicClient.waitForTransactionReceipt({
-      hash: await this.walletClient.writeContract(request),
+    const txReceipt = await this.extendedClient.waitForTransactionReceipt({
+      hash: await this.extendedClient.writeContract(request),
     });
 
     const log = extractEvent(
@@ -360,7 +354,7 @@ export class L1ToL2TokenPortalManager {
       if (amount !== mintableAmount) {
         throw new Error(`Minting amount must be ${mintableAmount} for testing`);
       }
-      await this.tokenManager.mint(this.walletClient.account.address);
+      await this.tokenManager.mint(this.extendedClient.account.address);
     }
     await this.tokenManager.approve(amount, this.portal.address, 'TokenPortal');
     return generateClaimSecret();
@@ -369,22 +363,21 @@ export class L1ToL2TokenPortalManager {
 
 /** Helper for interacting with a test TokenPortal on L1 for both withdrawing from and bridging to L2. */
 export class L1TokenPortalManager extends L1ToL2TokenPortalManager {
-  private readonly outbox: GetContractReturnType<typeof OutboxAbi, ViemWalletClient>;
+  private readonly outbox: ViemContract<typeof OutboxAbi>;
 
   constructor(
     portalAddress: EthAddress,
     tokenAddress: EthAddress,
     handlerAddress: EthAddress | undefined,
     outboxAddress: EthAddress,
-    publicClient: ViemPublicClient,
-    walletClient: ViemWalletClient,
+    extendedClient: ExtendedViemWalletClient,
     logger: Logger,
   ) {
-    super(portalAddress, tokenAddress, handlerAddress, publicClient, walletClient, logger);
+    super(portalAddress, tokenAddress, handlerAddress, extendedClient, logger);
     this.outbox = getContract({
       address: outboxAddress.toString(),
       abi: OutboxAbi,
-      client: walletClient,
+      client: extendedClient,
     });
   }
 
@@ -422,7 +415,9 @@ export class L1TokenPortalManager extends L1ToL2TokenPortalManager {
       siblingPath.toBufferArray().map((buf: Buffer): Hex => `0x${buf.toString('hex')}`),
     ]);
 
-    await this.publicClient.waitForTransactionReceipt({ hash: await this.walletClient.writeContract(withdrawRequest) });
+    await this.extendedClient.waitForTransactionReceipt({
+      hash: await this.extendedClient.writeContract(withdrawRequest),
+    });
 
     const isConsumedAfter = await this.outbox.read.hasMessageBeenConsumedAtBlockAndIndex([blockNumber, messageIndex]);
     if (!isConsumedAfter) {
@@ -455,7 +450,7 @@ export class L1TokenPortalManager extends L1ToL2TokenPortalManager {
       l2Bridge.toBuffer(),
       new Fr(version).toBuffer(), // aztec version
       EthAddress.fromString(this.portal.address).toBuffer32() ?? Buffer.alloc(32, 0),
-      new Fr(this.publicClient.chain.id).toBuffer(), // chain id
+      new Fr(this.extendedClient.chain.id).toBuffer(), // chain id
       content.toBuffer(),
     ]);
 

yarn-project/aztec.js/src/test/anvil_test_watcher.ts

@@ -1,4 +1,4 @@
-import type { ViemPublicClient } from '@aztec/ethereum';
+import type { ViemClient } from '@aztec/ethereum';
 import type { EthCheatCodes } from '@aztec/ethereum/eth-cheatcodes';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import { type Logger, createLogger } from '@aztec/foundation/log';
@@ -20,7 +20,7 @@ import { RollupCheatCodes } from './rollup_cheat_codes.js';
 export class AnvilTestWatcher {
   private isSandbox: boolean = false;
 
-  private rollup: GetContractReturnType<typeof RollupAbi, ViemPublicClient>;
+  private rollup: GetContractReturnType<typeof RollupAbi, ViemClient>;
   private rollupCheatCodes: RollupCheatCodes;
 
   private filledRunningPromise?: RunningPromise;
@@ -34,13 +34,13 @@ export class AnvilTestWatcher {
   constructor(
     private cheatcodes: EthCheatCodes,
     rollupAddress: EthAddress,
-    publicClient: ViemPublicClient,
+    l1Client: ViemClient,
     private dateProvider?: TestDateProvider,
   ) {
     this.rollup = getContract({
       address: getAddress(rollupAddress.toString()),
       abi: RollupAbi,
-      client: publicClient,
+      client: l1Client,
     });
 
     this.rollupCheatCodes = new RollupCheatCodes(this.cheatcodes, {