Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

LedgerHQ/ledger-live-wagmi-connector

Repository files navigation

Ledger

Ledger Live Wagmi Connector

Wagmi Connector for the Ledger Live Ethereum Dapp Browser

License Tests Passing Issues GitHub pull requests Discord

Ledger Developer Portal · Report Bug · Request Feature

⛔️ DEPRECATED

This repository is now deprecated.

About

@ledgerhq/ledger-live-wagmi-connector is a connector for the popular wagmi library built on top of the @ledgerhq/iframe-provider .

It can be used to initialize a wagmi client that will seemlessly manage the interaction of your DApp with the Ledger Live wallet through the ethereum dapp browser.

For more details on how to develop, test and integrate your DApp in the Ledger Live context, head over to our developer portal.

How to use

Here is an example of a wagmi client using both the IFrameEthereumConnector and the default InjectedConnector to be used, respectively, within Ledger Live DApp browser and on a regular browser with an injected provider like Metamask for example.

import { IFrameEthereumConnector } from "@ledgerhq/ledger-live-wagmi-connector";
import { defaultChains, configureChains, createClient } from "wagmi";
import { InjectedConnector } from "wagmi/connectors/injected";
import { publicProvider } from "wagmi/providers/public";

const { chains, provider } = configureChains(defaultChains, [publicProvider()]);

const wagmiClient = createClient({
  autoConnect: true,
  connectors: [
    new IFrameEthereumConnector({ chains, options: {} }),
    new InjectedConnector({ chains }),
  ],
  provider,
});

Contributing

You need to have a recent Node.js and pnpm installed.

Install dependencies

pnpm i

Build

Build the Connector

pnpm build

Lint

Check code quality with

pnpm lint

Format

Check code formatting with

pnpm format:check

Documentation

Have a look at the wagmi repo and the wagmi doc to learn more on connectors and wagmi.