Move from gitbook to docusaurus, build docs in Travis CI (#10970)
* fix: ignore unknown fields in more RPC responses * Remove mdbook infrastructure * Delete gitattributes and other theme related items Move all docs to /docs folder to support Docusaurus * all docs need to be moved to /docs * can be changed in the future Add Docusaurus infrastructure * initialize docusaurus repo Remove trailing whitespace, add support for eslint Change Docusaurus configuration to support `src` * No need to rename the folder! Change a setting and we're all good to go. * Fixing rebase items * Remove unneccessary markdown file, fix type * Some fonts are hard to read. Others, not so much. Rubik, you've been sidelined. Roboto, into the limelight! * As much as we all love tutorials, I think we all can navigate around a markdown file. Say goodbye, `mdx.md`. * Setup deployment infrastructure * Move docs job from buildkite to travic * Fix travis config * Add vercel token to travis config * Only deploy docs after merge * Docker rust env * Revert "Docker rust env" This reverts commit f84bc208e807aab1c0d97c7588bbfada1fedfa7c. * Build CLI usage from docker * Pacify shellcheck * Run job on PR and new commits for publication * Update README * Fix svg image building * shellcheck Co-authored-by: Michael Vines <mvines@gmail.com> Co-authored-by: Ryan Shea <rmshea@users.noreply.github.com> Co-authored-by: publish-docs.sh <maintainers@solana.com>
This commit is contained in:
Dan Albert
GitHub
@@ -1,34 +1,38 @@
|
||||
# Solana Wallet Guide
|
||||
---
|
||||
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.
|
||||
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*.
|
||||
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 _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
|
||||
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
|
||||
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
|
||||
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**.
|
||||
@@ -44,6 +48,7 @@ of security and convenience.
|
||||
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.
|
||||
|
||||
@@ -58,4 +63,4 @@ 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.md" %}
|
||||
{% page-ref page="cli.md" %}
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# App Wallets
|
||||
---
|
||||
title: 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.
|
||||
|
||||
@@ -13,8 +16,8 @@ The app is free and getting your wallet set up only takes a few minutes.
|
||||
### Trust Wallet Security
|
||||
|
||||
Tokens held in Trust Wallet are only as secure as the device on which the app is
|
||||
installed. Anyone who is able to unlock your phone or tablet may be able to
|
||||
use the Trust Wallet app and transfer your tokens. To improve security,
|
||||
installed. Anyone who is able to unlock your phone or tablet may be able to
|
||||
use the Trust Wallet app and transfer your tokens. To improve security,
|
||||
you can add a passcode to the Trust Wallet application.
|
||||
To add a Trust Wallet passcode, open the app and go to
|
||||
Settings -> Security -> Passcode.
|
||||
@@ -26,15 +29,17 @@ your Trust Wallet keys on a different device. From there, they could
|
||||
sign transactions from that device rather than on your own phone or tablet.
|
||||
The seed phrase is displayed when a new wallet is created and it can also be
|
||||
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"
|
||||
|
||||
{% page-ref page="trust-wallet.md" %}
|
||||
- Go to Setting -> Wallets
|
||||
- Under the Options menu for a particular wallet tap "Show Recovery Phrase"
|
||||
|
||||
[Trust Wallet](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
|
||||
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
|
||||
@@ -45,4 +50,4 @@ keep track of the hardware device.
|
||||
|
||||
Solana does not support the Ledger Nano **X** at this time.
|
||||
|
||||
{% page-ref page="ledger-live.md" %}
|
||||
[Ledger Live](ledger-live.md)
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
# Command Line Wallets
|
||||
---
|
||||
title: Command Line Wallets
|
||||
---
|
||||
|
||||
Solana supports several different types of wallets that can be used to interface
|
||||
directly with the Solana command-line tools.
|
||||
@@ -11,7 +13,7 @@ To use a Command Line Wallet, you must first [install the Solana CLI tools](../c
|
||||
|
||||
## File System Wallet
|
||||
|
||||
A *file system wallet*, aka an FS wallet, is a directory in your computer's
|
||||
A _file system wallet_, aka an FS wallet, is a directory in your computer's
|
||||
file system. Each file in the directory holds a keypair.
|
||||
|
||||
### File System Wallet Security
|
||||
@@ -28,11 +30,11 @@ keypairs are stored on your computer as files, a skilled hacker with physical
|
||||
access to your computer may be able to access it. Using an encrypted hard
|
||||
drive, such as FileVault on MacOS, minimizes that risk.
|
||||
|
||||
{% page-ref page="../file-system-wallet/README.md" %}
|
||||
[File System Wallet](../file-system-wallet/README.md")
|
||||
|
||||
## Paper Wallet
|
||||
|
||||
A *paper wallet* is a collection of *seed phrases* written on paper. A seed
|
||||
A _paper wallet_ is a collection of _seed phrases_ written on paper. A seed
|
||||
phrase is some number of words (typically 12 or 24) that can be used to
|
||||
regenerate a keypair on demand.
|
||||
|
||||
@@ -47,7 +49,7 @@ wallets are used in conjunction with
|
||||
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" %}
|
||||
[Paper Wallets](../paper-wallet/README.md)
|
||||
|
||||
## Hardware Wallet
|
||||
|
||||
@@ -62,4 +64,4 @@ security and convenience for cryptocurrencies. It effectively automates the
|
||||
process of offline signing while retaining nearly all the convenience of a file
|
||||
system wallet.
|
||||
|
||||
{% page-ref page="../hardware-wallet/README.md" %}
|
||||
[Hardware Wallets]("../hardware-wallet/README.md")
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Ledger Live and Ledger Nano S
|
||||
---
|
||||
title: 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.
|
||||
@@ -13,56 +16,61 @@ Users may [use a Ledger Nano S with the Solana command
|
||||
line tools](../hardware-wallets/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/)
|
||||
|
||||
- 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 the latest device firmware](https://support.ledgerwallet.com/hc/en-us/articles/360002731113-Update-Ledger-Nano-S-firmware)
|
||||
|
||||
## 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 [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.
|
||||
|
||||
|
||||
- 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
|
||||
|
||||
|
||||
|
||||
- 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
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
- 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)
|
||||
- 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)
|
||||
|
||||
|
||||
|
||||
|
||||
- Once the upgrade is finished, confirm v0.2.2 is installed under "Apps Installed"
|
||||
- Once the upgrade is finished, confirm v0.2.2 is installed under "Apps Installed"
|
||||
|
||||
|
||||
|
||||
|
||||
## 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](../hardware-wallets/ledger.md).
|
||||
instructions on how to
|
||||
[use a Ledger Nano S with the Solana command line tools](../hardware-wallets/ledger.md).
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
# Support / Troubleshooting
|
||||
---
|
||||
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](README.md). The Solana team is working hard to support new
|
||||
[Wallet Guide](README.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.
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
# Trust Wallet
|
||||
---
|
||||
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.
|
||||
@@ -7,101 +10,109 @@ receive tokens.
|
||||
|
||||
#### 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
|
||||
- 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
|
||||
- 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.
|
||||
|
||||
- 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**.
|
||||
|
||||
- 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,
|
||||
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
|
||||
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
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".
|
||||
- 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
|
||||
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.*
|
||||
- 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)
|
||||
- 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)
|
||||
[Community Help Center](https://community.trustwallet.com/c/helpcenter)
|
||||
|
||||
## Support
|
||||
|
||||
|
||||
Reference in New Issue
Block a user