diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 29a0dac501..1156b5d12b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -3,6 +3,8 @@ * [Introduction](introduction.md) * [Wallet Guide](wallet/README.md) * [App Wallets](wallet/app-wallets.md) + * [Trust Wallet](wallet/trust-wallet.md) + * [Ledger Live](wallet/ledger-live.md) * [Command-line Wallets](wallet/cli-wallets.md) * [Hardware Wallets](remote-wallet/README.md) * [Ledger Hardware Wallet](remote-wallet/ledger.md) diff --git a/docs/src/cli/README.md b/docs/src/cli/README.md index 7985c13d44..1423aa66c9 100644 --- a/docs/src/cli/README.md +++ b/docs/src/cli/README.md @@ -1,7 +1,9 @@ # Command-line Guide -In this section, we will describe how to create a Solana *wallet*, how to send -and receive tokens, and how to participate in the cluster by delegating stake. +In this section, we will describe how to use the Solana command-line tools to +create a *wallet*, to send and receive SOL tokens, and to participate in +the cluster by delegating stake. + To interact with a Solana cluster, we will use its command-line interface, also known as the CLI. We use the command-line because it is the first place the Solana core team deploys new functionality. The command-line interface is not diff --git a/docs/src/wallet/README.md b/docs/src/wallet/README.md index 81bef4b603..1ee48c5fb6 100644 --- a/docs/src/wallet/README.md +++ b/docs/src/wallet/README.md @@ -1,4 +1,61 @@ -# Solana Wallet +# Solana Wallet Guide This document describes the different wallet options that are available to users of Solana who want to be able to send, receive and interact with SOL tokens on the Solana blockchain. + +## What is a Wallet? +A crypto wallet is a device or application that stores a collection of keys and +can be used to send, receive, +and track ownership of cryptocurrencies. Wallets can take many forms. +A wallet might be a directory or file in your computer's file system, +a piece of paper, or a specialized device called a *hardware wallet*. +There are also various smartphone apps and computer programs +that provide a user-friendly way to create and manage wallets. + +A *keypair* is a securely generated *private key* and its +cryptographically-derived *public key*. A private key and its corresponding +public key are together known as a *keypair*. +A wallet contains a collection of one or more keypairs and provides some means +to interact with them. + +The *public key* (commonly shortened to *pubkey*) is known as the wallet's +*receiving address* or simply its *address*. The wallet address **may be shared +and displayed freely**. When another party is going to send some amount of +cryptocurrency to a wallet, they need to know the wallet's receiving address. +Depending on a blockchain's implementation, the address can also be used to view +certain information about a wallet, such as viewing the balance, +but has no ability to change anything about the wallet or withdraw any tokens. + +The *private key* is required to digitally sign any transactions to send +cryptocurrencies to another address or to make any changes to the wallet. +The private key **must never be shared**. If someone gains access to the +private key to a wallet, they can withdraw all the tokens it contains. +If the private key for a wallet is lost, any tokens that have been sent +to that wallet's address are **permanently lost**. + +Different wallet solutions offer different approaches to keypair security and +interacting with the keypair and sign transactions to use/spend the tokens. +Some are easier to use than others. +Some store and back up private keys more securely. +Solana supports multiple types of wallets so you can choose the right balance +of security and convenience. + +**If you want to be able to receive SOL tokens on the Solana blockchain, +you first will need to create a wallet.** + +## Supported Wallets +Solana supports supports several types of wallets in the Solana native +command-line app as well as wallets from third-parties. + +For the majority of users, we recommend using one of the +[app wallets](app-wallets.md), which will provide a more familiar user +experience rather than needing to learn command line tools. + +{% page-ref page="app-wallets.md" %} + +For advanced users or developers, the [command-line wallets](cli-wallets.md) +may be more appropriate, as new features on the Solana blockchain will always be +supported on the command line first before being integrated into third-party +solutions. + +{% page-ref page="cli-wallets.md" %} \ No newline at end of file diff --git a/docs/src/wallet/app-wallets.md b/docs/src/wallet/app-wallets.md index c30346c167..0337e7be13 100644 --- a/docs/src/wallet/app-wallets.md +++ b/docs/src/wallet/app-wallets.md @@ -1 +1,26 @@ -Documentation of supported for App Wallets coming soon! \ No newline at end of file +# App Wallets +Solana supports 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 on Solana. +The app is free and getting your wallet set up only takes a few minutes. + +{% page-ref page="trust-wallet.md" %} + +## 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. + +{% page-ref page="ledger-live.md" %} \ No newline at end of file diff --git a/docs/src/wallet/cli-wallets.md b/docs/src/wallet/cli-wallets.md index 10986f894f..202f055e03 100644 --- a/docs/src/wallet/cli-wallets.md +++ b/docs/src/wallet/cli-wallets.md @@ -5,7 +5,7 @@ directly with the Solana command-line tools. **If you are unfamiliar with using command line programs and just want to be able to send and receive SOL tokens, we recommend setting up a third-party -[Web Wallet](app-wallets.md)**. +[App Wallet](app-wallets.md)**. To use a Command Line Wallet, you must first [install the Solana CLI tools](../cli/install-solana-cli-tools.md) @@ -41,9 +41,11 @@ side of the spectrum from an FS wallet. It is terribly inconvenient to use, but offers excellent security. That high security is further amplified when paper wallets are used in conjunction with [offline signing](../offline-signing/index.md). Custody services such as -[Coinbase Custody](https://custody.coinbase.com/) use this combination. Paper wallets -and custody services are an excellent way to secure a large number of tokens -for a long period of time. +[Coinbase Custody](https://custody.coinbase.com/) use this combination. +Paper wallets and custody services are an excellent way to secure a large number +of tokens for a long period of time. + +{% page-ref page="../paper-wallet/README.md" %} ## Hardware Wallet @@ -58,10 +60,4 @@ security and convenience for cryptocurrencies. It effectively automates the process of offline signing while retaining nearly all the convenience of an FS wallet. -## Which Wallet is Best? - -Different people will have different needs, but if you are still unsure what -is best for you after reading the comparisons above, go with a -[Ledger Nano S](https://shop.ledger.com/products/ledger-nano-s). The -[Nano S is well-integrated into Solana's tool suite](../remote-wallet/ledger.md) -and offers an outstanding blend of security and convenience. +{% page-ref page="../remote-wallet/README.md" %} diff --git a/docs/src/wallet/ledger-live.md b/docs/src/wallet/ledger-live.md new file mode 100644 index 0000000000..51e2eacfbc --- /dev/null +++ b/docs/src/wallet/ledger-live.md @@ -0,0 +1,42 @@ +#Ledger Live and Ledger Nano S +This document describes how to set up a +[Ledger Nano S hardware wallet](https://shop.ledger.com/products/ledger-nano-s) +with the [Ledger Live](https://www.ledger.com/ledger-live) software. + +**NOTE: While Solana tools are fully integrated with the Ledger Nano S device, +and the Solana App can be installed on the Nano S using Ledger Live, adding and +managing wallet accounts currently requires use of our command-line tools. +Integration with Ledger Live to use Solana wallet accounts on Ledger Live +will be available in the future.** + +Users may [use a Ledger Nano S with the Solana command +line tools](../remote-wallet/ledger.md). + +##Set up a Ledger Nano S + - Order a [Nano S from Ledger](https://shop.ledger.com/products/ledger-nano-s) + - Follow the instructions for device setup included in the package, + or [Ledger's Start page](https://www.ledger.com/start/) + +##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 + - Open Ledger Live + - Currently Ledger Live needs to be in "Developer Mode" + (Settings > Experimental Features > Developer Mode) to see our app. + - Go to Manager in the app and find "Solana" in the App Catalog and + 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 + - "Solana" should now show as "Installed" in the Ledger Live Manager + +##Interact with Solana network +- To interact with your Ledger wallet on our live network, please see our +instructions on how to [use a Ledger Nano S with the Solana command +line tools](../remote-wallet/ledger.md). diff --git a/docs/src/wallet/trust-wallet.md b/docs/src/wallet/trust-wallet.md new file mode 100644 index 0000000000..235597c6a5 --- /dev/null +++ b/docs/src/wallet/trust-wallet.md @@ -0,0 +1,37 @@ +#Trust Wallet + +**NOTE: Trust Wallet currently only supports Solana on the iOS version of its +app. Support for Android is coming very very soon!** + +##Set Up Trust Wallet + - Open the App Store or Play Store + - Download “Trust: Crypto & Bitcoin Wallet” from Six Days LLC + - Requires iOS 13.0 or higher + - 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) + +##Troubleshooting +If you are having trouble setting up your Trust Wallet app, check out their + [Community Help Center](https://community.trustwallet.com/c/helpcenter)