refactor!: hoist bufferChainSyncEvent to projection package

Co-authored-by: Martynas Kazlauskas <[email protected]>

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

Author: AngelCastilloB

packages/cardano-services/src/Projection/createTypeormProjection.ts

@@ -1,7 +1,13 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable prefer-spread */
-import { Bootstrap, ProjectionEvent, logProjectionProgress, requestNext } from '@cardano-sdk/projection';
-import { Cardano, ObservableCardanoNode } from '@cardano-sdk/core';
+import {
+  Bootstrap,
+  ObservableCardanoNode,
+  ProjectionEvent,
+  logProjectionProgress,
+  requestNext
+} from '@cardano-sdk/projection';
+import { Cardano } from '@cardano-sdk/core';
 import { Logger } from 'ts-log';
 import { Observable, concat, defer, groupBy, mergeMap, take, takeWhile } from 'rxjs';
 import {

packages/cardano-services/src/Projection/prepareTypeormProjection.ts

@@ -44,8 +44,8 @@ import {
   willStoreStakePools,
   willStoreUtxo
 } from '@cardano-sdk/projection-typeorm';
-import { Cardano, ChainSyncEventType } from '@cardano-sdk/core';
-import { Mappers as Mapper, ProjectionEvent } from '@cardano-sdk/projection';
+import { Cardano } from '@cardano-sdk/core';
+import { ChainSyncEventType, Mappers as Mapper, ProjectionEvent } from '@cardano-sdk/projection';
 import { ObservableType, passthrough } from '@cardano-sdk/util-rxjs';
 import { POOLS_METRICS_INTERVAL_DEFAULT, POOLS_METRICS_OUTDATED_INTERVAL_DEFAULT } from '../Program/programs/types';
 import { Sorter } from '@hapi/topo';

packages/cardano-services/src/TxSubmit/NodeTxSubmitProvider.ts

@@ -5,7 +5,6 @@ import {
   HandleOwnerChangeError,
   HandleProvider,
   HealthCheckResponse,
-  ObservableCardanoNode,
   ProviderError,
   ProviderFailure,
   SubmitTxArgs,
@@ -14,6 +13,7 @@ import {
 } from '@cardano-sdk/core';
 import { InMemoryCache } from '../InMemoryCache';
 import { Logger } from 'ts-log';
+import { ObservableCardanoNode } from '@cardano-sdk/projection';
 import { WithLogger } from '@cardano-sdk/util';
 
 type ObservableTxSubmitter = Pick<ObservableCardanoNode, 'healthCheck$' | 'submitTx'>;

packages/cardano-services/test/Projection/createTypeormProjection.test.ts

@@ -6,8 +6,9 @@ import {
   TokensEntity,
   createDataSource
 } from '@cardano-sdk/projection-typeorm';
-import { Cardano, ChainSyncEventType } from '@cardano-sdk/core';
+import { Cardano } from '@cardano-sdk/core';
 import { ChainSyncDataSet, chainSyncData, logger } from '@cardano-sdk/util-dev';
+import { ChainSyncEventType } from '@cardano-sdk/projection';
 import { ProjectionName, createTypeormProjection, prepareTypeormProjection } from '../../src';
 import { lastValueFrom } from 'rxjs';
 import { projectorConnectionConfig, projectorConnectionConfig$ } from '../util';

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

@@ -1,5 +1,5 @@
 import type { HealthCheckResponse } from '../../Provider';
-import type { Lovelace, PoolId, VrfVkHex } from '../../Cardano';
+import type { Lovelace, PoolId, Tip, VrfVkHex } from '../../Cardano';
 import type { Milliseconds } from '../../util';
 
 export interface EraSummary {
@@ -48,3 +48,13 @@ 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;
+};

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

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

packages/e2e/test/projection/offline-fork.test.ts

@@ -2,24 +2,20 @@ import * as Postgres from '@cardano-sdk/projection-typeorm';
 import { BlockDataEntity, BlockEntity, StakeKeyEntity } from '@cardano-sdk/projection-typeorm';
 import {
   Bootstrap,
+  ChainSyncEvent,
+  ChainSyncEventType,
+  ChainSyncRollForward,
   InMemory,
   Mappers,
+  ObservableCardanoNode,
   ProjectionEvent,
   ProjectionOperator,
   StabilityWindowBuffer,
   WithBlock,
   requestNext,
   withStaticContext
 } from '@cardano-sdk/projection';
-import {
-  Cardano,
-  ChainSyncEvent,
-  ChainSyncEventType,
-  ChainSyncRollForward,
-  ObservableCardanoNode,
-  Point,
-  TipOrOrigin
-} from '@cardano-sdk/core';
+import { Cardano, Point, TipOrOrigin } from '@cardano-sdk/core';
 import { ChainSyncDataSet, chainSyncData, logger } from '@cardano-sdk/util-dev';
 import { ConnectionConfig } from '@cardano-ogmios/client';
 import { Observable, filter, firstValueFrom, lastValueFrom, map, of, take, takeWhile, throwError, toArray } from 'rxjs';

packages/e2e/test/projection/single-tenant-utxo.test.ts

@@ -1,6 +1,6 @@
 import * as Postgres from '@cardano-sdk/projection-typeorm';
-import { Bootstrap, Mappers, ProjectionEvent, requestNext } from '@cardano-sdk/projection';
-import { Cardano, ObservableCardanoNode } from '@cardano-sdk/core';
+import { Bootstrap, Mappers, ObservableCardanoNode, ProjectionEvent, requestNext } from '@cardano-sdk/projection';
+import { Cardano } from '@cardano-sdk/core';
 import { ConnectionConfig } from '@cardano-ogmios/client';
 import { DataSource, QueryRunner } from 'typeorm';
 import { Observable, filter, firstValueFrom, lastValueFrom, of, scan, takeWhile } from 'rxjs';

packages/golden-test-generator/package.json

@@ -45,6 +45,7 @@
   "dependencies": {
     "@cardano-sdk/core": "workspace:~",
     "@cardano-sdk/ogmios": "workspace:~",
+    "@cardano-sdk/projection": "workspace:~",
     "@cardano-sdk/util": "workspace:~",
     "@cardano-sdk/util-dev": "workspace:~",
     "bunyan": "^1.8.15",

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

@@ -1,4 +1,5 @@
-import { Cardano, ChainSyncEventType, Intersection } from '@cardano-sdk/core';
+import { Cardano, Intersection } from '@cardano-sdk/core';
+import { ChainSyncEventType } from '@cardano-sdk/projection';
 import { GeneratorMetadata } from '../Content';
 import { Logger } from 'ts-log';
 import { Ogmios, ogmiosToCore } from '@cardano-sdk/ogmios';