solana-docs 0.0.0

package/src/wallet-guide/ledger-live.md

@@ -0,0 +1,77 @@
+---
+title: Ledger Nano S and Nano X
+---
+
+This document describes how to set up a
+[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 device, users have several options of how to
+[use the Nano to interact with the Solana Network](#interact-with-the-solana-network)
+
+## Getting Started
+
+- 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 [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 the Solana App on your Nano
+
+- Open Ledger Live
+- 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 to confirm the install of Solana App
+- "Solana" should now show as "Installed" in the Ledger Live Manager
+
+## 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 `v1.0.1` by following these steps.
+
+- 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 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 Nano with SolFlare](solflare.md).
+
+- Developers and advanced users may
+  [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.

package/src/wallet-guide/paper-wallet.md

@@ -0,0 +1,203 @@
+---
+title: Paper Wallet
+---
+
+This document describes how to create and use a paper wallet with the Solana CLI
+tools.
+
+> We do not intend to advise on how to _securely_ create or manage paper wallets. Please research the security concerns carefully.
+
+## Overview
+
+Solana provides a key generation tool to derive keys from
+[BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)-compliant
+seed phrases. Solana CLI commands for running a validator and staking tokens all
+support keypair input via seed phrases.
+
+## Paper Wallet Usage
+
+Solana commands can be run without ever saving a keypair to disk on a machine.
+If avoiding writing a private key to disk is a security concern of yours, you've
+come to the right place.
+
+> Even using this secure input method, it's still possible that a private key gets written to disk by unencrypted memory swaps. It is the user's responsibility to protect against this scenario.
+
+## Before You Begin
+
+- [Install the Solana command-line tools](../cli/install-solana-cli-tools.md)
+
+### Check your installation
+
+Check that `solana-keygen` is installed correctly by running:
+
+```bash
+solana-keygen --version
+```
+
+## Creating a Paper Wallet
+
+Using the `solana-keygen` tool, it is possible to generate new seed phrases as
+well as derive a keypair from an existing seed phrase and (optional) passphrase.
+The seed phrase and passphrase can be used together as a paper wallet. As long
+as you keep your seed phrase and passphrase stored safely, you can use them to
+access your account.
+
+> For more information about how seed phrases work, review this [Bitcoin Wiki page](https://en.bitcoin.it/wiki/Seed_phrase).
+
+### Seed Phrase Generation
+
+Generating a new keypair can be done using the `solana-keygen new` command. The
+command will generate a random seed phrase, ask you to enter an optional
+passphrase, and then will display the derived public key and the generated seed
+phrase for your paper wallet.
+
+After copying down your seed phrase, you can use the
+[public key derivation](#public-key-derivation) instructions to verify that you
+have not made any errors.
+
+```bash
+solana-keygen new --no-outfile
+```
+
+> If the `--no-outfile` flag is **omitted**, the default behavior is to write the keypair to `~/.config/solana/id.json`, resulting in a [file system wallet](file-system-wallet.md).
+
+The output of this command will display a line like this:
+
+```bash
+pubkey: 9ZNTfG4NyQgxy2SWjSiQoUyBPEvXT2xo7fKc5hPYYJ7b
+```
+
+The value shown after `pubkey:` is your _wallet address_.
+
+**Note:** In working with paper wallets and file system wallets, the terms "pubkey"
+and "wallet address" are sometimes used interchangably.
+
+> For added security, increase the seed phrase word count using the `--word-count` argument
+
+For full usage details, run:
+
+```bash
+solana-keygen new --help
+```
+
+
+### Public Key Derivation
+
+Public keys can be derived from a seed phrase and a passphrase if you choose to
+use one. This is useful for using an offline-generated seed phrase to derive a
+valid public key. The `solana-keygen pubkey` command will walk you through how
+to use your seed phrase (and a passphrase if you chose to use one) as a signer
+with the solana command-line tools using the `prompt` URI scheme.
+
+```bash
+solana-keygen pubkey prompt://
+```
+
+> Note that you could potentially use different passphrases for the same seed phrase. Each unique passphrase will yield a different keypair.
+
+The `solana-keygen` tool uses the same BIP39 standard English word list as it
+does to generate seed phrases. If your seed phrase was generated with another
+tool that uses a different word list, you can still use `solana-keygen`, but
+will need to pass the `--skip-seed-phrase-validation` argument and forego this
+validation.
+
+```bash
+solana-keygen pubkey prompt:// --skip-seed-phrase-validation
+```
+
+After entering your seed phrase with `solana-keygen pubkey prompt://` the console
+will display a string of base-58 characters. This is the [derived](#hierarchical-derivation) solana BIP44 _wallet address_
+associated with your seed phrase.
+
+> Copy the derived address to a USB stick for easy usage on networked computers
+
+If needed, you can access the legacy, raw keypair's pubkey by instead passing the `ASK` keyword:
+
+```bash
+solana-keygen pubkey ASK
+```
+
+> A common next step is to [check the balance](#checking-account-balance) of the account associated with a public key
+
+For full usage details, run:
+
+```bash
+solana-keygen pubkey --help
+```
+
+### Hierarchical Derivation
+
+The solana-cli supports
+[BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) and
+[BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
+hierarchical derivation of private keys from your seed phrase and passphrase by
+adding either the `?key=` query string or the `?full-path=` query string.
+
+By default, `prompt:` will derive solana's base derivation path `m/44'/501'`. To
+derive a child key, supply the `?key=<ACCOUNT>/<CHANGE>` query string.
+
+```bash
+solana-keygen pubkey prompt://?key=0/1
+```
+
+To use a derivation path other than solana's standard BIP44, you can supply `?full-path=m/<PURPOSE>/<COIN_TYPE>/<ACCOUNT>/<CHANGE>`.
+
+```bash
+solana-keygen pubkey prompt://?full-path=m/44/2017/0/1
+```
+
+Because Solana uses Ed25519 keypairs, as per
+[SLIP-0010](https://github.com/satoshilabs/slips/blob/master/slip-0010.md) all
+derivation-path indexes will be promoted to hardened indexes -- eg.
+`?key=0'/0'`, `?full-path=m/44'/2017'/0'/1'` -- regardless of whether ticks are
+included in the query-string input.
+
+## Verifying the Keypair
+
+To verify you control the private key of a paper wallet address, use
+`solana-keygen verify`:
+
+```bash
+solana-keygen verify <PUBKEY> prompt://
+```
+
+where `<PUBKEY>` is replaced with the wallet address and the keyword `prompt://`
+tells the command to prompt you for the keypair's seed phrase; `key` and
+`full-path` query-strings accepted. Note that for security reasons, your seed
+phrase will not be displayed as you type. After entering your seed phrase, the
+command will output "Success" if the given public key matches the keypair
+generated from your seed phrase, and "Failed" otherwise.
+
+## Checking Account Balance
+
+All that is needed to check an account balance is the public key of an account.
+To retrieve public keys securely from a paper wallet, follow the
+[Public Key Derivation](#public-key-derivation) instructions on an
+[air gapped computer](<https://en.wikipedia.org/wiki/Air_gap_(networking)>).
+Public keys can then be typed manually or transferred via a USB stick to a
+networked machine.
+
+Next, configure the `solana` CLI tool to
+[connect to a particular cluster](../cli/choose-a-cluster.md):
+
+```bash
+solana config set --url <CLUSTER URL> # (i.e. https://api.mainnet-beta.solana.com)
+```
+
+Finally, to check the balance, run the following command:
+
+```bash
+solana balance <PUBKEY>
+```
+
+## Creating Multiple Paper Wallet Addresses
+
+You can create as many wallet addresses as you like. Simply re-run the
+steps in [Seed Phrase Generation](#seed-phrase-generation) or
+[Public Key Derivation](#public-key-derivation) to create a new address.
+Multiple wallet addresses can be useful if you want to transfer tokens between
+your own accounts for different purposes.
+
+## Support
+
+Check out our [Wallet Support Page](support.md) for ways to get help.

package/src/wallet-guide/solflare.md

@@ -0,0 +1,201 @@
+---
+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 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
+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.
+
+### 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 hardware wallet
+
+_NOTE: Please see [known issues](ledger-live.md#known-issues) for any current
+limitations in using the Nano._
+
+#### Initial Device Setup
+
+To use a Ledger Nano with SolFlare, first ensure you have
+[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)
+on your device.
+
+#### Select a Ledger address to access
+
+Plug in your Nano and open the Solana app so the device screen displays
+"Application is Ready".
+
+From the SolFlare home page, click "Access a Wallet" then select "Using Ledger
+Nano S | Ledger Nano X". 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), 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).
+
+### 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#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#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#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
+
+If you accessed your wallet with a Ledger Nano, you will be prompted to
+confirm the pending transaction details on your device whenever the key is needed
+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
+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.

package/src/wallet-guide/support.md

@@ -0,0 +1,16 @@
+---
+title: Support / Troubleshooting
+---
+
+If you have questions or are having trouble setting up or using your wallet
+of choice, please make sure you've read through all the relevant pages in our
+[Wallet Guide](paper-wallet.md). The Solana team is working hard to support new
+features on popular wallets, and we do our best to keep our documents up to date
+with the latest available features.
+
+If you have questions after reading the docs, feel free to reach out to us on
+our [Telegram](https://t.me/solana).
+
+For **technical support**, reach out to us on
+[Discord](https://discordapp.com/invite/pquxPsq), using the #wallet-support
+channel in our Community section.

package/src/wallet-guide/web-wallets.md

@@ -0,0 +1,52 @@
+---
+title: Web Wallets
+---
+
+## BitKeep
+
+[BitKeep](https://bitkeep.com) is an digital currency wallet and can send and receive SOL/SPL tokens.
+BitKeep also support Solana DApps with BitKeep Browser and BitKeep Chrome.
+
+## 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_
+
+## Phantom
+
+[Phantom](https://phantom.app/) is a friendly non-custodial, browser
+extension, Solana wallet that makes it safe & easy for you to store, send,
+receive, collect, and swap tokens.
+
+- Use Solana dapps
+- Beautiful NFT support
+- Ledger hardware wallet support
+
+Available for Chrome, Brave, Firefox, Vivaldi, and Edge
+
+## Solflare
+
+[Solflare](https://solflare.com/) is a non-custodial web wallet created by the
+[Solrise Finance](https://solrise.finance) team that was built specifically for Solana.
+Solflare is accessible and easy to use but also has a very comprehensive set of features, including:
+
+- The ability to connect your wallet to almost any Solana Dapp
+- Transaction simulations, which show the balance changes expected from a transaction and protect against malicious dapps
+- Deep staking support with the ability to create and manage all your staking accounts
+- Comprehensive NFT functionality, including the ability to send, receive and preview NFTs from a Metaplex-compatible NFT gallery. Support is provided for image, video, audio, and 3d/VR NFTs.
+- An in wallet swap for SPL tokens
+- Compatibility with the Ledger hardware wallet
+
+Solflare is available on web, as a browser extension, and as a mobile app for both Android and iOS.
+The extension is available on Chrome, Brave, Firefox, Opera, and Edge.
+
+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.

package/src/wallet-guide.md

@@ -0,0 +1,63 @@
+---
+title: 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,
+interacting with the keypair, and signing 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 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) 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
+supported on the command line first before being integrated into third-party
+solutions.