@aztec/archiver 0.0.1-commit.d3ec352c → 0.0.1-commit.d58ff9d0

package/src/archiver/config.ts

@@ -1,79 +0,0 @@
-import { type BlobSinkConfig, blobSinkConfigMapping } from '@aztec/blob-sink/client';
-import {
-  type L1ContractsConfig,
-  type L1ReaderConfig,
-  l1ContractAddressesMapping,
-  l1ContractsConfigMappings,
-  l1ReaderConfigMappings,
-} from '@aztec/ethereum';
-import {
-  type ConfigMappingsType,
-  booleanConfigHelper,
-  getConfigFromMappings,
-  numberConfigHelper,
-} from '@aztec/foundation/config';
-import { type ChainConfig, chainConfigMappings } from '@aztec/stdlib/config';
-import type { ArchiverSpecificConfig } from '@aztec/stdlib/interfaces/server';
-
-/**
- * The archiver configuration.
- * There are 2 polling intervals used in this configuration. The first is the archiver polling interval, archiverPollingIntervalMS.
- * This is the interval between successive calls to eth_blockNumber via viem.
- * Results of calls to eth_blockNumber are cached by viem with this cache being updated periodically at the interval specified by viemPollingIntervalMS.
- * As a result the maximum observed polling time for new blocks will be viemPollingIntervalMS + archiverPollingIntervalMS.
- */
-export type ArchiverConfig = ArchiverSpecificConfig & L1ReaderConfig & L1ContractsConfig & BlobSinkConfig & ChainConfig;
-
-export const archiverConfigMappings: ConfigMappingsType<ArchiverConfig> = {
-  ...blobSinkConfigMapping,
-  archiverPollingIntervalMS: {
-    env: 'ARCHIVER_POLLING_INTERVAL_MS',
-    description: 'The polling interval in ms for retrieving new L2 blocks and encrypted logs.',
-    ...numberConfigHelper(500),
-  },
-  archiverBatchSize: {
-    env: 'ARCHIVER_BATCH_SIZE',
-    description: 'The number of L2 blocks the archiver will attempt to download at a time.',
-    ...numberConfigHelper(100),
-  },
-  maxLogs: {
-    env: 'ARCHIVER_MAX_LOGS',
-    description: 'The max number of logs that can be obtained in 1 "getPublicLogs" call.',
-    ...numberConfigHelper(1_000),
-  },
-  archiverStoreMapSizeKb: {
-    env: 'ARCHIVER_STORE_MAP_SIZE_KB',
-    parseEnv: (val: string | undefined) => (val ? +val : undefined),
-    description: 'The maximum possible size of the archiver DB in KB. Overwrites the general dataStoreMapSizeKb.',
-  },
-  skipValidateBlockAttestations: {
-    description: 'Whether to skip validating block attestations (use only for testing).',
-    ...booleanConfigHelper(false),
-  },
-  maxAllowedEthClientDriftSeconds: {
-    env: 'MAX_ALLOWED_ETH_CLIENT_DRIFT_SECONDS',
-    description: 'Maximum allowed drift in seconds between the Ethereum client and current time.',
-    ...numberConfigHelper(300),
-  },
-  ...chainConfigMappings,
-  ...l1ReaderConfigMappings,
-  viemPollingIntervalMS: {
-    env: 'ARCHIVER_VIEM_POLLING_INTERVAL_MS',
-    description: 'The polling interval viem uses in ms',
-    ...numberConfigHelper(1000),
-  },
-  ...l1ContractsConfigMappings,
-  l1Contracts: {
-    description: 'The deployed L1 contract addresses',
-    nested: l1ContractAddressesMapping,
-  },
-};
-
-/**
- * Returns the archiver configuration from the environment variables.
- * Note: If an environment variable is not set, the default value is used.
- * @returns The archiver configuration.
- */
-export function getArchiverConfigFromEnv(): ArchiverConfig {
-  return getConfigFromMappings<ArchiverConfig>(archiverConfigMappings);
-}

package/src/archiver/errors.ts

@@ -1,26 +0,0 @@
-export class NoBlobBodiesFoundError extends Error {
-  constructor(l2BlockNum: number) {
-    super(`No blob bodies found for block ${l2BlockNum}`);
-  }
-}
-
-export class InitialBlockNumberNotSequentialError extends Error {
-  constructor(
-    public readonly newBlockNumber: number,
-    public readonly previousBlockNumber: number | undefined,
-  ) {
-    super(
-      `Cannot insert new block ${newBlockNumber} given previous block number in store is ${
-        previousBlockNumber ?? 'undefined'
-      }`,
-    );
-  }
-}
-
-export class BlockNumberNotSequentialError extends Error {
-  constructor(newBlockNumber: number, previous: number | undefined) {
-    super(
-      `Cannot insert new block ${newBlockNumber} given previous block number in batch is ${previous ?? 'undefined'}`,
-    );
-  }
-}

package/src/archiver/index.ts

@@ -1,6 +0,0 @@
-export * from './archiver.js';
-export * from './config.js';
-export { type PublishedL2Block, type L1PublishedData } from './structs/published.js';
-export type { ArchiverDataStore } from './archiver_store.js';
-export { KVArchiverDataStore, ARCHIVER_DB_VERSION } from './kv_archiver_store/kv_archiver_store.js';
-export { ContractInstanceStore } from './kv_archiver_store/contract_instance_store.js';

package/src/archiver/instrumentation.ts

@@ -1,187 +0,0 @@
-import { createLogger } from '@aztec/foundation/log';
-import type { L2BlockNew } from '@aztec/stdlib/block';
-import {
-  Attributes,
-  type Gauge,
-  type Histogram,
-  LmdbMetrics,
-  type LmdbStatsCallback,
-  Metrics,
-  type TelemetryClient,
-  type Tracer,
-  type UpDownCounter,
-  ValueType,
-} from '@aztec/telemetry-client';
-
-export class ArchiverInstrumentation {
-  public readonly tracer: Tracer;
-
-  private blockHeight: Gauge;
-  private txCount: UpDownCounter;
-  private l1BlockHeight: Gauge;
-  private proofsSubmittedDelay: Histogram;
-  private proofsSubmittedCount: UpDownCounter;
-  private dbMetrics: LmdbMetrics;
-
-  private pruneDuration: Histogram;
-  private pruneCount: UpDownCounter;
-
-  private syncDurationPerBlock: Histogram;
-  private syncBlockCount: UpDownCounter;
-  private manaPerBlock: Histogram;
-  private txsPerBlock: Histogram;
-
-  private syncDurationPerMessage: Histogram;
-  private syncMessageCount: UpDownCounter;
-
-  private log = createLogger('archiver:instrumentation');
-
-  private constructor(
-    private telemetry: TelemetryClient,
-    lmdbStats?: LmdbStatsCallback,
-  ) {
-    this.tracer = telemetry.getTracer('Archiver');
-    const meter = telemetry.getMeter('Archiver');
-
-    this.blockHeight = meter.createGauge(Metrics.ARCHIVER_BLOCK_HEIGHT, {
-      description: 'The height of the latest block processed by the archiver',
-      valueType: ValueType.INT,
-    });
-
-    this.l1BlockHeight = meter.createGauge(Metrics.ARCHIVER_L1_BLOCK_HEIGHT, {
-      description: 'The height of the latest L1 block processed by the archiver',
-      valueType: ValueType.INT,
-    });
-
-    this.txCount = meter.createUpDownCounter(Metrics.ARCHIVER_TOTAL_TXS, {
-      description: 'The total number of transactions',
-      valueType: ValueType.INT,
-    });
-
-    this.proofsSubmittedCount = meter.createUpDownCounter(Metrics.ARCHIVER_ROLLUP_PROOF_COUNT, {
-      description: 'Number of proofs submitted',
-      valueType: ValueType.INT,
-    });
-
-    this.proofsSubmittedDelay = meter.createHistogram(Metrics.ARCHIVER_ROLLUP_PROOF_DELAY, {
-      unit: 'ms',
-      description: 'Time after a block is submitted until its proof is published',
-      valueType: ValueType.INT,
-    });
-
-    this.syncDurationPerBlock = meter.createHistogram(Metrics.ARCHIVER_SYNC_PER_BLOCK, {
-      unit: 'ms',
-      description: 'Duration to sync a block',
-      valueType: ValueType.INT,
-    });
-
-    this.syncBlockCount = meter.createUpDownCounter(Metrics.ARCHIVER_SYNC_BLOCK_COUNT, {
-      description: 'Number of blocks synced from L1',
-      valueType: ValueType.INT,
-    });
-
-    this.manaPerBlock = meter.createHistogram(Metrics.ARCHIVER_MANA_PER_BLOCK, {
-      description: 'The mana consumed by blocks',
-      valueType: ValueType.DOUBLE,
-      unit: 'Mmana',
-    });
-
-    this.txsPerBlock = meter.createHistogram(Metrics.ARCHIVER_TXS_PER_BLOCK, {
-      description: 'The block tx count',
-      valueType: ValueType.INT,
-      unit: 'tx',
-    });
-
-    this.syncDurationPerMessage = meter.createHistogram(Metrics.ARCHIVER_SYNC_PER_MESSAGE, {
-      unit: 'ms',
-      description: 'Duration to sync a message',
-      valueType: ValueType.INT,
-    });
-
-    this.syncMessageCount = meter.createUpDownCounter(Metrics.ARCHIVER_SYNC_MESSAGE_COUNT, {
-      description: 'Number of L1 to L2 messages synced',
-      valueType: ValueType.INT,
-    });
-
-    this.pruneDuration = meter.createHistogram(Metrics.ARCHIVER_PRUNE_DURATION, {
-      unit: 'ms',
-      description: 'Duration to sync a message',
-      valueType: ValueType.INT,
-    });
-
-    this.pruneCount = meter.createUpDownCounter(Metrics.ARCHIVER_PRUNE_COUNT, {
-      description: 'Number of prunes detected',
-      valueType: ValueType.INT,
-    });
-
-    this.dbMetrics = new LmdbMetrics(
-      meter,
-      {
-        [Attributes.DB_DATA_TYPE]: 'archiver',
-      },
-      lmdbStats,
-    );
-  }
-
-  public static async new(telemetry: TelemetryClient, lmdbStats?: LmdbStatsCallback) {
-    const instance = new ArchiverInstrumentation(telemetry, lmdbStats);
-
-    instance.syncBlockCount.add(0);
-    instance.syncMessageCount.add(0);
-    instance.pruneCount.add(0);
-
-    await instance.telemetry.flush();
-
-    return instance;
-  }
-
-  public isEnabled(): boolean {
-    return this.telemetry.isEnabled();
-  }
-
-  public processNewBlocks(syncTimePerBlock: number, blocks: L2BlockNew[]) {
-    this.syncDurationPerBlock.record(Math.ceil(syncTimePerBlock));
-    this.blockHeight.record(Math.max(...blocks.map(b => b.number)));
-    this.syncBlockCount.add(blocks.length);
-
-    for (const block of blocks) {
-      this.txCount.add(block.body.txEffects.length);
-      this.txsPerBlock.record(block.body.txEffects.length);
-      this.manaPerBlock.record(block.header.totalManaUsed.toNumber() / 1e6);
-    }
-  }
-
-  public processNewMessages(count: number, syncPerMessageMs: number) {
-    if (count === 0) {
-      return;
-    }
-    this.syncMessageCount.add(count);
-    this.syncDurationPerMessage.record(Math.ceil(syncPerMessageMs));
-  }
-
-  public processPrune(duration: number) {
-    this.pruneCount.add(1);
-    this.pruneDuration.record(Math.ceil(duration));
-  }
-
-  public updateLastProvenBlock(blockNumber: number) {
-    this.blockHeight.record(blockNumber, { [Attributes.STATUS]: 'proven' });
-  }
-
-  public processProofsVerified(logs: { proverId: string; l2BlockNumber: bigint; delay: bigint }[]) {
-    for (const log of logs) {
-      this.log.debug('Recording proof verified event', log);
-      this.proofsSubmittedCount.add(1, {
-        [Attributes.ROLLUP_PROVER_ID]: log.proverId,
-        [Attributes.PROOF_TIMED_OUT]: log.delay > 20n * 60n * 1000n,
-      });
-      this.proofsSubmittedDelay.record(Math.ceil(Number(log.delay)), {
-        [Attributes.ROLLUP_PROVER_ID]: log.proverId,
-      });
-    }
-  }
-
-  public updateL1BlockHeight(blockNumber: bigint) {
-    this.l1BlockHeight.record(Number(blockNumber));
-  }
-}