@aztec/sequencer-client 0.0.0-test.1 → 0.0.1-commit.5476d83

package/src/global_variable_builder/global_builder.ts

@@ -1,29 +1,35 @@
 import {
   type L1ContractsConfig,
   type L1ReaderConfig,
+  RollupContract,
   type ViemPublicClient,
   createEthereumChain,
 } from '@aztec/ethereum';
+import { SlotNumber } from '@aztec/foundation/branded-types';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { createLogger } from '@aztec/foundation/log';
-import { RollupAbi } from '@aztec/l1-artifacts';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { GasFees } from '@aztec/stdlib/gas';
 import type { GlobalVariableBuilder as GlobalVariableBuilderInterface } from '@aztec/stdlib/tx';
 import { GlobalVariables } from '@aztec/stdlib/tx';
 
-import { type GetContractReturnType, createPublicClient, fallback, getAddress, getContract, http } from 'viem';
+import { createPublicClient, fallback, http } from 'viem';
 
 /**
  * Simple global variables builder.
  */
 export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
   private log = createLogger('sequencer:global_variable_builder');
+  private currentBaseFees: Promise<GasFees> = Promise.resolve(new GasFees(0, 0));
+  private currentL1BlockNumber: bigint | undefined = undefined;
 
-  private rollupContract: GetContractReturnType<typeof RollupAbi, ViemPublicClient>;
-  private publicClient: ViemPublicClient;
-  private ethereumSlotDuration: number;
+  private readonly rollupContract: RollupContract;
+  private readonly publicClient: ViemPublicClient;
+  private readonly ethereumSlotDuration: number;
+
+  private chainId?: Fr;
+  private version?: Fr;
 
   constructor(config: L1ReaderConfig & Pick<L1ContractsConfig, 'ethereumSlotDuration'>) {
     const { l1RpcUrls, l1ChainId: chainId, l1Contracts } = config;
@@ -38,28 +44,48 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
       pollingInterval: config.viemPollingIntervalMS,
     });
 
-    this.rollupContract = getContract({
-      address: getAddress(l1Contracts.rollupAddress.toString()),
-      abi: RollupAbi,
-      client: this.publicClient,
-    });
+    this.rollupContract = new RollupContract(this.publicClient, l1Contracts.rollupAddress);
   }
 
   /**
    * Computes the "current" base fees, e.g., the price that you currently should pay to get include in the next block
-   * @returns Base fees for the expected next block
+   * @returns Base fees for the next block
    */
-  public async getCurrentBaseFees(): Promise<GasFees> {
+  private async computeCurrentBaseFees(): Promise<GasFees> {
     // Since this might be called in the middle of a slot where a block might have been published,
     // we need to fetch the last block written, and estimate the earliest timestamp for the next block.
     // The timestamp of that last block will act as a lower bound for the next block.
 
-    const lastBlock = await this.rollupContract.read.getBlock([await this.rollupContract.read.getPendingBlockNumber()]);
-    const earliestTimestamp = await this.rollupContract.read.getTimestampForSlot([lastBlock.slotNumber + 1n]);
+    const lastBlock = await this.rollupContract.getCheckpoint(await this.rollupContract.getCheckpointNumber());
+    const earliestTimestamp = await this.rollupContract.getTimestampForSlot(
+      SlotNumber.fromBigInt(lastBlock.slotNumber + 1n),
+    );
     const nextEthTimestamp = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(this.ethereumSlotDuration));
     const timestamp = earliestTimestamp > nextEthTimestamp ? earliestTimestamp : nextEthTimestamp;
 
-    return new GasFees(Fr.ZERO, new Fr(await this.rollupContract.read.getManaBaseFeeAt([timestamp, true])));
+    return new GasFees(0, await this.rollupContract.getManaBaseFeeAt(timestamp, true));
+  }
+
+  public async getCurrentBaseFees(): Promise<GasFees> {
+    // Get the current block number
+    const blockNumber = await this.publicClient.getBlockNumber();
+
+    // If the L1 block number has changed then chain a new promise to get the current base fees
+    if (this.currentL1BlockNumber === undefined || blockNumber > this.currentL1BlockNumber) {
+      this.currentL1BlockNumber = blockNumber;
+      this.currentBaseFees = this.currentBaseFees.then(() => this.computeCurrentBaseFees());
+    }
+    return this.currentBaseFees;
+  }
+
+  public async getGlobalConstantVariables(): Promise<Pick<GlobalVariables, 'chainId' | 'version'>> {
+    if (!this.chainId) {
+      this.chainId = new Fr(this.publicClient.chain.id);
+    }
+    if (!this.version) {
+      this.version = new Fr(await this.rollupContract.getVersion());
+    }
+    return { chainId: this.chainId, version: this.version };
   }
 
   /**
@@ -71,33 +97,32 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
    * @returns The global variables for the given block number.
    */
   public async buildGlobalVariables(
-    blockNumber: Fr,
+    blockNumber: number,
     coinbase: EthAddress,
     feeRecipient: AztecAddress,
-    slotNumber?: bigint,
+    slotNumber?: SlotNumber,
   ): Promise<GlobalVariables> {
-    const version = new Fr(await this.rollupContract.read.getVersion());
-    const chainId = new Fr(this.publicClient.chain.id);
+    const { chainId, version } = await this.getGlobalConstantVariables();
 
+    let slot: SlotNumber;
     if (slotNumber === undefined) {
       const ts = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(this.ethereumSlotDuration));
-      slotNumber = await this.rollupContract.read.getSlotAt([ts]);
+      slot = await this.rollupContract.getSlotAt(ts);
+    } else {
+      slot = slotNumber;
     }
 
-    const timestamp = await this.rollupContract.read.getTimestampForSlot([slotNumber]);
-
-    const slotFr = new Fr(slotNumber);
-    const timestampFr = new Fr(timestamp);
+    const timestamp = await this.rollupContract.getTimestampForSlot(slot);
 
     // We can skip much of the logic in getCurrentBaseFees since it we already check that we are not within a slot elsewhere.
-    const gasFees = new GasFees(Fr.ZERO, new Fr(await this.rollupContract.read.getManaBaseFeeAt([timestamp, true])));
+    const gasFees = new GasFees(0, await this.rollupContract.getManaBaseFeeAt(timestamp, true));
 
     const globalVariables = new GlobalVariables(
       chainId,
       version,
       blockNumber,
-      slotFr,
-      timestampFr,
+      slot,
+      timestamp,
       coinbase,
       feeRecipient,
       gasFees,

package/src/index.ts

@@ -1,9 +1,13 @@
 export * from './client/index.js';
 export * from './config.js';
 export * from './publisher/index.js';
+export {
+  FullNodeBlockBuilder as BlockBuilder,
+  Sequencer,
+  SequencerState,
+  type SequencerEvents,
+} from './sequencer/index.js';
 export * from './tx_validator/tx_validator_factory.js';
-export * from './slasher/index.js';
-export { Sequencer, SequencerState, getDefaultAllowedSetupFunctions } from './sequencer/index.js';
 
 // Used by the node to simulate public parts of transactions. Should these be moved to a shared library?
 // ISSUE(#9832)

package/src/publisher/config.ts

@@ -2,11 +2,15 @@ import { type BlobSinkConfig, blobSinkConfigMapping } from '@aztec/blob-sink/cli
 import {
   type L1ReaderConfig,
   type L1TxUtilsConfig,
-  NULL_KEY,
   l1ReaderConfigMappings,
   l1TxUtilsConfigMappings,
 } from '@aztec/ethereum';
-import { type ConfigMappingsType, getConfigFromMappings } from '@aztec/foundation/config';
+import {
+  type ConfigMappingsType,
+  SecretValue,
+  booleanConfigHelper,
+  getConfigFromMappings,
+} from '@aztec/foundation/config';
 import { EthAddress } from '@aztec/foundation/eth-address';
 
 /**
@@ -16,12 +20,12 @@ export type TxSenderConfig = L1ReaderConfig & {
   /**
    * The private key to be used by the publisher.
    */
-  publisherPrivateKey: `0x${string}`;
+  publisherPrivateKeys?: SecretValue<`0x${string}`>[];
 
   /**
-   * The address of the custom forwarder contract.
+   * Publisher addresses to be used with a remote signer
    */
-  customForwarderContractAddress: EthAddress;
+  publisherAddresses?: EthAddress[];
 };
 
 /**
@@ -29,27 +33,28 @@ export type TxSenderConfig = L1ReaderConfig & {
  */
 export type PublisherConfig = L1TxUtilsConfig &
   BlobSinkConfig & {
-    /**
-     * The interval to wait between publish retries.
-     */
-    l1PublishRetryIntervalMS: number;
+    /** True to use publishers in invalid states (timed out, cancelled, etc) if no other is available */
+    publisherAllowInvalidStates?: boolean;
+    /** Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1 */
+    fishermanMode?: boolean;
   };
 
 export const getTxSenderConfigMappings: (
   scope: 'PROVER' | 'SEQ',
 ) => ConfigMappingsType<Omit<TxSenderConfig, 'l1Contracts'>> = (scope: 'PROVER' | 'SEQ') => ({
   ...l1ReaderConfigMappings,
-  customForwarderContractAddress: {
-    env: `CUSTOM_FORWARDER_CONTRACT_ADDRESS`,
-    parseEnv: (val: string) => EthAddress.fromString(val),
-    description: 'The address of the custom forwarder contract.',
-    defaultValue: EthAddress.ZERO,
+  publisherPrivateKeys: {
+    env: scope === 'PROVER' ? `PROVER_PUBLISHER_PRIVATE_KEYS` : `SEQ_PUBLISHER_PRIVATE_KEYS`,
+    description: 'The private keys to be used by the publisher.',
+    parseEnv: (val: string) => val.split(',').map(key => new SecretValue(`0x${key.replace('0x', '')}`)),
+    defaultValue: [],
+    fallback: [scope === 'PROVER' ? `PROVER_PUBLISHER_PRIVATE_KEY` : `SEQ_PUBLISHER_PRIVATE_KEY`],
   },
-  publisherPrivateKey: {
-    env: scope === 'PROVER' ? `PROVER_PUBLISHER_PRIVATE_KEY` : `SEQ_PUBLISHER_PRIVATE_KEY`,
-    description: 'The private key to be used by the publisher.',
-    parseEnv: (val: string) => (val ? `0x${val.replace('0x', '')}` : NULL_KEY),
-    defaultValue: NULL_KEY,
+  publisherAddresses: {
+    env: scope === 'PROVER' ? `PROVER_PUBLISHER_ADDRESSES` : `SEQ_PUBLISHER_ADDRESSES`,
+    description: 'The addresses of the publishers to use with remote signers',
+    parseEnv: (val: string) => val.split(',').map(address => EthAddress.fromString(address)),
+    defaultValue: [],
   },
 });
 
@@ -60,11 +65,16 @@ export function getTxSenderConfigFromEnv(scope: 'PROVER' | 'SEQ'): Omit<TxSender
 export const getPublisherConfigMappings: (
   scope: 'PROVER' | 'SEQ',
 ) => ConfigMappingsType<PublisherConfig & L1TxUtilsConfig> = scope => ({
-  l1PublishRetryIntervalMS: {
-    env: scope === `PROVER` ? `PROVER_PUBLISH_RETRY_INTERVAL_MS` : `SEQ_PUBLISH_RETRY_INTERVAL_MS`,
-    parseEnv: (val: string) => +val,
-    defaultValue: 1000,
-    description: 'The interval to wait between publish retries.',
+  publisherAllowInvalidStates: {
+    description: 'True to use publishers in invalid states (timed out, cancelled, etc) if no other is available',
+    env: scope === `PROVER` ? `PROVER_PUBLISHER_ALLOW_INVALID_STATES` : `SEQ_PUBLISHER_ALLOW_INVALID_STATES`,
+    ...booleanConfigHelper(true),
+  },
+  fishermanMode: {
+    env: 'FISHERMAN_MODE',
+    description:
+      'Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1',
+    ...booleanConfigHelper(false),
   },
   ...l1TxUtilsConfigMappings,
   ...blobSinkConfigMapping,

package/src/publisher/index.ts

@@ -1 +1,5 @@
 export { SequencerPublisher } from './sequencer-publisher.js';
+export { SequencerPublisherFactory } from './sequencer-publisher-factory.js';
+
+// Used for tests
+export { SequencerPublisherMetrics } from './sequencer-publisher-metrics.js';

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

@@ -0,0 +1,91 @@
+import { EthAddress } from '@aztec/aztec.js/addresses';
+import { type Logger, createLogger } from '@aztec/aztec.js/log';
+import type { BlobSinkClientInterface } from '@aztec/blob-sink/client';
+import type { EpochCache } from '@aztec/epoch-cache';
+import type { GovernanceProposerContract, PublisherFilter, PublisherManager, RollupContract } from '@aztec/ethereum';
+import type { L1TxUtilsWithBlobs } from '@aztec/ethereum/l1-tx-utils-with-blobs';
+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>;
+      blobSinkClient?: BlobSinkClientInterface;
+      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,
+      blobSinkClient: this.deps.blobSinkClient,
+      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,4 +1,4 @@
-import { createLogger } from '@aztec/aztec.js';
+import { createLogger } from '@aztec/aztec.js/log';
 import type { L1PublishBlockStats, L1PublishStats } from '@aztec/stdlib/stats';
 import {
   Attributes,
@@ -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',
@@ -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
     }
   }