1.19.2-0.1.0: network display name option (#502)

* Adds optional networkName
* Remove redundant 'network' text

Author: taylorjdawson

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnc-onboard",
-  "version": "1.19.2",
+  "version": "1.19.2-0.1.0",
   "description": "Onboard users to web3 by allowing them to select a wallet, get that wallet ready to transact and have access to synced wallet state.",
   "keywords": [
     "ethereum",

src/interfaces.ts

@@ -1,6 +1,7 @@
 export interface Initialization {
   dappId?: string
   networkId: number
+  networkName?: string
   subscriptions?: Subscriptions
   walletSelect?: WalletSelectModuleOptions
   walletCheck?: Array<WalletCheckModule | WalletCheckInit>
@@ -464,6 +465,7 @@ export type OS = {
 export interface AppState {
   dappId: string
   networkId: number
+  networkName: string
   version: string
   mobileDevice: boolean
   os: OS

src/modules/check/network.ts

@@ -46,7 +46,7 @@ function network(
             network
           )}</b> to <b>${networkName(
             appNetworkId
-          )} network</b> for this Dapp. <br><br> <i style="font-size: inherit; font-family: inherit;">*Some wallets may not support changing networks. If you can not change networks in your wallet you may consider switching to a different wallet.</i>`,
+          )}</b> for this Dapp. <br><br> <i style="font-size: inherit; font-family: inherit;">*Some wallets may not support changing networks. If you can not change networks in your wallet you may consider switching to a different wallet.</i>`,
         eventCode: 'networkFail',
         button: button || {
           onclick: () => {

src/onboard.ts

@@ -46,6 +46,7 @@ function init(initialization: Initialization): API {
     subscriptions,
     dappId,
     networkId,
+    networkName,
     darkMode,
     apiUrl,
     hideBranding,
@@ -82,6 +83,7 @@ function init(initialization: Initialization): API {
     dappId,
     apiUrl,
     networkId,
+    networkName,
     version,
     mobileDevice: isMobile,
     os,

src/stores.ts

@@ -18,6 +18,7 @@ export const app: WritableStore = writable({
   dappId: '',
   apiUrl: '',
   networkId: 1,
+  networkName: '',
   version: '',
   mobileDevice: false,
   os: '',
@@ -32,7 +33,7 @@ export const app: WritableStore = writable({
   walletSelectDisplayedUI: false,
   walletCheckDisplayedUI: false,
   displayBranding: false,
-  blockPollingInterval: 4000,
+  blockPollingInterval: 4000
 })
 
 export const stateSyncStatus: {

src/utilities.ts

@@ -2,6 +2,8 @@ import bowser from 'bowser'
 import BigNumber from 'bignumber.js'
 
 import { WalletInterface } from './interfaces'
+import { app } from './stores'
+import { get } from 'svelte/store'
 
 export function getNetwork(provider: any): Promise<number | any> {
   return new Promise((resolve, reject) => {
@@ -298,7 +300,7 @@ export function networkName(id: number): string {
     case 100:
       return 'xdai'
     default:
-      return 'local'
+      return get(app).networkName || 'local'
   }
 }
 

src/validation.ts

@@ -58,6 +58,7 @@ export function validateInit(init: Initialization): never | void {
   const {
     dappId,
     networkId,
+    networkName,
     subscriptions,
     walletSelect,
     walletCheck,
@@ -73,6 +74,7 @@ export function validateInit(init: Initialization): never | void {
     [
       'dappId',
       'networkId',
+      'networkName',
       'subscriptions',
       'walletSelect',
       'walletCheck',
@@ -91,6 +93,12 @@ export function validateInit(init: Initialization): never | void {
     optional: true
   })
   validateType({ name: 'networkId', value: networkId, type: 'number' })
+  validateType({
+    name: 'networkName',
+    value: networkName,
+    type: 'string',
+    optional: true
+  })
   validateType({
     name: 'darkMode',
     value: darkMode,
@@ -648,7 +656,7 @@ export function validateWalletInit(
       'rpcUri',
       'webUri',
       'xsUri',
-      'blockedPopupRedirect',
+      'blockedPopupRedirect'
     ],
     'walletInitObject'
   )