refactor!: move generic equals methods to util package

Moved generic utilities for equality check to util package.

BREAKING CHANGE: moved strictEquals, sameArrayItems, shallowArrayEquals to util package

Author: mirceahasegan

packages/util/src/equals.ts

@@ -1,3 +1,10 @@
 import isEqual from 'lodash/isEqual';
 
 export const deepEquals = <T>(a: T, b: T) => isEqual(a, b);
+
+export const strictEquals = <T>(a: T, b: T) => a === b;
+
+export const sameArrayItems = <T>(arrayA: T[], arrayB: T[], itemEquals: (a: T, b: T) => boolean) =>
+  arrayA.length === arrayB.length && arrayA.every((a) => arrayB.some((b) => itemEquals(a, b)));
+
+export const shallowArrayEquals = <T>(a: T[], b: T[]) => sameArrayItems(a, b, strictEquals);

packages/util/test/equals.test.ts

@@ -1,4 +1,4 @@
-import { deepEquals } from '../src';
+import { deepEquals, sameArrayItems, shallowArrayEquals, strictEquals } from '../src';
 
 describe('equals', () => {
   test('deepEquals', () => {
@@ -7,4 +7,24 @@ describe('equals', () => {
     expect(deepEquals([{ prop: 'prop' }], [{ prop: 'prop' }])).toBe(true);
     expect(deepEquals([{ prop: 'prop' }], [{ prop: 'prop2' }])).toBe(false);
   });
+
+  test('strictEquals', () => {
+    expect(strictEquals('1', 1 as unknown as string)).toBe(false);
+    expect(strictEquals('1', '1')).toBe(true);
+  });
+
+  test('sameArrayItems', () => {
+    expect(sameArrayItems([], [], strictEquals)).toBe(true);
+    expect(sameArrayItems(['a'], ['a', 'b'], strictEquals)).toBe(false);
+    expect(sameArrayItems(['a', 'b'], ['a', 'b'], strictEquals)).toBe(true);
+    expect(sameArrayItems(['a', 'b'], ['b', 'a'], strictEquals)).toBe(true);
+  });
+
+  test('shallowArrayEquals', () => {
+    expect(shallowArrayEquals([], [])).toBe(true);
+    const a = { prop: 'prop' };
+    const b = { prop: 'prop' };
+    expect(shallowArrayEquals([a], [b])).toBe(false);
+    expect(shallowArrayEquals([a], [a])).toBe(true);
+  });
 });

packages/wallet/src/services/DelegationTracker/DelegationDistributionTracker.ts

@@ -1,4 +1,4 @@
-import { BigIntMath, Percent, calcPercentages } from '@cardano-sdk/util';
+import { BigIntMath, Percent, calcPercentages, sameArrayItems } from '@cardano-sdk/util';
 import { Cardano } from '@cardano-sdk/core';
 import { DelegatedStake } from '../types';
 import { DelegationTrackerProps } from './DelegationTracker';
@@ -14,7 +14,7 @@ import {
   withLatestFrom
 } from 'rxjs';
 import { createUtxoBalanceByAddressTracker } from '../BalanceTracker';
-import { delegatedStakeEquals, sameArrayItems } from '../util';
+import { delegatedStakeEquals } from '../util';
 import _groupBy from 'lodash/groupBy';
 import _map from 'lodash/map';
 

packages/wallet/src/services/DelegationTracker/RewardAccounts.ts

@@ -1,5 +1,5 @@
 /* eslint-disable unicorn/no-nested-ternary */
-import { BigIntMath, deepEquals, isNotNil } from '@cardano-sdk/util';
+import { BigIntMath, deepEquals, isNotNil, shallowArrayEquals } from '@cardano-sdk/util';
 import { Cardano, RewardsProvider, StakePoolProvider } from '@cardano-sdk/core';
 import {
   EMPTY,
@@ -28,7 +28,7 @@ import {
 import { RetryBackoffConfig } from 'backoff-rxjs';
 import { TrackedStakePoolProvider } from '../ProviderTracker';
 import { TxWithEpoch } from './types';
-import { coldObservableProvider, shallowArrayEquals } from '../util';
+import { coldObservableProvider } from '../';
 import findLast from 'lodash/findLast';
 import isEqual from 'lodash/isEqual';
 import uniq from 'lodash/uniq';

packages/wallet/src/services/HandlesTracker.ts

@@ -12,8 +12,7 @@ import {
   withLatestFrom
 } from 'rxjs';
 import { Logger } from 'ts-log';
-import { deepEquals, isNotNil } from '@cardano-sdk/util';
-import { sameArrayItems, strictEquals } from './util';
+import { deepEquals, isNotNil, sameArrayItems, strictEquals } from '@cardano-sdk/util';
 import uniqBy from 'lodash/uniqBy';
 
 export interface HandlesTrackerProps {

packages/wallet/src/services/util/coldObservableProvider.ts

@@ -1,4 +1,4 @@
-import { InvalidStringError } from '@cardano-sdk/util';
+import { InvalidStringError, strictEquals } from '@cardano-sdk/util';
 import {
   NEVER,
   Observable,
@@ -15,7 +15,6 @@ import {
   throwError
 } from 'rxjs';
 import { RetryBackoffConfig, retryBackoff } from 'backoff-rxjs';
-import { strictEquals } from './equals';
 
 export interface ColdObservableProviderProps<T> {
   provider: () => Promise<T>;

packages/wallet/src/services/util/equals.ts

@@ -1,13 +1,7 @@
 import { Cardano, EpochInfo, EraSummary } from '@cardano-sdk/core';
 import { DelegatedStake } from '../types';
 import { GroupedAddress } from '@cardano-sdk/key-management';
-
-export const strictEquals = <T>(a: T, b: T) => a === b;
-
-export const sameArrayItems = <T>(arrayA: T[], arrayB: T[], itemEquals: (a: T, b: T) => boolean) =>
-  arrayA.length === arrayB.length && arrayA.every((a) => arrayB.some((b) => itemEquals(a, b)));
-
-export const shallowArrayEquals = <T>(a: T[], b: T[]) => sameArrayItems(a, b, strictEquals);
+import { sameArrayItems } from '@cardano-sdk/util';
 
 export const tipEquals = (a: Cardano.Tip, b: Cardano.Tip) => a.hash === b.hash;
 

packages/wallet/test/services/util/equals.test.ts

@@ -6,9 +6,6 @@ import {
   epochInfoEquals,
   eraSummariesEquals,
   groupedAddressesEquals,
-  sameArrayItems,
-  shallowArrayEquals,
-  strictEquals,
   tipEquals,
   transactionsEquals,
   txEquals,
@@ -21,26 +18,6 @@ describe('equals', () => {
   const txId1 = Cardano.TransactionId('4123d70f66414cc921f6ffc29a899aafc7137a99a0fd453d6b200863ef5702d6');
   const txId2 = Cardano.TransactionId('01d7366549986d83edeea262e97b68eca3430d3bb052ed1c37d2202fd5458872');
 
-  test('strictEquals', () => {
-    expect(strictEquals('1', 1 as unknown as string)).toBe(false);
-    expect(strictEquals('1', '1')).toBe(true);
-  });
-
-  test('sameArrayItems', () => {
-    expect(sameArrayItems([], [], strictEquals)).toBe(true);
-    expect(sameArrayItems(['a'], ['a', 'b'], strictEquals)).toBe(false);
-    expect(sameArrayItems(['a', 'b'], ['a', 'b'], strictEquals)).toBe(true);
-    expect(sameArrayItems(['a', 'b'], ['b', 'a'], strictEquals)).toBe(true);
-  });
-
-  test('shallowArrayEquals', () => {
-    expect(shallowArrayEquals([], [])).toBe(true);
-    const a = { prop: 'prop' };
-    const b = { prop: 'prop' };
-    expect(shallowArrayEquals([a], [b])).toBe(false);
-    expect(shallowArrayEquals([a], [a])).toBe(true);
-  });
-
   test('txEquals', () => {
     expect(txEquals({ id: txId1 } as Cardano.HydratedTx, { id: txId2 } as Cardano.HydratedTx)).toBe(false);
     expect(txEquals({ id: txId1 } as Cardano.HydratedTx, { id: txId1 } as Cardano.HydratedTx)).toBe(true);