feature(#1030): Add ability to create StaticJsonRpcProvider with ConnectionInfo (#1031)

* feature: Add ability to create StaticJsonRpcProvider with ConnectionInfo

* feature(#1030): update package version

* Increment version

Co-authored-by: Aaron Barnard <abarnard@protonmail.com>

Author: applicature-dlitvinov

.gitignore

@@ -3,4 +3,4 @@ node_modules
 dist/
 package-lock.json
 .rpt2_cache
-.vscode
+.vscode

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/common",
-  "version": "2.1.0",
+  "version": "2.1.1-alpha.1",
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c -w",

packages/common/src/types.ts

@@ -1,4 +1,5 @@
 import type { ethers, BigNumber } from 'ethers'
+import type { ConnectionInfo } from 'ethers/lib/utils'
 import type EventEmitter from 'eventemitter3'
 import type { TypedData as EIP712TypedData } from 'eip-712'
 export type { TypedData as EIP712TypedData } from 'eip-712'
@@ -428,6 +429,7 @@ export interface Chain {
   token: TokenSymbol // eg ETH, BNB, MATIC
   color?: string
   icon?: string // svg string
+  providerConnectionInfo?: ConnectionInfo
 }
 
 export type TokenSymbol = string // eg ETH

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/core",
-  "version": "2.2.11",
+  "version": "2.2.12-alpha.1",
   "scripts": {
     "build": "rollup -c",
     "dev": "rollup -c -w",
@@ -41,7 +41,7 @@
     "typescript": "^4.5.5"
   },
   "dependencies": {
-    "@web3-onboard/common": "^2.1.0",
+    "@web3-onboard/common": "^2.1.1-alpha.1",
     "bowser": "^2.11.0",
     "ethers": "5.5.3",
     "eventemitter3": "^4.0.7",

packages/core/src/provider.ts

@@ -25,6 +25,20 @@ export const ethersProviders: {
   [key: string]: providers.StaticJsonRpcProvider
 } = {}
 
+export function getProvider(chain: Chain): providers.StaticJsonRpcProvider {
+  if (!chain) return null
+
+  if (!ethersProviders[chain.rpcUrl]) {
+    ethersProviders[chain.rpcUrl] = new providers.StaticJsonRpcProvider(
+      chain.providerConnectionInfo?.url
+        ? chain.providerConnectionInfo
+        : chain.rpcUrl
+    )
+  }
+
+  return ethersProviders[chain.rpcUrl]
+}
+
 export function requestAccounts(
   provider: EIP1193Provider
 ): Promise<ProviderAccounts> {
@@ -231,13 +245,7 @@ export async function getEns(
   // chain we don't recognize and don't have a rpcUrl for requests
   if (!chain) return null
 
-  if (!ethersProviders[chain.rpcUrl]) {
-    ethersProviders[chain.rpcUrl] = new providers.StaticJsonRpcProvider(
-      chain.rpcUrl
-    )
-  }
-
-  const provider = ethersProviders[chain.rpcUrl]
+  const provider = getProvider(chain);
 
   try {
     const name = await provider.lookupAddress(address)
@@ -277,13 +285,7 @@ export async function getBalance(
   // chain we don't recognize and don't have a rpcUrl for requests
   if (!chain) return null
 
-  if (!ethersProviders[chain.rpcUrl]) {
-    ethersProviders[chain.rpcUrl] = new providers.StaticJsonRpcProvider(
-      chain.rpcUrl
-    )
-  }
-
-  const provider = ethersProviders[chain.rpcUrl]
+  const provider = getProvider(chain);
 
   try {
     const balanceWei = await provider.getBalance(address)

packages/core/src/validation.ts

@@ -14,14 +14,30 @@ const chainId = Joi.string().pattern(/^0x[0-9a-fA-F]+$/)
 const chainNamespace = Joi.string().valid('evm')
 const unknownObject = Joi.object().unknown()
 
+// const address = Joi.string().regex(/^0x[a-fA-F0-9]{40}$/)
+/** Related to ConnectionInfo from 'ethers/lib/utils' */
+const providerConnectionInfo = Joi.object({
+  url: Joi.string().required(),
+  headers: Joi.object(),
+  user: Joi.string(),
+  password: Joi.string(),
+  allowInsecureAuthentication: Joi.boolean(),
+  allowGzip: Joi.boolean(),
+  throttleLimit: Joi.number(),
+  throttleSlotInterval: Joi.number(),
+  throttleCallback: Joi.function(),
+  timeout: Joi.number()
+})
+
 const chain = Joi.object({
   namespace: chainNamespace,
   id: chainId.required(),
   rpcUrl: Joi.string().required(),
   label: Joi.string().required(),
   token: Joi.string().required(),
   icon: Joi.string(),
-  color: Joi.string()
+  color: Joi.string(),
+  providerConnectionInfo: providerConnectionInfo
 })
 
 const connectedChain = Joi.object({
@@ -214,4 +230,4 @@ export function validateLocale(data: string): ValidateReturn {
 export function validateUpdateBalances(data: 
 WalletState[]): ValidateReturn {
   return validate(wallets, data)
-}
+}