thirdweb-dev · lnbc1QWFyb24 · Sep 2, 2022 · Aug 31, 2022 · Sep 1, 2022
diff --git a/packages/dcent/README.md b/packages/dcent/README.md
@@ -25,3 +25,48 @@ const onboard = Onboard({
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)
 ```
+
+### Filtering Platforms
+
+You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import dcentModule from '@web3-onboard/dcent'
+
+const dcent = dcentModule({ filter: ['Safari'] })
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    dcent
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+The following is a list of the platforms that can be filtered:
+
+```typescript
+type Platform =
+  | 'Windows Phone'
+  | 'Windows'
+  | 'macOS'
+  | 'iOS'
+  | 'Android'
+  | 'Linux'
+  | 'Chrome OS'
+  | 'Android Browser'
+  | 'Chrome'
+  | 'Chromium'
+  | 'Firefox'
+  | 'Microsoft Edge'
+  | 'Opera'
+  | 'Safari'
+  | 'desktop'
+  | 'mobile'
+  | 'tablet'
+```
diff --git a/packages/dcent/package.json b/packages/dcent/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/dcent",
-  "version": "2.1.1",
+  "version": "2.2.0-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",

diff --git a/packages/dcent/src/index.ts b/packages/dcent/src/index.ts
@@ -1,4 +1,10 @@
-import type { Chain, WalletInit, EIP1193Provider } from '@web3-onboard/common'
+import type {
+  Chain,
+  WalletInit,
+  EIP1193Provider,
+  Platform
+} from '@web3-onboard/common'
+
 import type { providers } from 'ethers'
 
 import type {
@@ -51,15 +57,24 @@ const generateAccounts = async (
 }
 
 function dcent({
-  customNetwork
+  customNetwork,
+  filter
 }: {
   customNetwork?: CustomNetwork
+  filter?: Platform[]
 } = {}): WalletInit {
   const getIcon = async () => (await import('./icon.js')).default
-  return helpers => {
-    const { device } = helpers
+
+  return ({ device }) => {
+    const filtered =
+      Array.isArray(filter) &&
+      (filter.includes(device.type) || filter.includes(device.os.name))
+
+    if (filtered) return null
+
     const isMobile = device.type === 'mobile'
     let accounts: Account[] | undefined
+
     return {
       label: "D'CENT",
       getIcon,

diff --git a/packages/demo/package.json b/packages/demo/package.json
@@ -24,19 +24,19 @@
   "dependencies": {
     "@web3-onboard/coinbase": "^2.1.1",
     "@web3-onboard/core": "^2.8.1",
-    "@web3-onboard/dcent": "^2.1.1",
+    "@web3-onboard/dcent": "^2.2.0-alpha.1",
     "@web3-onboard/fortmatic": "^2.0.12",
     "@web3-onboard/gas": "^2.1.1",
     "@web3-onboard/gnosis": "^2.1.1",
     "@web3-onboard/injected-wallets": "^2.2.0",
-    "@web3-onboard/keepkey": "^2.2.1",
-    "@web3-onboard/keystone": "^2.2.1",
-    "@web3-onboard/ledger": "^2.2.1",
+    "@web3-onboard/keepkey": "^2.3.0-alpha.1",
+    "@web3-onboard/keystone": "^2.3.0-alpha.1",
+    "@web3-onboard/ledger": "^2.3.0-alpha.1",
     "@web3-onboard/magic": "^2.1.1",
     "@web3-onboard/portis": "^2.1.1",
     "@web3-onboard/sequence": "^2.0.0",
     "@web3-onboard/torus": "^2.1.1",
-    "@web3-onboard/trezor": "^2.2.1",
+    "@web3-onboard/trezor": "^2.3.0-alpha.1",
     "@web3-onboard/walletconnect": "^2.1.1",
     "@web3-onboard/web3auth": "^2.1.1",
     "vconsole": "^3.9.5"

diff --git a/packages/keepkey/README.md b/packages/keepkey/README.md
@@ -25,3 +25,48 @@ const onboard = Onboard({
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)
 ```
+
+### Filtering Platforms
+
+You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import keepkeyModule from '@web3-onboard/keepkey'
+
+const keepkey = keepkeyModule({ filter: ['Safari'] })
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    keepkey
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+The following is a list of the platforms that can be filtered:
+
+```typescript
+type Platform =
+  | 'Windows Phone'
+  | 'Windows'
+  | 'macOS'
+  | 'iOS'
+  | 'Android'
+  | 'Linux'
+  | 'Chrome OS'
+  | 'Android Browser'
+  | 'Chrome'
+  | 'Chromium'
+  | 'Firefox'
+  | 'Microsoft Edge'
+  | 'Opera'
+  | 'Safari'
+  | 'desktop'
+  | 'mobile'
+  | 'tablet'
+```
diff --git a/packages/keepkey/package.json b/packages/keepkey/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/keepkey",
-  "version": "2.2.1",
+  "version": "2.3.0-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",

diff --git a/packages/keepkey/src/index.ts b/packages/keepkey/src/index.ts
@@ -1,4 +1,4 @@
-import type { Chain, WalletInit } from '@web3-onboard/common'
+import type { Chain, Platform, WalletInit } from '@web3-onboard/common'
 import type { StaticJsonRpcProvider } from '@ethersproject/providers'
 import type { ETHAccountPath } from '@shapeshiftoss/hdwallet-core'
 import type { KeepKeyHDWallet } from '@shapeshiftoss/hdwallet-keepkey'
@@ -36,12 +36,18 @@ const errorMessages = {
 
 type ErrorCode = 'busy' | 'pairing'
 
-function keepkey(): WalletInit {
+function keepkey({ filter }: { filter?: Platform[] } = {}): WalletInit {
   const getIcon = async () => (await import('./icon.js')).default
 
-  return () => {
+  return ({ device }) => {
     let accounts: Account[] | undefined
 
+    const filtered =
+      Array.isArray(filter) &&
+      (filter.includes(device.type) || filter.includes(device.os.name))
+
+    if (filtered) return null
+
     return {
       label: 'KeepKey',
       getIcon,

diff --git a/packages/keystone/README.md b/packages/keystone/README.md
@@ -65,3 +65,48 @@ const onboard = Onboard({
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)
 ```
+
+### Filtering Platforms
+
+You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import keystoneModule from '@web3-onboard/keystone'
+
+const keystone = keystoneModule({ filter: ['Safari'] })
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    keystone
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+The following is a list of the platforms that can be filtered:
+
+```typescript
+type Platform =
+  | 'Windows Phone'
+  | 'Windows'
+  | 'macOS'
+  | 'iOS'
+  | 'Android'
+  | 'Linux'
+  | 'Chrome OS'
+  | 'Android Browser'
+  | 'Chrome'
+  | 'Chromium'
+  | 'Firefox'
+  | 'Microsoft Edge'
+  | 'Opera'
+  | 'Safari'
+  | 'desktop'
+  | 'mobile'
+  | 'tablet'
+```
diff --git a/packages/keystone/package.json b/packages/keystone/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/keystone",
-  "version": "2.2.1",
+  "version": "2.3.0-alpha.1",
   "description": "Keystone 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",

diff --git a/packages/keystone/src/index.ts b/packages/keystone/src/index.ts
@@ -1,4 +1,10 @@
-import type { Chain, CustomNetwork, WalletInit } from '@web3-onboard/common'
+import type {
+  Chain,
+  CustomNetwork,
+  Platform,
+  WalletInit
+} from '@web3-onboard/common'
+
 import type { Account, ScanAccountsOptions } from '@web3-onboard/hw-common'
 import type { StaticJsonRpcProvider } from '@ethersproject/providers'
 
@@ -58,13 +64,23 @@ const generateAccounts = async (
 }
 
 function keystone({
-  customNetwork
+  customNetwork,
+  filter
 }: {
   customNetwork?: CustomNetwork
+  filter?: Platform[]
 } = {}): WalletInit {
   const getIcon = async () => (await import('./icon.js')).default
-  return () => {
+
+  return ({ device }) => {
     let accounts: Account[] | undefined
+
+    const filtered =
+      Array.isArray(filter) &&
+      (filter.includes(device.type) || filter.includes(device.os.name))
+
+    if (filtered) return null
+
     return {
       label: 'Keystone',
       getIcon,

diff --git a/packages/ledger/README.md b/packages/ledger/README.md
@@ -65,3 +65,48 @@ const onboard = Onboard({
 const connectedWallets = await onboard.connectWallet()
 console.log(connectedWallets)
 ```
+
+### Filtering Platforms
+
+You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the `filter` init option which is an array of platforms that you would like this wallet to **not** be displayed to the end user:
+
+```typescript
+import Onboard from '@web3-onboard/core'
+import ledgerModule from '@web3-onboard/ledger'
+
+const ledger = ledgerModule({ filter: ['Safari'] })
+
+const onboard = Onboard({
+  // ... other Onboard options
+  wallets: [
+    ledger
+    //... other wallets
+  ]
+})
+
+const connectedWallets = await onboard.connectWallet()
+console.log(connectedWallets)
+```
+
+The following is a list of the platforms that can be filtered:
+
+```typescript
+type Platform =
+  | 'Windows Phone'
+  | 'Windows'
+  | 'macOS'
+  | 'iOS'
+  | 'Android'
+  | 'Linux'
+  | 'Chrome OS'
+  | 'Android Browser'
+  | 'Chrome'
+  | 'Chromium'
+  | 'Firefox'
+  | 'Microsoft Edge'
+  | 'Opera'
+  | 'Safari'
+  | 'desktop'
+  | 'mobile'
+  | 'tablet'
+```
diff --git a/packages/ledger/package.json b/packages/ledger/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@web3-onboard/ledger",
-  "version": "2.2.1",
+  "version": "2.3.0-alpha.1",
   "description": "Ledger hardare 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",

diff --git a/packages/ledger/src/index.ts b/packages/ledger/src/index.ts
@@ -7,7 +7,8 @@ import type Eth from '@ledgerhq/hw-app-eth'
 import type {
   Chain,
   WalletInit,
-  GetInterfaceHelpers
+  GetInterfaceHelpers,
+  Platform
 } from '@web3-onboard/common'
 
 import type {
@@ -108,13 +109,23 @@ const getAddresses = async (
 }
 
 function ledger({
-  customNetwork
+  customNetwork,
+  filter
 }: {
   customNetwork?: CustomNetwork
+  filter?: Platform[]
 } = {}): WalletInit {
   const getIcon = async () => (await import('./icon.js')).default
-  return () => {
+
+  return ({ device }) => {
     let accounts: Account[] | undefined
+
+    const filtered =
+      Array.isArray(filter) &&
+      (filter.includes(device.type) || filter.includes(device.os.name))
+
+    if (filtered) return null
+
     return {
       label: 'Ledger',
       getIcon,