From a66a49d3849038d7ec153882734f3b3415d29a98 Mon Sep 17 00:00:00 2001 From: Justin Starry Date: Tue, 3 Dec 2019 20:12:24 -0500 Subject: [PATCH] Update paper wallet documentation (#7223) * wip * Update paper wallet documentation * Add install from tarball instructions * Separate out installation page --- book/src/paper-wallet/README.md | 7 +-- book/src/paper-wallet/installation.md | 85 +++++++++++++++++++++++++++ book/src/paper-wallet/keypair.md | 5 ++ 3 files changed, 91 insertions(+), 6 deletions(-) create mode 100644 book/src/paper-wallet/installation.md diff --git a/book/src/paper-wallet/README.md b/book/src/paper-wallet/README.md index 5e4e389167..2ab3700b5c 100644 --- a/book/src/paper-wallet/README.md +++ b/book/src/paper-wallet/README.md @@ -17,12 +17,7 @@ support keypair input via seed phrases. To learn more about the BIP39 standard, visit the Bitcoin BIPs Github repository [here](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki). -## Installation - -The tools used in this guide can all be installed by following the -[Installing the Validator Software](running-validator/validator-software.md) -guide. After installation, you will have access to the `solana`, -`solana-keygen`, and `solana-validator` tools. +{% page-ref page="paper-wallet/installation.md" %} {% page-ref page="paper-wallet/keypair.md" %} diff --git a/book/src/paper-wallet/installation.md b/book/src/paper-wallet/installation.md new file mode 100644 index 0000000000..22b2269c16 --- /dev/null +++ b/book/src/paper-wallet/installation.md @@ -0,0 +1,85 @@ +# Installation +Solana provides a CLI tool for key generation called `solana-keygen`. Here are 3 +different options for installations. + +## Option 1: via Solana Install Script +Install the Solana CLI tools on your machine by running: + +```bash +curl -sSf https://raw.githubusercontent.com/solana-labs/solana/v0.21.1/install/solana-install-init.sh | sh -s - 0.21.1 +``` + +The following output indicates a successful update: + +```text +looking for latest release +downloading v0.21.1 installer +Configuration: /home/solana/.config/solana/install/config.yml +Active release directory: /home/solana/.local/share/solana/install/active_release +* Release version: 0.21.1 +* Release URL: https://github.com/solana-labs/solana/releases/download/v0.21.1/solana-release-x86_64-unknown-linux-gnu.tar.bz2 +Update successful +``` + +You can now verify that `solana-keygen` was installed by running: + +```bash +solana-keygen -h +``` + +After a successful install, `solana-install update` may be used to easily update +the cluster software to a newer version at any time. + +### Option 2: via Rust Cargo +First, install Rust's package manager `cargo` + +```bash +$ curl https://sh.rustup.rs -sSf | sh +$ source $HOME/.cargo/env +``` + +Then, install the `solana-keygen` tool + +```bash +cargo install solana-keygen +``` + +You can now verify that `solana-keygen` was installed by running: + +```bash +solana-keygen -h +``` + +### Option 3: via Tarball +First download the desired release tarball from GitHub. The examples below will +retrieve the most recent release. If you would like to download a specific +version instead replace `latest/download` with `download/VERSION` where VERSION +is a tag name from https://github.com/solana-labs/solana/releases (ie. v0.21.0). + +MacOS +```bash +$ curl -L -sSf -o solana-release.tar.bz2 'https://github.com/solana-labs/solana/releases/latest/download/solana-release-x86_64-apple-darwin.tar.bz2' +``` + +Linux +```bash +$ curl -L -sSf -o solana-release.tar.bz2 'https://github.com/solana-labs/solana/releases/latest/download/solana-release-x86_64-unknown-linux-gnu.tar.bz2' +``` + +Next, extract the tarball +```bash +$ tar xf solana-release.tar.bz2 +``` + +Finally, `solana-keygen` can be run by +```bash +$ solana-release/bin/solana-keygen +``` + +If you would like to follow the remainder of these instructions without typing +the leading path to `solana-keygen`, add it to your PATH environment variable +with the following command +```bash +$ export PATH="$(pwd)/solana-release/bin:${PATH}" +``` +This can be made permanent by adding it to your `~/.profile` diff --git a/book/src/paper-wallet/keypair.md b/book/src/paper-wallet/keypair.md index 71740670c4..d19711adfa 100644 --- a/book/src/paper-wallet/keypair.md +++ b/book/src/paper-wallet/keypair.md @@ -27,6 +27,11 @@ If `--no-outfile` is **not** specified, the default behavior is to write the keypair to `~/.config/solana/id.json` {% endhint %} +{% hint style="info" %} +For added security, increase the seed phrase word count using the `--word-count` +argumment +{% endhint %} + For full usage details run: ```bash