feat!: update EraSummary slotLength type to be Milliseconds

EraSummary.parameters.slotLength unit is milliseconds. Use the appropriate opaque type to make it clear. BREAKING CHANGE: EraSummary.parameters.slotLength type changed from number to Milliseconds
input-output-hk · Jan 20, 2023 · fb1f1a2 · fb1f1a2
1 parent 666701c
commit fb1f1a2
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 26 deletions.
diff --git a/packages/core/src/CardanoNode/types/CardanoNode.ts b/packages/core/src/CardanoNode/types/CardanoNode.ts
@@ -3,11 +3,12 @@ import { Block, Lovelace, PoolId, Tip, VrfVkHex } from '../../Cardano';
 // @ts-ignore
 import { CardanoNodeError } from './CardanoNodeErrors';
 import { HealthCheckResponse } from '../../Provider';
+import { Milliseconds } from '../../util';
 
 export interface EraSummary {
   parameters: {
     epochLength: number;
-    slotLength: number;
+    slotLength: Milliseconds;
   };
   start: {
     slot: number;

diff --git a/packages/core/src/util/slotCalc.ts b/packages/core/src/util/slotCalc.ts
@@ -82,7 +82,7 @@ export const createSlotTimeCalc = (eraSummaries: EraSummary[]) => {
     }
     return new Date(
       activeEraSummary.start.time.getTime() +
-        (slotNo.valueOf() - activeEraSummary.start.slot) * activeEraSummary.parameters.slotLength
+        (slotNo.valueOf() - activeEraSummary.start.slot) * activeEraSummary.parameters.slotLength.valueOf()
     );
   };
 };

diff --git a/packages/core/test/CardanoNode/mocks.ts b/packages/core/test/CardanoNode/mocks.ts
@@ -1,9 +1,12 @@
-import { Cardano, EraSummary, HealthCheckResponse, StakeDistribution } from '../../src';
+import { Cardano, EraSummary, HealthCheckResponse, Milliseconds, StakeDistribution } from '../../src';
 
 const mockEraSummaries: EraSummary[] = [
-  { parameters: { epochLength: 21_600, slotLength: 20_000 }, start: { slot: 0, time: new Date(1_563_999_616_000) } },
   {
-    parameters: { epochLength: 432_000, slotLength: 1000 },
+    parameters: { epochLength: 21_600, slotLength: Milliseconds(20_000) },
+    start: { slot: 0, time: new Date(1_563_999_616_000) }
+  },
+  {
+    parameters: { epochLength: 432_000, slotLength: Milliseconds(1000) },
     start: { slot: 1_598_400, time: new Date(1_595_964_016_000) }
   }
 ];

diff --git a/packages/core/test/util/slotCalc.test.ts b/packages/core/test/util/slotCalc.test.ts
@@ -5,17 +5,35 @@ import {
   EpochInfo,
   EraSummary,
   EraSummaryError,
+  Milliseconds,
   SlotEpochCalc,
   SlotEpochInfoCalc,
   SlotTimeCalc,
   createSlotEpochCalc,
   createSlotEpochInfoCalc,
   createSlotTimeCalc
 } from '../../src';
-import { testnetEraSummaries } from '../../../util-dev/src';
 
 import merge from 'lodash/merge';
 
+// Era summaries copied from util-dev package.
+// Importing directly from util-dev reports Milliseconds types incompatible.
+// Type 'import("core/dist/cjs/util/time").Milliseconds' is not assignable to type
+// 'import("core/src/util/time").Milliseconds'.
+// Property '__opaqueNumber' is protected but type 'OpaqueNumber<T>' is not a class derived from 'OpaqueNumber<T>'.
+// Duplicating the test era summaries here to work around it.
+
+export const testnetEraSummaries: EraSummary[] = [
+  {
+    parameters: { epochLength: 21_600, slotLength: Milliseconds(20_000) },
+    start: { slot: 0, time: new Date(1_563_999_616_000) }
+  },
+  {
+    parameters: { epochLength: 432_000, slotLength: Milliseconds(1000) },
+    start: { slot: 1_598_400, time: new Date(1_595_967_616_000) }
+  }
+];
+
 describe('slotCalc utils', () => {
   describe('slotTimeCalc', () => {
     describe('testnet', () => {
@@ -61,11 +79,17 @@ describe('slotCalc utils', () => {
       it('correctly computes epoch with multiple summaries starting from genesis', () => {
         const eraSummaries: EraSummary[] = [
           {
-            parameters: { epochLength: 100, slotLength: 3 },
+            parameters: { epochLength: 100, slotLength: Milliseconds(3) },
+            start: { slot: 0, time: new Date(1_563_999_616_000) }
+          },
+          {
+            parameters: { epochLength: 200, slotLength: Milliseconds(10) },
             start: { slot: 0, time: new Date(1_563_999_616_000) }
           },
-          { parameters: { epochLength: 200, slotLength: 10 }, start: { slot: 0, time: new Date(1_563_999_616_000) } },
-          { parameters: { epochLength: 200, slotLength: 1 }, start: { slot: 0, time: new Date(1_563_999_616_000) } }
+          {
+            parameters: { epochLength: 200, slotLength: Milliseconds(1) },
+            start: { slot: 0, time: new Date(1_563_999_616_000) }
+          }
         ];
         const slotEpochCalc: SlotEpochCalc = createSlotEpochCalc(eraSummaries);
 
@@ -74,15 +98,15 @@ describe('slotCalc utils', () => {
       it('correctly computes epoch with summaries indicating an upgrade after genesis, from the same slotNo', () => {
         const eraSummaries: EraSummary[] = [
           {
-            parameters: { epochLength: 100, slotLength: 3 },
+            parameters: { epochLength: 100, slotLength: Milliseconds(3) },
             start: { slot: 0, time: new Date(1_563_999_616_000) }
           },
           {
-            parameters: { epochLength: 200, slotLength: 10 },
+            parameters: { epochLength: 200, slotLength: Milliseconds(10) },
             start: { slot: 301, time: new Date(1_563_999_716_000) }
           },
           {
-            parameters: { epochLength: 200, slotLength: 1 },
+            parameters: { epochLength: 200, slotLength: Milliseconds(1) },
             start: { slot: 301, time: new Date(1_563_999_716_000) }
           }
         ];
@@ -143,15 +167,17 @@ describe('slotCalc utils', () => {
         expect(firstSlot).toEqual({
           date: new Date(
             epochEraSummary.start.time.getTime() +
-              epochEraSummary.parameters.epochLength * epochEraSummary.parameters.slotLength * relativeEpoch
+              epochEraSummary.parameters.epochLength * epochEraSummary.parameters.slotLength.valueOf() * relativeEpoch
           ),
           slot: epochEraSummary.start.slot + epochEraSummary.parameters.epochLength * relativeEpoch
         });
         expect(lastSlot).toEqual({
           date: new Date(
             epochEraSummary.start.time.getTime() +
-              epochEraSummary.parameters.epochLength * epochEraSummary.parameters.slotLength * (relativeEpoch + 1) -
-              epochEraSummary.parameters.slotLength
+              epochEraSummary.parameters.epochLength *
+                epochEraSummary.parameters.slotLength.valueOf() *
+                (relativeEpoch + 1) -
+              epochEraSummary.parameters.slotLength.valueOf()
           ),
           slot: epochEraSummary.start.slot + epochEraSummary.parameters.epochLength * (relativeEpoch + 1) - 1
         });

diff --git a/packages/ogmios/src/CardanoNode/mappers.ts b/packages/ogmios/src/CardanoNode/mappers.ts
@@ -1,10 +1,10 @@
-import { EraSummary } from '@cardano-sdk/core';
+import { EraSummary, Seconds } from '@cardano-sdk/core';
 import { Schema } from '@cardano-ogmios/client';
 
 export const mapEraSummary = (eraSummary: Schema.EraSummary, systemStart: Date): EraSummary => ({
   parameters: {
     epochLength: eraSummary.parameters.epochLength,
-    slotLength: eraSummary.parameters.slotLength * 1000
+    slotLength: Seconds.toMilliseconds(Seconds(eraSummary.parameters.slotLength))
   },
   start: {
     slot: eraSummary.start.slot,

diff --git a/packages/ogmios/test/CardanoNode/mappers.test.ts b/packages/ogmios/test/CardanoNode/mappers.test.ts
@@ -1,5 +1,5 @@
 import * as mappers from '../../src/CardanoNode/mappers';
-import { EraSummary } from '@cardano-sdk/core';
+import { EraSummary, Milliseconds } from '@cardano-sdk/core';
 import { Schema } from '@cardano-ogmios/client';
 
 describe('cardano node mappers', () => {
@@ -14,7 +14,7 @@ describe('cardano node mappers', () => {
       expect(result).toEqual<EraSummary>({
         parameters: {
           epochLength: 432_000,
-          slotLength: 1000
+          slotLength: Milliseconds(1000)
         },
         start: {
           slot: 1_598_400,

diff --git a/packages/projection/test/events/genesisToEraSummary.ts b/packages/projection/test/events/genesisToEraSummary.ts
@@ -1,9 +1,9 @@
-import { Cardano, EraSummary } from '@cardano-sdk/core';
+import { Cardano, EraSummary, Seconds } from '@cardano-sdk/core';
 
 export const genesisToEraSummary = ({ systemStart, epochLength, slotLength }: Cardano.CompactGenesis): EraSummary => ({
   parameters: {
     epochLength,
-    slotLength
+    slotLength: Seconds.toMilliseconds(slotLength)
   },
   start: {
     slot: 0,

diff --git a/packages/projection/test/operators/withEpochNo.test.ts b/packages/projection/test/operators/withEpochNo.test.ts
@@ -1,10 +1,10 @@
-import { Cardano, ChainSyncEventType } from '@cardano-sdk/core';
+import { Cardano, ChainSyncEventType, Milliseconds } from '@cardano-sdk/core';
 import { RollForwardEvent, UnifiedProjectorEvent, operators } from '../../src';
 import { createTestScheduler } from '@cardano-sdk/util-dev';
 
 const eraSummaries = [
   {
-    parameters: { epochLength: 432_000, slotLength: 1000 },
+    parameters: { epochLength: 432_000, slotLength: Milliseconds(1000) },
     start: { slot: 0, time: new Date(1_595_967_616_000) }
   }
 ];

diff --git a/packages/util-dev/src/eraSummaries.ts b/packages/util-dev/src/eraSummaries.ts
@@ -1,13 +1,16 @@
-import { EraSummary } from '@cardano-sdk/core';
+import { EraSummary, Milliseconds } from '@cardano-sdk/core';
 
 /**
  * Valid at 2022-05-28
  */
 
 export const testnetEraSummaries: EraSummary[] = [
-  { parameters: { epochLength: 21_600, slotLength: 20_000 }, start: { slot: 0, time: new Date(1_563_999_616_000) } },
   {
-    parameters: { epochLength: 432_000, slotLength: 1000 },
+    parameters: { epochLength: 21_600, slotLength: Milliseconds(20_000) },
+    start: { slot: 0, time: new Date(1_563_999_616_000) }
+  },
+  {
+    parameters: { epochLength: 432_000, slotLength: Milliseconds(1000) },
     start: { slot: 1_598_400, time: new Date(1_595_967_616_000) }
   }
 ];