Skip to content

[ledger-v2.4.1-alpha.1]: Update - Add Ledger docs for new init options #1457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 12, 2023
Merged

[ledger-v2.4.1-alpha.1]: Update - Add Ledger docs for new init options #1457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/demo/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"@web3-onboard/injected-wallets": "^2.5.0",
"@web3-onboard/keepkey": "^2.3.2",
"@web3-onboard/keystone": "^2.3.2",
"@web3-onboard/ledger": "^2.4.0",
"@web3-onboard/ledger": "^2.4.1-alpha.1",
"@web3-onboard/magic": "^2.1.3",
"@web3-onboard/phantom": "^2.0.0-alpha.1",
"@web3-onboard/portis": "^2.1.3",
Expand Down
41 changes: 6 additions & 35 deletions packages/ledger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,16 @@

### Install

`npm i @web3-onboard/ledger`
`npm i @web3-onboard/core @web3-onboard/ledger`

### Options

```typescript
type LedgerOptions = {
customNetwork?: CustomNetwork
}

interface CustomNetwork {
networkId: number
genesis: GenesisBlock
hardforks: Hardfork[]
bootstrapNodes: BootstrapNode[]
}

interface GenesisBlock {
hash: string
timestamp: string | null
gasLimit: number
difficulty: number
nonce: string
extraData: string
stateRoot: string
}

interface Hardfork {
name: string
block: number | null
}

interface BootstrapNode {
ip: string
port: number | string
network?: string
interface LedgerOptions {
chainId?: number
id: string
location: string
comment: string
bridge?: string
infuraId?: string
rpc?: { [chainId: number]: string }
}
```

Expand Down Expand Up @@ -74,7 +45,7 @@ You may decide that on certain platforms you do not want to display this wallet
import Onboard from '@web3-onboard/core'
import ledgerModule from '@web3-onboard/ledger'

const ledger = ledgerModule({ filter: ['Safari'] })
const ledger = ledgerModule()

const onboard = Onboard({
// ... other Onboard options
Expand Down
2 changes: 1 addition & 1 deletion packages/ledger/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@web3-onboard/ledger",
"version": "2.4.0",
"version": "2.4.1-alpha.1",
"description": "Ledger hardare wallet module for connecting to Web3-Onboard. Web3-Onboard makes it simple to connect Ethereum hardware and software wallets to your dapp. Features standardised spec compliant web3 providers for all supported wallets, framework agnostic modern javascript UI with code splitting, CSS customization, multi-chain and multi-account support, reactive wallet state subscriptions and real-time transaction state change notifications.",
"keywords": [
"Ethereum",
Expand Down