Web3-Onboard

easy way to connect users to dapps

Features

• Minimal Dependencies: All wallet dependencies are included in separate packages, so you only include the ones you want to use in your app.
• Multiple Wallets and Accounts Connection: Allow your users to connect multiple wallets and multiple accounts within each wallet at the same time to your app.
• Multiple Chain Support: Allow users to switch between chains/networks with ease.
• Account Center: A persistent interface to manage wallet connections and networks, with a minimal version for mobile
• Wallet Provider Standardization: All wallet modules expose a provider that is patched to be compliant with the EIP-1193, EIP-1102, EIP-3085 and EIP-3326 specifications.
• Dynamic Imports: Supporting multiple wallets in your app requires a lot of dependencies. Onboard dynamically imports a wallet and its dependencies only when the user selects it, so that minimal bandwidth is used.

Quickstart

Install the core Onboard library, the injected wallets module and optionally ethers js to support browser extension and mobile wallets:

NPM npm i @web3-onboard/core @web3-onboard/injected-wallets ethers

Yarn yarn add @web3-onboard/core @web3-onboard/injected-wallets ethers

Then initialize in your app:

1import Onboard from '@web3-onboard/core'
2import injectedModule from '@web3-onboard/injected-wallets'
3import { ethers } from 'ethers'
4
5const MAINNET_RPC_URL = 'https://mainnet.infura.io/v3/<INFURA_KEY>'
6
7const injected = injectedModule()
8
9const onboard = Onboard({
10  wallets: [injected],
11  chains: [
12    {
13      id: '0x1',
14      token: 'ETH',
15      label: 'Ethereum Mainnet',
16      rpcUrl: MAINNET_RPC_URL
17    },
18    {
19      id: 42161,
20      token: 'ARB-ETH',
21      label: 'Arbitrum One',
22      rpcUrl: 'https://rpc.ankr.com/arbitrum'
23    },
24    {
25      id: '0xa4ba',
26      token: 'ARB',
27      label: 'Arbitrum Nova',
28      rpcUrl: 'https://nova.arbitrum.io/rpc'
29    },
30    {
31      id: '0x2105',
32      token: 'ETH',
33      label: 'Base',
34      rpcUrl: 'https://mainnet.base.org'
35    }
36  ]
37})
38
39const wallets = await onboard.connectWallet()
40
41console.log(wallets)
42
43if (wallets[0]) {
44  // create an ethers provider with the last connected wallet provider
45  const ethersProvider = new ethers.providers.Web3Provider(
46    wallets[0].provider,
47    'any'
48  )
49
50  const signer = ethersProvider.getSigner()
51
52  // send a transaction with the ethers provider
53  const txn = await signer.sendTransaction({
54    to: '0x',
55    value: 100000000000000
56  })
57
58  const receipt = await txn.wait()
59  console.log(receipt)
60}

Onboard v1 migration guide

If you're coming from v1, we've created a migration guide for you.

Documentation

For full documentation, check out the README.md for each package or the docs page here:

Core Repo

• Core

Injected Wallets

• Injected

SDK Wallets

• Arcana
• Bitget
• Blocto
• Capsule
• Coinbase
• Enkrypt
• FinoaConnect
• Fortmatic
• Frame
• Frontier
• Infinity Wallet
• Magic
• MetaMask
• MEW-Wallet
• OKX
• Particle Network
• Portis
• Safe
• Sequence
• Taho (previously Tally Ho)
• Trust
• Unstoppable Domains
• WalletConnect
• Web3Auth
• XDEFI

Hardware Wallets

• D'CENT
• KeepKey
• Keystone
• Ledger
• Trezor

Frameworks

• React
• Solid
• Vue

Test out the demo app

If you would like to test out the current functionality of V2 in a small browser demo, then:

• Clone the repo: git clone git@github.com:blocknative/onboard.git
• Change in to the onboard directory: cd onboard
• Checkout the V2 feature branch: git checkout main
• Install the dependencies: yarn (if running a M1 mac - yarn install-m1-mac)
• Run all packages in dev mode: yarn dev
• To view the demo app in the browser after running the above steps navigate to http://localhost:8080