Skip to content

Latest commit

 

History

History
152 lines (95 loc) · 8.92 KB

README.md

File metadata and controls

152 lines (95 loc) · 8.92 KB
Raw

Bitshares Wallet App for Ledger Nano S

This is the app that runs on the Ledger Nano S device and signs transactions recieved via USB from a host wallet interface.

It also manages and safeguards your keys, deriving the public and private keys from the wallet seed according to BitShares specific conventions.

Features

  • Processes serialized transactions to decode and display parameters of recognized BitShares operations, so that the user may be assured that the transaction is as intended before signing.
  • Can process transactions that contain multiple operations (currently capped at four).
  • For unrecognized operations, displays a warning that the details cannot be extracted, but still allows the user to sign the transaction if they wish.
  • Follows the SLIP-0048 specification for deriving public keys for Graphene blockchains.

Supported Operations:

The following operations are supported in-device, and will show details of the operation on-screen. Support for additional operations beyond those listed here will be an on-going effort.

  • Transfer
  • Limit Order Create
  • Limit Order Cancel
  • Account Update
  • Account Upgrade

Included tools and docs:

A set of python scripts are provided to allow command-line interaction with the device, to request the signing of transactions read in from a file in JSON format. The main purpose of the app, however, is to be a back-end to a more sophisticated wallet interface, and these scripts are primarily intended to provide a reference for developers developing GUI wallets.

The app follows the specification available in the doc/ folder, which documents the communication protocol with the device.

To use the generic wallet via the scripts, refer to signTransaction.py, getPublicKey.py. Some examples are given in sections below.

Installing a GUI wallet / front end

GUI wallet front-end support for Ledger Nano S is being developed independently by multiple wallet developers. This repository contains the back-end app for your Nano that the wallets will connect to via USB. As such, this repository is intended primarily for developers and wallet integrators. If you are a regular user, then it is anticipated that by the time the GUI apps are ready, this back-end app will be available for download directly to your device via the Ledger Live app store. You will not need to get the app from here.

There is however a very rudimentary GUI Wallet that accompanies this repository to enable basic use of the Nano S while awaiting integration into existing BitShares wallets. It is located in the SimpleGUIWallet/ folder and exaplained in the README file there.

A list of supporting GUI apps will be added here when available.

Building and installing the app

If you are installing the app from this repository (not recommended for regular users, who should instead install the app on their device through LedgerLive), you will need a development environment that supports cross-compiling to the embedded ARM architecture of the Nano device. This environment can be configured in a virtual machine created with Vagrant, as described below.

Note that the following build environment assumes Firmware version 1.6.x is installed on you Ledger Nano.

Configuring Ledger build environment with Ledger-Vagrant

A ready-to-use build environment configured in a virtual machine is available via christophersanborn/ledger-vagrant. This pre-configured VM-based environment saves you the trouble of needing to configure the cross-compiling tools for building apps for the Ledger Nano. To use it, you will need Vagrant and VirtualBox installed on your build machine. Then run the following:

git clone https://github.com/christophersanborn/ledger-vagrant
cd ledger-vagrant
vagrant up

This creates the virtual machine, and will take a few minutes to complete. For more info on setting up the build environment, refer to christophersanborn/ledger-vagrant. Once the virtual machine is up and running, you can connect to it with:

vagrant ssh

Compile and load the Ledger app

With the build environment configured, we can now clone, compile, and load ledger-app-bitshares. Note that when you installed ledger-vagrant, it created an apps/ directory that is accessible in both the host filesystem and the virtual machine.

  • Clone the app repository, under the apps/ folder:
cd apps/
git clone https://github.com/bitshares/ledger-app-bitshares
  • Now connect to the virtual machine with vagrant ssh and compile the app:
cd apps/ledger-app-bitshares
make clean
make
  • Next connect your Ledger Nano S to your computer:
    • Install the app on your Ledger with: make load
    • Remove the app from the Ledger with: make delete

Testing the app

Once loaded on your device, the app shows up in the Nano's dashboard as "BitShares" with the familiar icon. Select it and start the app by pressing both buttons on the Nano simultaneously.

BitShares wallet addresses:

You can retrieve a BitShares public key managed by the Nano with getPublicKey.py. Examples:

python3 getPublicKey.py
python3 getPublicKey.py --path "48'/1'/0'/0'/0'"

In the first instance the default derivation path is used. In the second instance, a specific path is requested. Note that the app is constrained to use paths beginning with 48'/1'/. The public key is also shown on screen on the device.

You can see a range of addresses and an illustration of the SLIP-0048 scheme with testDerivationPathGeneration.py:

python3 testDerivationPathGeneration.py
Signing transactions:

Some example transactions are included as .json files in the example-tx directory. We can ask the BitShares app on the Nano to sign one of these transactions with the signTransaction.py python script. Examples:

python3 signTransaction.py --file=example-tx/tx_transfer.json
python3 signTransaction.py --file=example-tx/tx_limit_order_create.json

Details of the transaction will be shown on the Ledger's screen, and the user will be able to accept or reject the transaction.

One particularly interesting example transaction is tx_trade_and_transfer.json. This one contains two operations: the first trades 30 BTS for (at least) 1 bitEUR, then sends the 1 bitEUR to a different account. This transaction was broadcast and is recorded in the blockchain at block height 35501245, and has transaction Id 1bab1b079e3dfb52ef34984891ceeddbfa000fd8. (If you sign this transaction on your own device, you can confirm that the TxId's match.)

python3 signTransaction.py --file=example-tx/tx_trade_and_transfer.json
Developer notes:

  • The python scripts will show a hex representation of the bytes exchanged with the device in the terminal output. This will be useful in confirming your understanding of the communication protocol with the device, and help with GUI wallet integration efforts.

  • Developers may find useful the "debugging firmware", which enables streaming of stdout over the USB connection, allowing debugging output via a PRINTF macro. Instructions for installing and using this firmware are here

Developer Resources

Developers planning to add Ledger Nano support to their GUI wallet projects will need to handle device communication with the Nano in their apps. Ledger provides several libraries for this purpose. Depending on the type of project, developers may find the following resources useful:

For Python projects:

For Javascript projects:

  • Ledger's JavaScript libraries
    Communication protocol for Ledger's hardware wallet devices (Ledger Nano / Ledger Nano S / Ledger Nano X / Ledger Blue) in many platforms: Web, Node, Electron, React Native,... and using many different communication channels: U2F, HID, WebUSB, Bluetooth,...

For C/C++ projects:

  • btchip-c-api
    The documentation and examples are a bit dated, but this link appears to include the needed API and library functions for connecting to and exchanging data with the Nano S.