Browse Source

feat: wallet doc updates

feat/wallet-doc-update
Ken 4 years ago
parent
commit
24390f7662
  1. 25
      src/pages/stacks-wallet/install.md
  2. 83
      src/pages/stacks-wallet/overview.md
  3. 28
      src/pages/stacks-wallet/usage.md

25
src/pages/stacks-wallet/install.md

@ -22,7 +22,7 @@ by Blockstack PBC.
This button downloads the software to your computer.
3. Open a terminal window.
3. To verify the authenticity of the downloaded package before installation, open a terminal window.
To find the terminal software, enter `terminal` into the Spotlight search.
@ -36,15 +36,17 @@ by Blockstack PBC.
cd ~/Downloads
```
5. In the terminal window, type the following Command
5. In the terminal window, type the following command to verify the authenticity of the downloaded file `Stacks-Wallet-macOS-3.1.0-en-US.dmg`
```bash
shasum -a 512 Stacks-Wallet-macOS-3.0.0.dmg
shasum -a 512 Stacks-Wallet-macOS-3.1.0-en-US.dmg
```
![](/images/mac-shasum.png)
6. Verify that the resulting hash (a string of letters and numbers) is the same as the latest hash published [on this page](https://github.com/blockstack/stacks-wallet/releases).
6. Verify that the resulting hash (a string of letters and numbers) is the same as the hash published [on the Stacks Wallet's Github repository](https://github.com/blockstack/stacks-wallet/releases).
7. To proceed with installation, open the downloaded file and complete the setup.
## Windows Installation
@ -52,7 +54,7 @@ by Blockstack PBC.
This button downloads the software to your computer.
2. Open a command prompt.
2. To verify the authenticity of the downloaded package before installation, open a command prompt.
To find the command prompt software, enter `command` into the Start menu.
@ -66,7 +68,7 @@ by Blockstack PBC.
cd <You-User-Directory>/Downloads
```
4. In the command prompt window, type the following at the command prompt.
4. In the command prompt window, type the following command to verify the authenticity of the downloaded file `Stacks-Wallet-win10-3.1.0-en-US.dmg`
```bash
certUtil -hashfile Stacks-Wallet-win10-3.0.0.exe SHA512
@ -74,15 +76,16 @@ by Blockstack PBC.
![](/images/windows-certutil.png)
5. Verify that the resulting hash (a string of letters and numbers) is the same as the latest hash published [on this page](https://github.com/blockstack/stacks-wallet/releases).
5. Verify that the resulting hash (a string of letters and numbers) is the same as the hash published [on the Stacks Wallet's Github repository](https://github.com/blockstack/stacks-wallet/releases).
## Additional requirement and option
Sending and receiving Stacks (STX) does require a Bitcoin account. You also have the option to use the wallet with or without a hardware wallet.
Sending and receiving Stacks (STX) does require a Bitcoin as fuel.
You also have the option to use the wallet with or without a hardware wallet.
### Bitcoin account for fuel (required)
You need very small fractions of Bitcoin to fuel your Stacks Wallet transactions. For example, .00025 Bitcoin can fuel several transactions. You can acquire this Bitcoin fuel and send it to the Stacks Wallet via a Coinbase or other Bitcoin account. Before you begin using the wallet transactions, make sure that you have such an account. You must create this account yourself.
You need small amounts of Bitcoin to fuel your Stacks Wallet transactions. For example, 0.001 Bitcoin can fuel several transactions. You can acquire this Bitcoin fuel and send it to the Stacks Wallet's Bitcoin fuel address via a Coinbase or other Bitcoin account. You can view the Stacks Wallet's Bitcoin fuel address in the settings menu.
### Hardware wallet (optional but recommended)
@ -92,7 +95,7 @@ If you have a paper wallet or a custodial wallet, you should set up a secondary
- [Ledger Nano S](https://www.ledger.com/)
- Ledger Blue
-> Blockstack only supports the hardware wallets listed above. Other wallets, for example, the Trezor Model T, **are not supported**. If you have questions about wallet support, please [contact Blockstack support](mailto:support@blockstack.org).
-> Blockstack only supports the hardware wallets listed above. Other wallets, for example, the Trezor Model T, **are not currently supported**. If you have questions about wallet support, please [contact Blockstack support](mailto:support@blockstack.org).
For information on setting up a hardware wallet, refer to the vendor's
documentation. We cannot help you set up your hardware wallet.
documentation.

83
src/pages/stacks-wallet/overview.md

@ -5,32 +5,23 @@ description: Learn about cryptocurrency wallets, STX, and the Stacks wallet.
## Introduction
If you are, or plan to be a Stacks token holder, you need to think about how you
can manage your Stacks (STX) tokens. How can you review your token balance? How can send or
receive your tokens? STX tokens are a cryptocurrency and you manage your tokens through a **cryptocurrency wallet**.
This overview introduces basic wallet terminology and concepts.
The Stacks Wallet is the application used to manage your Stacks (STX) token holdings. You can
use it to view your token balance, send and receive tokens. This overview will introduce some
basic concepts and terminology. If you have a good understanding of cryptocurrencies, you can
skip to the [installation page](https://docs.blockstack.org/stacks-wallet/install).
## Wallets, addresses, and tokens
Cryptocurrency wallets are software that make sending and receiving cryptocurrency easier. Unlike the wallets you
carry physical money in, a cryptocurrency wallet doesn't contain your tokens. A wallet has one or more cryptocurrency
addresses, in the case of Stacks these are _Stacks token address_.
Cryptocurrency wallets are software that enables the sending and receiving of cryptocurrency.
Unlike the wallets you carry physical money in, a cryptocurrency wallet doesn't contain your
tokens.
An address is public and can be viewed by other people much like your house is visible to any passerby. To open a
particular address, you must know the address value and you must have the private key for that address. Wallets can
read existing addresses to send from or create new addresses to send to. A wallet can show you the history of
transactions for an address on the blockchain.
Exchanging cryptocurrency requires moving currency from one address to another. Say a company, Bitbook, is selling
books and receive crypto currency in payment. Lena sees a book she wants to buy on Bitbook, she selects a **Buy**
button and Bitbook gives her an address to send currency to. Lena uses her private key to open one of her cryptocurrency
addresses. She then sends from this address to BitBook's address.
![](/images/key.png)
Token exchanges are recorded by _transactions_ on a blockchain. In the case of STX, these exchanges appear on the
Stacks blockchain. The movement of tokens from Lena to Bitbook is recorded on the blockchain. The private key Lena
uses is not recorded.
Every wallet has one or more cryptocurrency addresses. An address is similar to an account number,
it is public and will be used by others to send tokens to you. Each address has a corresponding
private key, which is used to sign outgoing transactions from your account. The wallet software
securely manages this private key for you. When setting up a new wallet (when not using a hardware
wallet), you will be asked to write down a seed phrase. This seed phrase is the equivalent of your
private key. You should keep it safe and **never reveal it to anyone.**
> ##### Security tip: What to share and what not to
>
@ -38,7 +29,13 @@ uses is not recorded.
> `SM3KJBA4RZ7Z20KD2HBXNSXVPCR1D3CRAV6Q05MKT`. You can and should share the address when you want
> someone to send STX tokens to you.
>
> Your seed phrase, 24 words in an ordered sequence, is the private key for your addresses and wallet. **never** share your seed phrase with anyone.
> Your seed phrase, 24 words in an ordered sequence, is the private key for your addresses and wallet.
> **never** share your seed phrase with anyone.
When you send a transaction from the wallet, you are digitally signing a token transfer from your
account and broadcasting this to the Blockchain network. After the network has received and
validated your transaction, tokens will be moved from your account to the specified destination
address. The transaction will be permanently recorded on the Blockchain and is irreversible.
## Large-scale or institutional token holders
@ -55,16 +52,16 @@ assets as an investment, you should choose a custodial service as if you were
selecting any investment service. Consider your needs, the firm’s reputation,
fees, and so forth.
!> None of our ecosystem entities, Blockstack PBC, Blockstack Signature Fund, and Blockstack Token LLC, are custodial services. Or the Stacks Wallet is not recommended for institutional holdings.
!> The Stacks Wallet is not recommended for institutional holdings.
Blockstack suggests a firm such as [Coinbase Custody](https://custody.coinbase.com/) for institutional holders.
Coinbase Custody charges its clients a management fee based on assets. Of course, like
any responsible asset holder, you should do your own research and select a
service that meets your needs. The Investopedia's article
Blockstack suggests a firm such as [Coinbase Custody](https://custody.coinbase.com/) for
institutional holders. Coinbase Custody charges its clients a management fee based on
assets. Of course, like any responsible asset holder, you should do your own research and
select a service that meets your needs. The Investopedia's article
[What Are Cryptocurrency Custody Solutions?](https://www.investopedia.com/news/what-are-cryptocurrency-custody-solutions/)
is one place to start.
## Choosing a cryptocurrency wallet
## Software and Hardware wallets
You can choose among different types of cryptocurrency wallets. There are mainly
two types of wallets, software and hardware.
@ -75,13 +72,13 @@ they are on one system, they are vulnerable to theft either of the computer
itself or through computer hacking. Computer viruses can also impact desktop
wallets.
Similarly, mobile, online wallets do not require a desktop, but they also tend to be smaller and simpler.
Online wallets run over the web and are accessible from any networked device, computer or phone.
However, online wallets are vulnerable to hacking as well and also rely on third-party service
providers who themselves may also be vulnerable.
Similarly, mobile, online wallets do not require a desktop, but they also tend to be smaller
and simpler. Online wallets run over the web and are accessible from any networked device,
computer or phone. However, online wallets are vulnerable to hacking as well and also rely on
third-party service providers who themselves may also be vulnerable.
Hardware wallets store your seed and addresses on a device like a USB. To use
these wallets, you connect them to a networked computer, enter a pin, and
Hardware wallets store your seed and addresses on a separate and secure device.
To use these wallets, you connect them to a networked computer, enter a pin, and
communicate to send and receive tokens across the web.
Unlike a pure software wallet, hardware wallets can be disconnected and placed
@ -89,19 +86,3 @@ offline in a secure physical location like a bank deposit box. For this reason,
hardware offers another level of security that software wallets don’t have.
Blockstack suggests that you use a hardware wallet such as
[Trezor](https://trezor.io/) or [Ledger](https://www.ledger.com/).
## Multiple wallets
Of course, you need not use a software or hardware wallet exclusively, you can
use multiple wallets choosing whichever works best for you at a specific time.
For example, the Stacks Wallet is a software wallet. It operates with and
without a link to a hardware wallet. With a link to a hardware wallet, you can
use the Stacks Wallet to send and receive Stacks. When used without a hardware
wallet link, the Stacks Wallet is in _watch-only_ mode. This means the wallet
cannot send or receive Stacks. You can view only balances and transaction
history.
In some cases, you may need to transfer Stacks to a reference token address in whichever
wallet you want to move. Consult the documentation for your wallets for more
information.

28
src/pages/stacks-wallet/usage.md

@ -17,6 +17,7 @@ You use Stacks Wallet software to manage STX tokens. Using the wallet you can:
- receive STX at a specific STX address
- view balances on an address
- review transaction history associated with an address
- withdraw Bitcoin sent to the wallet's fuel address
To send STX, you need Bitcoin in your wallet. Bitcoin is the "gas" for transactions on the Stacks blockchain. A **_very small_** amount of Bitcoin is required to send STX. The gas price fluctuates like any market and is driven by the price of Bitcoin. Gas is not required to receive STX.
@ -40,9 +41,9 @@ The private key on your hardware wallet is used by the Stacks Wallet software to
### Software only wallet and a seed phrase
You can use the Stacks Wallet software without a hardware device to create one or more software wallets. Each wallet has its own address which corresponds to a STX address on the Stacks blockchain. You access this address with a unique, **seed phrase**. The software generates a seed phrase for you when create a software-only wallet. The seed phrase consists of 24 words in a sequence. Both the word _and its position the sequence_ are important.
You can use the Stacks Wallet software without a hardware wallet device. Each wallet has its own address which corresponds to a STX address on the Stacks blockchain. You access this address with a unique, **seed phrase**. The software generates a seed phrase for you when create a software-only wallet. The seed phrase consists of 24 words in a sequence. Both the word _and its position the sequence_ are important.
Write down your seed phrase and store it in a secure location such as a safe deposit box. When you write the seed phrase down, include its position, for example,`1-frog, 2-horse, 3-building` and so on until you reach a final position `24-ocean`.
Write down your seed phrase and store it in a secure location such as a safe deposit box.
!> Do not lose your seed phrase. If you lose your seed phrase, you lose any STX tokens in that associated wallet. **No person or organization, including Blockstack, can recover a lost seed phrase**.
@ -123,12 +124,9 @@ If you have an existing 24 word seed phrase from this or a previous version of t
The system generates a seed phrase for you and prompts you to write it down.
Don't lose your seed phrase. If you lose your seed phrase, you lose your STX tokens and can never get them back.
5. Write down each word and its position, for example,`1 - frog`.
5. Write down each word in the displayed order.
6. Store your written seed phrase in a secure location such as a safe deposit box.
7. Click **I've written down my seed phrase**.
The system prompts you to re-enter your seed phrase. The sequence numbers are out of order. For example, `5` may appear in the `1` position. Enter the corresponding `5` and `1` word as appropriate.
8. Select **Done**.
The system displays the balance for the address that corresponds to your seed phrase.
@ -176,11 +174,11 @@ example.
## Add Bitcoin gas
The Stacks Wallet uses very small amounts of Bitcoin to pay fees for sending transactions. You need very small fractions of Bitcoin (BTC) for gas. The cost of gas you need fluctuates with the market price of Bitcoin.
The Stacks Wallet uses very small amounts of Bitcoin to pay fees for sending transactions. You need very small amounts of Bitcoin (BTC) for gas. The cost of gas you need fluctuates with the market price of Bitcoin.
!> Very small amounts of Bitcoin are all you need to fuel transactions. **Never send an entire coin to your Stacks Wallet. Amounts such as .0002 BTC are plenty**.
!> Very small amounts of Bitcoin are all you need to fuel transactions.
You can only receive Bitcoin with Stacks Wallet; you cannot send Bitcoin. You need an account with Coinbase or similar exchange to buy Bitcoin and send it to the Stacks Wallet.
You need an account with Coinbase or similar exchange to buy Bitcoin and send it to the Stacks Wallet.
If you attempt to send STX with your wallet and you do not have enough Bitcoin to fuel the transaction, you see this dialog:
@ -208,7 +206,9 @@ To increase your Bitcoin for transactions, do the following:
![](/images/gas-up-cb.gif)
Review your Stacks Wallet settings to see the increase in your balance. Your BTC balance only appears in this area.
Review your Stacks Wallet settings to see the increase in your balance. Your BTC balance only appears in this area. The Bitcoin fuel address is tied to your Stacks wallet private key. No one else including Blockstack can access the Bitcoin.
To withdraw Bitcoin from the fuel address. Click on the `Withdraw BTC` button in the **Settings** dialog. Note that you can only withdraw the entire balance in one transaction.
## Send stacks
@ -292,10 +292,10 @@ Due to technical compatibility issues, we are currently unable to fully support
-> The wallet only supports Trezor One, Ledger Nano S, and Ledger Blue. Other wallets, for example, the Trezor Model T, are not supported. If you have questions about wallet support, please [contact Blockstack support](emailto:support@blockstack.org).
The current Stacks Wallet ([v3.0.0](https://github.com/blockstack/stacks-wallet/releases/tag/v3.0.0)) supports only the Trezor One device, and only up to firmware [version 1.8.3](https://wiki.trezor.io/Firmware_changelog). If you have a newer firmware, you will have to downgrade by [following instructions described on this page](https://wiki.trezor.io/Firmware_downgrade).
The current Stacks Wallet ([v3.1.0](https://github.com/blockstack/stacks-wallet/releases/tag/v3.0.0)) supports only the Trezor One device, and only up to firmware [version 1.8.3](https://wiki.trezor.io/Firmware_changelog). If you have a newer firmware, you will have to downgrade by [following instructions described on this page](https://wiki.trezor.io/Firmware_downgrade).
!> Downgrading your wallet is dangerous and will erase your Trezor, so make sure you have your seed phrase backed up.
!> Downgrading your wallet is dangerous and will erase your Trezor, so make sure you have your Trezor seed phrase backed up.
Alternatively to downgrading the firmware, you can use Stacks (STX) tokens with a [Ledger hardware device](https://www.ledger.com/). You can enter your seed phrase into the Ledger device to access your account. View the [Ledger documentation on how to restore a seed phrase to a Ledger device](https://support.ledger.com/hc/en-us/articles/360005434914-Restore-from-recovery-phrase). You will need the original 24-word Trezor recovery phrase which you backed up when setting up your Trezor.
Alternatively to downgrading the firmware, you can use Stacks (STX) tokens with a [Ledger hardware device](https://www.ledger.com/). You can enter your Trezor seed phrase into the Ledger device to access your account. View the [Ledger documentation on how to restore a seed phrase to a Ledger device](https://support.ledger.com/hc/en-us/articles/360005434914-Restore-from-recovery-phrase). You will need the original 24-word Trezor recovery phrase which you backed up when setting up your Trezor.
-> Only Ledger Nano S is currently supported by the v3.0.0 Stacks Wallet.
-> Only Ledger Nano S is currently supported by the v3.1.0 Stacks Wallet.

Loading…
Cancel
Save