@aztec/sequencer-client 0.0.0-test.0 → 0.0.1-commit.03f7ef2

package/src/publisher/sequencer-publisher-factory.ts

@@ -0,0 +1,92 @@
+import { EthAddress } from '@aztec/aztec.js/addresses';
+import { type Logger, createLogger } from '@aztec/aztec.js/log';
+import type { BlobClientInterface } from '@aztec/blob-client/client';
+import type { EpochCache } from '@aztec/epoch-cache';
+import type { GovernanceProposerContract, RollupContract } from '@aztec/ethereum/contracts';
+import type { L1TxUtilsWithBlobs } from '@aztec/ethereum/l1-tx-utils-with-blobs';
+import type { PublisherFilter, PublisherManager } from '@aztec/ethereum/publisher-manager';
+import { SlotNumber } from '@aztec/foundation/branded-types';
+import type { DateProvider } from '@aztec/foundation/timer';
+import type { SlashFactoryContract } from '@aztec/stdlib/l1-contracts';
+import type { TelemetryClient } from '@aztec/telemetry-client';
+import { NodeKeystoreAdapter } from '@aztec/validator-client';
+
+import type { SequencerClientConfig } from '../config.js';
+import { SequencerPublisherMetrics } from './sequencer-publisher-metrics.js';
+import { type Action, SequencerPublisher } from './sequencer-publisher.js';
+
+export type AttestorPublisherPair = {
+  attestorAddress: EthAddress;
+  publisher: SequencerPublisher;
+};
+
+export class SequencerPublisherFactory {
+  private publisherMetrics: SequencerPublisherMetrics;
+
+  /** Stores the last slot in which every action was carried out by a publisher */
+  private lastActions: Partial<Record<Action, SlotNumber>> = {};
+
+  private logger: Logger;
+
+  constructor(
+    private sequencerConfig: SequencerClientConfig,
+    private deps: {
+      telemetry: TelemetryClient;
+      publisherManager: PublisherManager<L1TxUtilsWithBlobs>;
+      blobClient?: BlobClientInterface;
+      dateProvider: DateProvider;
+      epochCache: EpochCache;
+      rollupContract: RollupContract;
+      governanceProposerContract: GovernanceProposerContract;
+      slashFactoryContract: SlashFactoryContract;
+      nodeKeyStore: NodeKeystoreAdapter;
+      logger?: Logger;
+    },
+  ) {
+    this.publisherMetrics = new SequencerPublisherMetrics(deps.telemetry, 'SequencerPublisher');
+    this.logger = deps.logger ?? createLogger('sequencer');
+  }
+  /**
+   * Creates a new SequencerPublisher instance.
+   * @param _validatorAddress - The address of the validator that will be using the publisher.
+   * @returns A new SequencerPublisher instance.
+   */
+  public async create(validatorAddress?: EthAddress): Promise<AttestorPublisherPair> {
+    // If we have been given an attestor address we must only allow publishers permitted for that attestor
+
+    const allowedPublishers = !validatorAddress ? [] : this.deps.nodeKeyStore.getPublisherAddresses(validatorAddress);
+    const filter: PublisherFilter<L1TxUtilsWithBlobs> = !validatorAddress
+      ? () => true
+      : (utils: L1TxUtilsWithBlobs) => {
+          const publisherAddress = utils.getSenderAddress();
+          return allowedPublishers.some(allowedPublisher => allowedPublisher.equals(publisherAddress));
+        };
+
+    const l1Publisher = await this.deps.publisherManager.getAvailablePublisher(filter);
+    const attestorAddress =
+      validatorAddress ?? this.deps.nodeKeyStore.getAttestorForPublisher(l1Publisher.getSenderAddress());
+
+    const rollup = this.deps.rollupContract;
+    const slashingProposerContract = await rollup.getSlashingProposer();
+
+    const publisher = new SequencerPublisher(this.sequencerConfig, {
+      l1TxUtils: l1Publisher,
+      telemetry: this.deps.telemetry,
+      blobClient: this.deps.blobClient,
+      rollupContract: this.deps.rollupContract,
+      epochCache: this.deps.epochCache,
+      governanceProposerContract: this.deps.governanceProposerContract,
+      slashingProposerContract,
+      slashFactoryContract: this.deps.slashFactoryContract,
+      dateProvider: this.deps.dateProvider,
+      metrics: this.publisherMetrics,
+      lastActions: this.lastActions,
+      log: this.logger.createChild('publisher'),
+    });
+
+    return {
+      attestorAddress,
+      publisher,
+    };
+  }
+}

package/src/publisher/sequencer-publisher-metrics.ts

@@ -1,5 +1,5 @@
-import { createLogger } from '@aztec/aztec.js';
-import type { L1PublishBlockStats, L1PublishStats } from '@aztec/stdlib/stats';
+import { createLogger } from '@aztec/aztec.js/log';
+import type { L1PublishCheckpointStats, L1PublishStats } from '@aztec/stdlib/stats';
 import {
   Attributes,
   type Gauge,
@@ -24,6 +24,7 @@ export class SequencerPublisherMetrics {
   private txCalldataGas: Histogram;
   private txBlobDataGasUsed: Histogram;
   private txBlobDataGasCost: Histogram;
+  private txTotalFee: Histogram;
 
   private readonly blobCountHistogram: Histogram;
   private readonly blobInclusionBlocksHistogram: Histogram;
@@ -105,6 +106,17 @@ export class SequencerPublisherMetrics {
       description: 'Number of failed L1 transactions with blobs',
     });
 
+    this.txTotalFee = meter.createHistogram(Metrics.L1_PUBLISHER_TX_TOTAL_FEE, {
+      description: 'How much L1 tx costs',
+      unit: 'eth',
+      valueType: ValueType.DOUBLE,
+      advice: {
+        explicitBucketBoundaries: [
+          0.001, 0.002, 0.004, 0.008, 0.01, 0.02, 0.04, 0.08, 0.1, 0.2, 0.4, 0.8, 1, 1.2, 1.4, 1.8, 2,
+        ],
+      },
+    });
+
     this.senderBalance = meter.createGauge(Metrics.L1_PUBLISHER_BALANCE, {
       unit: 'eth',
       description: 'The balance of the sender address',
@@ -123,7 +135,7 @@ export class SequencerPublisherMetrics {
     }
   }
 
-  recordProcessBlockTx(durationMs: number, stats: L1PublishBlockStats) {
+  recordProcessBlockTx(durationMs: number, stats: L1PublishCheckpointStats) {
     this.recordTx('process', durationMs, stats);
 
     if (stats.blobCount && stats.blobCount > 0) {
@@ -169,7 +181,17 @@ export class SequencerPublisherMetrics {
 
     try {
       this.gasPrice.record(parseInt(formatEther(stats.gasPrice, 'gwei'), 10));
-    } catch (e) {
+    } catch {
+      // ignore
+    }
+
+    const executionFee = stats.gasUsed * stats.gasPrice;
+    const blobFee = stats.blobGasUsed * stats.blobDataGas;
+    const totalFee = executionFee + blobFee;
+
+    try {
+      this.txTotalFee.record(parseFloat(formatEther(totalFee)));
+    } catch {
       // ignore
     }
   }