refactor!: add ChainSyncRollBackward.point

It might not be the same as 'tip',
because node might already have more than 1
block of the selected fork

Author: mkazlauskas

packages/core/src/CardanoNode/types/CardanoNode.ts

@@ -80,6 +80,7 @@ export interface ChainSyncRollForward {
 
 export interface ChainSyncRollBackward {
   eventType: ChainSyncEventType.RollBackward;
+  point: PointOrOrigin;
   tip: TipOrOrigin;
   requestNext: RequestNext;
 }

packages/golden-test-generator/src/ChainSyncEvents/chainSyncEvents.ts

@@ -29,7 +29,15 @@ const blocksWithRollbacks = (blockHeights: number[], requestedBlocks: RequestedB
       const requestedBlock = requestedBlocks[blockNo];
       if (!requestedBlock) throw new Error(`Cannot rollback to a non-requested block: ${blockHeight}`);
       const header = ogmiosToCore.blockHeader(requestedBlock);
-      header && result.push({ eventType: ChainSyncEventType.RollBackward, tip: header });
+      header &&
+        result.push({
+          eventType: ChainSyncEventType.RollBackward,
+          point: {
+            hash: header.hash,
+            slot: header.slot
+          },
+          tip: header
+        });
     }
   }
   return result;

packages/projection/src/operators/withRolledBackBlock.ts

@@ -20,7 +20,7 @@ export const withRolledBackBlock =
               takeWhile(
                 (block): block is Cardano.Block =>
                   block !== 'origin' &&
-                  (chainSyncEvent.tip === 'origin' || chainSyncEvent.tip.hash !== block.header.hash)
+                  (chainSyncEvent.point === 'origin' || chainSyncEvent.point.hash !== block.header.hash)
               ),
               map((block) => ({
                 ...chainSyncEvent,

packages/projection/src/projectIntoSink.ts

@@ -104,6 +104,7 @@ export const projectIntoSink = <P extends object, PS extends P>(
             of({
               block,
               eventType: ChainSyncEventType.RollBackward,
+              point: chainSync.intersection.point,
               // requestNext is a no-op when rolling back during initialization, because projectIntoSink will
               // delete block from the buffer for every RollBackward event via `manageBuffer`,
               // which will trigger the buffer to emit the next tip$

packages/projection/src/sinks/inMemory/stakePools.ts

@@ -23,9 +23,9 @@ export const stakePools: Sink<StakePoolsProjection, WithInMemoryStore> = {
         findOrCreate(evt, poolId).retirements.push(...poolRetirements);
       }
     } else {
-      // Delete all updates and retirements >= current tip.
+      // Delete all updates and retirements >= current cursor.
       const belowTip = ({ source }: WithCertificateSource) =>
-        evt.tip !== 'origin' && source.slot < evt.block.header.slot;
+        evt.point !== 'origin' && source.slot < evt.block.header.slot;
       for (const [_, stakePool] of evt.store.stakePools) {
         stakePool.updates = stakePool.updates.filter(belowTip);
         stakePool.retirements = stakePool.retirements.filter(belowTip);

packages/projection/test/events/data/with-pool-retirement.json

@@ -1843,6 +1843,10 @@
     },
     {
       "eventType": 1,
+      "point": {
+        "hash": "75829e67ca40d91ef5fce0a665cc4c710cfa73adb59528925ae57264d8062abf",
+        "slot": 878533
+      },
       "tip": {
         "blockNo": 32205,
         "hash": "75829e67ca40d91ef5fce0a665cc4c710cfa73adb59528925ae57264d8062abf",
@@ -3085,6 +3089,10 @@
     },
     {
       "eventType": 1,
+      "point": {
+        "hash": "6bfb34f78a3a018a2b1453f78912df6b88fc470856b82f66184fee40ef73bc97",
+        "slot": 900033
+      },
       "tip": {
         "blockNo": 33275,
         "hash": "6bfb34f78a3a018a2b1453f78912df6b88fc470856b82f66184fee40ef73bc97",

packages/projection/test/events/data/with-stake-key-deregistration.json

@@ -547,6 +547,10 @@
     },
     {
       "eventType": 1,
+      "point": {
+        "hash": "b830b7fb2eb6f7ed18a30cedd2c347769d83ecd7902edf89a4c9ea2b7ffa2020",
+        "slot": 687859
+      },
       "tip": {
         "blockNo": 22618,
         "hash": "b830b7fb2eb6f7ed18a30cedd2c347769d83ecd7902edf89a4c9ea2b7ffa2020",
@@ -4197,6 +4201,10 @@
     },
     {
       "eventType": 1,
+      "point": {
+        "hash": "383bb0210d135b0701aca287b4b534957b64f364076158987af3a128d20c04f7",
+        "slot": 690875
+      },
       "tip": {
         "blockNo": 22734,
         "hash": "383bb0210d135b0701aca287b4b534957b64f364076158987af3a128d20c04f7",

packages/projection/test/operators/withRolledBackBlock.test.ts

@@ -9,16 +9,23 @@ const createEvent = (eventType: ChainSyncEventType, slot: number, tipSlot = slot
   ({
     block: { header: { blockNo: Cardano.BlockNo(slot), hash: stubBlockId(slot), slot: Cardano.Slot(slot) } },
     eventType,
+    point:
+      eventType === ChainSyncEventType.RollForward
+        ? undefined
+        : { hash: stubBlockId(tipSlot), slot: Cardano.Slot(tipSlot) },
     requestNext: expect.anything(),
     tip: { blockNo: Cardano.BlockNo(tipSlot), hash: stubBlockId(tipSlot), slot: Cardano.Slot(tipSlot) }
   } as UnifiedProjectorEvent<{}>);
 
-const sourceRollback = (slot: number) =>
-  ({
+const sourceRollback = (slot: number): ChainSyncRollBackward => {
+  const point = { hash: stubBlockId(slot), slot: Cardano.Slot(slot) };
+  return {
     eventType: ChainSyncEventType.RollBackward,
+    point,
     requestNext: jest.fn(),
-    tip: { blockNo: Cardano.BlockNo(slot), hash: stubBlockId(slot), slot: Cardano.Slot(slot) }
-  } as ChainSyncRollBackward);
+    tip: { ...point, blockNo: Cardano.BlockNo(slot) }
+  };
+};
 
 describe('withRolledBackBlocks', () => {
   let buffer: sinks.StabilityWindowBuffer;

packages/projection/test/projectIntoSink.test.ts

@@ -1,6 +1,6 @@
 import * as Crypto from '@cardano-sdk/crypto';
 import { Cardano, ChainSyncEventType, ChainSyncRollForward } from '@cardano-sdk/core';
-import { InvalidIntersectionError, projectIntoSink, projections, sinks } from '../src';
+import { ObservableChainSyncError, projectIntoSink, projections, sinks } from '../src';
 import { StubChainSyncData, dataWithPoolRetirement, dataWithStakeKeyDeregistration } from './events';
 import { concat, defaultIfEmpty, firstValueFrom, lastValueFrom, toArray } from 'rxjs';
 import { logger } from '@cardano-sdk/util-dev';
@@ -132,7 +132,7 @@ describe('projectIntoSink', () => {
       ).pipe(defaultIfEmpty(null))
     );
     await expect(projectAll(dataWithStakeKeyDeregistration, inMemorySinks)).rejects.toThrowError(
-      InvalidIntersectionError
+      ObservableChainSyncError
     );
   });