Various Fixes

A small release that includes a few minor fixes and improvements.

Binance Smart Chain has been added as a network now that it is supported by the Blocknative server infrastructure. Passing in the networkId: 56 is all that is necessary. For all other unrecognized networks that get displayed with the network name unknown, you can use the networkName parameter when initializing Onboard:

const onboard = Onboard({
  // ... other init options
  networkId: 137,
  networkName: 'Matic'
})

When Onboard is re-initialized in the same session, the WebSocket connection is now closed and the wallet interface is now reset(if one was selected on the previous instance) to ensure there are no extra socket connections or wallet instances hanging around.

A bug with KeepKey missing the preferred property which prevented it from being included as one of the top 4 wallets has been also fixed.

Changelog:

• 1.29.0-0.1.0: [enhancement] - Cleanup Upon Re-Initialization (#604)
• 1.29.0-0.2.0: [fix] Keepkey issues (#607)
• 1.29.0-0.3.0: [refactor] Move cta buttons (#609)
• 1.29.0-0.3.1: [fix] Adds bsc network (#611)

Generic Detected Wallet Module

The main feature of this release is a generic detected wallet module. It can be added to your project by adding the following wallet object to your wallets array when initializing Onboard: { walletName: 'detectedwallet' }. If a user then visits your app and they have a wallet provider injected in to the page that is not recognized by Onboard, it will try to pull the name from the provider and will display it as an option so that any injected wallet that conforms to the EIP-1193 standard can connect to your app.

Also included in this release is a enhanced switch wallet flow for when a user is on the wrong network, but cannot switch networks on the current connected wallet. The full flow is detailed here.

A bug has also been fixed where the derivation path for hardware wallets was incorrectly validating account values > 9.

Changelog:

• 1.27.0-0.2.2: Refactor network check flow (#584)
• Fix derivation path validation (#590)
• 1.28.0-0.1.1: [fix] - Agreed Type (#591)
• 1.28.0-0.2.0: Generic web3 wallet for injected wallet providers (#583)
• 1.28.0-0.2.1: [fix] - Switch Wallet Flow (#592)

🎊 Keepkey Support, Ledger Chrome 91 Fix & Gnosis dep updates

This release adds support for Shapeshift's Keepkey hardware wallet! This integration comes with a PIN UI and passphrase entry for a smooth onboarding process. To enable Keepkey support simply add the following to your Onboard init object:
{ walletName: 'keepkey', rpcUrl: '<rpc-provider-url>' }

Furthermore, this release includes an update to the Ledger wallet where it now uses WebUSB if the browser supports it. This consequently mitigates an issue with Chrome v91 where the U2F protocol no longer works with the Ledger device ( See #577 ).

Changelog:

• 1.27.0-0.0.1: [update] Update Gnosis deps (#578)
• 1.27.0-0.0.2: [fix] Ledger use WebUSB where supported (#580)
• 1.25.0-0.1.2: [feature] KeepKey Wallet (#552)

SSR Support, Export Wallet Icons

This release adds support for SSR (server side rendered) projects by adding a check for the window object in the init function to prevent errors. Also included in this release is an additional icons property on the wallet object for when a user selects a wallet. This property includes the icon strings available for the selected wallet, so the app can also display the selected wallet in the UI.

Changelog:

1.26.1-0.1.0: [feature] Export wallet icons (#572)
1.26.2-0.1.0: [enhancement] - SSR Support (#570)
Bump browserslist from 4.13.0 to 4.16.6 (#563)
1.26.1-0.0.1: [chore] Update Wallet type (#574)

Torus Wallet RPC URL option

This release adds an option for Torus wallet to provide a custom RPC url.

Example:

{
  walletName: 'torus',
  rpcUrl: 'https://ethboston1.skalenodes.com:10062',
  ...
}

Changelog:

• 1.26.0-0.1.0: [feature] Adds custom RPC url option for Torus (#565)

🎉 Gnosis Safe, Bitpie, & XDefi wallets + Security Updates

This release adds support for 3 new wallets: Gnosis Safe, Bitpie and XDefi. The Ledger provider now supports signing Typed data messages (See EIP712 for more information). Additionally, we include a number of vulnerability fixes to various Onboard.js dependancies.

Bitpie and XDefi

For Bitpie and XDefi add the following wallet init object to your wallets array when initializing Onboard:

{ walletName: 'bitpie' },
{ walletName: 'xdefi' }

Gnosis Safe

For Gnosis Safe add the following wallet init object to your wallets array when initializing Onboard:

{ walletName: 'gnosis' }

With Gnosis Safe if a user opens your dApp within the Safe Interface, Onboard.js will automatically select the Gnosis Safe for the user.

Changlog

• 1.25.0-0.1.0: [feature] gnosis safe wallet (#551)
• Bump lodash from 4.17.19 to 4.17.21 (#549)
• Bump hosted-git-info from 2.8.8 to 2.8.9 (#550)
• 1.25.0-0.2.2: [feature] Ledger EIP712 Support (#554)
• 1.25.0-0.3.2: [feature] Adds bitpie wallet (#541)
• 1.25.0-0.4.2: [chore] patch vulnerabilities (#553)
• 1.25.0-0.5.2: [refactor] Adds autoselect for gnosis wallet (#555)
• 1.25.0-0.5.3: [fix] Fixes issue when gnosis wallet is not found label is undefined (#557)
• feat: add XDEFI (#540)
• 1.25.0-0.5.4: [update] Updates the bnc-sdk to latest (#558)
• 1.25.0-0.5.5: [fix] Add check for WalletConnect Initialization object (#560)

WalletLink Update 🚀

This release updates WalletLink to the latest version and replaces the old Coinbase logo with the new one.

Changelog:

• Update WalletLink to 2.1.0 and Coinbase Wallet icon (#544)

Terms of service feature & Portis update

The latest release of Onboard includes a new option that enables developers to ask users to agree to the terms of services before using Onboard. To enable this feature add the following to your Onboard init object:

const onboard = Onboard({
  ...
  walletSelect: {
    agreement: {
      version: '0.1.0',
      termsUrl:'https://www.yourdapp.com/terms-conditions',
      privacyUrl: 'https://www.yourdapp.com/privacy-policy',
    }
  }
})

Example:

Please see the docs for more information regarding this feature.

Additionally, it includes the updated Portis wallet!

Changelog:

• 1.23.0-0.1.0: [feature] Adds optional terms agreement (#531)
• 1.23.0-0.2.0: [feature] Configure CircleCI (#532)
• 1.23.0-0.2.1: [fix] Terms of service (#536)
• 1.23.0-0.2.2: [chore] move authereum below fold (#543)
• Updated Portis version to 3.0.10 (#539)

AlphaWallet

This release adds support for AlphaWallet. To add to your project, simply add the following wallet init object to your wallets array when initializing Onboard: { walletName: 'alphawallet' }.

Also is included in this release is an update to the latest WalletConnect version which includes additional mobile wallets.

Changelog:

• Add AlphaWallet connector (#505)
• 1.22.0-0.1.0: [feature] update wallet connect (#525)
• 1.22.0-0.2.0: [enhancement] - Filter Confirmed Status (#527)
• 1.22.0-0.2.1: [refactor] Fixes formatting (#528)

Ownbit Wallet

This release adds Ownbit wallet as a supported wallet module. To add it to your project, simply add the following wallet init object to your wallets array when initializing Onboard: { walletName: 'ownbit' }.

Also included in this release are a couple of small bugfixes for custom network names and a TypeScript issue.

Changelog:

Adds Ownbit wallet (#510)
1.21.0-0.0.1: [fix] - isMobile Parameter (#522)
1.21.0-0.0.2: [fix] - Adds unknown network name (#520)