Highlander •
Understanding The KeepKey REST API
Loading content...
Highlander •
TL:DR build on KeepKey today with our new SDK: https://www.npmjs.com/package/@keepkey/keepkey-sdk
TL:DR build on KeepKey today with our new SDK: https://www.npmjs.com/package/@keepkey/keepkey-sdk
Fixing the largest point of friction in the KeepKey Ecosystem.
Here I am demonstrating some simple things that you have never been able to do with a KeepKey until now.
In this screenshot I have open:
All three of these applications are connected simultaneously, functional, and can be interacted with seamlessly.
Why was something so simple not possible before?
WebUSB was the primary interface for KeepKey prior to our acquisition. The architectural decision to build on this protocol severely limited applications and potential integration partners.
WebUSB has a limitation of
claimInterfaceThis limitation, that only 1 interface is able to claim an interface, has plagued KeepKey users for years. Not only that, but the first application that claims a device can lock onto that device, and prevent a new application from ever connecting. For instance, if you have a tab of app.shapeshift.com open in the background, no new windows may connect to your KeepKey.
And Firefox and Safari users just plain have not been able to use their KeepKey because those browsers do not support WebUSB.
KeepKey desktop is now the primary interface for anyone wishing to build on KeepKey. This application provides native HID USB drivers for firmware updating, manages advanced features like PIN management in BIP39 mnemonics so integrators don’t need to account for them, and most importantly, provides the new KeepKey REST interface hosted on the user’s localhost.
Introducing the KeepKey REST interface.
(You can view this developer documentation on http://localhost:1645/docs or by going to settings/Open API developer documentation)
All applications wishing to integrate KeepKey now have a new developer toolkit.
This npm package provides full access to the KeepKey’s REST API and provides TypeScript typing for coding assistance.
Integrating this REST interface into shapeshift.com
At the core of app.shapeshift.com is its HDwallet package.
You can view a live preview of this feature coded here:
ShapeShift DAO
ShapeShift DAO | Your Web3 & DeFi Portal
web-theta-one.vercel.app
https://github.com/shapeshift/web/pull/3678
And that's it! This new KeepKey REST API is a building block for future amazing applications to integrate and allow their users to leverage self-custody.
Interested in building multi-chain dapp’s for KeepKey?
Check out this tutorial.