Ledger + Lunie guide docs (#208)

* improve lunie guide with screenshots

* Apply suggestions from code review

Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* code review
This commit is contained in:
gamarin2
2019-12-09 13:17:09 +01:00
committed by Federico Kunze
parent e88b0c17be
commit 83787aa28d
8 changed files with 52 additions and 29 deletions

View File

@@ -1,5 +1,5 @@
# Cosmos Hub
![banner](./docs/cosmos-hub-image.jpg)
![banner](./docs/images/cosmos-hub-image.jpg)
[![CircleCI](https://circleci.com/gh/cosmos/gaia/tree/master.svg?style=shield)](https://circleci.com/gh/cosmos/gaia/tree/master)
[![codecov](https://codecov.io/gh/cosmos/gaia/branch/master/graph/badge.svg)](https://codecov.io/gh/cosmos/gaia)

View File

Before

Width:  |  Height:  |  Size: 359 KiB

After

Width:  |  Height:  |  Size: 359 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 317 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 230 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 208 KiB

BIN
docs/ledger-tuto-search.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 207 KiB

View File

@@ -8,13 +8,61 @@ At the core of a Ledger device there is a mnemonic seed phrase that is used to g
Do not lose or share your 24 words with anyone. To prevent theft or loss of funds, it is best to keep multiple copies of your mnemonic stored in safe, secure places. If someone is able to gain access to your mnemonic, they will fully control the accounts associated with them.
:::
## Install the Cosmos Ledger application
Installing the `Cosmos` application on your ledger device is required before you can use either [Lunie](#lunie-io-+-ledger-nano) or [`gaiacli`](gaia-cli-+-ledger-nano). To do so, you need to:
1. Install [Ledger Live](https://shop.ledger.com/pages/ledger-live) on your machine.
2. Using Ledger Live, [update your Ledger Nano S with the latest firmware](https://support.ledger.com/hc/en-us/articles/360002731113-Update-device-firmware).
3. On the Ledger Live application, navigate to the `Manager` menu .
![manager](./ledger-tuto-manager.png)
4. Connect your Ledger Nano device and allow Ledger Manager from it.
5. On the Ledger Live application, Search for `Cosmos`.
![search](./ledger-tuto-search.png)
6. Install the Cosmos application by clicking on `Install`.
::: tip
To see the `Cosmos` application when you search for it, you might need to activate the `Developer Mode`, located in the Experimental features tab of the Ledger Live application.
:::
![Devmode](./ledger-tuto-dev-mode.png)
## Lunie.io + Ledger Nano
**Note: You need to [install the Cosmos app](#install-the-cosmos-ledger-application) on your Ledger Nano before using following this section**
1. Connect your Ledger device to your computer, unlock it with the PIN and open the Cosmos app.
2. Open [https://app.lunie.io](https://app.lunie.io/existing) in your web browser (latest version of [Brave](https://brave.com/) preferred).
3. Choose `Sign in with Ledger Nano S`.
![lunie-option](./ledger-tuto-lunie-option.png)
4. Make sure your Ledger device is unlocked and with the Cosmos app open and then click on the`Sign in` button.
That's it! You can now use Lunie with your Ledger Nano S. You will find your Cosmos address here:
![lunie-address](./ledger-tuto-lunie-address.png)
**Note: Each time you will send a transaction, you will need to confirm it on your Ledger device. Indication will be prompted from the Lunie interface**
### (Optional) Confirm your address
You can double check that Lunie is displaying the correct address directly on your Ledger Nano device. To do so:
1. Connect your Ledger to your computer and open the Cosmos application on the device.
2. Once the Cosmos app is open, click on the right button to access the `Show Address` option.
3. Click on both button, then select `Account 0` and `Index 0`.
You should now see the same address that is displayed on the Lunie application.
To learn more about using Lunie, [here is a tutorial](https://medium.com/easy2stake/how-to-delegate-re-delegate-un-delegate-cosmos-atoms-with-the-lunie-web-wallet-eb72369e52db) on staking and delegating ATOMs using the Lunie web wallet.
## Gaia CLI + Ledger Nano
**Note: You need to [install the Cosmos app](#install-the-cosmos-ledger-application) on your Ledger Nano before using following this section**
The tool used to generate addresses and transactions on the Cosmos Hub network is `gaiacli`. Here is how to get started. If using a CLI tool is unfamiliar to you, scroll down and follow instructions for using the Lunie.io web wallet instead.
### Before you Begin
- [Install the Cosmos app onto your Ledger](https://github.com/cosmos/ledger-cosmos/blob/master/README.md#installing)
- [Install Golang](https://golang.org/doc/install)
- [Install Gaia](https://cosmos.network/docs/cosmos-hub/installation.html)
@@ -28,7 +76,6 @@ git commit: 67ab0b1e1d1e5b898c8cbdede35ad5196dba01b2
vendor hash: 0341b356ad7168074391ca7507f40b050e667722
build tags: netgo ledger
go version go1.11.5 darwin/amd64
```
### Add your Ledger key
@@ -138,31 +185,7 @@ gaiacli tx --help
```
:::
# Lunie.io
The Lunie web wallet supports signing with Ledger Nano S. Here is a short intro to using your Ledger with [Lunie.io](https://lunie.io).
### Connect your device
- Connect your Ledger device to your computer, unlock it with the PIN and open the Cosmos app.
- Open [https://lunie.io](https://lunie.io) in your web browser (latest version of Google Chrome preferred)
- Click “Sign in”.
- Choose “Sign in with Ledger Nano S”
### Confirm your address
Run this command to display your address on the device. Use the `keyName` you gave your ledger key. The `-d` flag is supported in version `1.5.0` and higher.
```bash
gaiacli keys show <keyName> -d
```
Confirm that the address displayed on your Ledger matches that shown on Lunie.io before proceeding.
Now you can use your Ledger key to sign transctions on Lunie.
To learn more about using Lunie, [here is a tutorial](https://medium.com/easy2stake/how-to-delegate-re-delegate-un-delegate-cosmos-atoms-with-the-lunie-web-wallet-eb72369e52db) on staking and delegating ATOMs using the Lunie web wallet.
# The Cosmos Standard Transaction
## The Cosmos Standard Transaction
Transactions in Cosmos embed the [Standard Transaction type](https://godoc.org/github.com/cosmos/cosmos-sdk/x/auth#StdTx) from the Cosmos SDK. The Ledger device displays a serialized JSON representation of this object for you to review before signing the transaction. Here are the fields and what they mean:
@@ -173,7 +196,7 @@ Transactions in Cosmos embed the [Standard Transaction type](https://godoc.org/g
- `memo`: optional text field used in various ways to tag transactions.
- `msgs_<index>/<field>`: The array of messages included in the transaction. Double click to drill down into nested fields of the JSON.
# Support
## Support
For further support, start by looking over the posts in our [forum](https://forum.cosmos.network/search?q=ledger)