refactor!: hoist bufferChainSyncEvent to projection package

BREAKING CHANGE: OgmiosObservableCardanoNode and bufferChainSyncEvent were moved from core package to projection package

Author: AngelCastilloB

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

@@ -1,5 +1,5 @@
+import type { Block, Lovelace, PoolId, Tip, VrfVkHex } from '../../Cardano';
 import type { HealthCheckResponse } from '../../Provider';
-import type { Lovelace, PoolId, VrfVkHex } from '../../Cardano';
 import type { Milliseconds } from '../../util';
 
 export interface EraSummary {
@@ -48,3 +48,38 @@ export interface CardanoNode {
    */
   healthCheck(): Promise<HealthCheckResponse>;
 }
+
+// Similar to Ogmios.Point, but using Cardano.BlockId opaque string for hash
+export type Point = Pick<Tip, 'hash' | 'slot'>;
+export type Origin = 'origin';
+export type TipOrOrigin = Tip | Origin;
+export type PointOrOrigin = Point | Origin;
+export type Intersection = {
+  point: PointOrOrigin;
+  tip: TipOrOrigin;
+};
+
+export enum ChainSyncEventType {
+  RollForward,
+  RollBackward
+}
+
+export type RequestNext = () => void;
+
+export interface WithRequestNext {
+  requestNext: RequestNext;
+}
+
+export interface ChainSyncRollForward extends WithRequestNext {
+  tip: Tip;
+  eventType: ChainSyncEventType.RollForward;
+  block: Block;
+}
+
+export interface ChainSyncRollBackward extends WithRequestNext {
+  eventType: ChainSyncEventType.RollBackward;
+  point: PointOrOrigin;
+  tip: TipOrOrigin;
+}
+
+export type ChainSyncEvent = ChainSyncRollForward | ChainSyncRollBackward;

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

@@ -1,3 +1,2 @@
 export * from './CardanoNode';
 export * from './CardanoNodeErrors';
-export * from './ObservableCardanoNode';

packages/ogmios/package.json

@@ -58,6 +58,7 @@
     "@cardano-ogmios/schema": "6.5.0",
     "@cardano-sdk/core": "workspace:~",
     "@cardano-sdk/crypto": "workspace:~",
+    "@cardano-sdk/projection": "workspace:~",
     "@cardano-sdk/util": "workspace:~",
     "backoff-rxjs": "^7.0.0",
     "buffer": "5.7.1",

packages/ogmios/src/CardanoNode/OgmiosObservableCardanoNode/OgmiosObservableCardanoNode.ts

@@ -8,8 +8,6 @@ import {
   GeneralCardanoNodeErrorCode,
   HealthCheckResponse,
   Milliseconds,
-  ObservableCardanoNode,
-  ObservableChainSync,
   PointOrOrigin,
   StakeDistribution,
   StateQueryErrorCode
@@ -49,6 +47,7 @@ import {
   withCoreCardanoNodeError
 } from '../queries';
 import isEqual from 'lodash/isEqual.js';
+import type { ObservableCardanoNode, ObservableChainSync } from '@cardano-sdk/projection';
 import type { Serialization } from '@cardano-sdk/core';
 
 const ogmiosToCoreIntersection = (intersection: ChainSynchronization.Intersection) => ({

packages/projection/src/Bootstrap/fromCardanoNode.ts

@@ -1,16 +1,10 @@
 /* eslint-disable max-len */
 /* eslint-disable jsdoc/valid-types */
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import {
-  Cardano,
-  ChainSyncEventType,
-  Intersection,
-  ObservableCardanoNode,
-  ObservableChainSync,
-  TipOrOrigin
-} from '@cardano-sdk/core';
+import { Cardano, ChainSyncEventType, Intersection, TipOrOrigin } from '@cardano-sdk/core';
 import { Logger } from 'ts-log';
 import { Observable, concat, defer, map, mergeMap, noop, of, switchMap, take, takeWhile, tap } from 'rxjs';
+import { ObservableCardanoNode, ObservableChainSync } from '../ObservableCardanoNode';
 import { ProjectionEvent, StabilityWindowBuffer, UnifiedExtChainSyncEvent } from '../types';
 import { contextLogger } from '@cardano-sdk/util';
 import { pointDescription } from '../util';

packages/core/src/CardanoNode/types/ObservableCardanoNode.ts renamed to packages/projection/src/ObservableCardanoNode.ts

@@ -1,43 +1,15 @@
-import { bufferChainSyncEvent } from '../util/bufferChainSyncEvent';
-import type { Cardano, HealthCheckResponse, Serialization } from '../..';
-import type { EraSummary } from './CardanoNode';
+import { bufferChainSyncEvent } from './bufferChainSyncEvent';
+import type {
+  Cardano,
+  ChainSyncEvent,
+  EraSummary,
+  HealthCheckResponse,
+  Intersection,
+  PointOrOrigin,
+  Serialization
+} from '@cardano-sdk/core';
 import type { Observable } from 'rxjs';
 
-// Similar to Ogmios.Point, but using Cardano.BlockId opaque string for hash
-export type Point = Pick<Cardano.Tip, 'hash' | 'slot'>;
-export type Origin = 'origin';
-export type TipOrOrigin = Cardano.Tip | Origin;
-export type PointOrOrigin = Point | Origin;
-export type Intersection = {
-  point: PointOrOrigin;
-  tip: TipOrOrigin;
-};
-
-export enum ChainSyncEventType {
-  RollForward,
-  RollBackward
-}
-
-export type RequestNext = () => void;
-
-export interface WithRequestNext {
-  requestNext: RequestNext;
-}
-
-export interface ChainSyncRollForward extends WithRequestNext {
-  tip: Cardano.Tip;
-  eventType: ChainSyncEventType.RollForward;
-  block: Cardano.Block;
-}
-
-export interface ChainSyncRollBackward extends WithRequestNext {
-  eventType: ChainSyncEventType.RollBackward;
-  point: PointOrOrigin;
-  tip: TipOrOrigin;
-}
-
-export type ChainSyncEvent = ChainSyncRollForward | ChainSyncRollBackward;
-
 export interface ObservableChainSync {
   /** Observable that can be used to subscribe to Chain Sync events from `intersection`. */
   chainSync$: Observable<ChainSyncEvent>;

packages/core/src/CardanoNode/util/bufferChainSyncEvent.ts renamed to packages/projection/src/bufferChainSyncEvent.ts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { RequestNext, WithRequestNext } from '../types';
+import { RequestNext, WithRequestNext } from '@cardano-sdk/core';
 
 export const bufferChainSyncEvent =
   <T extends WithRequestNext>(length: number) =>

packages/projection/src/index.ts

@@ -2,3 +2,5 @@ export * as InMemory from './InMemory';
 export * as Bootstrap from './Bootstrap';
 export * from './operators';
 export * from './types';
+export * from './bufferChainSyncEvent';
+export * from './ObservableCardanoNode';

packages/projection/src/operators/withNetworkInfo.ts

@@ -1,4 +1,4 @@
-import { ObservableCardanoNode } from '@cardano-sdk/core';
+import { ObservableCardanoNode } from '../ObservableCardanoNode';
 import { WithNetworkInfo } from '../types';
 import { combineLatest, map, take } from 'rxjs';
 import { withStaticContext } from './withStaticContext';

packages/core/test/CardanoNode/util/bufferChainSyncEvent.test.ts renamed to packages/projection/test/bufferChainSyncEvent.test.ts

@@ -1,8 +1,7 @@
 /* eslint-disable sonarjs/no-duplicate-string */
-import { BlockId, BlockNo, Slot, Tip } from '../../../src/Cardano';
-import { ChainSyncEvent, ChainSyncEventType, RequestNext } from '../../../src';
+import { Cardano, ChainSyncEvent, ChainSyncEventType, RequestNext } from '@cardano-sdk/core';
 import { Observable, Subject, Subscription } from 'rxjs';
-import { bufferChainSyncEvent } from '../../../src/CardanoNode/util/bufferChainSyncEvent';
+import { bufferChainSyncEvent } from '../src/bufferChainSyncEvent';
 
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
@@ -20,7 +19,7 @@ class ChainSyncEventTestConsumer {
       complete: () => this.events.push('Consumer completed'),
       error: (error) => this.events.push(`Consumer error: ${error}`),
       next: (value) => {
-        this.current = (value.tip as Tip).blockNo;
+        this.current = (value.tip as Cardano.Tip).blockNo;
         this.events.push(`Got ${this.current}`);
         this.requestNext = value.requestNext;
       }
@@ -106,7 +105,7 @@ class ChainSyncEventTestProducer {
         requestNext: () => {
           this.canProduce = true;
         },
-        tip: { blockNo: BlockNo(count), hash: '' as BlockId, slot: Slot(count) }
+        tip: { blockNo: Cardano.BlockNo(count), hash: '' as Cardano.BlockId, slot: Cardano.Slot(count) }
       });
     }, 1);
   }