Skip to content

turtlemoji/onboard

This branch is 35 commits ahead of, 1940 commits behind blocknative/web3-onboard:develop.

Folders and files

NameName
Last commit message
Last commit date
Dec 3, 2021
Sep 7, 2021
Feb 8, 2022
Nov 11, 2019
Jun 11, 2021
Aug 21, 2020
Aug 5, 2021
Oct 3, 2019
Nov 22, 2019
Feb 11, 2022
Jan 19, 2022
Oct 14, 2021
Nov 13, 2019
Apr 20, 2020
Sep 2, 2021
Feb 11, 2022

Repository files navigation

Onboard

JavaScript library to easily onboard users to ethereum apps by enabling wallet selection, connection, wallet checks and real time state updates.

Install

npm install bnc-onboard

Quick Start

import Onboard from 'bnc-onboard'
import Web3 from 'web3'

// set a variable to store instantiated web3
let web3

// head to blocknative.com to create a key
const BLOCKNATIVE_KEY = 'blocknative-api-key'

// the network id that your dapp runs on
const NETWORK_ID = 1

// initialize onboard
const onboard = Onboard({
  dappId: BLOCKNATIVE_KEY,
  networkId: NETWORK_ID,
  subscriptions: {
    wallet: wallet => {
      // instantiate web3 when the user has selected a wallet
      web3 = new Web3(wallet.provider)
      console.log(`${wallet.name} connected!`)
    }
  }
})

// Prompt user to select a wallet
await onboard.walletSelect()

// Run wallet checks to make sure that user is ready to transact
await onboard.walletCheck()

Documentation

For detailed documentation head to docs.blocknative.com

About

Client library to onboard users to web3 apps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 87.5%
  • Svelte 11.5%
  • Other 1.0%