feat: mark finalized blocks

.github/workflows/nova-build-temp.yaml

@@ -6,7 +6,7 @@ on:
       TARGET_COMMIT:
         description: "Target Commit Hash for the SDK"
         required: false
-        default: "133f911b18191cda9099f1b4aeaf7d0022dfe0fb"
+        default: "8f0ff5e1e899a0d960ddfea09237739a88c3bcf1"
       environment:
         type: choice
         description: "Select the environment to deploy to"

api/src/models/api/nova/feed/IFeedUpdate.ts

@@ -1,6 +1,6 @@
 /* eslint-disable import/no-unresolved */
 /* eslint-disable @typescript-eslint/no-redundant-type-constituents */
-import { Block, IBlockMetadata } from "@iota/sdk-nova";
+import { Block, IBlockMetadata, SlotIndex } from "@iota/sdk-nova";
 
 interface IFeedBlockUpdate {
     blockId: string;
@@ -11,4 +11,5 @@ export interface IFeedUpdate {
     subscriptionId: string;
     blockUpdate?: IFeedBlockUpdate;
     blockMetadataUpdate?: IBlockMetadata;
+    slotFinalized?: SlotIndex;
 }

api/src/services/nova/feed/novaFeed.ts

@@ -1,6 +1,6 @@
 /* eslint-disable import/no-unresolved */
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
-import { Block, Client, IBlockMetadata } from "@iota/sdk-nova";
+import { Block, Client, IBlockMetadata, SlotCommitment } from "@iota/sdk-nova";
 import { ClassConstructor, plainToInstance } from "class-transformer";
 import { ServiceFactory } from "../../../factories/serviceFactory";
 import logger from "../../../logger";
@@ -112,6 +112,22 @@ export class NovaFeed {
                 logger.error("[NovaFeed]: Failed broadcasting block-metadata downstream.");
             }
         });
+
+        // eslint-disable-next-line no-void
+        void this._mqttClient.listenMqtt(["commitments/finalized"], async (_, message) => {
+            try {
+                const deserializedMessage: { topic: string; payload: string } = JSON.parse(message);
+                const slotCommitment: SlotCommitment = JSON.parse(deserializedMessage.payload);
+                const slotFinalized = slotCommitment.slot;
+
+                const update: Partial<IFeedUpdate> = { slotFinalized };
+
+                // eslint-disable-next-line no-void
+                void this.broadcastBlock(update);
+            } catch {
+                logger.error("[NovaFeed]: Failed broadcasting block-metadata downstream.");
+            }
+        });
     }
 
     private parseMqttPayloadMessage<T>(cls: ClassConstructor<T>, serializedMessage: string): T {

client/src/features/visualizer-threejs/VisualizerInstance.tsx

@@ -27,7 +27,8 @@ import { Wrapper } from "./wrapper/Wrapper";
 import { CanvasElement } from "./enums";
 import { useGetThemeMode } from "~/helpers/hooks/useGetThemeMode";
 import { TSelectFeedItemNova } from "~/app/types/visualizer.types";
-import { BasicBlockBody, IBlockMetadata } from "@iota/sdk-wasm-nova/web";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { BasicBlockBody, Utils, type IBlockMetadata, type BlockState, type SlotIndex, type BlockId } from "@iota/sdk-wasm-nova/web";
 import { IFeedBlockData } from "~/models/api/nova/feed/IFeedBlockData";
 import CameraControls from "./CameraControls";
 import "./Visualizer.scss";
@@ -67,6 +68,9 @@ const VisualizerInstance: React.FC<RouteComponentProps<VisualizerRouteProps>> =
     const blockMetadata = useTangleStore((s) => s.blockMetadata);
     const indexToBlockId = useTangleStore((s) => s.indexToBlockId);
     const clickedInstanceId = useTangleStore((s) => s.clickedInstanceId);
+    const confirmedBlocksBySlot = useTangleStore((s) => s.confirmedBlocksBySlot);
+    const addToConfirmedBlocksSlot = useTangleStore((s) => s.addToConfirmedBlocksBySlot);
+    const removeConfirmedBlocksSlot = useTangleStore((s) => s.removeConfirmedBlocksSlot);
 
     const selectedFeedItem: TSelectFeedItemNova = clickedInstanceId ? blockMetadata.get(clickedInstanceId) ?? null : null;
     const resetConfigState = useTangleStore((s) => s.resetConfigState);
@@ -171,7 +175,7 @@ const VisualizerInstance: React.FC<RouteComponentProps<VisualizerRouteProps>> =
         if (!feedService) {
             return;
         }
-        feedService.subscribeBlocks(onNewBlock, onBlockMetadataUpdate);
+        feedService.subscribeBlocks(onNewBlock, onBlockMetadataUpdate, onSlotFinalized);
 
         bpsCounter.start();
     };
@@ -239,9 +243,31 @@ const VisualizerInstance: React.FC<RouteComponentProps<VisualizerRouteProps>> =
             if (selectedColor) {
                 addToColorQueue(metadataUpdate.blockId, selectedColor);
             }
+
+            const acceptedStates: BlockState[] = ["confirmed", "accepted"];
+
+            if (acceptedStates.includes(metadataUpdate.blockState)) {
+                const slot = Utils.computeSlotIndex(metadataUpdate.blockId);
+                addToConfirmedBlocksSlot(metadataUpdate.blockId, slot);
+            }
         }
     }
 
+    function onSlotFinalized(slot: SlotIndex): void {
+        const blocks = confirmedBlocksBySlot.get(slot);
+
+        if (blocks?.length) {
+            blocks.forEach((blockId) => {
+                const selectedColor = BLOCK_STATE_TO_COLOR.get("finalized");
+                if (selectedColor) {
+                    addToColorQueue(blockId, selectedColor);
+                }
+            });
+        }
+
+        removeConfirmedBlocksSlot(slot);
+    }
+
     return (
         <Wrapper
             key={network}

client/src/features/visualizer-threejs/store/tangle.ts

@@ -3,6 +3,7 @@ import { create } from "zustand";
 import { devtools } from "zustand/middleware";
 import { ZOOM_DEFAULT, ANIMATION_TIME_SECONDS } from "../constants";
 import { IFeedBlockData } from "~models/api/nova/feed/IFeedBlockData";
+import { BlockId, SlotIndex } from "@iota/sdk-wasm-nova/web";
 
 interface IPosition {
     x: number;
@@ -64,6 +65,11 @@ interface TangleState {
 
     updateBlockIdToAnimationPosition: (updatedPositions: Map<string, IBlockInitPosition>) => void;
     resetConfigState: () => void;
+
+    // Handle finalized blocks
+    confirmedBlocksBySlot: Map<number, string[]>;
+    addToConfirmedBlocksBySlot: (blockId: BlockId, slot: SlotIndex) => void;
+    removeConfirmedBlocksSlot: (slot: SlotIndex) => void;
 }
 
 const INITIAL_STATE = {
@@ -79,6 +85,7 @@ const INITIAL_STATE = {
     zoom: ZOOM_DEFAULT,
     bps: 0,
     clickedInstanceId: null,
+    confirmedBlocksBySlot: new Map(),
 };
 
 export const useTangleStore = create<TangleState>()(
@@ -204,5 +211,33 @@ export const useTangleStore = create<TangleState>()(
                 clickedInstanceId,
             }));
         },
+        addToConfirmedBlocksBySlot: (blockId, slot) => {
+            set((state) => {
+                state.confirmedBlocksBySlot.has(slot)
+                    ? state.confirmedBlocksBySlot.get(slot)?.push(blockId)
+                    : state.confirmedBlocksBySlot.set(slot, [blockId]);
+                return {
+                    ...state,
+                    confirmedBlocksBySlot: state.confirmedBlocksBySlot,
+                };
+            });
+        },
+        removeConfirmedBlocksSlot: (slot) => {
+            set((state) => {
+                state.confirmedBlocksBySlot.delete(slot);
+
+                // Cleanup all slots that are lower than the current slot
+                for (const existingSlot of state.confirmedBlocksBySlot.keys()) {
+                    if (existingSlot < slot) {
+                        state.confirmedBlocksBySlot.delete(existingSlot);
+                    }
+                }
+
+                return {
+                    ...state,
+                    confirmedBlocksBySlot: state.confirmedBlocksBySlot,
+                };
+            });
+        },
     })),
 );

client/src/models/api/nova/feed/IFeedUpdate.ts

@@ -1,4 +1,4 @@
-import { Block, IBlockMetadata } from "@iota/sdk-wasm-nova/web";
+import { Block, IBlockMetadata, SlotIndex } from "@iota/sdk-wasm-nova/web";
 
 interface IFeedBlockUpdate {
     blockId: string;
@@ -9,4 +9,5 @@ export interface IFeedUpdate {
     subscriptionId: string;
     blockUpdate?: IFeedBlockUpdate;
     blockMetadataUpdate?: IBlockMetadata;
+    slotFinalized?: SlotIndex;
 }

client/src/services/nova/novaFeedClient.ts

@@ -1,4 +1,4 @@
-import { IBlockMetadata } from "@iota/sdk-wasm-nova/web";
+import { IBlockMetadata, SlotIndex } from "@iota/sdk-wasm-nova/web";
 import { io, Socket } from "socket.io-client";
 import { ServiceFactory } from "~/factories/serviceFactory";
 import { IFeedSubscribeResponse } from "~/models/api/IFeedSubscribeResponse";
@@ -54,6 +54,7 @@ export class NovaFeedClient {
     public subscribeBlocks(
         onBlockDataCallback?: (blockData: IFeedBlockData) => void,
         onMetadataUpdatedCallback?: (blockMetadata: IBlockMetadata) => void,
+        onSlotFinalizedCallback?: (slotFinalized: SlotIndex) => void,
     ) {
         this.socket = io(this.endpoint, { upgrade: true, transports: ["websocket"] });
 
@@ -88,6 +89,10 @@ export class NovaFeedClient {
                         if (update.blockMetadataUpdate) {
                             onMetadataUpdatedCallback?.(update.blockMetadataUpdate);
                         }
+
+                        if (update.slotFinalized) {
+                            onSlotFinalizedCallback?.(update.slotFinalized);
+                        }
                     }
                 });
 

setup_nova.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 SDK_DIR="iota-sdk"
-TARGET_COMMIT="133f911b18191cda9099f1b4aeaf7d0022dfe0fb"
+TARGET_COMMIT="8f0ff5e1e899a0d960ddfea09237739a88c3bcf1"
 
 if [ ! -d "$SDK_DIR" ]; then
   git clone -b 2.0 [email protected]:iotaledger/iota-sdk.git