• Core
  • Connectors
  • Ledger

Ledger

The LedgerConnector supports connecting with a Ledger device using the Ledger Connect Kit.

import { LedgerConnector } from '@wagmi/connectors/ledger'

Usage

WalletConnect v2

To get started with Ledger + WalletConnect v2, you will need to retrieve a Project ID. You can find your Project ID here.

import { LedgerConnector } from '@wagmi/connectors/ledger'
import { mainnet } from '@wagmi/core/chains'
 
const connector = new LedgerConnector({
  chains: [mainnet],
  projectId: '...',
})

Note: The above example is using chains from @wagmi/core/chains entrypoint.

WalletConnect v1

import { LedgerConnector } from '@wagmi/connectors/ledger'
import { mainnet } from '@wagmi/core/chains'
 
const connector = new LedgerConnector({
  chains: [mainnet],
})

Configuration

chains (optional)

Chains supported by app. Defaults to defaultChains.

import { LedgerConnector } from '@wagmi/connectors/ledger'
import { mainnet } from '@wagmi/core/chains'
 
const connector = new LedgerConnector({
  chains: [mainnet],
})

options (WalletConnect v2)

projectId

WalletConnect Cloud Project ID. You can find your Project ID here.

import { LedgerConnector } from '@wagmi/connectors/ledger'
 
const connector = new LedgerConnector({
  options: {
    projectId: '...',
  },
})

enableDebugLogs

Toggle debug logging for Ledger Connect Kit.

import { LedgerConnector } from '@wagmi/connectors/ledger'
 
const connector = new LedgerConnector({
  options: {
    projectId: '...',
    enableDebugLogs: true,
  },
})

options (WalletConnect v1)

chainId

The Chain ID of the connecting chain.

import { LedgerConnector } from '@wagmi/connectors/ledger'
 
const connector = new LedgerConnector({
  options: {
    chainId: 1,
  },
})

enableDebugLogs

Toggle debug logging for Ledger Connect Kit.

import { LedgerConnector } from '@wagmi/connectors/ledger'
 
const connector = new LedgerConnector({
  options: {
    enableDebugLogs: true,
  },
})

rpc

A Chain ID (key) / RPC URL (value) map.

import { LedgerConnector } from '@wagmi/connectors/ledger'
 
const connector = new LedgerConnector({
  options: {
    rpc: {
      1: 'https://eth-mainnet.alchemyapi.io/v2/yourAlchemyId',
    },
  },
})