@aztec/archiver 0.75.0-commit.c03ba01a2a4122e43e90d5133ba017e54b90e9d2 → 0.76.0

package/dest/archiver/archiver.d.ts

@@ -0,0 +1,186 @@
+import { type BlobSinkClientInterface } from '@aztec/blob-sink/client';
+import { type GetContractClassLogsResponse, type GetPublicLogsResponse, type InBlock, type L1RollupConstants, type L1ToL2MessageSource, type L2Block, type L2BlockSource, type L2LogsSource, type L2Tips, type LogFilter, type NullifierWithBlockSource, type TxEffect, type TxHash, type TxReceipt, type TxScopedL2Log } from '@aztec/circuit-types';
+import { type BlockHeader, type ContractClassPublic, type ContractDataSource, type ContractInstanceWithAddress, type FunctionSelector, type PrivateLog, type PublicFunction } from '@aztec/circuits.js';
+import { type AztecAddress } from '@aztec/foundation/aztec-address';
+import { type EthAddress } from '@aztec/foundation/eth-address';
+import { Fr } from '@aztec/foundation/fields';
+import { type Logger } from '@aztec/foundation/log';
+import { type TelemetryClient, type Traceable, type Tracer } from '@aztec/telemetry-client';
+import { type Chain, type HttpTransport, type PublicClient } from 'viem';
+import { type ArchiverDataStore } from './archiver_store.js';
+import { type ArchiverConfig } from './config.js';
+import { ArchiverInstrumentation } from './instrumentation.js';
+/**
+ * Helper interface to combine all sources this archiver implementation provides.
+ */
+export type ArchiveSource = L2BlockSource & L2LogsSource & ContractDataSource & L1ToL2MessageSource & NullifierWithBlockSource;
+/**
+ * Pulls L2 blocks in a non-blocking manner and provides interface for their retrieval.
+ * Responsible for handling robust L1 polling so that other components do not need to
+ * concern themselves with it.
+ */
+export declare class Archiver implements ArchiveSource, Traceable {
+    private readonly publicClient;
+    private readonly l1Addresses;
+    readonly dataStore: ArchiverDataStore;
+    private readonly config;
+    private readonly blobSinkClient;
+    private readonly instrumentation;
+    private readonly l1constants;
+    private readonly log;
+    /**
+     * A promise in which we will be continually fetching new L2 blocks.
+     */
+    private runningPromise?;
+    private rollup;
+    private inbox;
+    private store;
+    l1BlockNumber: bigint | undefined;
+    l1Timestamp: bigint | undefined;
+    readonly tracer: Tracer;
+    /**
+     * Creates a new instance of the Archiver.
+     * @param publicClient - A client for interacting with the Ethereum node.
+     * @param rollupAddress - Ethereum address of the rollup contract.
+     * @param inboxAddress - Ethereum address of the inbox contract.
+     * @param registryAddress - Ethereum address of the registry contract.
+     * @param pollingIntervalMs - The interval for polling for L1 logs (in milliseconds).
+     * @param store - An archiver data store for storage & retrieval of blocks, encrypted logs & contract data.
+     * @param log - A logger.
+     */
+    constructor(publicClient: PublicClient<HttpTransport, Chain>, l1Addresses: {
+        rollupAddress: EthAddress;
+        inboxAddress: EthAddress;
+        registryAddress: EthAddress;
+    }, dataStore: ArchiverDataStore, config: {
+        pollingIntervalMs: number;
+        batchSize: number;
+    }, blobSinkClient: BlobSinkClientInterface, instrumentation: ArchiverInstrumentation, l1constants: L1RollupConstants, log?: Logger);
+    /**
+     * Creates a new instance of the Archiver and blocks until it syncs from chain.
+     * @param config - The archiver's desired configuration.
+     * @param archiverStore - The backing store for the archiver.
+     * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
+     * @returns - An instance of the archiver.
+     */
+    static createAndSync(config: ArchiverConfig, archiverStore: ArchiverDataStore, deps: {
+        telemetry: TelemetryClient;
+        blobSinkClient: BlobSinkClientInterface;
+    }, blockUntilSynced?: boolean): Promise<Archiver>;
+    /**
+     * Starts sync process.
+     * @param blockUntilSynced - If true, blocks until the archiver has fully synced.
+     */
+    start(blockUntilSynced: boolean): Promise<void>;
+    /**
+     * Fetches logs from L1 contracts and processes them.
+     */
+    private sync;
+    /** Checks if there'd be a reorg for the next block submission and start pruning now. */
+    private handleEpochPrune;
+    private nextRange;
+    private handleL1ToL2Messages;
+    private handleL2blocks;
+    /**
+     * Stops the archiver.
+     * @returns A promise signalling completion of the stop process.
+     */
+    stop(): Promise<void>;
+    getL1Constants(): Promise<L1RollupConstants>;
+    getRollupAddress(): Promise<EthAddress>;
+    getRegistryAddress(): Promise<EthAddress>;
+    getL1BlockNumber(): bigint;
+    getL1Timestamp(): bigint;
+    getL2SlotNumber(): Promise<bigint>;
+    getL2EpochNumber(): Promise<bigint>;
+    getBlocksForEpoch(epochNumber: bigint): Promise<L2Block[]>;
+    isEpochComplete(epochNumber: bigint): Promise<boolean>;
+    /**
+     * Gets up to `limit` amount of L2 blocks starting from `from`.
+     * @param from - Number of the first block to return (inclusive).
+     * @param limit - The number of blocks to return.
+     * @param proven - If true, only return blocks that have been proven.
+     * @returns The requested L2 blocks.
+     */
+    getBlocks(from: number, limit: number, proven?: boolean): Promise<L2Block[]>;
+    /**
+     * Gets an l2 block.
+     * @param number - The block number to return.
+     * @returns The requested L2 block.
+     */
+    getBlock(number: number): Promise<L2Block | undefined>;
+    getBlockHeader(number: number | 'latest'): Promise<BlockHeader | undefined>;
+    getTxEffect(txHash: TxHash): Promise<InBlock<TxEffect> | undefined>;
+    getSettledTxReceipt(txHash: TxHash): Promise<TxReceipt | undefined>;
+    /**
+     * Gets the public function data for a contract.
+     * @param address - The contract address containing the function to fetch.
+     * @param selector - The function selector of the function to fetch.
+     * @returns The public function data (if found).
+     */
+    getPublicFunction(address: AztecAddress, selector: FunctionSelector): Promise<PublicFunction | undefined>;
+    /**
+     * Retrieves all private logs from up to `limit` blocks, starting from the block number `from`.
+     * @param from - The block number from which to begin retrieving logs.
+     * @param limit - The maximum number of blocks to retrieve logs from.
+     * @returns An array of private logs from the specified range of blocks.
+     */
+    getPrivateLogs(from: number, limit: number): Promise<PrivateLog[]>;
+    /**
+     * Gets all logs that match any of the received tags (i.e. logs with their first field equal to a tag).
+     * @param tags - The tags to filter the logs by.
+     * @returns For each received tag, an array of matching logs is returned. An empty array implies no logs match
+     * that tag.
+     */
+    getLogsByTags(tags: Fr[]): Promise<TxScopedL2Log[][]>;
+    /**
+     * Returns the provided nullifier indexes scoped to the block
+     * they were first included in, or undefined if they're not present in the tree
+     * @param blockNumber Max block number to search for the nullifiers
+     * @param nullifiers Nullifiers to get
+     * @returns The block scoped indexes of the provided nullifiers, or undefined if the nullifier doesn't exist in the tree
+     */
+    findNullifiersIndexesWithBlock(blockNumber: number, nullifiers: Fr[]): Promise<(InBlock<bigint> | undefined)[]>;
+    /**
+     * Gets public logs based on the provided filter.
+     * @param filter - The filter to apply to the logs.
+     * @returns The requested logs.
+     */
+    getPublicLogs(filter: LogFilter): Promise<GetPublicLogsResponse>;
+    /**
+     * Gets contract class logs based on the provided filter.
+     * @param filter - The filter to apply to the logs.
+     * @returns The requested logs.
+     */
+    getContractClassLogs(filter: LogFilter): Promise<GetContractClassLogsResponse>;
+    /**
+     * Gets the number of the latest L2 block processed by the block source implementation.
+     * @returns The number of the latest L2 block processed by the block source implementation.
+     */
+    getBlockNumber(): Promise<number>;
+    getProvenBlockNumber(): Promise<number>;
+    getProvenL2EpochNumber(): Promise<number | undefined>;
+    /** Forcefully updates the last proven block number. Use for testing. */
+    setProvenBlockNumber(blockNumber: number): Promise<void>;
+    getContractClass(id: Fr): Promise<ContractClassPublic | undefined>;
+    getBytecodeCommitment(id: Fr): Promise<Fr | undefined>;
+    getContract(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined>;
+    /**
+     * Gets L1 to L2 message (to be) included in a given block.
+     * @param blockNumber - L2 block number to get messages for.
+     * @returns The L1 to L2 messages/leaves of the messages subtree (throws if not found).
+     */
+    getL1ToL2Messages(blockNumber: bigint): Promise<Fr[]>;
+    /**
+     * Gets the L1 to L2 message index in the L1 to L2 message tree.
+     * @param l1ToL2Message - The L1 to L2 message.
+     * @returns The index of the L1 to L2 message in the L1 to L2 message tree (undefined if not found).
+     */
+    getL1ToL2MessageIndex(l1ToL2Message: Fr): Promise<bigint | undefined>;
+    getContractClassIds(): Promise<Fr[]>;
+    addContractClass(contractClass: ContractClassPublic): Promise<void>;
+    registerContractFunctionSignatures(address: AztecAddress, signatures: string[]): Promise<void>;
+    getContractFunctionName(address: AztecAddress, selector: FunctionSelector): Promise<string | undefined>;
+    getL2Tips(): Promise<L2Tips>;
+}
+//# sourceMappingURL=archiver.d.ts.map

package/dest/archiver/archiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"archiver.d.ts","sourceRoot":"","sources":["../../src/archiver/archiver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,EAC1B,KAAK,OAAO,EAEZ,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,OAAO,EAEZ,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,wBAAwB,EAC7B,KAAK,QAAQ,EACb,KAAK,MAAM,EACX,KAAK,SAAS,EACd,KAAK,aAAa,EAMnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAEhC,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,cAAc,EAKpB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAWlE,OAAO,EAAc,KAAK,eAAe,EAAE,KAAK,SAAS,EAAE,KAAK,MAAM,EAAa,MAAM,yBAAyB,CAAC;AAGnH,OAAO,EACL,KAAK,KAAK,EAEV,KAAK,aAAa,EAClB,KAAK,YAAY,EAIlB,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,KAAK,iBAAiB,EAA6B,MAAM,qBAAqB,CAAC;AACxF,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAI/D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,aAAa,GACvC,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,wBAAwB,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,QAAS,YAAW,aAAa,EAAE,SAAS;IA2BrD,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,QAAQ,CAAC,SAAS,EAAE,iBAAiB;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,GAAG;IAjCtB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAC,CAAiB;IAExC,OAAO,CAAC,MAAM,CAA8E;IAC5F,OAAO,CAAC,KAAK,CAA6E;IAE1F,OAAO,CAAC,KAAK,CAAsB;IAE5B,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B;;;;;;;;;OASG;gBAEgB,YAAY,EAAE,YAAY,CAAC,aAAa,EAAE,KAAK,CAAC,EAChD,WAAW,EAAE;QAAE,aAAa,EAAE,UAAU,CAAC;QAAC,YAAY,EAAE,UAAU,CAAC;QAAC,eAAe,EAAE,UAAU,CAAA;KAAE,EACzG,SAAS,EAAE,iBAAiB,EACpB,MAAM,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EACxD,cAAc,EAAE,uBAAuB,EACvC,eAAe,EAAE,uBAAuB,EACxC,WAAW,EAAE,iBAAiB,EAC9B,GAAG,GAAE,MAAiC;IAkBzD;;;;;;OAMG;WACiB,aAAa,CAC/B,MAAM,EAAE,cAAc,EACtB,aAAa,EAAE,iBAAiB,EAChC,IAAI,EAAE;QAAE,SAAS,EAAE,eAAe,CAAC;QAAC,cAAc,EAAE,uBAAuB,CAAA;KAAE,EAC7E,gBAAgB,UAAO,GACtB,OAAO,CAAC,QAAQ,CAAC;IAqCpB;;;OAGG;IACU,KAAK,CAAC,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB5D;;OAEG;YAEW,IAAI;IA0ElB,wFAAwF;YAC1E,gBAAgB;IAyB9B,OAAO,CAAC,SAAS;YAUH,oBAAoB;YAkCpB,cAAc;IA4K5B;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B,cAAc,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAI5C,gBAAgB,IAAI,OAAO,CAAC,UAAU,CAAC;IAIvC,kBAAkB,IAAI,OAAO,CAAC,UAAU,CAAC;IAIzC,gBAAgB,IAAI,MAAM;IAQ1B,cAAc,IAAI,MAAM;IAQxB,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAIlC,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkB1D,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA4BnE;;;;;;OAMG;IACU,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAOzF;;;;OAIG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAYtD,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAWjF,WAAW,CAAC,MAAM,EAAE,MAAM;IAI1B,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAI1E;;;;;OAKG;IACU,iBAAiB,CAC5B,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,gBAAgB,GACzB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAYtC;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAIzE;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC;IAIrD;;;;;;OAMG;IACH,8BAA8B,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;IAI/G;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIhE;;;;OAIG;IACH,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAI9E;;;OAGG;IACI,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC;IAIjC,oBAAoB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIvC,sBAAsB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI5D,wEAAwE;IACjE,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,gBAAgB,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAIlE,qBAAqB,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAItD,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC;IAI3F;;;;OAIG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAIrD;;;;OAIG;IACH,qBAAqB,CAAC,aAAa,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIrE,mBAAmB,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;IAK9B,gBAAgB,CAAC,aAAa,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IASzE,kCAAkC,CAAC,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9F,uBAAuB,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIjG,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;CA8BnC"}