Browse Source

feat: Incorporated review comments for new feature #891

Also added images accompanying the doc.
clarity-values-guide
HariniRajan397 4 years ago
committed by Charlie
parent
commit
587b761dba
  1. BIN
      public/images/mining-windows-popup.png
  2. BIN
      public/images/mining-windows.png
  3. 15
      src/pages/mining.md
  4. 12
      src/pages/stacks-blockchain/running-testnet-node.md

BIN
public/images/mining-windows-popup.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

BIN
public/images/mining-windows.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

15
src/pages/mining.md

@ -22,7 +22,7 @@ Make sure you've followed the [Running testnet node](/stacks-blockchain/running-
First, we need to generate a keychain. With this keychain, we'll get some testnet BTC from a faucet, and then use that BTC to start mining.
To get a keychain, the simplest way is to use the `blockstack-cli`. We'll use the `make_keychain` command, and pass `-t` to indicate that we want a testnet keychain.
To get a keychain, the simplest way is to use the `stacks-cli`. We'll use the `make_keychain` command, and pass `-t` to indicate that we want a testnet keychain.
```bash
npx @stacks/cli make_keychain -t 2>/dev/null
@ -128,11 +128,15 @@ BLOCKSTACK_DEBUG=1 stacks-node krypton
## Running a miner in Windows
### Prerequisites
Make sure you've followed the [Running the testnet node on Windows](stacks-blockchain/running-testnet-node#running-the-testnet-node-on-windows) tutorial before starting this tutorial.
### Generate keychain and get testnet tokens in Windows
To setup the miner, first, we need to generate a keychain. With this keychain, we'll get some testnet BTC from a faucet, and then use that BTC to start mining.
To get a keychain, the simplest way is to use the `stacks-cli`.We'll use the `stx make-keychain` command,and pass -t to indicate that we want a testnet keychain.
To get a keychain, the simplest way is to use the `stacks-cli`. We'll use the `stx make-keychain` command, and pass `-t` to indicate that we want a testnet keychain.
Generate a keychain:
@ -158,7 +162,10 @@ After this runs, you'll probably see some installation logs, and at the end you
Request BTC from faucet:
We need to get some testnet BTC to that address. Grab the btcAddress field, and call the BTC faucet:
We need to get some testnet BTC to that address. Grab the `btcAddress` field, and call the BTC faucet:
-> Note: The below command needs curl. If you are on Windows 10, version 1803 or later, your OS ships with a copy of curl, already set up and ready to use.
If not, [download and install curl](https://curl.se/windows/).
```bash
# replace <btc_address> with `btcAddress` property from your keychain
@ -169,7 +176,7 @@ You'll be sent 0.5 testnet BTC to that address. Don't lose this information - we
### Create configuration file
Now, we need to configure our node to use this Bitcoin keychain. In the `folder where your binary is extracted`, create a new file called `testnet-miner-conf.toml`.
Now, we need to configure our node to use this Bitcoin keychain. In the **folder where your binary is extracted**, create a new file called `testnet-miner-conf.toml`.
Paste in the following configuration:

12
src/pages/stacks-blockchain/running-testnet-node.md

@ -108,17 +108,23 @@ Before you begin, check that you have the below necessary softwares installed on
### Download the Binary and run the follower node
First, download the binary using the below link:
-> Note: Please make sure to download the new Binary and follow the below steps as and when a [new release build](https://github.com/blockstack/stacks-blockchain/releases/latest) is available.
<https://github.com/blockstack/stacks-blockchain/releases/download/v23.0.0.10-krypton/windows-x64.zip>
First, Visit the [Stacks Github releases repo](https://github.com/blockstack/stacks-blockchain/releases/latest). From the various binary list, click to download the Windows binary.Refer the image below.
![BinaryList](/images/mining-windows.png)
Extract the binary .Open the command prompt from the folder where binary is extracted and execute the below command:
Next, click on save file and Press **Ok** in the popup window.
![Windowspopup](/images/mining-windows-popup.png)
Once saved, Extract the binary. Open the command prompt **from the folder where binary is extracted** and execute the below command:
```bash
stacks-node krypton
# This command will start the testnet follower node.
```
-> Note : Sometimes windows might pop up a message to allow access. If so, allow access to keep on running the node.
To execute Stacks node with extra debugging enabled, run:
```bash

Loading…
Cancel
Save