intersect custom network config with wallet-provided config

Author: pkieltyka

packages/0xsequence/tests/browser/wallet-provider/dapp.test.ts

@@ -21,6 +21,9 @@ export const tests = async () => {
   //
   const providerConfig = { ...DefaultProviderConfig }
   providerConfig.walletAppURL = 'http://localhost:9999/mock-wallet/mock-wallet.test.html'
+  providerConfig.networks = [{
+    name: 'hardhat', rpcUrl: 'http://0.0.0.0:8545'
+  }]
 
   const wallet = new Wallet('hardhat', providerConfig)
 

packages/network/src/utils.ts

@@ -21,7 +21,7 @@ export const maybeNetworkId = (chainId?: ChainId): number | undefined => {
   return getNetworkId(chainId)
 }
 
-export const isValidNetworkConfig = (networkConfig: NetworkConfig | NetworkConfig[], raise: boolean = false): boolean => {
+export const isValidNetworkConfig = (networkConfig: NetworkConfig | NetworkConfig[], raise: boolean = false, skipRelayerCheck: boolean = false): boolean => {
   if (!networkConfig) throw new Error(`invalid network config: empty config`)
 
   const configs: NetworkConfig[] = []
@@ -67,9 +67,11 @@ export const isValidNetworkConfig = (networkConfig: NetworkConfig | NetworkConfi
       if (raise) throw new Error(`invalid network config for chainId ${c.chainId}: rpcUrl or provider must be provided`)
       return false
     }
-    if ((!c.relayerUrl || c.relayerUrl === '') && !c.relayer) {
-      if (raise) throw new Error(`invalid network config for chainId ${c.chainId}: relayerUrl or relayer must be provided`)
-      return false
+    if (!skipRelayerCheck) {
+      if ((!c.relayerUrl || c.relayerUrl === '') && !c.relayer) {
+        if (raise) throw new Error(`invalid network config for chainId ${c.chainId}: relayerUrl or relayer must be provided`)
+        return false
+      }
     }
     if (c.isDefaultChain) {
       if (defaultChain) {
@@ -98,8 +100,8 @@ export const isValidNetworkConfig = (networkConfig: NetworkConfig | NetworkConfi
   return true
 }
 
-export const ensureValidNetworks = (networks: NetworkConfig[]): NetworkConfig[] => {
-  isValidNetworkConfig(networks, true)
+export const ensureValidNetworks = (networks: NetworkConfig[], skipRelayerCheck: boolean = false): NetworkConfig[] => {
+  isValidNetworkConfig(networks, true, skipRelayerCheck)
   return networks
 }
 
@@ -155,6 +157,42 @@ export const sortNetworks = (networks: Networks, defaultChainId?: string | numbe
   return config
 }
 
+export const updateNetworkConfig = (src: Partial<NetworkConfig>, dest: NetworkConfig) => {
+  if (!src || !dest) return
+
+  if (!src.chainId && !src.name) {
+    throw new Error('failed to update network config: source config is missing chainId or name')
+  }
+  if (src.chainId !== dest.chainId && src.name !== dest.name) {
+    throw new Error('failed to update network config: one of chainId or name must match')
+  }
+
+  if (src.rpcUrl) {
+    dest.rpcUrl = src.rpcUrl
+    dest.provider = undefined
+  }
+  if (src.provider) {
+    dest.provider = src.provider
+  }
+  if (src.relayerUrl) {
+    dest.relayerUrl = src.relayerUrl
+    dest.relayer = undefined
+  }
+  if (src.relayer) {
+    dest.relayer = src.relayer
+  }
+  if (src.ensAddress) {
+    dest.ensAddress = src.ensAddress
+  }
+  // NOTE: we do not set default or auth chain from here
+  // if (src.isDefaultChain) {
+  //   dest.isDefaultChain = src.isDefaultChain
+  // }
+  // if (src.isAuthChain) {
+  //   dest.isAuthChain = src.isAuthChain
+  // }
+}
+
 export const createNetworkConfig = (networks: Networks | NetworksBuilder, defaultChainId?: number, vars?: {[key: string]: any}): Networks => {
   let config: NetworkConfig[] = []
   if (typeof(networks) === 'function') {

packages/provider/src/wallet.ts

@@ -1,7 +1,7 @@
 import { Networks, NetworkConfig, WalletContext, sequenceContext, ChainId, getNetworkId, JsonRpcSender,
   JsonRpcRouter, JsonRpcMiddleware, allowProviderMiddleware, CachedProvider, PublicProvider, loggingProviderMiddleware,
   SigningProvider, EagerProvider, exceptionProviderMiddleware, JsonRpcExternalProvider,
-  JsonRpcHandlerFunc, JsonRpcRequest, JsonRpcResponse, JsonRpcResponseCallback, JsonRpcHandler, findNetworkConfig
+  JsonRpcHandlerFunc, JsonRpcRequest, JsonRpcResponse, JsonRpcResponseCallback, JsonRpcHandler, findNetworkConfig, updateNetworkConfig, ensureValidNetworks
 } from '@0xsequence/network'
 import { WalletConfig } from '@0xsequence/config'
 import { JsonRpcProvider, JsonRpcSigner, ExternalProvider } from '@ethersproject/providers'
@@ -227,6 +227,7 @@ export class Wallet implements WalletProvider {
   isLoggedIn(): boolean {
     return this.session !== undefined &&
       this.session.networks !== undefined && this.session.networks.length > 0 &&
+      this.networks !== undefined && this.networks.length > 0 &&
       this.session.accountAddress.startsWith('0x')
   }
 
@@ -246,27 +247,23 @@ export class Wallet implements WalletProvider {
     if (!this.isLoggedIn()) {
       throw new Error('login first')
     }
-
-    const session = this.getSession()
-    if (!session.networks) {
+    if (!this.networks) {
       throw new Error('network has not been set by session. login first.')
     }
-
     if (chainId) {
-      const network = findNetworkConfig(session.networks, chainId)
+      const network = findNetworkConfig(this.networks, chainId)
       return network ? [network] : []
     }
-    return session.networks
+    return this.networks
   }
 
   // getChainId returns the default chain id
   getChainId = async (): Promise<number> => {
-    const session = this.getSession()
-    if (!session.networks || session.networks.length < 1) {
+    if (!this.networks || this.networks.length < 1) {
       throw new Error('networks have not been set by session. login first.')
     }
     // default chain id is first one in the list, by design
-    return session.networks[0].chainId
+    return this.networks[0].chainId
   }
 
   openWallet = async (path?: string, state?: any): Promise<boolean> => {
@@ -304,13 +301,13 @@ export class Wallet implements WalletProvider {
     if (!chainId) {
       return this.transport.provider
     }
-    if (this.session.networks.length === 0) {
+    if (this.networks.length === 0) {
       throw new Error('networks list is empty. upon logging in, networks should be populated')
     }
 
-    let network = this.session.networks[0]
+    let network = this.networks[0]
     if (chainId) {
-      network = findNetworkConfig(this.session.networks, chainId)
+      network = findNetworkConfig(this.networks, chainId)
     }
 
     // return memoized network provider
@@ -420,11 +417,11 @@ export class Wallet implements WalletProvider {
     })
 
     // set networks
-    // TODO: build intersected list with this.config.networks
     if (session.networks) {
       this.useNetworks(session.networks)
     }
 
+    // save session
     this.saveSession(this.session)
 
     // confirm the session address matches the one with the signer
@@ -435,20 +432,30 @@ export class Wallet implements WalletProvider {
   }
 
   private useNetworks(networks: NetworkConfig[]) {
-    this.networks = networks
-
-    // hmm.. here..?
+    // set networks in the session
     if (!this.session) this.session = {}
-    this.session.networks = networks // TODO ..
-
-    // // ..
-    // if (this.config.networks) {
-    //   // intersect our this.config.networks if exists..
-    //   this.networks = networks
-    //   // TODO: add a method, which can combine network configs..
-    // } else {
-    //   this.networks = networks
-    // }
+    this.session.networks = networks
+
+    if (!this.config.networks && !this.config.networkRpcUrl) {
+      this.networks = networks
+      return
+    }
+
+    // combine custom network config with networks in the session
+    if (this.config.networks) {
+      this.networks = networks.map(n => ({ ...n })) // copy
+      this.config.networks.forEach(n => {
+        const network = findNetworkConfig(this.networks, n.chainId || n.name)
+        if (!network) return
+        updateNetworkConfig(n, network)
+      })
+      ensureValidNetworks(this.networks, true)
+    }
+
+    // an extra override for convenience
+    if (this.config.networkRpcUrl) {
+      this.networks[0].rpcUrl = this.config.networkRpcUrl
+    }
   }
 }
 
@@ -474,7 +481,7 @@ export interface ProviderConfig {
   // networks is a configuration list of networks used by the wallet. This list
   // is combined with the network list supplied from the wallet upon login,
   // and settings here take precedence such as overriding a relayer setting, or rpcUrl.
-  networks?: NetworkConfig[]
+  networks?: Partial<NetworkConfig>[]
 
   // networkRpcUrl will set the provider rpcUrl of the default network 
   networkRpcUrl?: string
@@ -485,33 +492,6 @@ export interface ProviderConfig {
   defaultNetworkId?: string | number
 }
 
-/*
-
-const wallet = new Wallet({
-  network: {
-    chainId: 1,
-    rpcUrl: 'https://.....',
-    mode: 'mainnet'
-  }
-})
-
-//--
-
-
-const wallet = new Wallet('mainnet')
-
-const wallet = new Wallet('mainnet', { etc ..})
-const wallet = new Wallet(1, { walletAppURL: 'xx', networkRpcUrl: 'xxx', networks: [{ chainId: 1, rpcUrl: 'xxx' }]  })
-
-
-everything can be omitted and will default to mainnet.. as..
-
-const wallet = new Wallet()
-
-//--
-
-
-*/
 
 // TODO: remove Web3Global ..?
 export type ProviderType = 'Web3Global' | 'Window' | 'Proxy' // TODO: combo..? ie, window+proxy ..