feat: add support for experimental networks

Author: abbesBenayache

src/config/config.ts

@@ -20,9 +20,10 @@ interface ChainConfig {
   ipfsUploadUrl: string;
   ipfsGateway: string;
   whitelistSmartContract: string;
+  isExperimental?: boolean;
 }
 
-export const CHAIN_CONFIG: Record<number, ChainConfig> = {
+const CHAIN_CONFIG: Record<number, ChainConfig> = {
   [CHAIN_IDS.BELLECOUR]: {
     name: 'bellecour',
     dappAddress: 'web3mail.apps.iexec.eth',
@@ -33,12 +34,32 @@ export const CHAIN_CONFIG: Record<number, ChainConfig> = {
     ipfsGateway: 'https://ipfs-gateway.v8-bellecour.iex.ec',
     whitelistSmartContract: '0x781482C39CcE25546583EaC4957Fb7Bf04C277D2',
   },
+  [CHAIN_IDS.ARBITRUM_SEPOLIA]: {
+    name: 'arbitrum-sepolia-testnet',
+    dappAddress: 'web3mail.apps.iexec.eth',
+    prodWorkerpoolAddress: '0x39c3cdd91a7f1c4ed59108a9da4e79de9a1c1b59',
+    dataProtectorSubgraph:
+      'https://thegraph.iex.ec/subgraphs/name/bellecour/dataprotector-v2',
+    ipfsGateway: 'https://ipfs-gateway.arbitrum-sepolia-testnet.iex.ec',
+    ipfsUploadUrl: 'https://ipfs-upload.arbitrum-sepolia-testnet.iex.ec',
+    whitelistSmartContract: '0x781482C39CcE25546583EaC4957Fb7Bf04C277D2', // TODO: add the correct address
+    isExperimental: true,
+  },
 };
 
-export function getChainConfig(chainId: number): ChainConfig {
+export const getChainConfig = (
+  chainId: number,
+  options?: { allowExperimentalNetworks?: boolean }
+): ChainConfig => {
   const config = CHAIN_CONFIG[chainId];
+
   if (!config) {
-    throw new Error(`Unsupported chain ID: ${chainId}`);
+    throw new Error(`Chain configuration not found for chainId: ${chainId}`);
   }
+
+  if (config.isExperimental && !options?.allowExperimentalNetworks) {
+    throw new Error(`Experimental network ${chainId} is not allowed. Use allowExperimentalNetworks option to enable it.`);
+  }
+
   return config;
-}
+};

src/utils/getWeb3Provider.ts

@@ -1,5 +1,13 @@
 import { getSignerFromPrivateKey } from 'iexec/utils';
 import { Web3SignerProvider } from '../web3mail/types.js';
 
-export const getWeb3Provider = (privateKey: string): Web3SignerProvider =>
-  getSignerFromPrivateKey('bellecour', privateKey);
+export const getWeb3Provider = (
+  privateKey: string,
+  options: { allowExperimentalNetworks?: boolean; host?: number | string } = {}
+): Web3SignerProvider => {
+  const chainHost = options?.host ? `${options.host}` : 'bellecour';
+  return getSignerFromPrivateKey(chainHost, privateKey, {
+    allowExperimentalNetworks: options?.allowExperimentalNetworks,
+    providers: {},
+  });
+};

src/web3mail/IExecWeb3mail.ts

@@ -14,9 +14,9 @@ import {
   Web3SignerProvider,
   FetchMyContactsParams,
 } from './types.js';
-import { CHAIN_CONFIG } from '../config/config.js';
 import { isValidProvider } from '../utils/validators.js';
 import { getChainIdFromProvider } from '../utils/getChainId.js';
+import { getChainConfig } from '../config/config.js';
 
 type EthersCompatibleProvider =
   | AbstractProvider
@@ -122,8 +122,9 @@ export class IExecWeb3mail {
 
   private async resolveConfig(): Promise<Web3mailResolvedConfig> {
     const chainId = await getChainIdFromProvider(this.ethProvider);
-    const chainDefaultConfig = CHAIN_CONFIG[chainId];
-
+    const chainDefaultConfig = getChainConfig(chainId, {
+      allowExperimentalNetworks: this.options.allowExperimentalNetworks,
+    });
     const subgraphUrl =
       this.options?.dataProtectorSubgraph ||
       chainDefaultConfig?.dataProtectorSubgraph;
@@ -162,6 +163,7 @@ export class IExecWeb3mail {
         {
           ipfsGatewayURL: ipfsGateway,
           ...this.options?.iexecOptions,
+          allowExperimentalNetworks: this.options.allowExperimentalNetworks,
         }
       );
     } catch (e: any) {

src/web3mail/types.ts

@@ -108,6 +108,13 @@ export type Web3MailConfigOptions = {
    * If not provided, the default IPFS gateway URL will be used.
    */
   ipfsGateway?: string;
+
+  /**
+   * if true allows using a provider connected to an experimental networks (default false)
+   *
+   * ⚠️ experimental networks are networks on which the iExec's stack is partially deployed, experimental networks can be subject to instabilities or discontinuity. Access is provided without warranties.
+   */
+  allowExperimentalNetworks?: boolean;
 };
 
 export type DappAddressConsumer = {

tests/e2e/constructor.test.ts

@@ -2,7 +2,7 @@
 // needed to access and assert IExecDataProtector's private properties
 import { describe, expect, it } from '@jest/globals';
 import { Wallet } from 'ethers';
-import { IExecWeb3mail } from '../../src/index.js';
+import { getWeb3Provider, IExecWeb3mail } from '../../src/index.js';
 import {
   getTestWeb3SignerProvider,
   MAX_EXPECTED_WEB2_SERVICES_TIME,
@@ -124,4 +124,34 @@ describe('IExecWeb3mail()', () => {
     },
     MAX_EXPECTED_WEB2_SERVICES_TIME
   );
+
+  describe('When instantiating SDK with an experimental network', () => {
+    const experimentalNetworkSigner = getWeb3Provider(
+      Wallet.createRandom().privateKey,
+      {
+        host: 421614,
+        allowExperimentalNetworks: true,
+      }
+    );
+
+    describe('Without allowExperimentalNetworks', () => {
+      it('should throw a configuration error', async () => {
+        const web3mail = new IExecWeb3mail(experimentalNetworkSigner);
+        await expect(web3mail.init()).rejects.toThrow(
+          'Experimental network 421614 is not allowed. Use allowExperimentalNetworks option to enable it.'
+        );
+      });
+    });
+
+    describe('With allowExperimentalNetworks: true', () => {
+      it('should resolve the configuration', async () => {
+        const web3mail = new IExecWeb3mail(
+          experimentalNetworkSigner,
+          { allowExperimentalNetworks: true }
+        );
+        await expect(web3mail.init()).resolves.toBeUndefined();
+        expect(web3mail).toBeInstanceOf(IExecWeb3mail);
+      });
+    });
+  });
 });