Getting Started

Installation

Get up and running with Web3-Onboard

Install

Install the core Onboard library and the injected wallets module to support browser extension and mobile wallets:

Yarn
Npm

terminal

yarn add @web3-onboard/core @web3-onboard/injected

terminal

npm install @web3-onboard/core @web3-onboard/injected

Import

import Onboard, { chains } from '@web3-onboard/core'
import injectedModule from '@web3-onboard/injected-wallets'

Configure

Wallets

import Onboard, { chains } from '@web3-onboard/core'
import injectedModule from '@web3-onboard/injected-wallets'

const injected = injectedModule()

const wallets = [injected]

Chains

Select the chains that you'd like your dapp to support:

const INFURA_ID = '...'

const chains = [
  {
    id: 1,
    token: 'ETH',
    label: 'Ethereum Mainnet',
    rpcUrl: 'https://mainnet.infura.io/v3/${INFURA_ID}'
  },
  {
    id: 137,
    token: 'MATIC',
    label: 'Matic Mainnet',
    rpcUrl: 'https://matic-mainnet.chainstacklabs.com'
  }
]

App Metadata (Optional)

You can add metadata about your dapp.

const appMetadata = {
  name: 'My App',
  icon: '<SVG_ICON_STRING>',
  logo: '<SVG_LOGO_STRING>',
  description: 'My app using Onboard',
  recommendedInjectedWallets: [
    { name: 'Coinbase', url: 'https://wallet.coinbase.com/' },
    { name: 'MetaMask', url: 'https://metamask.io' }
  ]
}

Initialize Onboard

const onboard = Onboard({
  wallets,
  chains,
  appMetadata
})

Installation

# Install

# Import

# Configure

# Wallets

# Chains

# App Metadata (Optional)

# Initialize Onboard