Coder Social home page Coder Social logo

pinkdiamond1 / zk-wallet-onboarding Goto Github PK

View Code? Open in Web Editor NEW

This project forked from matter-labs-archive/zk-wallet-onboarding

0.0 1.0 0.0 4.81 MB

Client library to onboard users to web3 apps

Home Page: https://www.npmjs.com/package/@matterlabs/zk-wallet-onboarding

License: MIT License

Shell 0.08% JavaScript 1.11% TypeScript 83.10% Svelte 15.70%

zk-wallet-onboarding's Introduction

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 @mattermost/zk-wallet-onboarding

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!`)
    }
  },
  // Content shown in wallet select popup at the botton -> expandable teaser that can be used to onboard, describe or as a call-to-action
  popupContent: {
    teaser: "Can't find your wallet?",
    fullHtml: "Oh, dear... It's so sad :(",
    dismiss: "Dismiss"
  }
})

// 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

zk-wallet-onboarding's People

Contributors

alex-miller-0 avatar amiromayer avatar benjlevesque avatar chaitanyapotti avatar chendatony31 avatar cmeisl avatar dependabot[bot] avatar dmarzzz avatar keriat avatar kyungeunkim avatar lnbc1qwfyb24 avatar macomni avatar matthaltom avatar miguelmota avatar muchenshou avatar shanefontaine avatar thealexpatin avatar tomafrench avatar triplespeeder avatar vasa-develop avatar wujunchuan avatar yomarion avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.