Deep beacon set update check

src/update-feeds/check-feeds.test.ts

@@ -0,0 +1,221 @@
+import { ethers } from 'ethers';
+
+import { init } from '../../test/fixtures/mock-config';
+import { allowPartial } from '../../test/utils';
+import * as signedDataStore from '../signed-data-store/signed-data-store';
+import type * as stateModule from '../state';
+import type { SignedData } from '../types';
+
+import * as contractUtils from './api3-server-v1';
+import * as checkFeeds from './check-feeds';
+import { callAndParseMulticall, getFeedsToUpdate, shallowCheckFeeds } from './check-feeds';
+import type { ReadDapiWithIndexResponse } from './dapi-data-registry';
+
+describe('checks whether feeds should be updated or not', () => {
+  describe('shallow analysis', () => {
+    it('reports an updatable feed as updatable', () => {
+      init(
+        allowPartial<stateModule.State>({
+          signedApiStore: {
+            '0x000a': { timestamp: '100', encodedValue: ethers.BigNumber.from(200).toHexString() },
+            '0x000b': { timestamp: '150', encodedValue: ethers.BigNumber.from(250).toHexString() },
+            '0x000c': { timestamp: '200', encodedValue: ethers.BigNumber.from(300).toHexString() },
+          },
+        })
+      );
+
+      const batch = allowPartial<ReadDapiWithIndexResponse[]>([
+        {
+          updateParameters: { deviationThresholdInPercentage: 2 },
+          dataFeedValue: { value: ethers.BigNumber.from(1), timestamp: 1 },
+          decodedDataFeed: {
+            dataFeedId: '0x000',
+            beacons: [{ dataFeedId: '0x000a' }, { dataFeedId: '0x000b' }, { dataFeedId: '0x000c' }],
+          },
+          dapiName: 'test',
+        },
+      ]);
+
+      const result = shallowCheckFeeds(batch);
+
+      expect(result).toHaveLength(1);
+    });
+
+    it('does not report a feed that should not be updated', () => {
+      init(
+        allowPartial<stateModule.State>({
+          signedApiStore: {
+            '0x000a': { timestamp: '100', encodedValue: ethers.BigNumber.from(200).toHexString() },
+            '0x000b': { timestamp: '150', encodedValue: ethers.BigNumber.from(250).toHexString() },
+            '0x000c': { timestamp: '200', encodedValue: ethers.BigNumber.from(300).toHexString() },
+          },
+        })
+      );
+
+      const batch = allowPartial<ReadDapiWithIndexResponse[]>([
+        {
+          updateParameters: { deviationThresholdInPercentage: 2 },
+          dataFeedValue: { value: ethers.BigNumber.from(250), timestamp: 150 },
+          decodedDataFeed: {
+            dataFeedId: '0x000',
+            beacons: [{ dataFeedId: '0x000a' }, { dataFeedId: '0x000b' }, { dataFeedId: '0x000c' }],
+          },
+          dapiName: 'test',
+        },
+      ]);
+
+      const result = shallowCheckFeeds(batch);
+
+      expect(result).toHaveLength(0);
+    });
+  });
+
+  describe('deep analysis', () => {
+    const feedIds = [
+      '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
+      '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc7',
+      '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc8',
+    ] as const;
+
+    it('calls and parses a multicall', async () => {
+      const signedApiStore = {
+        [feedIds[0]]: { timestamp: '100', encodedValue: ethers.BigNumber.from(200).toHexString() },
+        [feedIds[1]]: { timestamp: '150', encodedValue: ethers.BigNumber.from(250).toHexString() },
+        [feedIds[2]]: { timestamp: '200', encodedValue: ethers.BigNumber.from(300).toHexString() },
+      };
+
+      init(
+        allowPartial<stateModule.State>({
+          signedApiStore,
+        })
+      );
+
+      const decodedDataFeed = {
+        dataFeedId: '0x000',
+        beacons: [{ dataFeedId: feedIds[0] }, { dataFeedId: feedIds[1] }, { dataFeedId: feedIds[2] }],
+      };
+
+      const batch = allowPartial<ReturnType<typeof shallowCheckFeeds>>([
+        {
+          updateParameters: { deviationThresholdInPercentage: 2 },
+          dataFeedValue: { value: ethers.BigNumber.from(1), timestamp: 1 },
+          decodedDataFeed,
+          signedData: decodedDataFeed.beacons.map(({ dataFeedId }) => signedApiStore[dataFeedId]),
+          dapiName: 'test',
+        },
+      ]);
+
+      const tryMulticallMock = jest.fn().mockReturnValue({
+        successes: [true, true, true],
+        returndata: [
+          ethers.utils.defaultAbiCoder.encode(['int224', 'uint32'], [100, 105]),
+          ethers.utils.defaultAbiCoder.encode(['int224', 'uint32'], [101, 106]),
+          ethers.utils.defaultAbiCoder.encode(['int224', 'uint32'], [102, 107]),
+        ],
+      });
+
+      const encodeFunctionDataMock = jest.fn();
+      encodeFunctionDataMock.mockReturnValueOnce('0xfirst');
+      encodeFunctionDataMock.mockReturnValueOnce('0xsecond');
+      encodeFunctionDataMock.mockReturnValueOnce('0xthird');
+
+      const mockContract = {
+        connect: jest.fn().mockReturnValue({
+          callStatic: {
+            tryMulticall: tryMulticallMock,
+          },
+        }),
+        interface: { encodeFunctionData: encodeFunctionDataMock },
+      };
+
+      jest.spyOn(contractUtils, 'getApi3ServerV1').mockReturnValue(mockContract as any);
+
+      const callAndParseMulticallPromise = callAndParseMulticall(batch, 'hardhat', '31337');
+
+      await expect(callAndParseMulticallPromise).resolves.toStrictEqual([
+        {
+          dataFeedId: '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
+          onChainValue: {
+            timestamp: ethers.BigNumber.from('0x69'),
+            value: ethers.BigNumber.from('0x64'),
+          },
+        },
+      ]);
+      expect(tryMulticallMock).toHaveBeenCalledWith(['0xfirst', '0xsecond', '0xthird']);
+    });
+
+    it('returns an updatable feed', async () => {
+      init();
+
+      jest.useFakeTimers().setSystemTime(90);
+
+      const mockSignedDataStore = allowPartial<Record<string, SignedData>>({
+        '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6': {
+          timestamp: '101',
+          encodedValue: ethers.BigNumber.from(200).toHexString(),
+        },
+        '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc7': {
+          timestamp: '150',
+          encodedValue: ethers.BigNumber.from(250).toHexString(),
+        },
+        '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc8': {
+          timestamp: '200',
+          encodedValue: ethers.BigNumber.from(300).toHexString(),
+        },
+      });
+
+      const getStoreDataPointSpy = jest.spyOn(signedDataStore, 'getStoreDataPoint');
+      getStoreDataPointSpy.mockImplementation((dataFeedId: string) => mockSignedDataStore[dataFeedId]!);
+
+      // None of the feeds failed to update
+      jest.spyOn(checkFeeds, 'callAndParseMulticall').mockResolvedValue([]);
+
+      const batch = allowPartial<ReturnType<typeof shallowCheckFeeds>>([
+        {
+          updateParameters: { deviationThresholdInPercentage: 2 },
+          dataFeedValue: {
+            value: ethers.BigNumber.from(1000),
+            timestamp: Number.parseInt('95', 10),
+          },
+          decodedDataFeed: {
+            dataFeedId: '0x000',
+            beacons: [{ dataFeedId: feedIds[0] }, { dataFeedId: feedIds[1] }, { dataFeedId: feedIds[2] }],
+          },
+          dapiName: 'test',
+        },
+      ]);
+
+      jest.spyOn(checkFeeds, 'shallowCheckFeeds').mockReturnValue(batch);
+
+      const promisedFeedsToUpdate = getFeedsToUpdate(batch, 'hardhat', '31337');
+
+      await expect(promisedFeedsToUpdate).resolves.toStrictEqual([
+        {
+          dapiName: 'test',
+          dataFeedValue: {
+            timestamp: 95,
+            value: ethers.BigNumber.from('0x03e8'),
+          },
+          decodedDataFeed: {
+            beacons: [
+              {
+                dataFeedId: '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc6',
+              },
+              {
+                dataFeedId: '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc7',
+              },
+              {
+                dataFeedId: '0xf5c140bcb4814dfec311d38f6293e86c02d32ba1b7da027fe5b5202cae35dbc8',
+              },
+            ],
+            dataFeedId: '0x000',
+          },
+          shouldUpdate: true,
+          updateParameters: {
+            deviationThresholdInPercentage: 2,
+          },
+        },
+      ]);
+    });
+  });
+});