@web3-onboard/ledger
Wallet module for connecting Ledger hardware wallets to web3-onboard
Install
npm i @web3-onboard/core @web3-onboard/ledger
Options
type LedgerOptionsWCv1 = {
walletConnectVersion?: 1
enableDebugLogs?: boolean
chainId?: number
bridge?: string
infuraId?: string
rpc?: { [chainId: number]: string }
}
type LedgerOptionsWCv2 = {
walletConnectVersion: 2
enableDebugLogs?: boolean
projectId: string
requiredChains?: string[] | number[]
requiredMethods?: string[]
optionalMethods?: string[]
requiredEvents?: string[]
optionalEvents?: string[]
}
type LedgerOptions = LedgerOptionsWCv1 | LedgerOptionsWCv2
Usage
import Onboard from '@web3-onboard/core'
import ledgerModule from '@web3-onboard/ledger'
const ledger = ledgerModule({
projectId: 'abc123...',
requiredChains: [1, 137]
})
const onboard = Onboard({
wallets: [
ledger
]
})
const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
Filtering Platforms
You may decide that on certain platforms you do not want to display this wallet as a selectable option. To do that you can use the filter
init option which is an array of platforms that you would like this wallet to not be displayed to the end user:
import Onboard from '@web3-onboard/core'
import ledgerModule from '@web3-onboard/ledger'
const ledger = ledgerModule({
projectId: 'abc123...',
requiredChains: [1, 137]
})
const onboard = Onboard({
wallets: [
ledger
]
})
const connectedWallets = await onboard.connectWallet()
console.log(connectedWallets)
The following is a list of the platforms that can be filtered:
type Platform =
| 'Windows Phone'
| 'Windows'
| 'macOS'
| 'iOS'
| 'Android'
| 'Linux'
| 'Chrome OS'
| 'Android Browser'
| 'Chrome'
| 'Chromium'
| 'Firefox'
| 'Microsoft Edge'
| 'Opera'
| 'Safari'
| 'desktop'
| 'mobile'
| 'tablet'