@aztec/stdlib 0.0.1-commit.5de5ca79e → 0.0.1-commit.6201a7b05

package/dest/interfaces/chain_tips.d.ts

@@ -0,0 +1,304 @@
+import { z } from 'zod';
+import { type L2BlockTag, type L2Tips } from '../block/l2_block_source.js';
+/**
+ * Public chain-tip selectors usable in RPC requests.
+ * Omits internal-only tags (e.g. `proposedCheckpoint`) from {@link L2BlockTag}.
+ */
+export type ChainTip = Exclude<L2BlockTag, 'proposedCheckpoint'>;
+export declare const ChainTipSchema: z.ZodUnion<[z.ZodLiteral<"proposed">, z.ZodLiteral<"checkpointed">, z.ZodLiteral<"proven">, z.ZodLiteral<"finalized">]>;
+/**
+ * Tips of the L2 chain.
+ * Omits the sequencer-internal `proposedCheckpoint` from the public RPC surface.
+ */
+export type ChainTips = Omit<L2Tips, 'proposedCheckpoint'>;
+export declare const ChainTipsSchema: z.ZodObject<Omit<{
+    proposed: z.ZodObject<{
+        number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").BlockNumber, string | number | bigint>;
+        hash: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        number: number & {
+            _branding: "BlockNumber";
+        };
+        hash: string;
+    }, {
+        number: string | number | bigint;
+        hash: string;
+    }>;
+    checkpointed: z.ZodObject<{
+        block: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").BlockNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+        checkpoint: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    }, {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    }>;
+    proposedCheckpoint: z.ZodObject<{
+        block: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").BlockNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+        checkpoint: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    }, {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    }>;
+    proven: z.ZodObject<{
+        block: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").BlockNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+        checkpoint: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    }, {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    }>;
+    finalized: z.ZodObject<{
+        block: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").BlockNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+        checkpoint: z.ZodObject<{
+            number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>;
+            hash: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        }, {
+            number: string | number | bigint;
+            hash: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    }, {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    }>;
+}, "proposedCheckpoint">, "strip", z.ZodTypeAny, {
+    proposed: {
+        number: number & {
+            _branding: "BlockNumber";
+        };
+        hash: string;
+    };
+    checkpointed: {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    };
+    proven: {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    };
+    finalized: {
+        block: {
+            number: number & {
+                _branding: "BlockNumber";
+            };
+            hash: string;
+        };
+        checkpoint: {
+            number: number & {
+                _branding: "CheckpointNumber";
+            };
+            hash: string;
+        };
+    };
+}, {
+    proposed: {
+        number: string | number | bigint;
+        hash: string;
+    };
+    checkpointed: {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    };
+    proven: {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    };
+    finalized: {
+        block: {
+            number: string | number | bigint;
+            hash: string;
+        };
+        checkpoint: {
+            number: string | number | bigint;
+            hash: string;
+        };
+    };
+}>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhaW5fdGlwcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2ludGVyZmFjZXMvY2hhaW5fdGlwcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsQ0FBQyxFQUFFLE1BQU0sS0FBSyxDQUFDO0FBRXhCLE9BQU8sRUFBRSxLQUFLLFVBQVUsRUFBRSxLQUFLLE1BQU0sRUFBZ0IsTUFBTSw2QkFBNkIsQ0FBQztBQUV6Rjs7O0dBR0c7QUFDSCxNQUFNLE1BQU0sUUFBUSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEVBQUUsb0JBQW9CLENBQUMsQ0FBQztBQUVqRSxlQUFPLE1BQU0sY0FBYyx5SEFLSyxDQUFDO0FBRWpDOzs7R0FHRztBQUNILE1BQU0sTUFBTSxTQUFTLEdBQUcsSUFBSSxDQUFDLE1BQU0sRUFBRSxvQkFBb0IsQ0FBQyxDQUFDO0FBRTNELGVBQU8sTUFBTSxlQUFlOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0VBQWtELENBQUMifQ==

package/dest/interfaces/chain_tips.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain_tips.d.ts","sourceRoot":"","sources":["../../src/interfaces/chain_tips.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,MAAM,EAAgB,MAAM,6BAA6B,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,oBAAoB,CAAC,CAAC;AAEjE,eAAO,MAAM,cAAc,yHAKK,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;AAE3D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAkD,CAAC"}

package/dest/interfaces/chain_tips.js

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { L2TipsSchema } from '../block/l2_block_source.js';
+export const ChainTipSchema = z.union([
+    z.literal('proposed'),
+    z.literal('checkpointed'),
+    z.literal('proven'),
+    z.literal('finalized')
+]);
+export const ChainTipsSchema = L2TipsSchema.omit({
+    proposedCheckpoint: true
+});

package/dest/interfaces/checkpoint_parameter.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+/**
+ * Selector for a checkpoint in RPC calls.
+ *
+ * Accepts a numeric checkpoint number (or `{ number }`), a slot number (`{ slot }`), a chain-tip
+ * name (e.g. `'proven'`), or `'latest'` (alias for `'proposed'` — on the checkpoint side, this
+ * means the most recent confirmed checkpoint).
+ */
+export declare const CheckpointParameterSchema: z.ZodUnion<[z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>, z.ZodUnion<[z.ZodLiteral<"proposed">, z.ZodLiteral<"checkpointed">, z.ZodLiteral<"proven">, z.ZodLiteral<"finalized">]>, z.ZodLiteral<"latest">, z.ZodObject<{
+    number: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").CheckpointNumber, string | number | bigint>;
+}, "strip", z.ZodTypeAny, {
+    number: number & {
+        _branding: "CheckpointNumber";
+    };
+}, {
+    number: string | number | bigint;
+}>, z.ZodObject<{
+    slot: z.ZodEffects<z.ZodPipeline<z.ZodUnion<[z.ZodNumber, z.ZodBigInt, z.ZodString]>, z.ZodNumber>, import("@aztec/foundation/branded-types").SlotNumber, string | number | bigint>;
+}, "strip", z.ZodTypeAny, {
+    slot: number & {
+        _branding: "SlotNumber";
+    };
+}, {
+    slot: string | number | bigint;
+}>]>;
+export type CheckpointParameter = z.infer<typeof CheckpointParameterSchema>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2twb2ludF9wYXJhbWV0ZXIuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL2NoZWNrcG9pbnRfcGFyYW1ldGVyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sRUFBRSxDQUFDLEVBQUUsTUFBTSxLQUFLLENBQUM7QUFJeEI7Ozs7OztHQU1HO0FBQ0gsZUFBTyxNQUFNLHlCQUF5Qjs7Ozs7Ozs7Ozs7Ozs7OztJQU1wQyxDQUFDO0FBRUgsTUFBTSxNQUFNLG1CQUFtQixHQUFHLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyx5QkFBeUIsQ0FBQyxDQUFDIn0=

package/dest/interfaces/checkpoint_parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkpoint_parameter.d.ts","sourceRoot":"","sources":["../../src/interfaces/checkpoint_parameter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;IAMpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

package/dest/interfaces/checkpoint_parameter.js

@@ -0,0 +1,20 @@
+import { CheckpointNumberSchema, SlotNumberSchema } from '@aztec/foundation/branded-types';
+import { z } from 'zod';
+import { ChainTipSchema } from './chain_tips.js';
+/**
+ * Selector for a checkpoint in RPC calls.
+ *
+ * Accepts a numeric checkpoint number (or `{ number }`), a slot number (`{ slot }`), a chain-tip
+ * name (e.g. `'proven'`), or `'latest'` (alias for `'proposed'` — on the checkpoint side, this
+ * means the most recent confirmed checkpoint).
+ */ export const CheckpointParameterSchema = z.union([
+    CheckpointNumberSchema,
+    ChainTipSchema,
+    z.literal('latest'),
+    z.object({
+        number: CheckpointNumberSchema
+    }),
+    z.object({
+        slot: SlotNumberSchema
+    })
+]);