step-by-step guide on how to use HWI and Bitcoin Core #413
Conversation
There was a problem hiding this comment.
Concept ACK
It would be nice for the screenshots to have more descriptive names rather than just the date and time they were made.
Additionally, since we are moving to using Sphinx and RST for docs soon (see #464), it would be nice for this to be formatted with RST so that it will work without changes in Sphinx.
docs/walk-through/README.md
Outdated
| # of unknown address on Trezor display | ||
| wallet=wallet.test | ||
| rec=$(hwi --testnet -f $TREZORFINGERPRINT_TESTNET getkeypool --wpkh --path m/84h/${DERIVATIONPATH_TESTNET}h/0h/0/* --keypool 0 1000) | ||
| chg=$(hwi --testnet -f $TREZORFINGERPRINT_TESTNET getkeypool --wpkh --path m/84h/${DERIVATIONPATH_TESTNET}h/0h/1/* --keypool --internal 0 1000) |
There was a problem hiding this comment.
--wpkh was replaced with --addr-type wpkh.
Additionally, it is unnecessary to specify --path if you are planning on just using the default path. To get the testnet path, you can use the --testnet option.
Lastly, without --path, getkeypool will return both change and receiving descriptors, so it is unnecessary to have call it twice.
There was a problem hiding this comment.
Ok, Andrew, I replaced the --wpkh with --addr-type wpkh so that this option is up-to-date.
I know and I understand that by removing --path that with a single command both receiving and change address will be handled at once and that there are fewer calls, i.e. the script is shorter. However, I copied this code out of my script that I used for testing many different scenarios. I find it definitely helpful, for users to see which address they are creating, so the next time around e.g. they can do address 1000 through 2000, etc. I personally also found it useful to see path so that the script can be adapted to different networks. In my humble opinion it helps the user understand better and through these examples the user learns more and can adapt this script to more situations.
In short, I was not going for the shortest code, or the simplest solution, but for the solution that teaches the most and demos the most info. As such, I have left the options --path and the additional --keypool arguments in place.
What do you think @achow101 ? Reasonable?
- all/most of the recommended changes from @achow101 have been worked into this RST file - see comments and discussion in bitcoin-core#413
- see suggestion from @achow101 in bitcoin-core#413, PR bitcoin-core#413
|
Thanks Andrew @achow101 for your valuable feedback on PR #413. I addressed nearly all of your issues and followed your suggestions. Your suggestions have been added via the 3 commits 067e0c0 , 58379f6 and 30b1bb4. Please have a look at the improved version. Let me know if there is anything else that needs to be done. Thanks again and cheers! |
Following suggestion from @achow101. See bitcoin-core#413 (comment)
|
Please squash your commits. Also, please don't @ mention people in commits as they will receive Github notifications every time that commit is pushed. I would still like for the screenshots to be given understandable names. |
|
Hi Andrew, All done. Please have a look at this revised version. Thanks! |
|
ACK 7de0237 |
c603135 Move walkthrough into sphinx (Andrew Chow) Pull request description: Followup to #413. Moves the walkthrough doc under the examples directory and adds the file to the sphinx generated documentation. Top commit has no ACKs. Tree-SHA512: 96af0fa093f3035da3842fc7601d587ccb09ac4a89f93844ccdd345802f351abae0005ccb3fe06a88cea7aac543674fb81d37a8ded18c65abd9bf8981f341170
|
Great! The page is live at |
This page shows in details through screenshots and description on how to use a hardware wallet with Bitcoin Core through the help of HWI. I hope this one-pager helps people to see how it works, takes their fear and increments the use of hardware wallets with Bitcoin Core.