@aztec/world-state 0.0.0-test.0 → 0.0.1-commit.03f7ef2

package/src/native/message.ts

@@ -1,8 +1,10 @@
-import { Fr } from '@aztec/foundation/fields';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import type { Tuple } from '@aztec/foundation/serialize';
 import { AppendOnlyTreeSnapshot, MerkleTreeId } from '@aztec/stdlib/trees';
 import type { StateReference } from '@aztec/stdlib/tx';
 import type { UInt32 } from '@aztec/stdlib/types';
+import type { WorldStateRevision } from '@aztec/stdlib/world-state';
 
 export enum WorldStateMessageType {
   GET_TREE_INFO = 100,
@@ -16,6 +18,7 @@ export enum WorldStateMessageType {
 
   FIND_LEAF_INDICES,
   FIND_LOW_LEAF,
+  FIND_SIBLING_PATHS,
 
   APPEND_LEAVES,
   BATCH_INSERT,
@@ -31,7 +34,7 @@ export enum WorldStateMessageType {
   CREATE_FORK,
   DELETE_FORK,
 
-  FINALISE_BLOCKS,
+  FINALIZE_BLOCKS,
   UNWIND_BLOCKS,
   REMOVE_HISTORICAL_BLOCKS,
 
@@ -40,6 +43,10 @@ export enum WorldStateMessageType {
   CREATE_CHECKPOINT,
   COMMIT_CHECKPOINT,
   REVERT_CHECKPOINT,
+  COMMIT_ALL_CHECKPOINTS,
+  REVERT_ALL_CHECKPOINTS,
+
+  COPY_STORES,
 
   CLOSE = 999,
 }
@@ -50,11 +57,11 @@ interface WithTreeId {
 
 export interface WorldStateStatusSummary {
   /** Last block number that can still be unwound. */
-  unfinalisedBlockNumber: bigint;
-  /** Last block number that is finalised and cannot be unwound. */
-  finalisedBlockNumber: bigint;
+  unfinalizedBlockNumber: BlockNumber;
+  /** Last block number that is finalized and cannot be unwound. */
+  finalizedBlockNumber: BlockNumber;
   /** Oldest block still available for historical queries and forks. */
-  oldestHistoricalBlock: bigint;
+  oldestHistoricalBlock: BlockNumber;
   /** Whether the trees are in sync with each other */
   treesAreSynched: boolean;
 }
@@ -75,11 +82,11 @@ export interface TreeMeta {
   /** The tree's initial root value  */
   initialRoot: Fr;
   /** The current oldest historical block number of the tree */
-  oldestHistoricBlock: bigint;
-  /** The current unfinalised block number of the tree */
-  unfinalisedBlockHeight: bigint;
-  /** The current finalised block number of the tree */
-  finalisedBlockHeight: bigint;
+  oldestHistoricBlock: BlockNumber;
+  /** The current unfinalized block number of the tree */
+  unfinalizedBlockHeight: BlockNumber;
+  /** The current finalized block number of the tree */
+  finalizedBlockHeight: BlockNumber;
 }
 
 export interface DBStats {
@@ -94,6 +101,8 @@ export interface DBStats {
 export interface TreeDBStats {
   /** The configured max size of the DB mapping file (effectively the max possible size of the DB) */
   mapSize: bigint;
+  /** The physical file size of the database on disk */
+  physicalFileSize: bigint;
   /** Stats for the 'blocks' DB */
   blocksDBStats: DBStats;
   /** Stats for the 'nodes' DB */
@@ -149,6 +158,7 @@ export function buildEmptyDBStats() {
 export function buildEmptyTreeDBStats() {
   return {
     mapSize: 0n,
+    physicalFileSize: 0n,
     blocksDBStats: buildEmptyDBStats(),
     nodesDBStats: buildEmptyDBStats(),
     leafIndicesDBStats: buildEmptyDBStats(),
@@ -164,9 +174,9 @@ export function buildEmptyTreeMeta() {
     depth: 0,
     size: 0n,
     committedSize: 0n,
-    unfinalisedBlockHeight: 0n,
-    finalisedBlockHeight: 0n,
-    oldestHistoricBlock: 0n,
+    unfinalizedBlockHeight: BlockNumber.ZERO,
+    finalizedBlockHeight: BlockNumber.ZERO,
+    oldestHistoricBlock: BlockNumber.ZERO,
     root: Fr.ZERO,
     initialRoot: Fr.ZERO,
     initialSize: 0n,
@@ -195,9 +205,9 @@ export function buildEmptyWorldStateDBStats() {
 
 export function buildEmptyWorldStateSummary() {
   return {
-    unfinalisedBlockNumber: 0n,
-    finalisedBlockNumber: 0n,
-    oldestHistoricalBlock: 0n,
+    unfinalizedBlockNumber: BlockNumber.ZERO,
+    finalizedBlockNumber: BlockNumber.ZERO,
+    oldestHistoricalBlock: BlockNumber.ZERO,
     treesAreSynched: true,
   } as WorldStateStatusSummary;
 }
@@ -210,61 +220,62 @@ export function buildEmptyWorldStateStatusFull() {
   } as WorldStateStatusFull;
 }
 
-export function sanitiseSummary(summary: WorldStateStatusSummary) {
-  summary.finalisedBlockNumber = BigInt(summary.finalisedBlockNumber);
-  summary.unfinalisedBlockNumber = BigInt(summary.unfinalisedBlockNumber);
-  summary.oldestHistoricalBlock = BigInt(summary.oldestHistoricalBlock);
+export function sanitizeSummary(summary: WorldStateStatusSummary) {
+  summary.finalizedBlockNumber = BlockNumber.fromBigInt(BigInt(summary.finalizedBlockNumber));
+  summary.unfinalizedBlockNumber = BlockNumber.fromBigInt(BigInt(summary.unfinalizedBlockNumber));
+  summary.oldestHistoricalBlock = BlockNumber.fromBigInt(BigInt(summary.oldestHistoricalBlock));
   return summary;
 }
 
-export function sanitiseDBStats(stats: DBStats) {
+export function sanitizeDBStats(stats: DBStats) {
   stats.numDataItems = BigInt(stats.numDataItems);
   stats.totalUsedSize = BigInt(stats.totalUsedSize);
   return stats;
 }
 
-export function sanitiseMeta(meta: TreeMeta) {
+export function sanitizeMeta(meta: TreeMeta) {
   meta.committedSize = BigInt(meta.committedSize);
-  meta.finalisedBlockHeight = BigInt(meta.finalisedBlockHeight);
+  meta.finalizedBlockHeight = BlockNumber.fromBigInt(BigInt(meta.finalizedBlockHeight));
   meta.initialSize = BigInt(meta.initialSize);
-  meta.oldestHistoricBlock = BigInt(meta.oldestHistoricBlock);
+  meta.oldestHistoricBlock = BlockNumber.fromBigInt(BigInt(meta.oldestHistoricBlock));
   meta.size = BigInt(meta.size);
-  meta.unfinalisedBlockHeight = BigInt(meta.unfinalisedBlockHeight);
+  meta.unfinalizedBlockHeight = BlockNumber.fromBigInt(BigInt(meta.unfinalizedBlockHeight));
   return meta;
 }
 
-export function sanitiseTreeDBStats(stats: TreeDBStats) {
-  stats.blocksDBStats = sanitiseDBStats(stats.blocksDBStats);
-  stats.leafIndicesDBStats = sanitiseDBStats(stats.leafIndicesDBStats);
-  stats.leafPreimagesDBStats = sanitiseDBStats(stats.leafPreimagesDBStats);
-  stats.blockIndicesDBStats = sanitiseDBStats(stats.blockIndicesDBStats);
-  stats.nodesDBStats = sanitiseDBStats(stats.nodesDBStats);
+export function sanitizeTreeDBStats(stats: TreeDBStats) {
+  stats.blocksDBStats = sanitizeDBStats(stats.blocksDBStats);
+  stats.leafIndicesDBStats = sanitizeDBStats(stats.leafIndicesDBStats);
+  stats.leafPreimagesDBStats = sanitizeDBStats(stats.leafPreimagesDBStats);
+  stats.blockIndicesDBStats = sanitizeDBStats(stats.blockIndicesDBStats);
+  stats.nodesDBStats = sanitizeDBStats(stats.nodesDBStats);
   stats.mapSize = BigInt(stats.mapSize);
+  stats.physicalFileSize = BigInt(stats.physicalFileSize);
   return stats;
 }
 
-export function sanitiseWorldStateDBStats(stats: WorldStateDBStats) {
-  stats.archiveTreeStats = sanitiseTreeDBStats(stats.archiveTreeStats);
-  stats.messageTreeStats = sanitiseTreeDBStats(stats.messageTreeStats);
-  stats.noteHashTreeStats = sanitiseTreeDBStats(stats.noteHashTreeStats);
-  stats.nullifierTreeStats = sanitiseTreeDBStats(stats.nullifierTreeStats);
-  stats.publicDataTreeStats = sanitiseTreeDBStats(stats.publicDataTreeStats);
+export function sanitizeWorldStateDBStats(stats: WorldStateDBStats) {
+  stats.archiveTreeStats = sanitizeTreeDBStats(stats.archiveTreeStats);
+  stats.messageTreeStats = sanitizeTreeDBStats(stats.messageTreeStats);
+  stats.noteHashTreeStats = sanitizeTreeDBStats(stats.noteHashTreeStats);
+  stats.nullifierTreeStats = sanitizeTreeDBStats(stats.nullifierTreeStats);
+  stats.publicDataTreeStats = sanitizeTreeDBStats(stats.publicDataTreeStats);
   return stats;
 }
 
-export function sanitiseWorldStateTreeMeta(meta: WorldStateMeta) {
-  meta.archiveTreeMeta = sanitiseMeta(meta.archiveTreeMeta);
-  meta.messageTreeMeta = sanitiseMeta(meta.messageTreeMeta);
-  meta.noteHashTreeMeta = sanitiseMeta(meta.noteHashTreeMeta);
-  meta.nullifierTreeMeta = sanitiseMeta(meta.nullifierTreeMeta);
-  meta.publicDataTreeMeta = sanitiseMeta(meta.publicDataTreeMeta);
+export function sanitizeWorldStateTreeMeta(meta: WorldStateMeta) {
+  meta.archiveTreeMeta = sanitizeMeta(meta.archiveTreeMeta);
+  meta.messageTreeMeta = sanitizeMeta(meta.messageTreeMeta);
+  meta.noteHashTreeMeta = sanitizeMeta(meta.noteHashTreeMeta);
+  meta.nullifierTreeMeta = sanitizeMeta(meta.nullifierTreeMeta);
+  meta.publicDataTreeMeta = sanitizeMeta(meta.publicDataTreeMeta);
   return meta;
 }
 
-export function sanitiseFullStatus(status: WorldStateStatusFull) {
-  status.dbStats = sanitiseWorldStateDBStats(status.dbStats);
-  status.summary = sanitiseSummary(status.summary);
-  status.meta = sanitiseWorldStateTreeMeta(status.meta);
+export function sanitizeFullStatus(status: WorldStateStatusFull) {
+  status.dbStats = sanitizeWorldStateDBStats(status.dbStats);
+  status.summary = sanitizeSummary(status.summary);
+  status.meta = sanitizeWorldStateTreeMeta(status.meta);
   return status;
 }
 
@@ -286,13 +297,13 @@ interface WithLeafIndex {
 
 export type SerializedLeafValue =
   | Buffer // Fr
-  | { value: Buffer } // NullifierLeaf
+  | { nullifier: Buffer } // NullifierLeaf
   | { value: Buffer; slot: Buffer }; // PublicDataTreeLeaf
 
 export type SerializedIndexedLeaf = {
-  value: Exclude<SerializedLeafValue, Buffer>;
+  leaf: Exclude<SerializedLeafValue, Buffer>;
   nextIndex: bigint | number;
-  nextValue: Buffer; // Fr
+  nextKey: Buffer; // Fr
 };
 
 interface WithLeafValues {
@@ -300,7 +311,7 @@ interface WithLeafValues {
 }
 
 interface BlockShiftRequest extends WithCanonicalForkId {
-  toBlockNumber: bigint;
+  toBlockNumber: BlockNumber;
 }
 
 interface WithLeaves {
@@ -344,6 +355,16 @@ interface FindLeafIndicesResponse {
   indices: bigint[];
 }
 
+interface FindSiblingPathsRequest extends WithTreeId, WithLeafValues, WithWorldStateRevision {}
+
+interface SiblingPathAndIndex {
+  index: bigint;
+  path: Buffer[];
+}
+interface FindSiblingPathsResponse {
+  paths: (SiblingPathAndIndex | undefined)[];
+}
+
 interface FindLowLeafRequest extends WithTreeId, WithWorldStateRevision {
   key: Fr;
 }
@@ -389,7 +410,7 @@ interface UpdateArchiveRequest extends WithForkId {
 }
 
 interface SyncBlockRequest extends WithCanonicalForkId {
-  blockNumber: number;
+  blockNumber: BlockNumber;
   blockStateRef: BlockStateReference;
   blockHeaderHash: Fr;
   paddedNoteHashes: readonly SerializedLeafValue[];
@@ -400,7 +421,7 @@ interface SyncBlockRequest extends WithCanonicalForkId {
 
 interface CreateForkRequest extends WithCanonicalForkId {
   latest: boolean;
-  blockNumber: number;
+  blockNumber: BlockNumber;
 }
 
 interface CreateForkResponse {
@@ -409,6 +430,11 @@ interface CreateForkResponse {
 
 interface DeleteForkRequest extends WithForkId {}
 
+interface CopyStoresRequest extends WithCanonicalForkId {
+  dstPath: string;
+  compact: boolean;
+}
+
 export type WorldStateRequestCategories = WithForkId | WithWorldStateRevision | WithCanonicalForkId;
 
 export function isWithForkId(body: WorldStateRequestCategories): body is WithForkId {
@@ -435,6 +461,7 @@ export type WorldStateRequest = {
 
   [WorldStateMessageType.FIND_LEAF_INDICES]: FindLeafIndicesRequest;
   [WorldStateMessageType.FIND_LOW_LEAF]: FindLowLeafRequest;
+  [WorldStateMessageType.FIND_SIBLING_PATHS]: FindSiblingPathsRequest;
 
   [WorldStateMessageType.APPEND_LEAVES]: AppendLeavesRequest;
   [WorldStateMessageType.BATCH_INSERT]: BatchInsertRequest;
@@ -452,13 +479,17 @@ export type WorldStateRequest = {
 
   [WorldStateMessageType.REMOVE_HISTORICAL_BLOCKS]: BlockShiftRequest;
   [WorldStateMessageType.UNWIND_BLOCKS]: BlockShiftRequest;
-  [WorldStateMessageType.FINALISE_BLOCKS]: BlockShiftRequest;
+  [WorldStateMessageType.FINALIZE_BLOCKS]: BlockShiftRequest;
 
   [WorldStateMessageType.GET_STATUS]: WithCanonicalForkId;
 
   [WorldStateMessageType.CREATE_CHECKPOINT]: WithForkId;
   [WorldStateMessageType.COMMIT_CHECKPOINT]: WithForkId;
   [WorldStateMessageType.REVERT_CHECKPOINT]: WithForkId;
+  [WorldStateMessageType.COMMIT_ALL_CHECKPOINTS]: WithForkId;
+  [WorldStateMessageType.REVERT_ALL_CHECKPOINTS]: WithForkId;
+
+  [WorldStateMessageType.COPY_STORES]: CopyStoresRequest;
 
   [WorldStateMessageType.CLOSE]: WithCanonicalForkId;
 };
@@ -475,6 +506,7 @@ export type WorldStateResponse = {
 
   [WorldStateMessageType.FIND_LEAF_INDICES]: FindLeafIndicesResponse;
   [WorldStateMessageType.FIND_LOW_LEAF]: FindLowLeafResponse;
+  [WorldStateMessageType.FIND_SIBLING_PATHS]: FindSiblingPathsResponse;
 
   [WorldStateMessageType.APPEND_LEAVES]: void;
   [WorldStateMessageType.BATCH_INSERT]: BatchInsertResponse;
@@ -492,33 +524,20 @@ export type WorldStateResponse = {
 
   [WorldStateMessageType.REMOVE_HISTORICAL_BLOCKS]: WorldStateStatusFull;
   [WorldStateMessageType.UNWIND_BLOCKS]: WorldStateStatusFull;
-  [WorldStateMessageType.FINALISE_BLOCKS]: WorldStateStatusSummary;
+  [WorldStateMessageType.FINALIZE_BLOCKS]: WorldStateStatusSummary;
 
   [WorldStateMessageType.GET_STATUS]: WorldStateStatusSummary;
 
   [WorldStateMessageType.CREATE_CHECKPOINT]: void;
   [WorldStateMessageType.COMMIT_CHECKPOINT]: void;
   [WorldStateMessageType.REVERT_CHECKPOINT]: void;
+  [WorldStateMessageType.COMMIT_ALL_CHECKPOINTS]: void;
+  [WorldStateMessageType.REVERT_ALL_CHECKPOINTS]: void;
 
-  [WorldStateMessageType.CLOSE]: void;
-};
+  [WorldStateMessageType.COPY_STORES]: void;
 
-export type WorldStateRevision = {
-  forkId: number;
-  blockNumber: number;
-  includeUncommitted: boolean;
+  [WorldStateMessageType.CLOSE]: void;
 };
-export function worldStateRevision(
-  includeUncommitted: boolean,
-  forkId: number | undefined,
-  blockNumber: number | undefined,
-): WorldStateRevision {
-  return {
-    forkId: forkId ?? 0,
-    blockNumber: blockNumber ?? 0,
-    includeUncommitted,
-  };
-}
 
 type TreeStateReference = readonly [Buffer, number | bigint];
 type BlockStateReference = Map<Exclude<MerkleTreeId, MerkleTreeId.ARCHIVE>, TreeStateReference>;