gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update docs to show support for Nano X (#12647)

Browse Source
This commit is contained in:
Dan Albert 2020-10-02 16:45:24 -06:00 committed by GitHub
parent 4ef3fcc976
commit 0ef3cac1f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 79 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/staking.md
View File

@ -66,12 +66,12 @@ description is below.
#### Supported Wallets #### Supported Wallets
Staking operations are supported by the following wallet solutions: Staking operations are supported by the following wallet solutions:
- SolFlare.com in conjunction with a keystore file or a Ledger Nano S. Check - SolFlare.com in conjunction with a keystore file or a Ledger Nano.
out our [guide to using SolFlare](wallet-guide/solflare.md) for details. Check out our [guide to using SolFlare](wallet-guide/solflare.md) for details.
- Solana command line tools can perform all stake operations in conjunction - Solana command line tools can perform all stake operations in conjunction
with a CLI-generated keypair file wallet, a paper wallet, or with a connected with a CLI-generated keypair file wallet, a paper wallet, or with a connected
Ledger Nano S. Ledger Nano.
[Staking commands using the Solana Command Line Tools](cli/delegate-stake.md). [Staking commands using the Solana Command Line Tools](cli/delegate-stake.md).
#### Create a Stake Account #### Create a Stake Account

9
docs/src/wallet-guide/apps.md
View File

@ -35,19 +35,18 @@ viewed at any later time in the app by following these steps:
[Trust Wallet](trust-wallet.md) [Trust Wallet](trust-wallet.md)
## Ledger Live with Ledger Nano S ## Ledger Live with Nano S or Nano X
[Ledger Live](https://www.ledger.com/ledger-live) is available as free desktop [Ledger Live](https://www.ledger.com/ledger-live) is available as free desktop
software and as a free app for iOS and Android. It is used to manage apps and software and as a free app for iOS and Android. It is used to manage apps and
crypto accounts on a Ledger _hardware wallet_, which must be purchased crypto accounts on a Ledger _hardware wallet_, which must be purchased
separately and connected to the device running Ledger Live. separately and connected to the device running Ledger Live.
[Ledger Nano S](https://shop.ledger.com/products/ledger-nano-s) is a [Ledger Nano S](https://shop.ledger.com/products/ledger-nano-s) and the
hardware wallet which stores the wallet's private keys on a secure device that [Ledger Nano X](https://shop.ledger.com/pages/ledger-nano-x) are
hardware wallets which stores the wallet's private keys on a secure device that
is physically separate from the computer, and connects via USB cable. is physically separate from the computer, and connects via USB cable.
This provides an extra level of security but requires the user to purchase and This provides an extra level of security but requires the user to purchase and
keep track of the hardware device. keep track of the hardware device.
Solana does not support the Ledger Nano **X** at this time.
[Ledger Live](ledger-live.md) [Ledger Live](ledger-live.md)

2
docs/src/wallet-guide/hardware-wallets.md
View File

@ -19,7 +19,7 @@ hardware wallet.
The Solana CLI supports the following hardware wallets: The Solana CLI supports the following hardware wallets:
- [Ledger Nano S](hardware-wallets/ledger.md) - [Ledger Nano S and Ledger Nano X](hardware-wallets/ledger.md)
## Specify a Keypair URL ## Specify a Keypair URL

33
docs/src/wallet-guide/hardware-wallets/ledger.md
View File

@ -2,22 +2,21 @@
title: Ledger Hardware Wallet title: Ledger Hardware Wallet
--- ---
The Ledger Nano S hardware wallet offers secure storage of your Solana private This page describes how to use a Ledger Nano S or Nano X to interact with Solana
keys. The Solana Ledger app enables derivation of essentially infinite keys, and using the command line tools. To see other solutions to interact with Solana with
secure transaction signing. your Nano, [click here](../ledger-live.md#interact-with-the-solana-network).
## Before You Begin ## Before You Begin
- [Set up a Ledger Nano S with the Solana App](../ledger-live.md) - [Set up a Nano with the Solana App](../ledger-live.md)
- [Install the Solana command-line tools](../../cli/install-solana-cli-tools.md) - [Install the Solana command-line tools](../../cli/install-solana-cli-tools.md)
## Use Ledger Nano S with Solana CLI ## Use Ledger Nano with Solana CLI
1. Ensure the Ledger Live application is closed 1. Ensure the Ledger Live application is closed
2. Plug your Ledger device into your computer's USB port 2. Plug your Nano into your computer's USB port
3. Enter your pin and start the Solana app on the Ledger device 3. Enter your pin and start the Solana app on the Nano
4. Press both buttons to advance past the "Pending Ledger review" screen 4. Ensure the screen reads "Application is ready"
5. Ensure the screen reads "Application is ready"
### View your Wallet ID ### View your Wallet ID
@ -29,16 +28,16 @@ solana-keygen pubkey usb://ledger
This confirms your Ledger device is connected properly and in the correct state This confirms your Ledger device is connected properly and in the correct state
to interact with the Solana CLI. The command returns your Ledger's unique to interact with the Solana CLI. The command returns your Ledger's unique
_wallet ID_. When you have multiple Nano S devices connected to the same _wallet ID_. When you have multiple Nano devices connected to the same
computer, you can use your wallet ID to specify which Ledger hardware wallet computer, you can use your wallet ID to specify which Ledger hardware wallet
you want to use. If you only plan to use a single Nano S on your computer you want to use. If you only plan to use a single Nano on your computer
at a time, you don't need to include the wallet ID. For information on at a time, you don't need to include the wallet ID. For information on
using the wallet ID to use a specific Ledger, see using the wallet ID to use a specific Ledger, see
[Manage Multiple Hardware Wallets](#manage-multiple-hardware-wallets). [Manage Multiple Hardware Wallets](#manage-multiple-hardware-wallets).
### View your Wallet Addresses ### View your Wallet Addresses
Your Nano S supports an arbitrary number of valid wallet addresses and signers. Your Nano supports an arbitrary number of valid wallet addresses and signers.
To view any address, use the `solana-keygen pubkey` command, as shown below, To view any address, use the `solana-keygen pubkey` command, as shown below,
followed by a valid [keypair URL](../hardware-wallets.md#specify-a-keypair-url). followed by a valid [keypair URL](../hardware-wallets.md#specify-a-keypair-url).
@ -59,7 +58,7 @@ solana-keygen pubkey usb://ledger?key=2
You can use other values for the number after `key=` as well. You can use other values for the number after `key=` as well.
Any of the addresses displayed by these commands are valid Solana wallet Any of the addresses displayed by these commands are valid Solana wallet
addresses. The private portion associated with each address is stored securely addresses. The private portion associated with each address is stored securely
on the Nano S device, and is used to sign transactions from this address. on the Nano, and is used to sign transactions from this address.
Just make a note of which keypair URL you used to derive any address you will be Just make a note of which keypair URL you used to derive any address you will be
using to receive tokens. using to receive tokens.
@ -100,11 +99,11 @@ Ledger, will show as "Not Found" in the explorer. Empty accounts and non-existen
accounts are treated the same in Solana. This will change when your account accounts are treated the same in Solana. This will change when your account
address has some SOL in it. address has some SOL in it.
### Send SOL from a Ledger Nano S ### Send SOL from a Nano
To send some tokens from an address controlled by your Nano S device, you will To send some tokens from an address controlled by your Nano, you will
need to use the device to sign a transaction, using the same keypair URL you need to use the device to sign a transaction, using the same keypair URL you
used to derive the address. To do this, make sure your Nano S is plugged in, used to derive the address. To do this, make sure your Nano is plugged in,
unlocked with the PIN, Ledger Live is not running, and the Solana App is open unlocked with the PIN, Ledger Live is not running, and the Solana App is open
on the device, showing "Application is Ready". on the device, showing "Application is Ready".
@ -160,7 +159,7 @@ choose which wallet to use for each signature.
Instead of using the interactive prompts, you can generate fully qualified Instead of using the interactive prompts, you can generate fully qualified
URLs using the Solana CLI `resolve-signer` command. For example, try URLs using the Solana CLI `resolve-signer` command. For example, try
connecting a Ledger Nano-S to USB, unlock it with your pin, and running the connecting a Nano to USB, unlock it with your pin, and running the
following command: following command:
```text ```text

81
docs/src/wallet-guide/ledger-live.md
View File

@ -1,76 +1,77 @@
--- ---
title: Ledger Live and Ledger Nano S title: Set up a Ledger Nano S or Nano X
--- ---
This document describes how to set up a This document describes how to set up a
[Ledger Nano S hardware wallet](https://shop.ledger.com/products/ledger-nano-s) [Ledger Nano S](https://shop.ledger.com/products/ledger-nano-s) or
[Ledger Nano X](https://shop.ledger.com/pages/ledger-nano-x)
with the [Ledger Live](https://www.ledger.com/ledger-live) software. with the [Ledger Live](https://www.ledger.com/ledger-live) software.
Once the setup steps shown below are complete and the Solana app is installed Once the setup steps shown below are complete and the Solana app is installed
on your Nano S device, users have several options of how to on your Nano device, users have several options of how to
[use the Nano S to interact with the Solana Network](#interact-with-the-solana-network) [use the Nano to interact with the Solana Network](#interact-with-the-solana-network)
## Set up a Ledger Nano S ## Getting Started
- Order a [Nano S from Ledger](https://shop.ledger.com/products/ledger-nano-s) - Order a [Nano S](https://shop.ledger.com/products/ledger-nano-s) or
[Nano X](https://shop.ledger.com/pages/ledger-nano-x) from Ledger.
- Follow the instructions for device setup included in the package, - Follow the instructions for device setup included in the package,
or [Ledger's Start page](https://www.ledger.com/start/) or [Ledger's Start page](https://www.ledger.com/start/)
- [Install the latest device firmware](https://support.ledgerwallet.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware) - Install [Ledger Live desktop software](https://www.ledger.com/ledger-live/)
- If you already have Ledger Live installed, please update to the latest
version of Ledger Live, which enables the newest firmware and app updates.
- Connect your Nano to your computer and follow the on-screen instructions.
- Update the firmware on your new Nano. This is needed to ensure you are able
to install the latest version of the Solana App.
- [Update Nano S Firmware](https://support.ledger.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware)
- [Update Nano X Firmware](https://support.ledger.com/hc/en-us/articles/360013349800)
## Install Ledger Live ## Install the Solana App on your Nano
- Install [Ledger Live desktop software](https://www.ledger.com/ledger-live/),
or
- Install the [Ledger Live app for iOS](https://apps.apple.com/app/id1361671700)
or [Ledger Live for Android](https://play.google.com/store/apps/details?id=com.ledger.live).
- Requires iOS 9.1 or later. Compatible with iPhone, iPad, and iPod touch.
- Requires Android 7.0 or later.
- Connect your Nano S to your device and follow the instructions
## Install the Solana App on your Nano S
- Open Ledger Live - Open Ledger Live
- Go to Manager in the app and find "Solana" in the App Catalog and - Click on "Manager" in the left pane on the app and search for "Solana" in the
click Install App Catalog, then click "Install".
- Make sure your device is plugged in via USB and is unlocked with its PIN - Make sure your device is plugged in via USB and is unlocked with its PIN
- You may be prompted on the Nano S to confirm the install of Solana App - You may be prompted on the Nano to confirm the install of Solana App
- "Solana" should now show as "Installed" in the Ledger Live Manager - "Solana" should now show as "Installed" in the Ledger Live Manager
![Installed Solana App in Manager](/img/ledger-live-latest-version-installed.png)
## Upgrade to the latest version of the Solana App ## Upgrade to the latest version of the Solana App
To make sure you have the latest functionality, if you are using an older version To make sure you have the latest functionality, if you are using an older version
of the Solana App, please upgrade to version v0.2.2 by following these steps. of the Solana App, please upgrade to version `v1.0.1` by following these steps.
- Connect your Nano S to your computer an unlock it by entering your PIN on the - Make sure you have Ledger Live version 2.10.0 or later.
device - To check your version of Ledger Live, click on the Settings button in the
- Open Ledger Live and click on "Manager" in the left pane upper-right corner, then click "About". If a newer version of Ledger Live is
- On your Nano S, click both buttons when prompted to "Allow Manager" available, you should see a banner prompting you to upgrade when you first open
- Click the "Update All" button to update the Solana app to the latest version Ledger Live.
(v.0.2.2) - Update the firmware on your Nano
- [Update Nano S Firmware](https://support.ledger.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware)
![Upgrade All button in Manager](/img/ledger-live-update-available-v0.2.2.png) - [Update Nano X Firmware](https://support.ledger.com/hc/en-us/articles/360013349800)
- After a successful firmware update, the Solana app should automatically get
- Once the upgrade is finished, confirm v0.2.2 is installed under "Apps Installed" re-installed with the latest version of the app.
![Upgrade complete](/img/ledger-live-latest-version-installed.png)
## Interact with the Solana network ## Interact with the Solana network
Users can use any of the following options to sign and submit transactions with Users can use any of the following options to use their Nano to interact with
the Ledger Nano S to interact with the Solana network: Solana:
- [SolFlare.com](https://solflare.com/) is a non-custodial web wallet built - [SolFlare.com](https://solflare.com/) is a non-custodial web wallet built
specifically for Solana and supports basic transfers and staking operations specifically for Solana and supports basic transfers and staking operations
with the Ledger device. with the Ledger device.
Check out our guide for [using a Ledger Nano S with SolFlare](solflare.md). Check out our guide for [using a Nano with SolFlare](solflare.md).
- Developers and advanced users may - Developers and advanced users may
[use a Ledger Nano S with the Solana command line tools](hardware-wallets/ledger.md). [use a Nano with the Solana command line tools](hardware-wallets/ledger.md).
New wallet features are almost always supported in the native command line tools New wallet features are almost always supported in the native command line tools
before being supported by third-party wallets. before being supported by third-party wallets.
## Known Issues
- Nano X sometimes cannot connect to web wallets using the Windows operating
system. This is likely to affect any browser-based wallets that use WebUSB.
The Ledger team is working to resolve this.
## Support ## Support
Check out our [Wallet Support Page](support.md) for ways to get help. Check out our [Wallet Support Page](support.md) for ways to get help.

26
docs/src/wallet-guide/solflare.md
View File

@ -13,7 +13,7 @@ SolFlare also supports staking of SOL tokens.
As a _non-custodial_ wallet, your private keys are not stored by the SolFlare As a _non-custodial_ wallet, your private keys are not stored by the SolFlare
site itself, but rather they are stored in an encrypted site itself, but rather they are stored in an encrypted
[Keystore File](#using-a-keystore-file) or on a [Keystore File](#using-a-keystore-file) or on a
[Ledger Nano S hardware wallet](#using-a-ledger-nano-s-hardware-wallet). [Ledger Nano S or X hardware wallet](#using-a-ledger-nano-hardware-wallet).
This guide describes how to set up a wallet using SolFlare, how to send and This guide describes how to set up a wallet using SolFlare, how to send and
receive SOL tokens, and how to create and manage a stake account. receive SOL tokens, and how to create and manage a stake account.
@ -22,7 +22,7 @@ receive SOL tokens, and how to create and manage a stake account.
Go to https://www.solflare.com in a supported browser. Most popular web browsers Go to https://www.solflare.com in a supported browser. Most popular web browsers
should work when interacting with a Keystore File, but currently only should work when interacting with a Keystore File, but currently only
Chrome and Brave are supported when interacting with a Ledger Nano S. Chrome and Brave are supported when interacting with a Ledger Nano.
### Using a Keystore File ### Using a Keystore File
@ -48,21 +48,23 @@ Keystore file, you will be taken to the Access page directly.
You will be prompted to enter the password and upload your Keystore file, You will be prompted to enter the password and upload your Keystore file,
then you will be taken to the wallet interface main page. then you will be taken to the wallet interface main page.
### Using a Ledger Nano S hardware wallet ### Using a Ledger Nano hardware wallet
*NOTE: Please see [known issues](ledger-live.md#known-issues) for any current
limitations in using the Nano.*
#### Initial Device Setup #### Initial Device Setup
To use a Ledger Nano S with SolFlare, first ensure you have To use a Ledger Nano with SolFlare, first ensure you have
[set up your Nano S](ledger-live.md) and have [installed the latest version of [set up your Nano](ledger-live.md) and have [installed the latest version of
the Solana app](ledger-live.md#upgrade-to-the-latest-version-of-the-solana-app) the Solana app](ledger-live.md#upgrade-to-the-latest-version-of-the-solana-app)
on your device. on your device.
#### Select a Ledger address to access #### Select a Ledger address to access
Plug in your Nano S and open the Solana app. Acknowledge a message of "Pending Plug in your Nano and open the Solana app so the device screen displays
Ledger Review" by tapping both buttons at once so the device screen displays
"Application is Ready". "Application is Ready".
From the SolFlare home page, click "Access a Wallet" then select "Using Ledger From the SolFlare home page, click "Access a Wallet" then select "Using Ledger
Nano S". Under "Select derivation path", select the only option: Nano S | Ledger Nano X". Under "Select derivation path", select the only option:
```Solana - 44`/501`/``` ```Solana - 44`/501`/```
@ -174,10 +176,10 @@ it will be accepted by the network.
If you accessed your wallet using a Keystore file, you will be prompted to enter If you accessed your wallet using a Keystore file, you will be prompted to enter
your password any time the key is needed to sign a transaction. your password any time the key is needed to sign a transaction.
### Using a Ledger Nano S ### Using a Ledger Nano
If you accessed your wallet with a Ledger Nano S, you will be prompted to confirm If you accessed your wallet with a Ledger Nano, you will be prompted to
the pending transaction details on your device whenever the key is needed to sign. confirm the pending transaction details on your device whenever the key is needed
On the Nano S, use the left and right buttons to view and confirm all of the to sign. On the Nano, use the left and right buttons to view and confirm all of the
transaction details. If everything looks correct, keep clicking the right button transaction details. If everything looks correct, keep clicking the right button
until the screen shows "Approve". Click both buttons to approve the transaction. until the screen shows "Approve". Click both buttons to approve the transaction.
If something looks incorrect, press the right button once more so the screen shows If something looks incorrect, press the right button once more so the screen shows