fix IPFS bootstrap comparison

Author: benjlevesque

packages/ethereum-storage/src/config.ts

@@ -3,9 +3,9 @@ import { BigNumber } from 'ethers';
 
 // This contains default values used to use Ethereum Network and IPFS
 // if information are not provided by the user
-const config: any = {
+const config = {
   ethereum: {
-    default: 'private',
+    default: 'private' as const,
     gasPriceDefault: '100000000000',
     maxRetries: 5,
     nodeUrlDefault: {
@@ -22,22 +22,19 @@ const config: any = {
     defaultNode: {
       host: 'localhost',
       port: 5001,
-      protocol: 'http',
+      protocol: 'http' as StorageTypes.IpfsGatewayProtocol,
       timeout: 30000,
     },
     errorHandling: {
       delayBetweenRetries: 500,
       maxRetries: 3,
     },
-    expectedBootstrapNodes: [
-      '/dns4/ipfs-bootstrap.request.network/tcp/4001/ipfs/QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967Fdxx',
-
-      '/dns4/ipfs-bootstrap-2.request.network/tcp/4001/ipfs/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj',
-
-      '/dns4/ipfs-2.request.network/tcp/4001/ipfs/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd',
-
-      '/dns4/ipfs-survival.request.network/tcp/4001/ipfs/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh',
-    ],
+    expectedBootstrapNodes: {
+      'ipfs-bootstrap.request.network': 'QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967Fdxx',
+      'ipfs-bootstrap-2.request.network': 'QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj',
+      'ipfs-2.request.network': 'QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd',
+      'ipfs-survival.request.network': 'Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh',
+    },
     maxIpfsReadRetry: 1,
     pinRequest: {
       delayBetweenCalls: 1000,
@@ -147,10 +144,12 @@ export function getIpfsErrorHandlingConfig(): StorageTypes.IIpfsErrorHandlingCon
 
 /**
  * Retrieve from config the ipfs bootstrap nodes of the ipfs node
- * @returns array of the swarm addresses
+ * @returns array of the swarm addresses regexes
  */
-export function getIpfsExpectedBootstrapNodes(): string[] {
-  return config.ipfs.expectedBootstrapNodes;
+export function getIpfsExpectedBootstrapNodes(): RegExp[] {
+  return Object.entries(config.ipfs.expectedBootstrapNodes).map(
+    ([host, id]) => new RegExp(`/dns4/${host}/tcp/4001/(ipfs|p2p)/${id}`),
+  );
 }
 
 /**

packages/ethereum-storage/src/ipfs-storage.ts

@@ -125,12 +125,7 @@ export class IpfsStorage implements StorageTypes.IIpfsStorage {
     this.logger.info('Checking ipfs network', ['ipfs', 'sanity']);
     try {
       const bootstrapList = await this.ipfsManager.getBootstrapList();
-
-      const bootstrapNodeFoundCount: number = getIpfsExpectedBootstrapNodes().filter(
-        (nodeExpected) => bootstrapList.includes(nodeExpected),
-      ).length;
-
-      if (bootstrapNodeFoundCount !== getIpfsExpectedBootstrapNodes().length) {
+      if (!IpfsStorage.hasRequiredBootstrapNodes(bootstrapList)) {
         throw Error(
           `The list of bootstrap node in the ipfs config don't match the expected bootstrap nodes`,
         );
@@ -139,4 +134,13 @@ export class IpfsStorage implements StorageTypes.IIpfsStorage {
       throw Error(`IPFS node bootstrap node check failed: ${error}`);
     }
   }
+
+  static hasRequiredBootstrapNodes(actualList: string[]): boolean {
+    const expectedList = getIpfsExpectedBootstrapNodes();
+    const bootstrapNodeFoundCount: number = expectedList.filter((nodeExpected) =>
+      actualList.find((actual) => nodeExpected.test(actual)),
+    ).length;
+
+    return bootstrapNodeFoundCount === expectedList.length;
+  }
 }

packages/ethereum-storage/test/ipfs-storage.test.ts

@@ -93,9 +93,47 @@ describe('IPFS Storage', () => {
     });
 
     await ipfsStorage.pinDataToIPFS([hash1]);
-    expect(warnLogMock).toHaveBeenCalledWith(
-      'Failed pinning some hashes the IPFS node: Error: expected error',
-      ['ipfs'],
-    );
+    expect(
+      warnLogMock,
+    ).toHaveBeenCalledWith('Failed pinning some hashes the IPFS node: Error: expected error', [
+      'ipfs',
+    ]);
+  });
+
+  describe('compareBootstrapNodes', () => {
+    describe.each(['ipfs', 'p2p'])('It supports the %s path', (path) => {
+      it('Returns true for same list', () => {
+        expect(
+          IpfsStorage.hasRequiredBootstrapNodes([
+            `/dns4/ipfs-survival.request.network/tcp/4001/${path}/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh`,
+            `/dns4/ipfs-2.request.network/tcp/4001/${path}/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd`,
+            `/dns4/ipfs-bootstrap-2.request.network/tcp/4001/${path}/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj`,
+            `/dns4/ipfs-bootstrap.request.network/tcp/4001/${path}/QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967Fdxx`,
+          ]),
+        ).toBeTruthy();
+      });
+
+      it('Returns false for additional items', () => {
+        expect(
+          IpfsStorage.hasRequiredBootstrapNodes([
+            `/dns4/ipfs-survival.request.network/tcp/4001/${path}/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh`,
+            `/dns4/ipfs-2.request.network/tcp/4001/${path}/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd`,
+            `/dns4/ipfs-bootstrap-2.request.network/tcp/4001/${path}/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj`,
+            `/dns4/ipfs-bootstrap.request.network/tcp/4001/${path}/QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967Fdxx`,
+            `/dns4/ipfs-bootstrap-NONEXISTANT.request.network/tcp/4001/${path}/QmaSrBXFBaupfeGMTuigswtKtsthbVaSonurjTV967FaKe`,
+          ]),
+        ).toBeTruthy();
+      });
+
+      it('Returns false for missing items', () => {
+        expect(
+          IpfsStorage.hasRequiredBootstrapNodes([
+            `/dns4/ipfs-survival.request.network/tcp/4001/${path}/Qmb6a5DH45k8JwLdLVZUhRhv1rnANpsbXjtsH41esGhNCh`,
+            `/dns4/ipfs-2.request.network/tcp/4001/${path}/QmPBPgTDVjveRu6KjGVMYixkCSgGtVyV8aUe6wGQeLZFVd`,
+            `/dns4/ipfs-bootstrap-2.request.network/tcp/4001/${path}/QmYdcSoVNU1axgSnkRAyHtwsKiSvFHXeVvRonGCAV9LVEj`,
+          ]),
+        ).toBeFalsy();
+      });
+    });
   });
 });