Update documentation

Update device specific docs to include setup and wipe commands.

Updated the features table in the readme to reflect these changes
and other feature changes that have already occurred.
This commit is contained in:
Andrew Chow 2018-12-29 00:22:09 -05:00
parent 176e808fcc
commit b88db63075
6 changed files with 69 additions and 17 deletions

View File

@ -48,28 +48,30 @@ Please also see [docs](docs/) for additional information about each device.
| Feature \ Device | Ledger Nano S | Trezor One | Digital BitBox | KeepKey | Coldcard |
|:---:|:---:|:---:|:---:|:---:|:---:|
| Support Planned | Yes | Yes | Yes | Yes | Yes |
| Implemented | Partial | Partial | Partial | Partial | Partial |
| Implemented | Yes | Partial | Yes | Partial | Partial |
| xpub retrieval | Yes | Yes | Yes | Yes | Yes |
| Message Signing | Yes | No | No | No | No |
| Device Setup | No | No | No | No | No |
| Device Recovery | No | No | No | No | No |
| Device Reset | No | No | No | No | No |
| Message Signing | Yes | No | Yes | No | No |
| Device Setup | N/A | Yes | Yes | Yes | N/A |
| Device Wipe | N/A | Yes | Yes | Yes | N/A |
| Device Recovery | N/A | Yes | N/A | Yes | N/A |
| Device Backup | N/A | N/A | Yes | N/A | Yes |
| P2PKH Inputs | Yes | Yes | Yes | Partial | Yes |
| P2SH-P2WPKH Inputs | Yes | Yes | Yes | Partial | Yes |
| P2WPKH Inputs | Yes | Yes | Yes | Partial | Yes |
| P2SH Multisig Inputs | Yes | No | Yes | No | ?? |
| P2SH-P2WSH Multisig Inputs | Yes | No | Yes | No | ?? |
| P2WSH Multisig Inputs | Yes | No | Yes | No | ?? |
| Bare Multisig Inputs | Yes | No | Yes | No | ?? |
| Aribtrary scriptPubKey Inputs | Yes | No | Yes | No | ?? |
| Aribtrary redeemScript Inputs | Yes | No | Yes | No | ?? |
| Arbitrary witnessScript Inputs | Yes | No | Yes | No | ?? |
| P2SH Multisig Inputs | Yes | No | Yes | No | N/A |
| P2SH-P2WSH Multisig Inputs | Yes | No | Yes | No | N/A |
| P2WSH Multisig Inputs | Yes | No | Yes | No | N/A |
| Bare Multisig Inputs | Yes | No | Yes | No | N/A |
| Aribtrary scriptPubKey Inputs | Yes | No | Yes | No | N/A |
| Aribtrary redeemScript Inputs | Yes | No | Yes | No | N/A |
| Arbitrary witnessScript Inputs | Yes | No | Yes | No | N/A |
| Non-wallet inputs | Yes | Yes | Yes | Yes | Yes |
| Mixed Segwit and Non-Segwit Inputs | No | Yes | Yes | ?? | ?? |
| Mixed Segwit and Non-Segwit Inputs | No | Yes | Yes | Partial | Yes |
| Display on device screen | Yes | Yes | N/A | No | No |
## Using with Bitcoin Core
See (Using Bitcoin Core with Hardware Wallets)[docs/bitcoin-core-usage.md].
See [Using Bitcoin Core with Hardware Wallets](docs/bitcoin-core-usage.md).
## License

View File

@ -5,5 +5,21 @@ The ColdCard is partially supported by HWI
Current implemented commands are:
* `getmasterxpub`
* `signtx`
* `signtx` (only single key)
* `getxpub`
- `setup`
- `wipe`
- `restore`
- `backup`
## Notes on `setup`, `wipe`, and `restore`
The Coldcard does not allow you to setup, wipe, or restore the device via software. That is done on the device itself. The implementation here is just to let users know those commands do not work.
## Note on `backup`
The `backup` command will create a backup file in the current working directory. This file is protected by the passphrase shown on the Coldcard during the backup process.
## Caveat for `signtx`
The Coldcard firmware only supports signing single key transactions. It cannot sign multisig or arbitrary scripts yet.

View File

@ -1,12 +1,16 @@
# Digital BitBox
The Digital BitBox is partially supported by HWI
The Digital BitBox is supported by HWI
Current implemented commands are:
* `getmasterxpub`
* `signtx`
* `getxpub` (with some caveats)
- `setup`
- `wipe`
- `restore`
- `backup`
## Usage Notes
@ -19,3 +23,7 @@ You must specify your Digital BitBox password using the `-p` option. E.g.
## `getxpub` Caveats
The Digital BitBox requires that one of the levels in the derivation path is hardened.
## Note on `restore`
The Digital BitBox does not allow users to restore a backup or seed via software.

View File

@ -6,7 +6,15 @@ Current implemented commands are:
* `getmasterxpub`
* `getxpub`
- `setup`
- `wipe`
- `restore`
- `backup`
## `signtx` Notes
`signtx` has an implementation but has not been tested to be working. Use at your own risk.
## Note on `backup`
Once the device is backed up at setup, the seed words will not be shown again to be backed up. The implementation here lets users know that `backup` does not work.

View File

@ -1,6 +1,6 @@
# Ledger Nano S
The Ledger Nano S is partially supported by HWI.
The Ledger Nano S is supported by HWI.
Currently implemented commands:
@ -8,9 +8,18 @@ Currently implemented commands:
* `signtx` (with some caveats)
* `getxpub`
* `signmessage`
- `displayaddress`
- `setup`
- `wipe`
- `restore`
- `backup`
## `signtx` Caveats
Due to device limitiations, not all kinds of transactions can be signed by a Ledger.
* Transactions containing both segwit and non-segwit inputs are not entirely supported; only the segwit inputs will be signed in this case.
## Notes on `setup`, `wipe`, `restore`, and `backup`
The Ledger does not allow you to setup, wipe, restore, or backup it via software. That is done on the device itself. The implementation here is just to let users know those commands do not work.

View File

@ -7,6 +7,11 @@ Current implemented commands are:
* `getmasterxpub`
* `signtx` (with some caveats)
* `getxpub`
- `displayaddress`
- `setup`
- `wipe`
- `restore`
- `backup`
## `signtx` Caveats
@ -14,3 +19,7 @@ Due to the limitations of the Trezor and of the lack of documentation, some tran
* The current implementation does not support signing Multisig inputs
* Transactions with arbitrary input scripts (scriptPubKey, redeemScript, or witnessScript) and arbitrary output scripts cannot be signed
## Note on `backup`
Once the device is backed up at setup, the seed words will not be shown again to be backed up. The implementation here lets users know that `backup` does not work.