refactor: move defaults hub address in config

Author: PierreJeanjacquot

docs/classes/internal_.IExecContractsClient.md

@@ -44,9 +44,9 @@ Create a client for IExec contracts
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `args` | `Object` | - |
-| `args.chainId` | `string` \| `number` | id of the chain to use (used to resolve IExec contract address) |
+| `args.chainId` | `string` \| `number` | id of the chain |
 | `args.confirms?` | `number` | number of block to wait for transactions confirmation (default 1) |
-| `args.hubAddress?` | `string` | override the IExec contract address to target a custom instance |
+| `args.hubAddress` | `string` | IExec contract address |
 | `args.isNative?` | `boolean` | true if IExec contract use the chain native token |
 | `args.provider` | `Provider` | ethers Provider |
 | `args.signer?` | `Signer` | ethers Signer, required to sign transactions and messages |

src/common/utils/IExecContractsClient.d.ts

@@ -14,13 +14,13 @@ export default class IExecContractsClient {
      */
     signer?: Signer;
     /**
-     * id of the chain to use (used to resolve IExec contract address)
+     * id of the chain
      */
     chainId: number | string;
     /**
-     * override the IExec contract address to target a custom instance
+     * IExec contract address
      */
-    hubAddress?: string;
+    hubAddress: string;
     /**
      * if false set the gasPrice to 0 (default true)
      */

src/common/utils/IExecContractsClient.js

@@ -1,7 +1,6 @@
 import Debug from 'debug';
 import { Contract } from 'ethers';
 import { version as pocoVersion } from '../generated/@iexec/poco/package.js';
-import { networks as iexecProxyNetworks } from '../generated/@iexec/poco/ERC1538Proxy.js';
 import iexecTokenDesc from '../generated/@iexec/poco/IexecInterfaceToken.js';
 import iexecNativeDesc from '../generated/@iexec/poco/IexecInterfaceNative.js';
 import appRegistryDesc from '../generated/@iexec/poco/AppRegistry.js';
@@ -20,17 +19,6 @@ const gasPriceByNetwork = {
   134: 0n,
 };
 
-const getHubAddress = (chainId) => {
-  if (
-    iexecProxyNetworks &&
-    iexecProxyNetworks[chainId] &&
-    iexecProxyNetworks[chainId].address
-  ) {
-    return iexecProxyNetworks[chainId].address;
-  }
-  throw Error(`Missing iExec contract default address for chain ${chainId}`);
-};
-
 const getIsNative = (chainId) => nativeNetworks.includes(chainId);
 
 const getGasPriceOverride = (chainId) => gasPriceByNetwork[chainId];
@@ -76,19 +64,12 @@ const getContractsDescMap = (isNative) => ({
   },
 });
 
-const createClient = ({
-  ethSigner,
-  ethProvider,
-  chainId,
-  globalHubAddress,
-  isNative,
-}) => {
+const createClient = ({ ethSigner, ethProvider, hubAddress, isNative }) => {
   const cachedAddresses = {};
+  if (!hubAddress) throw Error('Missing iExec contract address');
 
   const contractsDescMap = getContractsDescMap(isNative);
 
-  const hubAddress = globalHubAddress || getHubAddress(chainId);
-
   const getContract = (objName, address) => {
     try {
       const { contractDesc } = contractsDescMap[objName];
@@ -184,6 +165,7 @@ class IExecContractsClient {
   } = {}) {
     const stringChainId = `${chainId}`;
     if (!provider) throw Error('missing provider key');
+    if (!hubAddress) throw Error('missing hubAddress key');
     if (!stringChainId) throw Error('missing chainId key');
     if (!Number.isInteger(confirms) || confirms <= 0)
       throw Error('invalid confirms');
@@ -206,8 +188,7 @@ class IExecContractsClient {
     const client = createClient({
       ethSigner: signer,
       ethProvider: provider,
-      chainId: stringChainId,
-      globalHubAddress: hubAddress,
+      hubAddress,
       isNative: native,
     });
 

src/common/utils/config.js

@@ -1,14 +1,15 @@
 import { Network, EnsPlugin } from 'ethers';
 import { TEE_FRAMEWORKS } from './constant.js';
 import { address as voucherHubBellecourAddress } from '../generated/@iexec/voucher-contracts/deployments/bellecour/VoucherHubERC1967Proxy.js';
+import { networks as iexecProxyNetworks } from '../generated/@iexec/poco/ERC1538Proxy.js';
 
 const networkConfigs = [
   {
     id: 134,
     name: 'bellecour',
-    hub: undefined, // use default
+    hub: iexecProxyNetworks[134].address,
     host: 'https://bellecour.iex.ec',
-    ensRegistry: '0x5f5B93fca68c9C79318d1F3868A354EE67D8c006', // use ethers default '0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e'
+    ensRegistry: '0x5f5B93fca68c9C79318d1F3868A354EE67D8c006',
     ensPublicResolver: '0x1347d8a1840A810B990d0B774A6b7Bb8A1bd62BB',
     sms: {
       [TEE_FRAMEWORKS.SCONE]: 'https://sms.iex.ec',
@@ -31,7 +32,7 @@ const networkConfigs = [
   {
     id: 1,
     name: 'mainnet',
-    hub: undefined, // use default
+    hub: iexecProxyNetworks[1].address,
     host: 'mainnet',
     ensRegistry: undefined, // use ethers default
     ensPublicResolver: '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41',

src/lib/IExecConfig.js

@@ -144,12 +144,18 @@ export default class IExecConfig {
     const contractsPromise = (async () => {
       const { chainId } = await networkPromise;
       const chainConfDefaults = await chainConfDefaultsPromise;
+      const resolvedHubAddress = hubAddress || chainConfDefaults.hub;
+      if (!resolvedHubAddress) {
+        throw new ConfigurationError(
+          `hubAddress option not set and no default value for your chain ${chainId}`,
+        );
+      }
       try {
         return new IExecContractsClient({
           chainId,
           provider,
           signer,
-          hubAddress: hubAddress || chainConfDefaults.hub,
+          hubAddress: resolvedHubAddress,
           useGas,
           confirms,
           isNative,
@@ -177,9 +183,7 @@ export default class IExecConfig {
         );
       }
       const bridgedChainId =
-        bridgedNetworkConf.chainId !== undefined
-          ? bridgedNetworkConf.chainId
-          : chainConfDefaults.bridge && chainConfDefaults.bridge.bridgedChainId;
+        bridgedNetworkConf.chainId ?? chainConfDefaults.bridge?.bridgedChainId;
       if (!bridgedChainId) {
         throw new ConfigurationError(
           `Missing chainId in bridgedNetworkConf and no default value for your chain ${chainId}`,
@@ -189,30 +193,28 @@ export default class IExecConfig {
         allowExperimentalNetworks,
       });
       const bridgedRpcUrl =
-        bridgedNetworkConf.rpcURL !== undefined
-          ? bridgedNetworkConf.rpcURL
-          : bridgedChainConfDefaults.host;
+        bridgedNetworkConf.rpcURL ?? bridgedChainConfDefaults.host;
       if (!bridgedRpcUrl) {
         throw new ConfigurationError(
           `Missing rpcURL in bridgedNetworkConf and no default value for bridged chain ${bridgedChainId}`,
         );
       }
       const bridgedBridgeAddress =
-        bridgedNetworkConf.bridgeAddress !== undefined
-          ? bridgedNetworkConf.bridgeAddress
-          : bridgedChainConfDefaults.bridge &&
-            bridgedChainConfDefaults.bridge.contract;
+        bridgedNetworkConf.bridgeAddress ??
+        bridgedChainConfDefaults.bridge?.contract;
       if (!bridgedBridgeAddress) {
         throw new ConfigurationError(
           `Missing bridgeAddress in bridgedNetworkConf and no default value for bridged chain ${bridgedChainId}`,
         );
       }
+      const bridgedHubAddress =
+        bridgedNetworkConf.hubAddress ?? bridgedChainConfDefaults.hub;
       const contracts = await contractsPromise;
       return {
         chainId: bridgedChainId,
         rpcURL: bridgedRpcUrl,
         isNative: !contracts.isNative,
-        hubAddress: bridgedNetworkConf.hubAddress,
+        hubAddress: bridgedHubAddress,
         bridgeAddress: bridgedBridgeAddress,
       };
     })();
@@ -223,16 +225,22 @@ export default class IExecConfig {
 
     const bridgedContractsPromise = (async () => {
       const bridgedConf = await bridgedConfPromise;
+      const { hubAddress, chainId, isNative, rpcURL } = bridgedConf;
+      if (!hubAddress) {
+        throw new ConfigurationError(
+          `Missing hubAddress in bridgedNetworkConf and no default value for bridged chain ${chainId}`,
+        );
+      }
       try {
         return new IExecContractsClient({
-          chainId: bridgedConf.chainId,
-          provider: getReadOnlyProvider(bridgedConf.rpcURL, {
+          chainId,
+          provider: getReadOnlyProvider(rpcURL, {
             providers: providerOptions,
             allowExperimentalNetworks,
           }),
-          hubAddress: bridgedConf.hubAddress,
+          hubAddress,
           confirms,
-          isNative: bridgedConf.isNative,
+          isNative,
         });
       } catch (err) {
         throw new ConfigurationError(

test/lib/e2e/IExecConfig.test.js

@@ -433,7 +433,7 @@ describe('[IExecConfig]', () => {
 
           await expect(config.resolveContractsClient()).rejects.toThrow(
             Error(
-              'Failed to create contracts client: Missing iExec contract default address for chain 421614',
+              'hubAddress option not set and no default value for your chain 421614',
             ),
           );
         });
@@ -542,7 +542,7 @@ describe('[IExecConfig]', () => {
 
           await expect(config.resolveContractsClient()).rejects.toThrow(
             Error(
-              'Failed to create contracts client: Missing iExec contract default address for chain 421614',
+              'hubAddress option not set and no default value for your chain 421614',
             ),
           );
         });
@@ -800,7 +800,7 @@ describe('[IExecConfig]', () => {
       const promise = config.resolveContractsClient();
       await expect(promise).rejects.toThrow(
         Error(
-          `Failed to create contracts client: Missing iExec contract default address for chain ${unknownTestChain.chainId}`,
+          `hubAddress option not set and no default value for your chain ${unknownTestChain.chainId}`,
         ),
       );
       await expect(promise).rejects.toThrow(errors.ConfigurationError);

test/lib/unit/config.test.js

@@ -24,7 +24,7 @@ describe('getChainDefaults', () => {
       ensPublicResolver: '0x1347d8a1840A810B990d0B774A6b7Bb8A1bd62BB',
       ensRegistry: '0x5f5B93fca68c9C79318d1F3868A354EE67D8c006',
       host: 'https://bellecour.iex.ec',
-      hub: undefined,
+      hub: '0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f',
       iexecGateway: 'https://api.market.v8-bellecour.iex.ec',
       ipfsGateway: 'https://ipfs-gateway.v8-bellecour.iex.ec',
       name: 'bellecour',