Handle the case when the data feed is not registered and log warning

Author: Siegrift

contracts/contract-imports.sol

@@ -2,4 +2,3 @@
 pragma solidity 0.8.18;
 
 import "@api3/dapi-management/contracts/AirseekerRegistry.sol";
-import "@api3/airnode-protocol-v1/contracts/api3-server-v1/Api3ServerV1.sol";

local-test-configuration/monitoring/index.html

@@ -715,7 +715,7 @@ <h2>Active data feeds</h2>
           decodedDataFeed: decodeDataFeedDetails(dataFeedDetails),
           signedApiUrls,
         };
-        console.log('Data feed', dataFeed); // For debugging purposes.
+        console.info('Data feed', dataFeed); // For debugging purposes.
 
         let signedDatas = [];
         for (let i = 0; i < signedApiUrls.length; i++) {
@@ -727,7 +727,7 @@ <h2>Active data feeds</h2>
           const signedData = signedApiResponse.data[dataFeed.decodedDataFeed.beacons[i].beaconId];
           signedDatas.push({ ...signedData, value: decodeBeaconValue(signedData.encodedValue).toString() });
         }
-        console.log('Signed datas', signedDatas); // For debugging purposes.
+        console.info('Signed datas', signedDatas); // For debugging purposes.
 
         const newBeaconSetValue = calculateMedian(
           signedDatas.map((signedData) => ethers.BigNumber.from(signedData.value))

src/update-feeds-loops/contracts.ts

@@ -32,7 +32,11 @@ export const decodeActiveDataFeedCountResponse = (
   return activeDataFeedCount.toNumber();
 };
 
-export const decodeDataFeedDetails = (dataFeed: string): DecodedDataFeed => {
+export const decodeDataFeedDetails = (dataFeed: string): DecodedDataFeed | null => {
+  // The contract returns empty bytes if the data feed is not registered. See:
+  // https://github.com/api3dao/dapi-management/blob/f3d39e4707c33c075a8f07aa8f8369f8dc07736f/contracts/AirseekerRegistry.sol#L209
+  if (dataFeed === '0x') return null;
+
   if (dataFeed.length === 130) {
     // (64 [actual bytes] * 2[hex encoding] ) + 2 [for the '0x' preamble]
     // This is a hex encoded string, the contract works with bytes directly
@@ -63,7 +67,7 @@ export interface DecodedUpdateParameters {
   heartbeatInterval: ethers.BigNumber;
 }
 
-export const decodeUpdateParameters = (updateParameters: string) => {
+export const decodeUpdateParameters = (updateParameters: string): DecodedUpdateParameters => {
   // https://github.com/api3dao/airnode-protocol-v1/blob/5f861715749e182e334c273d6a52c4f2560c7994/contracts/api3-server-v1/extensions/BeaconSetUpdatesWithPsp.sol#L122
   const [deviationThresholdInPercentage, deviationReference, heartbeatInterval] = ethers.utils.defaultAbiCoder.decode(
     ['uint256', 'int224', 'uint256'],
@@ -77,17 +81,28 @@ export const decodeUpdateParameters = (updateParameters: string) => {
   };
 };
 
+export interface DecodedActiveDataFeedResponse {
+  dapiName: string | null;
+  decodedDapiName: string | null;
+  decodedUpdateParameters: DecodedUpdateParameters;
+  dataFeedValue: ethers.BigNumber;
+  dataFeedTimestamp: number;
+  decodedDataFeed: DecodedDataFeed;
+  signedApiUrls: string[];
+}
+
 export const decodeActiveDataFeedResponse = (
   airseekerRegistry: AirseekerRegistry,
   activeDataFeedReturndata: string
-) => {
+): DecodedActiveDataFeedResponse | null => {
   const { dapiName, updateParameters, dataFeedValue, dataFeedTimestamp, dataFeedDetails, signedApiUrls } =
     airseekerRegistry.interface.decodeFunctionResult('activeDataFeed', activeDataFeedReturndata) as Awaited<
       ReturnType<AirseekerRegistry['activeDataFeed']>
     >;
 
-  // https://github.com/api3dao/dapi-management/pull/3/files#diff-b6941851ebc92dc9691bbf0cb701fe9c4595cb78488c3bb92ad6e4b917719f4fR346
+  // https://github.com/api3dao/dapi-management/blob/f3d39e4707c33c075a8f07aa8f8369f8dc07736f/contracts/AirseekerRegistry.sol#L162
   const decodedDataFeed = decodeDataFeedDetails(dataFeedDetails);
+  if (!decodedDataFeed) return null;
 
   // The dAPI name will be set to zero (in bytes32) in case the data feed is not a dAPI and is identified by a data feed
   // ID.
@@ -103,5 +118,3 @@ export const decodeActiveDataFeedResponse = (
     signedApiUrls,
   };
 };
-
-export type DecodedActiveDataFeedResponse = ReturnType<typeof decodeActiveDataFeedResponse>;

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

@@ -181,12 +181,12 @@ describe(updateFeedsLoopsModule.runUpdateFeeds.name, () => {
     const decodedFirstDataFeed = {
       ...omit(firstDataFeed, ['dataFeedDetails', 'updateParameters']),
       decodedUpdateParameters: contractsModule.decodeUpdateParameters(firstDataFeed.updateParameters),
-      decodedDataFeed: contractsModule.decodeDataFeedDetails(firstDataFeed.dataFeedDetails),
+      decodedDataFeed: contractsModule.decodeDataFeedDetails(firstDataFeed.dataFeedDetails)!,
     };
     const decodedThirdDataFeed = {
       ...omit(thirdDataFeed, ['dataFeedDetails', 'updateParameters']),
       decodedUpdateParameters: contractsModule.decodeUpdateParameters(thirdDataFeed.updateParameters),
-      decodedDataFeed: contractsModule.decodeDataFeedDetails(thirdDataFeed.dataFeedDetails),
+      decodedDataFeed: contractsModule.decodeDataFeedDetails(thirdDataFeed.dataFeedDetails)!,
     };
     const airseekerRegistry = generateMockAirseekerRegistry();
     jest
@@ -343,7 +343,7 @@ describe(updateFeedsLoopsModule.runUpdateFeeds.name, () => {
 describe(updateFeedsLoopsModule.processBatch.name, () => {
   it('applies deviationThresholdCoefficient from config', async () => {
     const dataFeed = generateActiveDataFeedResponse();
-    const decodedDataFeed = contractsModule.decodeDataFeedDetails(dataFeed.dataFeedDetails);
+    const decodedDataFeed = contractsModule.decodeDataFeedDetails(dataFeed.dataFeedDetails)!;
     const decodedUpdateParameters = contractsModule.decodeUpdateParameters(dataFeed.updateParameters);
     const activeDataFeed = {
       ...omit(dataFeed, ['dataFeedDetails', 'updateParameters']),

src/update-feeds-loops/update-feeds-loops.ts

@@ -112,10 +112,11 @@ export const runUpdateFeeds = async (providerName: ProviderName, chain: Chain, c
           const firstBatch = activeDataFeedCallsReturndata
             // Because the activeDataFeedCount is not known during the multicall, we may ask for non-existent data feeds. These should be filtered out.
             .slice(0, activeDataFeedCount)
-            .map((dataFeedReturndata) => ({
-              ...decodeActiveDataFeedResponse(airseekerRegistry, dataFeedReturndata),
-              chainId,
-            }));
+            .map((dataFeedReturndata) => decodeActiveDataFeedResponse(airseekerRegistry, dataFeedReturndata))
+            .filter((dataFeed, dataFeedIndex): dataFeed is DecodedActiveDataFeedResponse => {
+              logger.warn(`Data feed not registered.`, { dataFeedIndex });
+              return dataFeed !== null;
+            });
           return {
             firstBatch,
             activeDataFeedCount,
@@ -169,7 +170,12 @@ export const runUpdateFeeds = async (providerName: ProviderName, chain: Chain, c
             await airseekerRegistry.callStatic.tryMulticall(activeDataFeedCalldatas)
           );
 
-          return returndata.map((returndata) => decodeActiveDataFeedResponse(airseekerRegistry, returndata));
+          return returndata
+            .map((returndata) => decodeActiveDataFeedResponse(airseekerRegistry, returndata))
+            .filter((dataFeed, index): dataFeed is DecodedActiveDataFeedResponse => {
+              logger.warn(`Data feed not registered.`, { dataFeedIndex: dataFeedBatchIndexStart + index });
+              return dataFeed !== null;
+            });
         });
         if (!goBatch.success) {
           logger.error(`Failed to get active data feeds batch.`, goBatch.error);

test/e2e/update-feeds.feature.ts

@@ -49,7 +49,7 @@ it('updates blockchain data', async () => {
   initializeGasState(chainId, providerName);
   const btcDataFeed = await airseekerRegistry.activeDataFeed(0);
 
-  const decodedDataFeed = decodeDataFeedDetails(btcDataFeed.dataFeedDetails);
+  const decodedDataFeed = decodeDataFeedDetails(btcDataFeed.dataFeedDetails)!;
   const activeBtcDataFeed = {
     ...omit(btcDataFeed, ['dataFeedDetails', 'updateParameters']),
     decodedUpdateParameters: decodeUpdateParameters(btcDataFeed.updateParameters),