feat: add dapp address resolution from compass

Author: PierreJeanjacquot

package-lock.json

@@ -52,7 +52,7 @@
     "buffer": "^6.0.3",
     "ethers": "^6.13.2",
     "graphql-request": "^6.1.0",
-    "iexec": "^8.16.1",
+    "iexec": "^8.17.0",
     "kubo-rpc-client": "^4.1.1",
     "yup": "^1.1.1"
   },

package.json

@@ -8,7 +8,7 @@ export const DEFAULT_CHAIN_ID = 134;
 
 interface ChainConfig {
   name: string;
-  dappAddress: string;
+  dappAddress?: string;
   prodWorkerpoolAddress: string;
   dataProtectorSubgraph: string;
   ipfsUploadUrl: string;
@@ -30,7 +30,7 @@ const CHAIN_CONFIG: Record<number, ChainConfig> = {
   },
   421614: {
     name: 'arbitrum-sepolia-testnet',
-    dappAddress: 'web3mail.apps.iexec.eth',
+    dappAddress: undefined, // ENS not supported on this network, address will be resolved from Compass
     prodWorkerpoolAddress: '0x39c3cdd91a7f1c4ed59108a9da4e79de9a1c1b59',
     dataProtectorSubgraph:
       'https://thegraph.iex.ec/subgraphs/name/bellecour/dataprotector-v2',

src/config/config.ts

@@ -0,0 +1,54 @@
+import { CompassCallError } from 'iexec/errors';
+import { AddressOrENS } from '../web3mail/types.js';
+
+export async function resolveDappAddressFromCompass(
+  compassUrl: string,
+  chainId: number
+): Promise<AddressOrENS | undefined> {
+  if (!compassUrl) {
+    return undefined;
+  }
+
+  const address = await fetch(`${compassUrl}/${chainId}/iapps/web3mail`)
+    // Handle network errors
+    .catch((error) => {
+      throw new CompassCallError(
+        `Connection to ${compassUrl} failed with a network error`,
+        error
+      );
+    })
+    // Handle server errors
+    .then((response) => {
+      if (response.status >= 500 && response.status <= 599) {
+        throw new CompassCallError(
+          `Server at ${compassUrl} encountered an internal error`,
+          Error(
+            `Server internal error: ${response.status} ${response.statusText}`
+          )
+        );
+      }
+      return response;
+    })
+    // Handle unexpected response formats
+    .then((response) => {
+      if (response.status !== 200) {
+        throw new Error(
+          `Failed to fetch dapp address from compass: ${response.statusText}`
+        );
+      }
+      if (response.headers.get('Content-Type') !== 'application/json') {
+        throw new Error(
+          'Failed to fetch dapp address from compass: response is not JSON'
+        );
+      }
+      return response.json();
+    })
+    .then((data) => {
+      if (!data || !data.address) {
+        throw new Error(`No dapp address found in compass response`);
+      }
+      return data.address;
+    });
+
+  return address;
+}

src/utils/resolveDappAddressFromCompass.ts

@@ -17,6 +17,7 @@ import {
 import { isValidProvider } from '../utils/validators.js';
 import { getChainIdFromProvider } from '../utils/getChainId.js';
 import { getChainDefaultConfig } from '../config/config.js';
+import { resolveDappAddressFromCompass } from '../utils/resolveDappAddressFromCompass.js';
 
 type EthersCompatibleProvider =
   | AbstractProvider
@@ -126,16 +127,37 @@ export class IExecWeb3mail {
       allowExperimentalNetworks: this.options.allowExperimentalNetworks,
     });
 
+    const ipfsGateway =
+      this.options?.ipfsGateway || chainDefaultConfig?.ipfsGateway;
+
+    let iexec: IExec, graphQLClient: GraphQLClient;
+
+    try {
+      iexec = new IExec(
+        { ethProvider: this.ethProvider },
+        {
+          ipfsGatewayURL: ipfsGateway,
+          ...this.options?.iexecOptions,
+          allowExperimentalNetworks: this.options.allowExperimentalNetworks,
+        }
+      );
+    } catch (e: any) {
+      throw new Error(`Unsupported ethProvider: ${e.message}`);
+    }
+
     const subgraphUrl =
       this.options?.dataProtectorSubgraph ||
       chainDefaultConfig?.dataProtectorSubgraph;
     const dappAddressOrENS =
-      this.options?.dappAddressOrENS || chainDefaultConfig?.dappAddress;
+      this.options?.dappAddressOrENS ||
+      chainDefaultConfig?.dappAddress ||
+      (await resolveDappAddressFromCompass(
+        await iexec.config.resolveCompassURL(),
+        chainId
+      ));
     const dappWhitelistAddress =
       this.options?.dappWhitelistAddress ||
       chainDefaultConfig?.whitelistSmartContract;
-    const ipfsGateway =
-      this.options?.ipfsGateway || chainDefaultConfig?.ipfsGateway;
     const defaultWorkerpool = chainDefaultConfig?.prodWorkerpoolAddress;
     const ipfsNode =
       this.options?.ipfsNode || chainDefaultConfig?.ipfsUploadUrl;
@@ -156,21 +178,6 @@ export class IExecWeb3mail {
       );
     }
 
-    let iexec: IExec, graphQLClient: GraphQLClient;
-
-    try {
-      iexec = new IExec(
-        { ethProvider: this.ethProvider },
-        {
-          ipfsGatewayURL: ipfsGateway,
-          ...this.options?.iexecOptions,
-          allowExperimentalNetworks: this.options.allowExperimentalNetworks,
-        }
-      );
-    } catch (e: any) {
-      throw new Error(`Unsupported ethProvider: ${e.message}`);
-    }
-
     try {
       graphQLClient = new GraphQLClient(subgraphUrl);
     } catch (error: any) {

src/web3mail/IExecWeb3mail.ts

@@ -220,4 +220,27 @@ describe('IExecWeb3mail()', () => {
       });
     });
   });
+
+  describe('When instantiating SDK with on a network backed by Compass', () => {
+    it('should resolve dapp address from Compass', async () => {
+      const chainId = 421614; // Arbitrum Sepolia Testnet ENS not supported
+      const chainConfig = getChainDefaultConfig(chainId, {
+        allowExperimentalNetworks: true,
+      });
+      expect(chainConfig.dappAddress).toBeUndefined(); // ENS not supported on this network
+
+      const web3mail = new IExecWeb3mail(
+        getWeb3Provider(Wallet.createRandom().privateKey, {
+          host: chainId,
+          allowExperimentalNetworks: true,
+        }),
+        { allowExperimentalNetworks: true }
+      );
+      await web3mail.init();
+
+      const dappAddressOrENS = web3mail['dappAddressOrENS'];
+      expect(typeof dappAddressOrENS).toBe('string');
+      expect(dappAddressOrENS).toMatch(/^0x[a-fA-F0-9]{40}$/);
+    });
+  });
 });

tests/e2e/constructor.test.ts

@@ -0,0 +1,23 @@
+import { describe, it, expect } from '@jest/globals';
+import { resolveDappAddressFromCompass } from '../../../src/utils/resolveDappAddressFromCompass.js';
+
+describe('resolveDappAddressFromCompass', () => {
+  it('should return undefined if compassUrl is not provided', async () => {
+    const result = await resolveDappAddressFromCompass('', 1);
+    expect(result).toBeUndefined();
+  });
+
+  it('should resolve dapp address from a valid compass instance', async () => {
+    const compassUrl = 'https://compass.arbitrum-sepolia-testnet.iex.ec';
+    const chainId = 421614;
+    const address = await resolveDappAddressFromCompass(compassUrl, chainId);
+    expect(address).toBeDefined();
+  });
+
+  it('should throw CompassCallError on network error', async () => {
+    const compassUrl = 'https://invalid-url.iex.ec';
+    await expect(resolveDappAddressFromCompass(compassUrl, 1)).rejects.toThrow(
+      'Compass API error: Connection to https://invalid-url.iex.ec failed with a network error'
+    );
+  });
+});