@aztec/stdlib 0.0.1-commit.e558bd1c → 0.0.1-commit.e57c76e

package/dest/interfaces/archiver.js

@@ -1,85 +1,235 @@
 import { BlockNumberSchema, CheckpointNumberSchema, EpochNumberSchema } from '@aztec/foundation/branded-types';
 import { z } from 'zod';
-import { BlockHash } from '../block/block_hash.js';
-import { CheckpointedL2Block } from '../block/checkpointed_l2_block.js';
+import { BlockDataSchema } from '../block/block_data.js';
 import { L2Block } from '../block/l2_block.js';
-import { L2TipsSchema } from '../block/l2_block_source.js';
+import { BlockQuerySchema, BlocksQuerySchema, CheckpointQuerySchema, CheckpointsQuerySchema, L2TipsSchema, ProposedCheckpointQuerySchema } from '../block/l2_block_source.js';
 import { ValidateCheckpointResultSchema } from '../block/validate_block_result.js';
-import { Checkpoint } from '../checkpoint/checkpoint.js';
+import { CheckpointDataSchema, ProposedCheckpointDataSchema } from '../checkpoint/checkpoint_data.js';
 import { PublishedCheckpoint } from '../checkpoint/published_checkpoint.js';
 import { ContractClassPublicSchema, ContractInstanceWithAddressSchema } from '../contract/index.js';
 import { L1RollupConstantsSchema } from '../epoch-helpers/index.js';
-import { LogFilterSchema } from '../logs/log_filter.js';
-import { SiloedTag } from '../logs/siloed_tag.js';
-import { Tag } from '../logs/tag.js';
-import { TxScopedL2Log } from '../logs/tx_scoped_l2_log.js';
+import { LogResultSchema } from '../logs/log_result.js';
+import { PrivateLogsQuerySchema, PublicLogsQuerySchema } from '../logs/logs_query.js';
+import { L2ToL1MembershipWitnessSchema } from '../messaging/l2_to_l1_membership.js';
 import { optional, schemas } from '../schemas/schemas.js';
-import { BlockHeader } from '../tx/block_header.js';
 import { indexedTxSchema } from '../tx/indexed_tx_effect.js';
 import { TxHash } from '../tx/tx_hash.js';
-import { TxReceipt } from '../tx/tx_receipt.js';
-import { GetContractClassLogsResponseSchema, GetPublicLogsResponseSchema } from './get_logs_response.js';
 export const ArchiverSpecificConfigSchema = z.object({
     archiverPollingIntervalMS: schemas.Integer.optional(),
     archiverBatchSize: schemas.Integer.optional(),
     viemPollingIntervalMS: schemas.Integer.optional(),
-    maxLogs: schemas.Integer.optional(),
     archiverStoreMapSizeKb: schemas.Integer.optional(),
     maxAllowedEthClientDriftSeconds: schemas.Integer.optional(),
     ethereumAllowNoDebugHosts: z.boolean().optional(),
-    skipValidateCheckpointAttestations: z.boolean().optional()
+    archiverSkipHistoricalLogsCheck: z.boolean().optional(),
+    skipValidateCheckpointAttestations: z.boolean().optional(),
+    skipPromoteProposedCheckpointDuringL1Sync: z.boolean().optional(),
+    orphanProposedBlockPruneGraceSeconds: schemas.Integer.optional()
 });
 export const ArchiverApiSchema = {
-    getRollupAddress: z.function().args().returns(schemas.EthAddress),
-    getRegistryAddress: z.function().args().returns(schemas.EthAddress),
-    getBlockNumber: z.function().args().returns(BlockNumberSchema),
-    getProvenBlockNumber: z.function().args().returns(BlockNumberSchema),
-    getCheckpointedL2BlockNumber: z.function().args().returns(BlockNumberSchema),
-    getFinalizedL2BlockNumber: z.function().args().returns(BlockNumberSchema),
-    getBlock: z.function().args(BlockNumberSchema).returns(L2Block.schema.optional()),
-    getBlockHeader: z.function().args(z.union([
-        BlockNumberSchema,
-        z.literal('latest')
-    ])).returns(BlockHeader.schema.optional()),
-    getCheckpointedBlock: z.function().args(BlockNumberSchema).returns(CheckpointedL2Block.schema.optional()),
-    getCheckpointedBlocks: z.function().args(BlockNumberSchema, schemas.Integer).returns(z.array(CheckpointedL2Block.schema)),
-    getBlocks: z.function().args(BlockNumberSchema, schemas.Integer).returns(z.array(L2Block.schema)),
-    getCheckpoints: z.function().args(CheckpointNumberSchema, schemas.Integer).returns(z.array(PublishedCheckpoint.schema)),
-    getCheckpointedBlockByHash: z.function().args(BlockHash.schema).returns(CheckpointedL2Block.schema.optional()),
-    getCheckpointedBlockByArchive: z.function().args(schemas.Fr).returns(CheckpointedL2Block.schema.optional()),
-    getBlockHeaderByHash: z.function().args(BlockHash.schema).returns(BlockHeader.schema.optional()),
-    getBlockHeaderByArchive: z.function().args(schemas.Fr).returns(BlockHeader.schema.optional()),
-    getL2Block: z.function().args(BlockNumberSchema).returns(L2Block.schema.optional()),
-    getL2BlockByHash: z.function().args(BlockHash.schema).returns(L2Block.schema.optional()),
-    getL2BlockByArchive: z.function().args(schemas.Fr).returns(L2Block.schema.optional()),
-    getTxEffect: z.function().args(TxHash.schema).returns(indexedTxSchema().optional()),
-    getSettledTxReceipt: z.function().args(TxHash.schema).returns(TxReceipt.schema.optional()),
-    getL2SlotNumber: z.function().args().returns(schemas.SlotNumber.optional()),
-    getL2EpochNumber: z.function().args().returns(EpochNumberSchema.optional()),
-    getCheckpointsForEpoch: z.function().args(EpochNumberSchema).returns(z.array(Checkpoint.schema)),
-    getCheckpointedBlocksForEpoch: z.function().args(EpochNumberSchema).returns(z.array(CheckpointedL2Block.schema)),
-    getBlocksForSlot: z.function().args(schemas.SlotNumber).returns(z.array(L2Block.schema)),
-    getCheckpointedBlockHeadersForEpoch: z.function().args(EpochNumberSchema).returns(z.array(BlockHeader.schema)),
-    isEpochComplete: z.function().args(EpochNumberSchema).returns(z.boolean()),
-    getL2Tips: z.function().args().returns(L2TipsSchema),
-    getPrivateLogsByTags: z.function().args(z.array(SiloedTag.schema), optional(z.number().gte(0))).returns(z.array(z.array(TxScopedL2Log.schema))),
-    getPublicLogsByTagsFromContract: z.function().args(schemas.AztecAddress, z.array(Tag.schema), optional(z.number().gte(0))).returns(z.array(z.array(TxScopedL2Log.schema))),
-    getPublicLogs: z.function().args(LogFilterSchema).returns(GetPublicLogsResponseSchema),
-    getContractClassLogs: z.function().args(LogFilterSchema).returns(GetContractClassLogsResponseSchema),
-    getContractClass: z.function().args(schemas.Fr).returns(ContractClassPublicSchema.optional()),
-    getBytecodeCommitment: z.function().args(schemas.Fr).returns(schemas.Fr),
-    getContract: z.function().args(schemas.AztecAddress, optional(schemas.BigInt)).returns(ContractInstanceWithAddressSchema.optional()),
-    getContractClassIds: z.function().args().returns(z.array(schemas.Fr)),
-    registerContractFunctionSignatures: z.function().args(z.array(z.string())).returns(z.void()),
-    getL1ToL2Messages: z.function().args(CheckpointNumberSchema).returns(z.array(schemas.Fr)),
-    getL1ToL2MessageIndex: z.function().args(schemas.Fr).returns(schemas.BigInt.optional()),
-    getDebugFunctionName: z.function().args(schemas.AztecAddress, schemas.FunctionSelector).returns(optional(z.string())),
-    getL1Constants: z.function().args().returns(L1RollupConstantsSchema),
-    getGenesisValues: z.function().args().returns(z.object({
-        genesisArchiveRoot: schemas.Fr
-    })),
-    getL1Timestamp: z.function().args().returns(schemas.BigInt.optional()),
-    syncImmediate: z.function().args().returns(z.void()),
-    isPendingChainInvalid: z.function().args().returns(z.boolean()),
-    getPendingChainValidationStatus: z.function().args().returns(ValidateCheckpointResultSchema)
+    getRollupAddress: z.function({
+        input: z.tuple([]),
+        output: schemas.EthAddress
+    }),
+    getRegistryAddress: z.function({
+        input: z.tuple([]),
+        output: schemas.EthAddress
+    }),
+    getBlockNumber: z.function({
+        input: z.tuple([
+            optional(BlockQuerySchema)
+        ]),
+        output: BlockNumberSchema.optional()
+    }),
+    getCheckpointNumber: z.function({
+        input: z.tuple([]),
+        output: CheckpointNumberSchema
+    }),
+    getCheckpoint: z.function({
+        input: z.tuple([
+            CheckpointQuerySchema
+        ]),
+        output: PublishedCheckpoint.schema.optional()
+    }),
+    getCheckpoints: z.function({
+        input: z.tuple([
+            CheckpointsQuerySchema
+        ]),
+        output: z.array(PublishedCheckpoint.schema)
+    }),
+    getCheckpointData: z.function({
+        input: z.tuple([
+            CheckpointQuerySchema
+        ]),
+        output: CheckpointDataSchema.optional()
+    }),
+    getCheckpointsData: z.function({
+        input: z.tuple([
+            CheckpointsQuerySchema
+        ]),
+        output: z.array(CheckpointDataSchema)
+    }),
+    getTxEffect: z.function({
+        input: z.tuple([
+            TxHash.schema
+        ]),
+        output: indexedTxSchema().optional()
+    }),
+    // Reads Outbox roots lazily, pinned to the node's synced L1 block. Caveat: cached roots that are
+    // sealed and L1-finalized are not re-validated, so a reorg deeper than L1 finality could leave the
+    // node serving a witness against a no-longer-canonical root.
+    getL2ToL1MembershipWitness: z.function({
+        input: z.tuple([
+            TxHash.schema,
+            schemas.Fr,
+            optional(schemas.Integer)
+        ]),
+        output: L2ToL1MembershipWitnessSchema.optional()
+    }),
+    getSyncedL2SlotNumber: z.function({
+        input: z.tuple([]),
+        output: schemas.SlotNumber.optional()
+    }),
+    getSyncedL2EpochNumber: z.function({
+        input: z.tuple([]),
+        output: EpochNumberSchema.optional()
+    }),
+    getBlocksForSlot: z.function({
+        input: z.tuple([
+            schemas.SlotNumber
+        ]),
+        output: z.array(L2Block.schema)
+    }),
+    isEpochComplete: z.function({
+        input: z.tuple([
+            EpochNumberSchema
+        ]),
+        output: z.boolean()
+    }),
+    getL2Tips: z.function({
+        input: z.tuple([]),
+        output: L2TipsSchema
+    }),
+    getPrivateLogsByTags: z.function({
+        input: z.tuple([
+            PrivateLogsQuerySchema
+        ]),
+        output: z.array(z.array(LogResultSchema))
+    }),
+    getPublicLogsByTags: z.function({
+        input: z.tuple([
+            PublicLogsQuerySchema
+        ]),
+        output: z.array(z.array(LogResultSchema))
+    }),
+    getContractClass: z.function({
+        input: z.tuple([
+            schemas.Fr
+        ]),
+        output: ContractClassPublicSchema.optional()
+    }),
+    getBytecodeCommitment: z.function({
+        input: z.tuple([
+            schemas.Fr
+        ]),
+        output: schemas.Fr
+    }),
+    getContract: z.function({
+        input: z.tuple([
+            schemas.AztecAddress,
+            optional(schemas.BigInt)
+        ]),
+        output: ContractInstanceWithAddressSchema.optional()
+    }),
+    getContractClassIds: z.function({
+        input: z.tuple([]),
+        output: z.array(schemas.Fr)
+    }),
+    registerContractFunctionSignatures: z.function({
+        input: z.tuple([
+            z.array(z.string())
+        ]),
+        output: z.void()
+    }),
+    getL1ToL2Messages: z.function({
+        input: z.tuple([
+            CheckpointNumberSchema
+        ]),
+        output: z.array(schemas.Fr)
+    }),
+    getL1ToL2MessageIndex: z.function({
+        input: z.tuple([
+            schemas.Fr
+        ]),
+        output: schemas.BigInt.optional()
+    }),
+    getDebugFunctionName: z.function({
+        input: z.tuple([
+            schemas.AztecAddress,
+            schemas.FunctionSelector
+        ]),
+        output: optional(z.string())
+    }),
+    getL1Constants: z.function({
+        input: z.tuple([]),
+        output: L1RollupConstantsSchema
+    }),
+    isPruneDueAtSlot: z.function({
+        input: z.tuple([
+            schemas.SlotNumber
+        ]),
+        output: z.boolean()
+    }),
+    getGenesisValues: z.function({
+        input: z.tuple([]),
+        output: z.object({
+            genesisArchiveRoot: schemas.Fr
+        })
+    }),
+    getL1Timestamp: z.function({
+        input: z.tuple([]),
+        output: schemas.BigInt.optional()
+    }),
+    getProposedCheckpointData: z.function({
+        input: z.tuple([
+            optional(ProposedCheckpointQuerySchema)
+        ]),
+        output: ProposedCheckpointDataSchema.optional()
+    }),
+    syncImmediate: z.function({
+        input: z.tuple([]),
+        output: z.void()
+    }),
+    isPendingChainInvalid: z.function({
+        input: z.tuple([]),
+        output: z.boolean()
+    }),
+    getPendingChainValidationStatus: z.function({
+        input: z.tuple([]),
+        output: ValidateCheckpointResultSchema
+    }),
+    getBlock: z.function({
+        input: z.tuple([
+            BlockQuerySchema
+        ]),
+        output: L2Block.schema.optional()
+    }),
+    getBlocks: z.function({
+        input: z.tuple([
+            BlocksQuerySchema
+        ]),
+        output: z.array(L2Block.schema)
+    }),
+    getBlockData: z.function({
+        input: z.tuple([
+            BlockQuerySchema
+        ]),
+        output: BlockDataSchema.optional()
+    }),
+    getBlocksData: z.function({
+        input: z.tuple([
+            BlocksQuerySchema
+        ]),
+        output: z.array(BlockDataSchema)
+    })
 };