Add Ledger Instructions #1512
Add Ledger Instructions #1512
Conversation
|
cc @cwgoes |
Codecov Report
@@ Coverage Diff @@
## develop #1512 +/- ##
========================================
Coverage 64.13% 64.13%
========================================
Files 118 118
Lines 6489 6489
========================================
Hits 4162 4162
Misses 2075 2075
Partials 252 252 |
docs/clients/ledger.md
Outdated
|
|
||
| ### Ledger Support for Account Keys | ||
|
|
||
| `gaiacli` now supports derivation of account keys from a Ledger seed. To use this functionality you will need the following: |
There was a problem hiding this comment.
Let's reference the BIP HD derivation spec, which we use - https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki
There was a problem hiding this comment.
Added a note below about this with links to our derivation paths in the code.
docs/clients/ledger.md
Outdated
| * Install the Cosmos app onto your Ledger by following the instructions in the [`ledger-cosmos`](https://github.com/cosmos/ledger-cosmos/blob/master/docs/BUILD.md) repository. | ||
| * A production-ready version of this app will soon be included in the [Ledger Apps Store](https://www.ledgerwallet.com/apps) | ||
|
|
||
| Once you have the Cosmos app installed on your Ledger, and the ledger is accessible from the machine you are using `gaiacli` from you can create a new Account key using the ledger: |
There was a problem hiding this comment.
"Ledger" (capitalized), "account" (lowercase), throughout
| $ gaiacli send --name {{ .Key.Name }} --to {{ .Destination.AccAddr }} --chain-id=gaia-7000 | ||
| ``` | ||
|
|
||
| You will be asked to review and confirm the transaction on the Ledger. Once you do this you should see the result in the console! Now you can use your Ledger to manage your Atoms and Stake! |
There was a problem hiding this comment.
Can we walk the user through confirming the transaction (menu items, which buttons to press) - maybe even including screenshots? 😄
docs/clients/ledger.md
Outdated
| This key will only be accessible while the ledger is plugged in and unlocked. To send some coins with this key, run the following: | ||
|
|
||
| ```bash | ||
| $ gaiacli send --name {{ .Key.Name }} --to {{ .Destination.AccAddr }} --chain-id=gaia-7000 |
There was a problem hiding this comment.
What's with the template syntax - is this autofilled somehow?
There was a problem hiding this comment.
No, just using it to try to show the format of the command. I can change that if you would like.
There was a problem hiding this comment.
we should definitely leverage template more in various places, incl. docs
There was a problem hiding this comment.
Many times docs writers use arbitrary formats for describing variables. A good example of this is our validator getting started documentation. I personally like a format like this because it can make things like this much more clear.
This adds a brief
READMEthat details how to use theledgerapp withgaiacli.