diff --git a/docs/sidebars.js b/docs/sidebars.js index d44d871ce2..e11396a8ba 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -16,6 +16,14 @@ module.exports = { "wallet-guide/ledger-live", ], }, + { + type: "category", + label: "Web Wallets", + items: [ + "wallet-guide/web-wallets", + "wallet-guide/solflare", + ], + }, { type: "category", label: "Command-line Wallets", diff --git a/docs/src/wallet-guide.md b/docs/src/wallet-guide.md index dbc7ab22dd..33af87fe50 100644 --- a/docs/src/wallet-guide.md +++ b/docs/src/wallet-guide.md @@ -53,8 +53,9 @@ Solana 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](wallet-guide/apps.md), which will provide a more familiar user -experience rather than needing to learn command line tools. +[app wallets](wallet-guide/apps.md) or a browser-based +[web wallet](wallet-guide/web-wallets.md), which will provide a more familiar +user experience rather than needing to learn command line tools. For advanced users or developers, the [command-line wallets](wallet-guide/cli.md) may be more appropriate, as new features on the Solana blockchain will always be diff --git a/docs/src/wallet-guide/ledger-live.md b/docs/src/wallet-guide/ledger-live.md index 321d58dddc..2f368302bd 100644 --- a/docs/src/wallet-guide/ledger-live.md +++ b/docs/src/wallet-guide/ledger-live.md @@ -6,14 +6,9 @@ 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](hardware-wallets/ledger.md). +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) ## Set up a Ledger Nano S @@ -66,11 +61,20 @@ of the Solana App, please upgrade to version v0.2.2 by following these steps. ![Upgrade complete](/img/ledger-live-latest-version-installed.png) -## Interact with Solana network +## Interact with the 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](hardware-wallets/ledger.md). +Users can use any of the following options to sign and submit transactions with +the Ledger Nano S to interact with the Solana network: + +- [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). + +- Developers and advanced users may +[use a Ledger Nano S 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. ## Support diff --git a/docs/src/wallet-guide/solflare.md b/docs/src/wallet-guide/solflare.md new file mode 100644 index 0000000000..bb43652be7 --- /dev/null +++ b/docs/src/wallet-guide/solflare.md @@ -0,0 +1,185 @@ +--- +title: SolFlare Web Wallet +--- + +## Introduction + +[SolFlare.com](https://solflare.com/) is a community-created web wallet built +specifically for Solana. +SolFlare supports sending and receiving native SOL tokens as well as sending and +receiving SPL Tokens (Solana's ERC-20 equivalent). +SolFlare also supports staking of SOL tokens. + +As a _non-custodial_ wallet, your private keys are not stored by the SolFlare +site itself, but rather they are stored in an encrypted +[Keystore File](#using-a-keystore-file) or on a +[Ledger Nano S hardware wallet](#using-a-ledger-nano-s-hardware-wallet). + +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. + +## Getting Started + +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 +Chrome and Brave are supported when interacting with a Ledger Nano S. + +### Using a Keystore File + +#### Create a new Keystore File +To create a wallet with a Keystore file, click on "Create a Wallet" and select +"Using Keystore File". Follow the prompts to create a password which will be +used to encrypt your Keystore file, and then to download the new file to your +computer. You will be prompted to then upload the Keystore file back to the site +to verify that the download was saved correctly. + +**NOTE: If you lose your Keystore file or the password used to encrypt it, any +funds in that wallet will be lost permanently. Neither the Solana team nor the +SolFlare developers can help you recover lost keys.** + +You may want to consider saving a backup copy of your Keystore file on an +external drive separate from your main computer, and storing your password in a +separate location. + +#### Access your wallet with a Keystore File +To use SolFlare with a previously created Keystore file, click on +"Access a Wallet" and select "Using Keystore File". If you just created a new +Keystore file, you will be taken to the Access page directly. +You will be prompted to enter the password and upload your Keystore file, +then you will be taken to the wallet interface main page. + +### Using a Ledger Nano S hardware wallet + +#### Initial Device Setup +To use a Ledger Nano S with SolFlare, first ensure you have +[set up your Nano S](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) +on your device. + +#### Select a Ledger address to access +Plug in your Nano S and open the Solana app. Acknowledge a message of "Pending +Ledger Review" by tapping both buttons at once so the device screen displays +"Application is Ready". + +From the SolFlare home page, click "Access a Wallet" then select "Using Ledger +Nano S". Under "Select derivation path", select the only option: + +```Solana - 44`/501`/``` + +Note: Your browser may prompt you to ask if SolFlare may communicate with your +Ledger device. Click to allow this. + +Select an address to interact with from the lower drop down box then click "Access". + +The Ledger device can derive a large number of private keys and associated +public addresses. This allows you to manage and interact with an arbitrary +number of different accounts from the same device. + +If you deposit funds to an address derived from your Ledger device, +make sure to access the same address when using SolFlare to be able to access +those funds. If you connect to the incorrect address, +simply click Logout and re-connect with the correct address. + +## Select a Network + +Solana maintains [three distinct networks](../clusters.md), each of which has +its own purpose in supporting the Solana ecosystem. Mainnet Beta is selected by +default on SolFlare, as this is the permanent network where exchanges and other +production apps are deployed. To select a different network, click on the name +of the currently selected network at the top of the wallet dashboard, either +Mainnet, Testnet or Devnet, then click on the name of the network you wish to be +using. + +## Sending and Receiving SOL Tokens + +### Receiving +To receive tokens into your wallet, someone must transfer some to your wallet's +address. The address is displayed at the top-left on the screen, and you can +click the Copy icon to copy the address and provide it to whoever is sending you +tokens. If you hold tokens in a different wallet or on an exchange, you can +withdraw to this address as well. Once the transfer is made, the balance shown +on SolFlare should update within a few seconds. + +### Sending +Once you have some tokens at your wallet address, you can send them to any other +wallet address or an exchange deposit address by clicking "Transfer SOL" in the +upper-right corner. Enter the recipient address and the amount of SOL to +transfer and click "Submit". You will be prompted to confirm the details of the +transaction before you [use your key to sign the transaction](#signing-a-transaction) +and then it will be submitted to the network. + +## Staking SOL Tokens +SolFlare supports creating and managing stake accounts and delegations. To learn +about how staking on Solana works in general, check out our +[Staking Guide](../staking.md). + +### Create a Stake Account +You can use some of the SOL tokens in your wallet to create a new stake account. +From the wallet main page click "Staking" at the top of the page. In the upper- +right, click "Create Account". Enter the amount of SOL you want to use to +fund your new stake account. This amount will be withdrawn from your wallet +and transfered to the stake account. Do not transfer your entire wallet balance +to a stake account, as the wallet is still used to pay any transaction fees +associated with your stake account. Consider leaving at least 1 SOL in your +wallet account. + +After you submit and [sign the transaction](#signing-a-transaction) you will see +your new stake account appear in the box labeled "Your Staking Accounts". + +Stake accounts created on SolFlare set your wallet address as the +[staking and withdrawing authority](../staking/stake-accounts.md#understanding-account-authorities) +for your new account, which gives your wallet's key the authority to sign +for any transactions related to the new stake account. + +### View your Stake Accounts +On the main Wallet dashboard page or on the Staking dashboard page, your stake +accounts will be visible in the "Your Staking Accounts" box. Stake accounts +exist at a different address from your wallet. + +SolFlare will locate any display all stake accounts on the +[selected network](#select-a-network) +for which your wallet address is assigned as the +[stake authority](../staking/stake-accounts.md#understanding-account-authorities). +Stake accounts that were created outside of SolFlare will also be displayed and +can be managed as long as the wallet you logged in with is assigned as the stake +authority. + +### Delegate tokens in a Stake Account +Once you have [selected a validator](../staking.md#select-a-validator), you may +delegate the tokens in one of your stake accounts to them. From the Staking +dashboard, click "Delegate" at the right side of a displayed stake account. +Select the validator you wish to delegate to from the drop down list and click +Delegate. + +To un-delegate your staked tokens (also called deactivating your stake), the +process is similar. On the Staking page, at the right side of a delegated stake +account, click the "Undelegate" button and follow the prompts. + +### Split a Stake Account +You may split an existing stake account into two stake accounts. Click on the +address of a stake account controlled by your wallet, and under the Actions bar, +click "Split". Specify the amount of SOL tokens you want to split. This will be +the amount of tokens in your new stake account and your existing stake account +balance will be reduced by the same amount. Splitting your stake account +allows you to delegate to multiple different validators with different amounts +of tokens. You may split a stake account as many times as you want, to create +as many stake accounts as you want. + +## Signing a Transaction +Any time you submit a transaction such as sending tokens to another wallet or +delegating stake, you need to use your private key to sign the transaction so +it will be accepted by the network. + +### Using a Keystore File +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. + +### Using a Ledger Nano S +If you accessed your wallet with a Ledger Nano S, you will be prompted to confirm +the pending transaction details on your device whenever the key is needed to sign. +On the Nano S, use the left and right buttons to view and confirm all of the +transaction details. If everything looks correct, keep clicking the right button +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 +"Reject" and press both buttons to reject the transaction. After you approve +or reject a transaction, you will see this reflected on the SolFlare page. diff --git a/docs/src/wallet-guide/web-wallets.md b/docs/src/wallet-guide/web-wallets.md new file mode 100644 index 0000000000..fb00815190 --- /dev/null +++ b/docs/src/wallet-guide/web-wallets.md @@ -0,0 +1,10 @@ +--- +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).