Merge pull request #467 from blocknative/enhancement/polling-interval-param

blockPollingInterval add

Author: dmarzzz

src/interfaces.ts

@@ -7,6 +7,7 @@ export interface Initialization {
   darkMode?: boolean
   apiUrl?: string
   hideBranding?: boolean
+  blockPollingInterval?: number
 }
 
 export interface Subscriptions {

src/modules/select/wallets/providerEngine.ts

@@ -4,6 +4,10 @@ import HookedWalletSubprovider from 'web3-provider-engine/subproviders/hooked-wa
 import SubscriptionSubprovider from 'web3-provider-engine/subproviders/subscriptions'
 import FilterSubprovider from 'web3-provider-engine/subproviders/filters'
 
+import { get } from 'svelte/store'
+
+import { app } from '../../../stores'
+
 function createProvider(config: any) {
   const {
     getAccounts,
@@ -12,9 +16,11 @@ function createProvider(config: any) {
     processMessage,
     processPersonalMessage,
     signMessage,
-    signPersonalMessage
+    signPersonalMessage,
   } = config
 
+  const pollingInterval = get(app).blockPollingInterval
+
   const idMgmt =
     getAccounts &&
     new HookedWalletSubprovider({
@@ -30,7 +36,7 @@ function createProvider(config: any) {
     rpcUrl: rpcUrl.includes('http') ? rpcUrl : `https://${rpcUrl}`
   })
 
-  const provider = new Web3ProviderEngine()
+  const provider = new Web3ProviderEngine({pollingInterval})
 
   provider.addProvider(new SubscriptionSubprovider())
   provider.addProvider(new FilterSubprovider())

src/modules/select/wallets/wallet-connect.ts

@@ -6,6 +6,12 @@ import {
 
 import walletConnectIcon from '../wallet-icons/icon-wallet-connect'
 
+import { get } from 'svelte/store'
+
+import {
+  app,
+} from '../../../stores'
+
 function walletConnect(
   options: WalletConnectOptions & { networkId: number }
 ): WalletModule {
@@ -20,6 +26,8 @@ function walletConnect(
     networkId
   } = options
 
+  const pollingInterval = get(app).blockPollingInterval
+
   if (!infuraKey) {
     if (!rpc || !rpc[networkId]) {
       throw new Error(
@@ -50,7 +58,8 @@ function walletConnect(
       const provider = new WalletConnectProvider({
         infuraId: infuraKey,
         rpc,
-        bridge
+        bridge,
+        pollingInterval
       })
 
       provider.autoRefreshOnNetworkChange = false

src/onboard.ts

@@ -49,7 +49,8 @@ function init(initialization: Initialization): API {
     networkId,
     darkMode,
     apiUrl,
-    hideBranding
+    hideBranding,
+    blockPollingInterval = 4000
   } = initialization
 
   const { os, browser, isMobile } = getDeviceInfo()
@@ -86,7 +87,8 @@ function init(initialization: Initialization): API {
     browser,
     darkMode,
     displayBranding,
-    checkModules: initializedModules.walletCheck
+    checkModules: initializedModules.walletCheck,
+    blockPollingInterval
   }))
 
   initializeStores()

src/stores.ts

@@ -30,7 +30,8 @@ export const app: WritableStore = writable({
   checkModules: [],
   walletSelectDisplayedUI: false,
   walletCheckDisplayedUI: false,
-  displayBranding: false
+  displayBranding: false,
+  blockPollingInterval: 4000,
 })
 
 export const stateSyncStatus: {

src/validation.ts

@@ -64,6 +64,7 @@ export function validateInit(init: Initialization): never | void {
     darkMode,
     apiUrl,
     hideBranding,
+    blockPollingInterval,
     ...otherParams
   } = init
 
@@ -77,7 +78,8 @@ export function validateInit(init: Initialization): never | void {
       'walletCheck',
       'darkMode',
       'apiUrl',
-      'hideBranding'
+      'hideBranding',
+      'blockPollingInterval'
     ],
     'init'
   )
@@ -107,6 +109,12 @@ export function validateInit(init: Initialization): never | void {
     type: 'boolean',
     optional: true
   })
+  validateType({
+    name: 'blockPollingInterval',
+    value: blockPollingInterval,
+    type: 'number',
+    optional: true
+  })
 
   validateType({
     name: 'subscriptions',
@@ -640,7 +648,7 @@ export function validateWalletInit(
       'rpcUri',
       'webUri',
       'xsUri',
-      'blockedPopupRedirect'
+      'blockedPopupRedirect',
     ],
     'walletInitObject'
   )