From 448887a469a9b50ccf05c0f092d8c5aee6df5ff1 Mon Sep 17 00:00:00 2001 From: Dan Albert Date: Thu, 8 Oct 2020 15:51:24 -0600 Subject: [PATCH] Fixup wallet docs, manual cherrypick for backport (#12738) Co-authored-by: publish-docs.sh --- docs/sidebars.js | 22 ++-- docs/src/wallet-guide/apps.md | 31 ++--- docs/src/wallet-guide/hardware-wallets.md | 2 +- .../wallet-guide/hardware-wallets/ledger.md | 57 +-------- docs/src/wallet-guide/ledger-live.md | 86 ++++++------- docs/src/wallet-guide/trust-wallet.md | 119 ------------------ docs/src/wallet-guide/web-wallets.md | 22 +++- 7 files changed, 81 insertions(+), 258 deletions(-) delete mode 100644 docs/src/wallet-guide/trust-wallet.md diff --git a/docs/sidebars.js b/docs/sidebars.js index e11396a8ba..3d77ed15ff 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -7,15 +7,7 @@ module.exports = { ], "Wallets": [ "wallet-guide", - { - type: "category", - label: "App Wallets", - items: [ - "wallet-guide/apps", - "wallet-guide/trust-wallet", - "wallet-guide/ledger-live", - ], - }, + "wallet-guide/apps", { type: "category", label: "Web Wallets", @@ -24,6 +16,13 @@ module.exports = { "wallet-guide/solflare", ], }, + { + type: "category", + label: "Hardware Wallets", + items: [ + "wallet-guide/ledger-live", + ], + }, { type: "category", label: "Command-line Wallets", @@ -33,7 +32,10 @@ module.exports = { { type: "category", label: "Hardware Wallets", - items: ["wallet-guide/hardware-wallets", "wallet-guide/hardware-wallets/ledger"], + items: [ + "wallet-guide/hardware-wallets", + "wallet-guide/hardware-wallets/ledger", + ], }, "wallet-guide/file-system-wallet", ], diff --git a/docs/src/wallet-guide/apps.md b/docs/src/wallet-guide/apps.md index b95c85e664..2f9a0b7199 100644 --- a/docs/src/wallet-guide/apps.md +++ b/docs/src/wallet-guide/apps.md @@ -1,15 +1,13 @@ --- -title: App Wallets +title: Mobile App Wallets --- -Solana supports multiple third-party apps which should provide a familiar +Solana is supported by multiple third-party apps which should provide a familiar experience for most people who are new or experienced with using crypto wallets. ## Trust Wallet -[Trust Wallet](https://trustwallet.com/) is an app for iOS and Android. This is -currently the easiest and fastest way to get set up with a new wallet to send -and receive SOL tokens on the Solana network. -The app is free and getting your wallet set up only takes a few minutes. +[Trust Wallet](https://trustwallet.com/) is an app available for iOS and Android +and can be used to send and receive SOL tokens. *Note: Trust Wallet does not support stake accounts or staking operations* @@ -33,21 +31,8 @@ viewed at any later time in the app by following these steps: - Go to Setting -> Wallets - Under the Options menu for a particular wallet tap "Show Recovery Phrase" -[Trust Wallet](trust-wallet.md) +## Coin98 +[Coin98](https://coin98.app/) is an app available for iOS and Android and can +be used to send and receive SOL tokens. -## Ledger Live with Ledger Nano S - -[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 -crypto accounts on a Ledger _hardware wallet_, which must be purchased -separately and connected to the device running Ledger Live. - -[Ledger Nano S](https://shop.ledger.com/products/ledger-nano-s) is a -hardware wallet which stores the wallet's private keys on a secure device that -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 -keep track of the hardware device. - -Solana does not support the Ledger Nano **X** at this time. - -[Ledger Live](ledger-live.md) +*Note: Coin98 does not support stake accounts or staking operations* diff --git a/docs/src/wallet-guide/hardware-wallets.md b/docs/src/wallet-guide/hardware-wallets.md index b6652fde5c..826126c46b 100644 --- a/docs/src/wallet-guide/hardware-wallets.md +++ b/docs/src/wallet-guide/hardware-wallets.md @@ -1,5 +1,5 @@ --- -title: Hardware Wallets +title: Using Hardware Wallets on the Solana CLI --- Signing a transaction requires a private key, but storing a private diff --git a/docs/src/wallet-guide/hardware-wallets/ledger.md b/docs/src/wallet-guide/hardware-wallets/ledger.md index 7ba96e311f..a21a2e2659 100644 --- a/docs/src/wallet-guide/hardware-wallets/ledger.md +++ b/docs/src/wallet-guide/hardware-wallets/ledger.md @@ -1,5 +1,5 @@ --- -title: Ledger Hardware Wallet +title: Ledger Nano --- The Ledger Nano S hardware wallet offers secure storage of your Solana private @@ -181,61 +181,6 @@ Use the output from the `resolve-signer` command anywhere a `solana` command expects a `` entry to use that resolved path as the signer for that part of the given transaction. -### Install the Solana Beta App - -You're invited to help us test the latest pre-release version of our Ledger app -on one of the public testnets. - -You can use the command-line to install the latest Solana Ledger app release -before it has been validated by -the Ledger team and made available via Ledger Live. Note that because the app -is not installed via Ledger Live, you will need to approve installation from an -"unsafe" manager, as well as see the message, "This app is not genuine" each -time you open the app. Once the app is available on Ledger Live, you can -reinstall the app from there, and the message will no longer be displayed. - -**WARNING:** Installing an unsigned Ledger app reduces the security of your -Ledger device. -If your client is compromised, an attacker will be able to trick you into -signing arbitrary transactions with arbitrary derivation paths. -Only use this installation method if you understand -the security implications. We strongly recommend that you use a separate -Ledger device, with no other wallets/apps sharing the same seed phrase. - -1. Connect your Ledger device via USB and enter your pin to unlock it -2. Download and run the Solana Ledger app installer: - ```text - curl -sSLf https://github.com/solana-labs/ledger-app-solana/releases/download/v0.2.1/install.sh | sh - ``` -3. When prompted, approve the "unsafe" manager on your device -4. When prompted, approve the installation on your device -5. An installation window appears and your device will display "Processing..." -6. The app installation is confirmed - -#### Installing the Solana Beta App returns an error - -If you encounter the following error: - -```text -Traceback (most recent call last): - File "/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.7/lib/python3.7/runpy.py", line 193, in _run_module_as_main - "__main__", mod_spec) - File "/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.7/lib/python3.7/runpy.py", line 85, in _run_code - exec(code, run_globals) - File "ledger-env/lib/python3.7/site-packages/ledgerblue/loadApp.py", line 197, in - dongle = getDongle(args.apdu) - File "ledger-env/lib/python3.7/site-packages/ledgerblue/comm.py", line 216, in getDongle - dev.open_path(hidDevicePath) - File "hid.pyx", line 72, in hid.device.open_path -OSError: open failed -``` - -To fix, check the following: - -1. Ensure your Ledger device is connected to USB -2. Ensure your Ledger device is unlocked and not waiting for you to enter your pin -3. Ensure the Ledger Live application is not open - ## Troubleshooting ### Keypair URL parameters are ignored in zsh diff --git a/docs/src/wallet-guide/ledger-live.md b/docs/src/wallet-guide/ledger-live.md index 2f368302bd..ad39c9e3f0 100644 --- a/docs/src/wallet-guide/ledger-live.md +++ b/docs/src/wallet-guide/ledger-live.md @@ -1,81 +1,77 @@ --- -title: Ledger Live and Ledger Nano S +title: Ledger Nano S and Nano X --- 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. 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 -[use the Nano S to interact with the Solana Network](#interact-with-the-solana-network) +on your Nano device, users have several options of how to +[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, 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 [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 +## Install the Solana App on your Nano - Open Ledger Live -- Currently Ledger Live needs to be in "Developer Mode" - (Settings > Experimental Features > Developer Mode) to see our app. - -![Enabling Developer Mode](/img/ledger-live-enable-developer-mode.png) - -- Go to Manager in the app and find "Solana" in the App Catalog and - click Install +- Click on "Manager" in the left pane on the app and search for "Solana" in the +App Catalog, then click "Install". - 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 -![Installed Solana App in Manager](/img/ledger-live-latest-version-installed.png) - ## Upgrade to the latest version of the Solana App 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 - device -- Open Ledger Live and click on "Manager" in the left pane -- On your Nano S, click both buttons when prompted to "Allow Manager" -- Click the "Update All" button to update the Solana app to the latest version - (v.0.2.2) - -![Upgrade All button in Manager](/img/ledger-live-update-available-v0.2.2.png) - -- Once the upgrade is finished, confirm v0.2.2 is installed under "Apps Installed" - -![Upgrade complete](/img/ledger-live-latest-version-installed.png) +- Make sure you have Ledger Live version 2.10.0 or later. + - To check your version of Ledger Live, click on the Settings button in the + upper-right corner, then click "About". If a newer version of Ledger Live is + available, you should see a banner prompting you to upgrade when you first open + Ledger Live. +- Update the firmware on your Nano + - [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) +- After a successful firmware update, the Solana app should automatically get +re-installed with the latest version of the app. ## Interact with the Solana network -Users can use any of the following options to sign and submit transactions with -the Ledger Nano S to interact with the Solana network: +Users can use any of the following options to use their Nano to interact with +Solana: - [SolFlare.com](https://solflare.com/) is a non-custodial web wallet built specifically for Solana and supports basic transfers and staking operations 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 -[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 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 Check out our [Wallet Support Page](support.md) for ways to get help. diff --git a/docs/src/wallet-guide/trust-wallet.md b/docs/src/wallet-guide/trust-wallet.md deleted file mode 100644 index 91a3e723e7..0000000000 --- a/docs/src/wallet-guide/trust-wallet.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Trust Wallet ---- - -Trust Wallet is an app for your smartphone or tablet and is the fastest and -simplest way for most users to get started with a Solana wallet to send and -receive tokens. - -## Install Trust Wallet - -#### iOS - -- Open the App Store -- Download “Trust: Crypto & Bitcoin Wallet” from Six Days LLC - - Requires iOS 13.0 or higher -- Open Trust Wallet and follow the app prompts to get started - -#### Android - -- Open the Play Store -- Download “Trust Crypto Wallet” from Six Days LLC - - Requires Android 6.0 or higher -- Open Trust Wallet and follow the app prompts to get started - -## Add Solana (SOL) tokens to your wallet - -- From the main page, go to the “Tokens” tab at the top of the screen -- Tap the “+” icon at the top right corner -- Search for “Solana” in the search page, and when the “Solana SOL” token is - shown, slide the slider to enable this token. -- You can now tap the Solana icon to access your Solana wallet. - -[Trust Wallet Official Docs: How to Add or Remove a Coin](https://community.trustwallet.com/t/how-to-add-or-remove-a-coin/896) - -## Receiving SOL tokens - -- To receive SOL tokens that you’ve purchased or earned, you need to send your - Receive Address to whoever is sending you tokens. -- Tap “Receive” to view a QR code and your text address, which is a long string - of letters and numbers. -- Tap “Copy” or “Share” to send the address. -- Be very careful when you copy and paste your receive address anywhere that - you do not miss any characters at the beginning or end of the string. -- If you send an incorrect Receive address to someone and they send tokens - to that address, **those tokens will be lost forever**. - -[Trust Wallet Official Docs: How to Find my Receiving Address](https://community.trustwallet.com/t/how-to-find-my-receiving-address/2006) - -## Sending SOL tokens - -You can send SOL from your Trust Wallet to any other valid address on the Solana -network. Once you know the other party's receiving address, -go to the main page of the wallet from which you want to send some SOL tokens: - -- Tap the "Solana" icon. -- Tap "Send" -- Under "Recipient Address": - - If you already have the receiving address you are going to send to, - tap "Paste" - - If you are transferring to another Trust Wallet user, you can use the app's - QR code reader by tapping the square icon to the right of the "Paste" button. -- Under "Amount", enter the amount of SOL you want to send, or tap "Max" - to send **all** of the SOL in your wallet to the new address -- Tap "Next" to view a summary/confirmation page to review before submitting - the transaction - - The real-time network transaction fee will be shown. This fee will be - paid by the sending account in addition to the full amount transferred. - - If you chose to send all your tokens to the new address by selecting - "Max" under amount, the amount sent to the recipient will be the account - balance _minus_ the current network transaction fee. - - **Make sure you entered the "To" address correctly and that it matches your - desired wallet's receiving address!** -- Tap "Send" to submit the transaction. The transaction will show as "Pending" - for a few seconds, and then will show as "Sent". - -[Trust Wallet Official Docs: Sending Cryptocurrencies](https://community.trustwallet.com/t/sending-cryptocurrencies/65) - -## Using Multiple Wallet Addresses - -Trust Wallet allows you to create multiple wallets, each of which is -secured by a different set of random seed words. If you want to use more than -one Solana address, follow these steps. - -#### Create an additional wallet - -- In the main page of the Trust Wallet App, tap "Settings" in the bottom-right - corner. -- Tap "Wallets" -- Tap "+" to create a new Wallet -- Follow the steps above to add SOL tokens to your new wallet - -_Note: In the "Wallets" page under "Settings" you can re-name each of your wallets. -Consider giving each a descriptive name if you are planning to use your wallets -for different purposes, so you don't mistake one for the other._ - -#### Transferring SOL between your wallets - -Just like you can transfer SOL to another party, you can transfer SOL between -wallets that you own. - -- Copy the receive address of your **newly created** wallet. - - Make sure your **new** wallet is selected by going to - "Settings" --> "Wallets", then tap on the name of your new wallet. - - Tap the "Solana" icon. - - Tap "Receive" then tap "Copy". -- Select your previous/original wallet which already has some SOL by going to - "Settings" --> "Wallets", then tap on the name of your **original** wallet. - - Now follow the same process for [sending SOL tokens](#sending-sol-tokens) - using your **new** wallet's receiving address as the address in the "To" - field when you make the transfer. - -## Troubleshooting - -If you are having trouble setting up your Trust Wallet app, check out their -[Community Help Center](https://community.trustwallet.com/c/helpcenter) - -## Support - -Check out our [Wallet Support Page](support.md) for ways to get help. diff --git a/docs/src/wallet-guide/web-wallets.md b/docs/src/wallet-guide/web-wallets.md index fb00815190..51bed751b9 100644 --- a/docs/src/wallet-guide/web-wallets.md +++ b/docs/src/wallet-guide/web-wallets.md @@ -2,9 +2,23 @@ title: Web Wallets --- -Solana is supported by the following web wallets. - ## SolFlare [SolFlare.com](https://solflare.com/) is a community-created non-custodial -web wallet that was built specifically for Solana. Check out our guide for -[using SolFlare](solflare.md). +web wallet that was built specifically for Solana. SolFlare supports the creation +and management of stake accounts, and gives users the ability to send and receive +any SPL Token. + +Check out our [guide for using SolFlare](solflare.md). + +## Sollet +[sollet.io](https://www.sollet.io/) is a non-custodial web wallet created by the +[Project Serum](https://projectserum.com/) team. sollet.io can be used to send +and receive SOL and any SPL Token. + +## MathWallet + +[MathWallet](https://mathwallet.org/) supports wallet +addresses for sending and receiving SOL and SPL Tokens through its +browser extension and web wallet interface. + +*Note: The MathWallet iOS and Android app do not yet support SOL and SPL Tokens*