Feat: HW wallet parameter to set zero balance threshold (#1715)

* Updated hw-common * Working as expected and version bumped * Update packages/demo/src/App.svelte * Merge in develop and bump package versions in demo * Update packages/hw-common/src/validation.ts Co-authored-by: Aaron <abarnard@protonmail.com> --------- Co-authored-by: Aaron <abarnard@protonmail.com>

Author: Adamj1232

packages/dcent/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@web3-onboard/dcent",
- "version": "2.2.6",
+ "version": "2.2.7-alpha.1",
  "description": "D'CENT 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",
@@ -57,7 +57,7 @@
  },
  "dependencies": {
  "@web3-onboard/common": "^2.3.2",
- "@web3-onboard/hw-common": "^2.2.2",
+ "@web3-onboard/hw-common": "^2.3.0-alpha.1",
  "@ethereumjs/tx": "^3.4.0",
  "@ethersproject/providers": "^5.5.0",
  "eth-dcent-keyring": "^0.2.2"

packages/dcent/src/index.ts

@@ -5,8 +5,6 @@ import type {
  Platform
 } from '@web3-onboard/common'
 
-import type { providers } from 'ethers'
-
 import type {
  CustomNetwork,
  Account,

packages/demo/package.json

@@ -27,22 +27,22 @@
  "@web3-onboard/core": "^2.18.1-alpha.2",
  "@web3-onboard/coinbase": "^2.2.3",
  "@web3-onboard/transaction-preview": "^2.0.7",
- "@web3-onboard/dcent": "^2.2.6",
+ "@web3-onboard/dcent": "^2.2.7-alpha.1",
  "@web3-onboard/frontier": "^2.0.3",
  "@web3-onboard/fortmatic": "^2.0.18",
  "@web3-onboard/frame": "2.0.0",
  "@web3-onboard/gas": "^2.1.7",
  "@web3-onboard/gnosis": "^2.1.9",
- "@web3-onboard/keepkey": "^2.3.6",
- "@web3-onboard/keystone": "^2.3.6",
+ "@web3-onboard/keepkey": "^2.3.7-alpha.1",
+ "@web3-onboard/keystone": "^2.3.7-alpha.1",
  "@web3-onboard/ledger": "^2.4.5",
  "@web3-onboard/infinity-wallet": "^2.0.3",
  "@web3-onboard/injected-wallets": "^2.8.5",
  "@web3-onboard/magic": "^2.1.6",
  "@web3-onboard/phantom": "^2.0.1",
  "@web3-onboard/portis": "^2.1.6",
  "@web3-onboard/sequence": "^2.0.7",
- "@web3-onboard/trezor": "^2.4.1",
+ "@web3-onboard/trezor": "^2.4.2-alpha.1",
  "@web3-onboard/trust": "^2.0.3",
  "@web3-onboard/torus": "^2.2.4",
  "@web3-onboard/taho": "^2.0.3",

packages/demo/src/App.svelte

@@ -150,7 +150,8 @@
 
  const trezorOptions = {
  email: 'test@test.com',
- appUrl: 'https://www.blocknative.com'
+ appUrl: 'https://www.blocknative.com',
+ consecutiveEmptyAccountThreshold: 10
  // containerElement: '#sample-container-el'
  }
  const trezor = trezorModule(trezorOptions)

packages/hw-common/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@web3-onboard/hw-common",
- "version": "2.2.2",
+ "version": "2.3.0-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/hw-common/src/types.ts

@@ -44,6 +44,11 @@ export type SelectAccountOptions = {
  scanAccounts: ScanAccounts
  supportsCustomPath?: boolean
  containerElement?: string
+ /**
+ * A number that defines the amount of consecutive empty addresses displayed
+ * within the Account Select modal. Default is 5 
+ */
+ consecutiveEmptyAccountThreshold?: number
 }
 
 export type BasePath = {

packages/hw-common/src/validation.ts

@@ -29,6 +29,7 @@ const selectAccountOptions = Joi.object({
  chains: chains,
  scanAccounts: Joi.function().arity(1).required(),
  supportsCustomPath: Joi.bool(),
+ consecutiveEmptyAccountThreshold: Joi.number(),
  containerElement: Joi.string()
 })
 

packages/keepkey/README.md

@@ -49,17 +49,23 @@ console.log(connectedWallets)
 ```
 
 Initialization options:
+
 ```typescript
 type keepkeyInitOptions = {
  containerElement?: string
  filter?: Platform
+ /**
+ * A number that defines the amount of consecutive empty addresses displayed
+ * within the Account Select modal. Default is 5
+ */
+ consecutiveEmptyAccountThreshold?: number
 }
 ```
 
 The following is a list of the platforms that can be filtered:
 
 ```typescript
-type Platform = DeviceOSName | DeviceBrowserName | DeviceType | 'all';
+type Platform = DeviceOSName | DeviceBrowserName | DeviceType | 'all'
 
 type Platform =
  | 'Windows Phone'

packages/keepkey/package.json

@@ -1,6 +1,6 @@
 {
  "name": "@web3-onboard/keepkey",
- "version": "2.3.6",
+ "version": "2.3.7-alpha.1",
  "description": "KeepKey hardware 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",
@@ -64,7 +64,7 @@
  "@shapeshiftoss/hdwallet-core": "^1.15.2",
  "@shapeshiftoss/hdwallet-keepkey-webusb": "^1.15.2",
  "@web3-onboard/common": "^2.3.2",
- "@web3-onboard/hw-common": "^2.2.2",
+ "@web3-onboard/hw-common": "^2.3.0-alpha.1",
  "ethereumjs-util": "^7.1.3"
  }
 }

packages/keepkey/src/index.ts

@@ -38,8 +38,17 @@ type ErrorCode = 'busy' | 'pairing'
 
 function keepkey({
  filter,
- containerElement
-}: { filter?: Platform[]; containerElement?: string } = {}): WalletInit {
+ containerElement,
+ consecutiveEmptyAccountThreshold
+}: {
+ filter?: Platform[]
+ containerElement?: string
+ /**
+ * A number that defines the amount of consecutive empty addresses displayed
+ * within the Account Select modal. Default is 5
+ */
+ consecutiveEmptyAccountThreshold?: number
+} = {}): WalletInit {
  const getIcon = async () => (await import('./icon.js')).default
 
  return ({ device }) => {
@@ -88,6 +97,7 @@ function keepkey({
  const keyring = new Keyring()
  const keepKeyAdapter = WebUSBKeepKeyAdapter.useKeyring(keyring)
  const eventEmitter = new EventEmitter()
+ const consecutiveEmptyAccounts = consecutiveEmptyAccountThreshold || 5
 
  let keepKeyWallet: KeepKeyHDWallet
  let currentChain: Chain = chains[0]
@@ -184,7 +194,7 @@ function keepkey({
 
  // Iterates until a 0 balance account is found
  // Then adds 4 more 0 balance accounts to the array
- while (zeroBalanceAccounts < 5) {
+ while (zeroBalanceAccounts < consecutiveEmptyAccounts) {
  const acc = await getAccount({
  accountIdx: index,
  provider,