@dcentralab/wc-ledger
TypeScript icon, indicating that this package has built-in type declarations

2.0.34 • Public • Published

Ledger Cold Wallet connector

Instalation

npm install @dcentralab/wc-ledger

or

yarn add @dcentralab/wc-ledger

Getting started

Ledger wallet connector for web3-wc-modal, package that implement wallet connection with Ledger Cold Wallet https://www.ledger.com/

CREATE-REACT-APP

To support hardware wallets in create-react-app you need to use react-app-rewired

const NodePolyfill = require('node-polyfill-webpack-plugin');

module.exports = function override (config, env) {
  console.log('override')
  config.plugins.push(new NodePolyfill())

  return config
}

Interface

export type TConnect = (connectingWalletType: string, options?: IConnectionOptions) => void
export type TDisconnect = (clearDerivationPath?: boolean) => void

export interface IConnectionOptions {
  rpcUrl?: string
  networkId?: number
  derivationPath?: string
  blockchainType?: BLOCKCHAIN_TYPE
  connectionType?: TWalletType
  onConnectStart?: () => void
  savePath?: boolean
  removeLSKey?: boolean,
  showModalOnError?: boolean,
  showToast?: (msg: string, duration?: number) => any
  connectWallet?: TConnect
  disconnectWallet?: TDisconnect
  internal?: boolean
}

export interface IConnectionResult {
  provider: any
  providerName?: string
}

export interface IConnector {
  type: TWalletType,
  blockchainType: BLOCKCHAIN_TYPE
  mobile: boolean
  enabled: () => boolean;
  connector: (opts: IConnectionOptions) => Promise<IConnectionResult>

  disconnector?: () => Promise<void>

  getAccount: (provider: AbstractProvider | IBinanceProvider | ICardanoProvider) => Promise<string | undefined>
  getBalance: (provider: AbstractProvider | IBinanceProvider | ICardanoProvider, address: string) => Promise<string | undefined>
  getHWAccounts?: (opts: IGetHWAccounts) => Promise<string[]>
  showToast?: (msg: string, duration?: number) => void
  localStorageKey?: string
  connectWallet?: TConnect
  disconnectWallet?: TDisconnect
  unsubscribeEvents?: () => void
}

Readme

Keywords

none

Package Sidebar

Install

npm i @dcentralab/wc-ledger

Weekly Downloads

334

Version

2.0.34

License

ISC

Unpacked Size

27.8 kB

Total Files

17

Last publish

Collaborators

  • aydnep
  • eitanlavi