isabella232 / web3-react-ledgerconnect-connector

@ledgerhq/web3-react-ledgerconnect-connector

This package is based on the @web3-react/injected-connector v6 package.

Please visit the web3-react repository, v6 for documentation and details on web3-react.

Install

Add it to your dapp along with web3-onboard with

    yarn add @web3-react/core
    yarn add @ledgerhq/web3-react-ledgerconnect-connector

Usage

• import LedgerConnectConnector and create an instance of it

    import { LedgerConnectConnector } from "@ledgerhq/web3-react-ledgerconnect-connector";
  
    const ledgerConnect = new LedgerConnectConnector();
  

• import the useWeb3React hook from web3-react core

    import { useWeb3React } from "@web3-react/core";
  

• get the activate property from the hook

    const { activate } = useWeb3React();
  

• add a button to your app that calls the activate method of the hook with the LedgerConnectConnector instance as a parameter

    <Button onClick={() => {
            ...
            activate(ledgerConnect);
            ...
      }}>
      Ledger Connect
    </Button>
  

• in the beta version this will only work on Safari for iOS when the Ledger Connect extension is loaded and enabled, you can check for that and only show the button if enabled with

    {window.ethereum?.isLedgerConnect && <Button ...>
    </Button>}
  

• when pressing the button you should get the Ledger Connect extension UI on you your screen and follow the instructions to connect to the wallet