[common, core] Update: allow instantiation with only chain id

docs/package.json

@@ -55,31 +55,31 @@
   "type": "module",
   "dependencies": {
     "bnc-sdk": "^4.6.6",
-    "@web3-onboard/coinbase": "^2.1.4",
-    "@web3-onboard/core": "^2.15.5",
-    "@web3-onboard/dcent": "^2.2.3",
-    "@web3-onboard/enkrypt": "^2.0.0",
-    "@web3-onboard/fortmatic": "^2.0.14",
-    "@web3-onboard/gas": "^2.1.4",
-    "@web3-onboard/gnosis": "^2.1.6",
-    "@web3-onboard/infinity-wallet": "^2.0.0",
-    "@web3-onboard/injected-wallets": "^2.8.1",
-    "@web3-onboard/keepkey": "^2.3.3",
-    "@web3-onboard/keystone": "^2.3.3",
-    "@web3-onboard/ledger": "^2.4.2",
-    "@web3-onboard/magic": "^2.1.3",
+    "@web3-onboard/coinbase": "^2.2.1-alpha.1",
+    "@web3-onboard/core": "^2.15.6-alpha.1",
+    "@web3-onboard/dcent": "^2.2.4-alpha.1",
+    "@web3-onboard/enkrypt": "^2.0.1-alpha.1",
+    "@web3-onboard/fortmatic": "^2.0.16-alpha.1",
+    "@web3-onboard/gas": "^2.1.5-alpha.1",
+    "@web3-onboard/gnosis": "^2.1.7-alpha.1",
+    "@web3-onboard/infinity-wallet": "^2.0.1-alpha.1",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
+    "@web3-onboard/keepkey": "^2.3.4-alpha.1",
+    "@web3-onboard/keystone": "^2.3.4-alpha.1",
+    "@web3-onboard/ledger": "^2.4.3-alpha.1",
+    "@web3-onboard/magic": "^2.1.4-alpha.1",
     "@web3-onboard/mew-wallet": "^2.0.0",
-    "@web3-onboard/portis": "^2.1.3",
-    "@web3-onboard/sequence": "^2.0.4",
-    "@web3-onboard/taho": "^2.0.0",
-    "@web3-onboard/torus": "^2.2.0",
-    "@web3-onboard/transaction-preview": "^2.0.4",
-    "@web3-onboard/trezor": "^2.3.3",
-    "@web3-onboard/trust": "^2.0.0",
-    "@web3-onboard/uauth": "^2.0.1",
-    "@web3-onboard/walletconnect": "^2.3.2",
-    "@web3-onboard/web3auth": "^2.1.4",
-    "@web3-onboard/xdefi": "^2.0.0",
+    "@web3-onboard/portis": "^2.1.4-alpha.1",
+    "@web3-onboard/sequence": "^2.0.5-alpha.1",
+    "@web3-onboard/taho": "^2.0.1-alpha.1",
+    "@web3-onboard/torus": "^2.2.2-alpha.1",
+    "@web3-onboard/transaction-preview": "^2.0.5-alpha.1",
+    "@web3-onboard/trezor": "^2.3.4-alpha.1",
+    "@web3-onboard/trust": "^2.0.1-alpha.1",
+    "@web3-onboard/uauth": "^2.0.2-alpha.1",
+    "@web3-onboard/walletconnect": "^2.3.3-alpha.1",
+    "@web3-onboard/web3auth": "^2.1.5-alpha.1",
+    "@web3-onboard/xdefi": "^2.0.1-alpha.1",
     "animejs": "^3.2.1",
     "ethers": "^5.7.0"
   }

docs/src/routes/docs/[...3]modules/core.md

@@ -113,10 +113,12 @@ An array of Chains that your app supports:
 ```ts
 type Chain = {
   id: ChainId // hex encoded string, eg '0x1' for Ethereum Mainnet
-  namespace?: 'evm' // string indicating chain namespace. Defaults to 'evm' but will allow other chain namespaces in the future
-  rpcUrl: string // used for network requests
-  label: string // used for display, eg Ethereum Mainnet
-  token: TokenSymbol // the native token symbol, eg ETH, BNB, MATIC
+  namespace?: 'evm' // string indicating chain namespace. Defaults to 'evm' but will allow other chain namespaces in the future 
+  // PLEASE NOTE: Some wallets require an rpcUrl, label, and token for actions such as adding a new chain. 
+  // It is recommended to include rpcUrl, label, and token for full functionality. 
+  rpcUrl?: string // Recommended to include. Used for network requests. 
+  label?: string // Recommended to include. Used for display, eg Ethereum Mainnet. 
+  token?: TokenSymbol // Recommended to include. The native token symbol, eg ETH, BNB, MATIC.
   color?: string // the color used to represent the chain and will be used as a background for the icon
   icon?: string // the icon to represent the chain
   publicRpcUrl?: string // an optional public RPC used when adding a new chain config to the wallet
@@ -967,12 +969,15 @@ type SetChainOptions = {
   chainId: string // hex encoded string
   chainNamespace?: 'evm' // defaults to 'evm' (currently the only valid value, but will add more in future updates)
   wallet?: string // the wallet.label of the wallet to set chain
+  rpcUrl?: string // if chain was instantiated without rpcUrl, include here. Used for network requests
+  token?: string // if chain was instantiated without token, include here. Used for display, eg Ethereum Mainnet
+  label?: string // if chain was instantiated without label, include here. The native token symbol, eg ETH, BNB, MATIC
 }
 
 const success = await onboard.setChain({ chainId: '0x89' })
 ```
 
-The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter.
+The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter. If a chain was instantiated without an rpcUrl, token, or label, add these options for wallets that require this information for adding a new chain.
 
 ## Custom Styling
 

docs/src/routes/docs/[...3]modules/react.md

@@ -196,7 +196,10 @@ type UseSetChain = (
 type SetChainOptions = {
   chainId: string
   chainNamespace?: string
-  wallet?: WalletState['label']
+  wallet?: WalletState['label'],
+  rpcUrl?: string,
+  label?: string,
+  token?: string,
 }
 
 const [

examples/with-ledger/package.json

@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "@web3-onboard/ledger": "^2.1.6",
+    "@web3-onboard/ledger": "^2.4.3-alpha.1",
     "@web3-onboard/react": "^2.4.1",
     "next": "12.2.4",
     "react": "18.2.0",

examples/with-nextjs-13/package.json

@@ -12,23 +12,23 @@
     "@types/node": "18.11.11",
     "@types/react": "18.0.26",
     "@types/react-dom": "18.0.9",
-    "@web3-onboard/coinbase": "^2.1.3",
-    "@web3-onboard/dcent": "^2.2.1",
-    "@web3-onboard/fortmatic": "^2.0.14",
-    "@web3-onboard/gnosis": "^2.1.3",
-    "@web3-onboard/injected-wallets": "^2.6.2",
-    "@web3-onboard/keepkey": "^2.3.1",
-    "@web3-onboard/keystone": "^2.3.1",
-    "@web3-onboard/ledger": "^2.3.1",
-    "@web3-onboard/magic": "^2.1.3",
+    "@web3-onboard/coinbase": "^2.2.1-alpha.1",
+    "@web3-onboard/dcent": "^2.2.4-alpha.1",
+    "@web3-onboard/fortmatic": "^2.0.16-alpha.1",
+    "@web3-onboard/gnosis": "^2.1.7-alpha.1",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
+    "@web3-onboard/keepkey": "^2.3.4-alpha.1",
+    "@web3-onboard/keystone": "^2.3.4-alpha.1",
+    "@web3-onboard/ledger": "^2.4.3-alpha.1",
+    "@web3-onboard/magic": "^2.1.4-alpha.1",
     "@web3-onboard/mew-wallet": "^2.0.0",
-    "@web3-onboard/portis": "^2.1.3",
+    "@web3-onboard/portis": "^2.1.4-alpha.1",
     "@web3-onboard/react": "^2.6.1",
-    "@web3-onboard/sequence": "^2.0.3",
-    "@web3-onboard/taho": "^2.0.0",
-    "@web3-onboard/torus": "^2.1.3",
-    "@web3-onboard/trezor": "^2.3.1",
-    "@web3-onboard/walletconnect": "^2.1.3",
+    "@web3-onboard/sequence": "^2.0.5-alpha.1",
+    "@web3-onboard/taho": "^2.0.1-alpha.1",
+    "@web3-onboard/torus": "^2.2.2-alpha.1",
+    "@web3-onboard/trezor": "^2.3.4-alpha.1",
+    "@web3-onboard/walletconnect": "^2.3.3-alpha.1",
     "ethers": "^5.7.2",
     "next": "13.1.6",
     "react": "18.2.0",

examples/with-sveltekit/package.json

@@ -32,9 +32,9 @@
   "type": "module",
   "dependencies": {
     "@fontsource/fira-mono": "^4.5.10",
-    "@web3-onboard/core": "^2.15.4",
-    "@web3-onboard/injected-wallets": "^2.8.1",
-    "@web3-onboard/walletconnect": "^2.3.1",
+    "@web3-onboard/core": "^2.15.6-alpha.1",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
+    "@web3-onboard/walletconnect": "^2.3.3-alpha.1",
     "buffer": "^6.0.3"
   }
 }

examples/with-vite-react/package.json

@@ -9,23 +9,23 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@web3-onboard/coinbase": "^2.1.3",
-    "@web3-onboard/dcent": "^2.2.1",
-    "@web3-onboard/fortmatic": "^2.0.14",
-    "@web3-onboard/gnosis": "^2.1.5",
-    "@web3-onboard/injected-wallets": "^2.6.2",
-    "@web3-onboard/keepkey": "^2.3.1",
-    "@web3-onboard/keystone": "^2.3.1",
-    "@web3-onboard/ledger": "^2.3.1",
-    "@web3-onboard/magic": "^2.1.3",
+    "@web3-onboard/coinbase": "^2.2.1-alpha.1",
+    "@web3-onboard/dcent": "^2.2.4-alpha.1",
+    "@web3-onboard/fortmatic": "^2.0.16-alpha.1",
+    "@web3-onboard/gnosis": "^2.1.7-alpha.1",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
+    "@web3-onboard/keepkey": "^2.3.4-alpha.1",
+    "@web3-onboard/keystone": "^2.3.4-alpha.1",
+    "@web3-onboard/ledger": "^2.4.3-alpha.1",
+    "@web3-onboard/magic": "^2.1.4-alpha.1",
     "@web3-onboard/mew": "^2.1.3",
-    "@web3-onboard/portis": "^2.1.3",
-    "@web3-onboard/react": "^2.4.1",
-    "@web3-onboard/sequence": "^2.0.3",
+    "@web3-onboard/portis": "^2.1.4-alpha.1",
+    "@web3-onboard/react": "^2.6.7-alpha.1",
+    "@web3-onboard/sequence": "^2.0.5-alpha.1",
     "@web3-onboard/tallyho": "^2.0.1",
-    "@web3-onboard/torus": "^2.1.3",
-    "@web3-onboard/trezor": "^2.3.1",
-    "@web3-onboard/walletconnect": "^2.2.0",
+    "@web3-onboard/torus": "^2.2.2-alpha.1",
+    "@web3-onboard/trezor": "^2.3.4-alpha.1",
+    "@web3-onboard/walletconnect": "^2.3.3-alpha.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },

examples/with-vuejs-v2/package.json

@@ -7,7 +7,7 @@
     "serve": "vite preview"
   },
   "dependencies": {
-    "@web3-onboard/injected-wallets": "^2.6.2",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
     "@web3-onboard/vue": "^2.5.1",
     "vue": "^2.7.14",
     "vue-template-compiler": "2.7.14"

examples/with-vuejs/package.json

@@ -8,7 +8,7 @@
     "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs --fix --ignore-path .gitignore"
   },
   "dependencies": {
-    "@web3-onboard/injected-wallets": "^2.6.2",
+    "@web3-onboard/injected-wallets": "^2.8.3-alpha.1",
     "@web3-onboard/vue": "^2.5.1",
     "pinia": "^2.0.29",
     "vue": "^3.2.45",

packages/coinbase/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/coinbase",
-  "version": "2.2.0",
+  "version": "2.2.1-alpha.1",
   "description": "Coinbase SDK wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
   "keywords": [
     "Ethereum",
@@ -59,6 +59,6 @@
   },
   "dependencies": {
     "@coinbase/wallet-sdk": "^3.6.0",
-    "@web3-onboard/common": "^2.2.3"
+    "@web3-onboard/common": "^2.2.4-alpha.1"
   }
 }

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/common",
-  "version": "2.2.3",
+  "version": "2.2.4-alpha.1",
   "description": "Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
   "keywords": [
     "Ethereum",

packages/common/src/types.ts

@@ -386,9 +386,9 @@ export enum ProviderRpcErrorCode {
 export interface Chain {
   namespace?: 'evm'
   id: ChainId
-  rpcUrl: string
-  label: string
-  token: TokenSymbol // eg ETH, BNB, MATIC
+  rpcUrl?: string
+  label?: string
+  token?: TokenSymbol // eg ETH, BNB, MATIC
   color?: string
   icon?: string // svg string
   providerConnectionInfo?: ConnectionInfo

packages/common/src/validation.ts

@@ -31,9 +31,9 @@ export const providerConnectionInfoValidation = Joi.object({
 export const chainValidation = Joi.object({
   namespace: chainNamespaceValidation,
   id: chainIdValidation.required(),
-  rpcUrl: Joi.string().required(),
-  label: Joi.string().required(),
-  token: Joi.string().required(),
+  rpcUrl: Joi.string(),
+  label: Joi.string(),
+  token: Joi.string(),
   icon: Joi.string(),
   color: Joi.string(),
   publicRpcUrl: Joi.string(),

packages/core/README.md

@@ -82,9 +82,11 @@ An array of Chains that your app supports:
 type Chain = {
   id: ChainId // hex encoded string, eg '0x1' for Ethereum Mainnet
   namespace?: 'evm' // string indicating chain namespace. Defaults to 'evm' but will allow other chain namespaces in the future
-  rpcUrl: string // used for network requests (eg Alchemy or Infura end point)
-  label: string // used for display, eg Ethereum Mainnet
-  token: TokenSymbol // the native token symbol, eg ETH, BNB, MATIC
+  // PLEASE NOTE: Some wallets require an rpcUrl, label, and token for actions such as adding a new chain. 
+  // It is recommended to include rpcUrl, label, and token for full functionality. 
+  rpcUrl?: string // Recommended to include. Used for network requests (eg Alchemy or Infura end point).
+  label?: string // Recommended to include. Used for display, eg Ethereum Mainnet.  
+  token?: TokenSymbol // Recommended to include. The native token symbol, eg ETH, BNB, MATIC. 
   color?: string // the color used to represent the chain and will be used as a background for the icon
   icon?: string // the icon to represent the chain
   publicRpcUrl?: string // an optional public RPC used when adding a new chain config to the wallet
@@ -908,12 +910,15 @@ type SetChainOptions = {
   chainId: string // hex encoded string
   chainNamespace?: 'evm' // defaults to 'evm' (currently the only valid value, but will add more in future updates)
   wallet?: string // the wallet.label of the wallet to set chain
+  rpcUrl?: string // if chain was instantiated without rpcUrl, include here. Used for network requests
+  token?: string // if chain was instantiated without token, include here. Used for display, eg Ethereum Mainnet
+  label?: string // if chain was instantiated without label, include here. The native token symbol, eg ETH, BNB, MATIC
 }
 
 const success = await onboard.setChain({ chainId: '0x89' })
 ```
 
-The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter.
+The `setChain` methods takes an options object with a `chainId` property hex encoded string for the chain id to switch to. The chain id must be one of the chains that Onboard was initialized with. If the wallet supports programatically adding and switching the chain, then the user will be prompted to do so, if not, then a modal will be displayed indicating to the user that they need to switch chains to continue. The `setChain` method returns a promise that resolves when either the user has confirmed the chain switch, or has dismissed the modal and resolves with a boolean indicating if the switch network was successful or not. The `setChain` method will by default switch the first wallet (the most recently connected) in the `wallets` array. A specific wallet can be targeted by passing in the `wallet.label` in the options object as the `wallet` parameter. If a chain was instantiated without an rpcUrl, token, or label, add these options for wallets that require this information for adding a new chain.
 
 ## Custom Styling
 

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/core",
-  "version": "2.15.5",
+  "version": "2.15.6-alpha.1",
   "description": "Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardized spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
   "keywords": [
     "Ethereum",
@@ -69,8 +69,8 @@
     "@types/lodash.partition": "^4.6.6",
     "@typescript-eslint/eslint-plugin": "^4.31.1",
     "@typescript-eslint/parser": "^4.31.1",
-    "@web3-onboard/gas": "^2.0.0",
-    "@web3-onboard/transaction-preview": "^2.0.4",
+    "@web3-onboard/gas": "^2.1.5-alpha.1",
+    "@web3-onboard/transaction-preview": "^2.0.5-alpha.1",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-svelte3": "^3.2.1",
@@ -85,7 +85,7 @@
   },
   "dependencies": {
     "@unstoppabledomains/resolution": "^8.0",
-    "@web3-onboard/common": "^2.2.3",
+    "@web3-onboard/common": "^2.2.4-alpha.1",
     "bignumber.js": "^9.0.0",
     "bnc-sdk": "^4.6.7",
     "bowser": "^2.11.0",

packages/core/src/chain.ts

@@ -9,9 +9,12 @@ import type { WalletState } from './types.js'
 import { toHexString } from './utils.js'
 
 async function setChain(options: {
-  chainId: string | number
-  chainNamespace?: string
-  wallet?: WalletState['label']
+  chainId: string | number,
+  chainNamespace?: string,
+  wallet?: WalletState['label'],
+  rpcUrl?: string,
+  label?: string,
+  token?: string
 }): Promise<boolean> {
   const error = validateSetChainOptions(options)
 
@@ -20,7 +23,7 @@ async function setChain(options: {
   }
 
   const { wallets, chains } = state.get()
-  const { chainId, chainNamespace = 'evm', wallet: walletToSet } = options
+  const { chainId, chainNamespace = 'evm', wallet: walletToSet, rpcUrl, label, token } = options
   const chainIdHex = toHexString(chainId)
 
   // validate that chainId has been added to chains
@@ -75,7 +78,10 @@ async function setChain(options: {
         wallet,
         chain,
         switchChainModalClosed$,
-        chainIdHex
+        chainIdHex,
+        rpcUrl,
+        label,
+        token,
       )
     }
 
@@ -93,10 +99,13 @@ const chainNotInWallet = async (
   wallet: WalletState,
   chain: Chain,
   switchChainModalClosed$: Observable<boolean>,
-  chainIdHex: string
+  chainIdHex: string,
+  rpcUrl?: string,
+  label?: string,
+  token?: string,
 ): Promise<boolean> => {
   try {
-    await addNewChain(wallet.provider, chain)
+    await addNewChain(wallet.provider, chain, rpcUrl, label, token)
     await switchChain(wallet.provider, chainIdHex)
     return true
   } catch (error) {