lukechilds
/
docs
mirror of https://github.com/lukechilds/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

feat: update node docs for argon (#610) 

* feat: update node docs for argon

* feat: rename neon-node to testnet-node

* fix: bootstrap node hostname
master-legacy
Hank Stoever 5 years ago
committed by GitHub
parent
5c6f14e954
commit
6a1f27fb9f
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 16 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 34
      _core/smart/testnet-node.md

34
_core/smart/neon-node.md → _core/smart/testnet-node.md
View File

@ -2,11 +2,13 @@
layout: smart layout: smart
description: "Run a Stacks Testnet Node" description: "Run a Stacks Testnet Node"
permalink: /:collection/:path.html permalink: /:collection/:path.html
redirect_from:
- /core/smart/neon-node.html
--- ---
# Running a Neon Testnet Node # Running a Testnet Node
{:.no_toc} {:.no_toc}
"Neon" is phase 1 of the Stacks 2.0 testnet. In Neon, you can run a node and connect it to a public network. This guide will walk you through downloading and running your own node in the Neon network. The Stacks 2.0 testnet is currently in development. As part of the testnet, you can run a node and connect it to a public network. This guide will walk you through downloading and running your own node in the testnet network.
* TOC * TOC
{:toc} {:toc}
@ -18,9 +20,7 @@ Note: If you use Linux, you may need to manually install [`libssl-dev`](https://
sudo apt-get install build-essential cmake libssl-dev pkg-config sudo apt-get install build-essential cmake libssl-dev pkg-config
``` ```
### Download and install the `stacks-blockchain` repository Ensure that you have Rust installed. If you are using macOS, Linux, or another Unix-like OS, run the following. If you are on a different OS, follow the [official Rust installation guide](https://www.rust-lang.org/tools/install).
The first step is to ensure that you have Rust installed. If you are using macOS, Linux, or another Unix-like OS, run the following. If you are on a different OS, follow the [official Rust installation guide](https://www.rust-lang.org/tools/install).
```bash ```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@ -36,6 +36,8 @@ In case you just installed Rust, you will be prompted to run the following comma
source $HOME/.cargo/env source $HOME/.cargo/env
``` ```
### Download and install the `stacks-blockchain` repository
Next, clone this repository: Next, clone this repository:
```bash ```bash
@ -52,12 +54,12 @@ cargo install --path ./testnet/stacks-node
### Run your node ### Run your node
You're all set to run a node that connects to the Neon network. You're all set to run a node that connects to the testnet network.
Back in the command line, run: Back in the command line, run:
```bash ```bash
stacks-node neon stacks-node argon
``` ```
The first time you run this, you'll see some logs indicating that the Rust code is being compiled. Once that's done, you should see some logs that look something like the this: The first time you run this, you'll see some logs indicating that the Rust code is being compiled. Once that's done, you should see some logs that look something like the this:
@ -66,11 +68,11 @@ The first time you run this, you'll see some logs indicating that the Rust code
INFO [1588108047.585] [src/chainstate/stacks/index/marf.rs:732] First-ever block 0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206 INFO [1588108047.585] [src/chainstate/stacks/index/marf.rs:732] First-ever block 0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206
``` ```
Awesome! Your node is now connected to the Neon network. Your node will receive new blocks when they are produced, and you can use your [node's RPC API](/core/smart/rpc-api) to send transactions, fetch information for contracts and accounts, and more. Awesome! Your node is now connected to the testnet network. Your node will receive new blocks when they are produced, and you can use your [node's RPC API](/core/smart/rpc-api) to send transactions, fetch information for contracts and accounts, and more.
### Running a miner ### Running a miner
Once you've followed the above steps to run a node, it's only a few more steps to run a Proof-of-burn miner on the Neon testnet. Once you've followed the above steps to run a node, it's only a few more steps to run a proof-of-burn miner on the testnet.
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. 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.
@ -96,7 +98,7 @@ After this runs, you'll probably see some installation logs, and at the end you
We need to get some testnet BTC to that address. Grab the `btcAddress` field, and head over to [the Stacks testnet website](https://testnet.blockstack.org/faucet). In the BTC faucet section, past in your `btcAddress`, and submit. You'll be sent 0.5 testnet BTC to that address. **Don't lose this information** - we'll need to use the `privateKey` field later on. We need to get some testnet BTC to that address. Grab the `btcAddress` field, and head over to [the Stacks testnet website](https://testnet.blockstack.org/faucet). In the BTC faucet section, past in your `btcAddress`, and submit. You'll be sent 0.5 testnet BTC to that address. **Don't lose this information** - we'll need to use the `privateKey` field later on.
Now, we need to configure out node to use this Bitcoin keychain. In the `stacks-blockchain` folder, create a new file called `testnet/stacks-node/conf/neon-miner-conf.toml`. Now, we need to configure out node to use this Bitcoin keychain. In the `stacks-blockchain` folder, create a new file called `testnet/stacks-node/conf/testnet-miner-conf.toml`.
Paste in the following configuration: Paste in the following configuration:
@ -104,15 +106,15 @@ Paste in the following configuration:
[node] [node]
rpc_bind = "0.0.0.0:20443" rpc_bind = "0.0.0.0:20443"
p2p_bind = "0.0.0.0:20444" p2p_bind = "0.0.0.0:20444"
bootstrap_node = "048dd4f26101715853533dee005f0915375854fd5be73405f679c1917a5d4d16aaaf3c4c0d7a9c132a36b8c5fe1287f07dad8c910174d789eb24bdfb5ae26f5f27@neon.blockstack.org:20444" bootstrap_node = "048dd4f26101715853533dee005f0915375854fd5be73405f679c1917a5d4d16aaaf3c4c0d7a9c132a36b8c5fe1287f07dad8c910174d789eb24bdfb5ae26f5f27@argon.blockstack.org:20444"
# Enter your private key here! # Enter your private key here!
seed = "replace-with-your-private-key" seed = "replace-with-your-private-key"
miner = true miner = true
[burnchain] [burnchain]
chain = "bitcoin" chain = "bitcoin"
mode = "neon" mode = "argon"
peer_host = "neon.blockstack.org" peer_host = "argon.blockstack.org"
rpc_port = 18443 rpc_port = 18443
peer_port = 18444 peer_port = 18444
@ -135,7 +137,7 @@ Now, grab your `privateKey` from earlier, when you ran the `make_keychain` comma
To run your miner, run this in the command line: To run your miner, run this in the command line:
```bash ```bash
stacks-node start --config=./testnet/stacks-node/conf/neon-miner-conf.toml stacks-node start --config=./testnet/stacks-node/conf/testnet-miner-conf.toml
``` ```
Your node should start. It will take some time to sync, and then your miner will be running! Your node should start. It will take some time to sync, and then your miner will be running!
@ -153,7 +155,7 @@ The above code will compile an optimized binary. To use it, run:
```bash ```bash
cd ../.. cd ../..
./target/release/stacks-node start --config=./testnet/conf/neon-follower-conf.toml ./target/release/stacks-node start --config=./testnet/conf/argon-follower-conf.toml
``` ```
### Enable debug logging ### Enable debug logging
@ -161,5 +163,5 @@ cd ../..
In case you are running into issues or would like to see verbose logging, you can run your node with debug logging enabled. In the command line, run: In case you are running into issues or would like to see verbose logging, you can run your node with debug logging enabled. In the command line, run:
```bash ```bash
BLOCKSTACK_DEBUG=1 stacks-node neon BLOCKSTACK_DEBUG=1 stacks-node argon
``` ```
Write Preview
Loading…
Cancel
Save