@aztec/stdlib 0.0.1-commit.b6e433891 → 0.0.1-commit.b8a057fa

package/src/block/block_parameter.ts

@@ -1,10 +1,78 @@
-import { BlockNumberSchema } from '@aztec/foundation/branded-types';
+import { type BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import { jsonStringify } from '@aztec/foundation/json-rpc';
+import { schemas } from '@aztec/foundation/schemas';
 
 import { z } from 'zod';
 
 import { BlockHash } from './block_hash.js';
 
-export const BlockParameterSchema = z.union([BlockHash.schema, BlockNumberSchema, z.literal('latest')]);
+export const BlockTag = ['latest', 'proposed', 'checkpointed', 'proven', 'finalized'] as const;
 
-/** Block parameter - either a specific BlockNumber, block hash (BlockHash), or 'latest' */
-export type BlockParameter = z.infer<typeof BlockParameterSchema>;
+/**
+ * Tag identifying a block by its position in the chain rather than by an absolute identifier.
+ * - `latest` / `proposed`: Latest L2 block proposed (not necessarily checkpointed/proven yet).
+ * - `checkpointed`: Latest L2 block whose enclosing checkpoint has been published on L1.
+ * - `proven`: Latest L2 block whose enclosing checkpoint has been proven on L1.
+ * - `finalized`: Latest L2 block whose proving L1 transaction has reached L1 finality.
+ */
+export type BlockTag = (typeof BlockTag)[number];
+
+export const BlockTagWithoutLatestSchema = z.union([
+  z.literal('proposed'),
+  z.literal('checkpointed'),
+  z.literal('proven'),
+  z.literal('finalized'),
+]);
+
+export const BlockTagSchema: z.ZodType<BlockTag> = z.union([z.literal('latest'), BlockTagWithoutLatestSchema]);
+
+/**
+ * Object-only form of {@link BlockParameter}. Used as the building block for {@link BlockQuery}.
+ */
+export type NormalizedBlockParameter =
+  | { number: BlockNumber }
+  | { hash: BlockHash }
+  | { archive: Fr }
+  | { tag: Exclude<BlockTag, 'latest'> };
+
+export const NormalizedBlockParameterSchema: z.ZodType<NormalizedBlockParameter, unknown> = z.union([
+  z.object({ number: BlockNumberSchema }).strict(),
+  z.object({ hash: BlockHash.schema }).strict(),
+  z.object({ archive: schemas.Fr }).strict(),
+  z.object({ tag: BlockTagWithoutLatestSchema }).strict(),
+]);
+
+/**
+ * Selector for a block in RPC calls.
+ *
+ * Accepts a block number, a {@link BlockHash}, a chain-tip name (e.g. `'proven'`, `'checkpointed'`),
+ * `'latest'` (alias for `'proposed'`), or any of the {@link NormalizedBlockParameter} object variants
+ * (`{ number }`, `{ hash }`, `{ archive }`, `{ tag }`).
+ */
+export type BlockParameter = NormalizedBlockParameter | BlockNumber | BlockHash | BlockTag;
+
+export const BlockParameterSchema: z.ZodType<BlockParameter, unknown> = z.union([
+  NormalizedBlockParameterSchema,
+  BlockHash.schema,
+  BlockTagSchema,
+  BlockNumberSchema,
+]);
+
+export function inspectBlockParameter(param: BlockParameter) {
+  if (typeof param === 'number') {
+    return param.toString();
+  } else if (typeof param === 'string') {
+    return param;
+  } else if ('number' in param) {
+    return `number=${param.number.toString()}`;
+  } else if ('hash' in param) {
+    return `hash=${param.hash.toString()}`;
+  } else if ('archive' in param) {
+    return `archive=${param.archive.toString()}`;
+  } else if ('tag' in param) {
+    return `tag=${param.tag}`;
+  } else {
+    return jsonStringify(param);
+  }
+}

package/src/block/index.ts

@@ -6,7 +6,6 @@ export * from './body.js';
 export * from './block_parameter.js';
 export * from './l2_block_source.js';
 export * from './block_hash.js';
-export * from './checkpointed_l2_block.js';
 export * from './proposal/index.js';
 export * from './validate_block_result.js';
 export * from './l2_block_info.js';

package/src/block/l2_block_info.ts

@@ -5,8 +5,10 @@ import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { z } from 'zod';
 
+import { BlockHash } from './block_hash.js';
+
 export type L2BlockInfo = {
-  blockHash?: Fr;
+  blockHash?: BlockHash;
   archive: Fr;
   lastArchive: Fr;
   blockNumber: BlockNumber;
@@ -17,7 +19,7 @@ export type L2BlockInfo = {
 
 export function randomBlockInfo(blockNumber?: BlockNumber | number): L2BlockInfo {
   return {
-    blockHash: Fr.random(),
+    blockHash: BlockHash.random(),
     archive: Fr.random(),
     lastArchive: Fr.random(),
     blockNumber: BlockNumber(blockNumber ?? Math.floor(Math.random() * 100000) + 1),
@@ -28,7 +30,7 @@ export function randomBlockInfo(blockNumber?: BlockNumber | number): L2BlockInfo
 }
 
 export const BlockInfoSchema = z.object({
-  blockHash: schemas.Fr.optional(),
+  blockHash: BlockHash.schema.optional(),
   archive: schemas.Fr,
   lastArchive: schemas.Fr,
   blockNumber: BlockNumberSchema,
@@ -39,7 +41,7 @@ export const BlockInfoSchema = z.object({
 
 export function serializeBlockInfo(blockInfo: L2BlockInfo): Buffer {
   return serializeToBuffer(
-    blockInfo.blockHash ?? Fr.ZERO,
+    blockInfo.blockHash ?? BlockHash.ZERO,
     blockInfo.archive,
     blockInfo.lastArchive,
     blockInfo.blockNumber,
@@ -51,9 +53,9 @@ export function serializeBlockInfo(blockInfo: L2BlockInfo): Buffer {
 
 export function deserializeBlockInfo(buffer: Buffer | BufferReader): L2BlockInfo {
   const reader = BufferReader.asReader(buffer);
-  const blockHash = reader.readObject(Fr);
+  const blockHash = BlockHash.fromBuffer(reader);
   return {
-    blockHash: blockHash.equals(Fr.ZERO) ? undefined : blockHash,
+    blockHash: blockHash.equals(BlockHash.ZERO) ? undefined : blockHash,
     archive: reader.readObject(Fr),
     lastArchive: reader.readObject(Fr),
     blockNumber: BlockNumber(reader.readNumber()),