@aztec/sequencer-client 0.72.1 → 0.74.0

package/src/client/sequencer-client.ts

@@ -1,8 +1,19 @@
 import { type BlobSinkClientInterface } from '@aztec/blob-sink/client';
 import { type L1ToL2MessageSource, type L2BlockSource, type WorldStateSynchronizer } from '@aztec/circuit-types';
-import { type ContractDataSource } from '@aztec/circuits.js';
-import { isAnvilTestChain } from '@aztec/ethereum';
-import { type EthAddress } from '@aztec/foundation/eth-address';
+import { type AztecAddress, type ContractDataSource } from '@aztec/circuits.js';
+import { EpochCache } from '@aztec/epoch-cache';
+import {
+  ForwarderContract,
+  GovernanceProposerContract,
+  L1TxUtilsWithBlobs,
+  RollupContract,
+  SlashingProposerContract,
+  createEthereumChain,
+  createL1Clients,
+  isAnvilTestChain,
+} from '@aztec/ethereum';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { createLogger } from '@aztec/foundation/log';
 import { type DateProvider } from '@aztec/foundation/timer';
 import { type P2P } from '@aztec/p2p';
 import { LightweightBlockBuilderFactory } from '@aztec/prover-client/block-builder';
@@ -12,7 +23,7 @@ import { type ValidatorClient } from '@aztec/validator-client';
 
 import { type SequencerClientConfig } from '../config.js';
 import { GlobalVariableBuilder } from '../global_variable_builder/index.js';
-import { L1Publisher } from '../publisher/index.js';
+import { SequencerPublisher } from '../publisher/index.js';
 import { Sequencer, type SequencerConfig } from '../sequencer/index.js';
 import { type SlasherClient } from '../slasher/index.js';
 
@@ -46,9 +57,11 @@ export class SequencerClient {
       l2BlockSource: L2BlockSource;
       l1ToL2MessageSource: L1ToL2MessageSource;
       telemetry: TelemetryClient;
-      publisher?: L1Publisher;
+      publisher?: SequencerPublisher;
       blobSinkClient?: BlobSinkClientInterface;
       dateProvider: DateProvider;
+      epochCache?: EpochCache;
+      l1TxUtils?: L1TxUtilsWithBlobs;
     },
   ) {
     const {
@@ -61,18 +74,68 @@ export class SequencerClient {
       l1ToL2MessageSource,
       telemetry: telemetryClient,
     } = deps;
+    const { l1RpcUrl: rpcUrl, l1ChainId: chainId, publisherPrivateKey } = config;
+    const chain = createEthereumChain(rpcUrl, chainId);
+    const log = createLogger('sequencer-client');
+    const { publicClient, walletClient } = createL1Clients(rpcUrl, publisherPrivateKey, chain.chainInfo);
+    const l1TxUtils = deps.l1TxUtils ?? new L1TxUtilsWithBlobs(publicClient, walletClient, log, config);
+    const rollupContract = new RollupContract(publicClient, config.l1Contracts.rollupAddress.toString());
+    const [l1GenesisTime, slotDuration] = await Promise.all([
+      rollupContract.getL1GenesisTime(),
+      rollupContract.getSlotDuration(),
+    ] as const);
+    const forwarderContract =
+      config.customForwarderContractAddress && config.customForwarderContractAddress !== EthAddress.ZERO
+        ? new ForwarderContract(
+            publicClient,
+            config.customForwarderContractAddress.toString(),
+            config.l1Contracts.rollupAddress.toString(),
+          )
+        : await ForwarderContract.create(
+            walletClient.account.address,
+            walletClient,
+            publicClient,
+            log,
+            config.l1Contracts.rollupAddress.toString(),
+          );
+
+    const governanceProposerContract = new GovernanceProposerContract(
+      publicClient,
+      config.l1Contracts.governanceProposerAddress.toString(),
+    );
+    const slashingProposerAddress = await rollupContract.getSlashingProposerAddress();
+    const slashingProposerContract = new SlashingProposerContract(publicClient, slashingProposerAddress.toString());
+    const epochCache =
+      deps.epochCache ??
+      (await EpochCache.create(
+        config.l1Contracts.rollupAddress,
+        {
+          l1RpcUrl: rpcUrl,
+          l1ChainId: chainId,
+          viemPollingIntervalMS: config.viemPollingIntervalMS,
+          aztecSlotDuration: config.aztecSlotDuration,
+          ethereumSlotDuration: config.ethereumSlotDuration,
+          aztecEpochDuration: config.aztecEpochDuration,
+        },
+        { dateProvider: deps.dateProvider },
+      ));
+
     const publisher =
-      deps.publisher ?? new L1Publisher(config, { telemetry: telemetryClient, blobSinkClient: deps.blobSinkClient });
+      deps.publisher ??
+      new SequencerPublisher(config, {
+        l1TxUtils,
+        telemetry: telemetryClient,
+        blobSinkClient: deps.blobSinkClient,
+        rollupContract,
+        epochCache,
+        forwarderContract,
+        governanceProposerContract,
+        slashingProposerContract,
+      });
     const globalsBuilder = new GlobalVariableBuilder(config);
 
     const publicProcessorFactory = new PublicProcessorFactory(contractDataSource, deps.dateProvider, telemetryClient);
 
-    const rollup = publisher.getRollupContract();
-    const [l1GenesisTime, slotDuration] = await Promise.all([
-      rollup.read.GENESIS_TIME(),
-      rollup.read.SLOT_DURATION(),
-    ] as const);
-
     const ethereumSlotDuration = config.ethereumSlotDuration;
 
     // When running in anvil, assume we can post a tx up until the very last second of an L1 slot.
@@ -117,7 +180,7 @@ export class SequencerClient {
    * @param config - New parameters.
    */
   public updateSequencerConfig(config: SequencerConfig) {
-    this.sequencer.updateConfig(config);
+    return this.sequencer.updateConfig(config);
   }
 
   /**
@@ -143,7 +206,11 @@ export class SequencerClient {
     return this.sequencer.coinbase;
   }
 
-  get feeRecipient() {
+  get feeRecipient(): AztecAddress {
     return this.sequencer.feeRecipient;
   }
+
+  get forwarderAddress(): EthAddress {
+    return this.sequencer.getForwarderAddress();
+  }
 }

package/src/config.ts

@@ -11,8 +11,8 @@ import {
   booleanConfigHelper,
   getConfigFromMappings,
   numberConfigHelper,
+  pickConfigMappings,
 } from '@aztec/foundation/config';
-import { pickConfigMappings } from '@aztec/foundation/config';
 import { EthAddress } from '@aztec/foundation/eth-address';
 
 import {
@@ -41,7 +41,7 @@ export type SequencerClientConfig = PublisherConfig &
   SequencerConfig &
   L1ReaderConfig &
   ChainConfig &
-  Pick<L1ContractsConfig, 'ethereumSlotDuration'>;
+  Pick<L1ContractsConfig, 'ethereumSlotDuration' | 'aztecSlotDuration' | 'aztecEpochDuration'>;
 
 export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
   transactionPollingIntervalMS: {
@@ -138,7 +138,7 @@ export const sequencerClientConfigMappings: ConfigMappingsType<SequencerClientCo
   ...getTxSenderConfigMappings('SEQ'),
   ...getPublisherConfigMappings('SEQ'),
   ...chainConfigMappings,
-  ...pickConfigMappings(l1ContractsConfigMappings, ['ethereumSlotDuration']),
+  ...pickConfigMappings(l1ContractsConfigMappings, ['ethereumSlotDuration', 'aztecSlotDuration', 'aztecEpochDuration']),
 };
 
 /**

package/src/publisher/config.ts

@@ -1,5 +1,6 @@
 import { type L1ReaderConfig, type L1TxUtilsConfig, NULL_KEY, l1TxUtilsConfigMappings } from '@aztec/ethereum';
 import { type ConfigMappingsType, getConfigFromMappings, numberConfigHelper } from '@aztec/foundation/config';
+import { EthAddress } from '@aztec/foundation/eth-address';
 
 /**
  * The configuration of the rollup transaction publisher.
@@ -14,6 +15,11 @@ export type TxSenderConfig = L1ReaderConfig & {
    * The number of confirmations required.
    */
   requiredConfirmations: number;
+
+  /**
+   * The address of the custom forwarder contract.
+   */
+  customForwarderContractAddress: EthAddress;
 };
 
 /**
@@ -44,6 +50,12 @@ export const getTxSenderConfigMappings: (
     defaultValue: 31337,
     description: 'The chain ID of the ethereum host.',
   },
+  customForwarderContractAddress: {
+    env: `CUSTOM_FORWARDER_CONTRACT_ADDRESS`,
+    parseEnv: (val: string) => EthAddress.fromString(val),
+    description: 'The address of the custom forwarder contract.',
+    defaultValue: EthAddress.ZERO,
+  },
   publisherPrivateKey: {
     env: `${scope}_PUBLISHER_PRIVATE_KEY`,
     description: 'The private key to be used by the publisher.',
@@ -78,7 +90,7 @@ export const getPublisherConfigMappings: (
   },
   ...l1TxUtilsConfigMappings,
   blobSinkUrl: {
-    env: `${scope}_BLOB_SINK_URL`,
+    env: 'BLOB_SINK_URL',
     description: 'The URL of the blob sink.',
     parseEnv: (val?: string) => val,
   },

package/src/publisher/index.ts

@@ -1 +1 @@
-export { L1Publisher, L1SubmitEpochProofArgs } from './l1-publisher.js';
+export { SequencerPublisher } from './sequencer-publisher.js';

package/src/publisher/{l1-publisher-metrics.ts → sequencer-publisher-metrics.ts}

@@ -12,7 +12,7 @@ import { formatEther } from 'viem/utils';
 
 export type L1TxType = 'submitProof' | 'process' | 'claimEpochProofRight';
 
-export class L1PublisherMetrics {
+export class SequencerPublisherMetrics {
   private gasPrice: Histogram;
 
   private txCount: UpDownCounter;
@@ -23,7 +23,12 @@ export class L1PublisherMetrics {
   private txBlobDataGasUsed: Histogram;
   private txBlobDataGasCost: Histogram;
 
-  constructor(client: TelemetryClient, name = 'L1Publisher') {
+  private readonly blobCountHistogram: Histogram;
+  private readonly blobInclusionBlocksHistogram: Histogram;
+  private readonly blobTxSuccessCounter: UpDownCounter;
+  private readonly blobTxFailureCounter: UpDownCounter;
+
+  constructor(client: TelemetryClient, name = 'SequencerPublisher') {
     const meter = client.getMeter(name);
 
     this.gasPrice = meter.createHistogram(Metrics.L1_PUBLISHER_GAS_PRICE, {
@@ -71,6 +76,26 @@ export class L1PublisherMetrics {
       unit: 'gwei',
       valueType: ValueType.INT,
     });
+
+    this.blobCountHistogram = meter.createHistogram(Metrics.L1_PUBLISHER_BLOB_COUNT, {
+      description: 'Number of blobs in L1 transactions',
+      unit: 'blobs',
+      valueType: ValueType.INT,
+    });
+
+    this.blobInclusionBlocksHistogram = meter.createHistogram(Metrics.L1_PUBLISHER_BLOB_INCLUSION_BLOCKS, {
+      description: 'Number of L1 blocks between blob tx submission and inclusion',
+      unit: 'blocks',
+      valueType: ValueType.INT,
+    });
+
+    this.blobTxSuccessCounter = meter.createUpDownCounter(Metrics.L1_PUBLISHER_BLOB_TX_SUCCESS, {
+      description: 'Number of successful L1 transactions with blobs',
+    });
+
+    this.blobTxFailureCounter = meter.createUpDownCounter(Metrics.L1_PUBLISHER_BLOB_TX_FAILURE, {
+      description: 'Number of failed L1 transactions with blobs',
+    });
   }
 
   recordFailedTx(txType: L1TxType) {
@@ -78,6 +103,10 @@ export class L1PublisherMetrics {
       [Attributes.L1_TX_TYPE]: txType,
       [Attributes.OK]: false,
     });
+
+    if (txType === 'process') {
+      this.blobTxFailureCounter.add(1);
+    }
   }
 
   recordSubmitProof(durationMs: number, stats: L1PublishProofStats) {
@@ -86,6 +115,16 @@ export class L1PublisherMetrics {
 
   recordProcessBlockTx(durationMs: number, stats: L1PublishBlockStats) {
     this.recordTx('process', durationMs, stats);
+
+    if (stats.blobCount && stats.blobCount > 0) {
+      this.blobCountHistogram.record(stats.blobCount);
+
+      if (stats.inclusionBlocks !== undefined) {
+        this.blobInclusionBlocksHistogram.record(stats.inclusionBlocks);
+      }
+
+      this.blobTxSuccessCounter.add(1);
+    }
   }
 
   recordClaimEpochProofRightTx(durationMs: number, stats: L1PublishStats) {