A library for interacting with hardware wallets from JS/TS. Supports KeepKey, Trezor, and Ledger. Intended for use in web apps, chrome apps/extensions, and electon/node apps.
Try it out here!
yarn add @shapeshiftoss/hdwallet-core
yarn add @shapeshiftoss/hdwallet-keepkey-webusb
yarn add @shapeshiftoss/hdwallet-trezor-connect
yarn add @shapeshiftoss/hdwallet-ledger-webusb
You can import the generated bundle to use each of the component libraries:
import { HDWallet } from '@shapeshiftoss/hdwallet-core'
import { isKeepKey, KeepKeyHDWallet } from '@shapeshiftoss/hdwallet-keepkey'
import { isLedger, LedgerHDWallet } from '@shapeshiftoss/hdwallet-ledger'
import { isTrezor, TrezorHDWallet } from '@shapeshiftoss/hdwallet-trezor'
import { WebUSBKeepKeyAdapter } from '@shapeshiftoss/hdwallet-keepkey-webusb'
import { WebUSBLedgerAdapter } from '@shapeshiftoss/hdwallet-ledger-webusb'
import { TrezorAdapter } from '@shapeshiftoss/hdwallet-trezor-connect'
The recommended way to use the library is through a Keyring
singleton,
which manages connected devices:
import { Keyring } from '@shapeshiftoss/hdwallet-core'
const keyring = new Keyring()
To add in support for a given wallet type, add in the relevant Transport
adapter by calling useKeyring()
on it:
import { WebUSBKeepKeyAdapter } from '@shapeshiftoss/hdwallet-keepkey-webusb'
import { TrezorAdapter } from '@shapeshiftoss/hdwallet-trezor-connect'
const keepkeyAdapter = WebUSBKeepKeyAdapter.useKeyring(keyring)
const trezorAdapter = TrezorAdapter.useKeyring(keyring, {
debug: false,
manifest: {
email: 'you@example.com', // TrezorConnect info
appUrl: 'https://example.com' // URL of hosted domain
}
})
const ledgerAdapter = LedgerAdapter.useKeyring(keyring)
After setting up a Keyring
, and plugging various transport adapters into
it, the next step is to pair a device:
let wallet = await keepkeyAdapter.pairDevice()
wallet.getLabel().then(result => { console.log(result) })
It is expected that this take quite some time (around 15 minutes), due to the large size of the compiled KeepKey protobuf encoder/decoder.
yarn clean
yarn
yarn build
To compile and watch the browser bundle, run:
yarn dev:sandbox
This will launch an ssl webserver that runs at https://localhost:1234
, with
a small demo app that shows how to use various HDWallet functionality.
We use Zeit Now for continuous deployment of this sandbox app. On pull requests, the builder will publish a new version of that app with the changes includeed (for example #68). Try out the latest build here: https://hdwallet.shapeshift.now.sh/
yarn
yarn build
yarn test
The integration tests have been set up to run either against a physical KeepKey with debug firmware on it, or in CI pointed at a dockerized version of the emulator. Trezor and Ledger tests run against mocks of their respective transport layers.
See our developer guidelines here.