From 524068301ab2f3da8bb8c8cc1fd64afd9b1df25e Mon Sep 17 00:00:00 2001 From: CharlieC3 <2747302+CharlieC3@users.noreply.github.com> Date: Tue, 1 Jun 2021 14:35:08 -0400 Subject: [PATCH] docs: addressing PR comments --- src/pages/understand-stacks/overview.md | 2 +- src/pages/understand-stacks/regtest.md | 8 +++++--- src/pages/understand-stacks/running-regtest-node.md | 2 +- src/pages/understand-stacks/testnet.md | 3 ++- 4 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/pages/understand-stacks/overview.md b/src/pages/understand-stacks/overview.md index 01842cf8..42f76738 100644 --- a/src/pages/understand-stacks/overview.md +++ b/src/pages/understand-stacks/overview.md @@ -89,7 +89,7 @@ Read one of our guides to understand the ins and outs of the Stacks 2.0 blockcha Ready to get started with Stacks? Try one of our existing tutorials: [@page-reference | grid-small] -| /understand-stacks/managing-accounts, /understand-stacks/sending-tokens, /understand-stacks/running-testnet-node, /understand-stacks/integrate-stacking +| /understand-stacks/managing-accounts, /understand-stacks/sending-tokens, /understand-stacks/running-testnet-node, /understand-stacks/running-regtest-node, /understand-stacks/integrate-stacking ## Developer tooling diff --git a/src/pages/understand-stacks/regtest.md b/src/pages/understand-stacks/regtest.md index 1656f055..529f279a 100644 --- a/src/pages/understand-stacks/regtest.md +++ b/src/pages/understand-stacks/regtest.md @@ -8,7 +8,7 @@ images: ## About regtest -The regtest is a separate blockchain from the Stacks mainnet analogous to a development environnment. Similar to the testnet, it's a network used by developers to test their apps, smart contracts, or changes to the protocol in a production-like environment. However, it differs by producing a new BTC and STX block every two minutes, making it much more suitable for rapid development. The regtest is reset frequently. +The regtest is a separate blockchain from the Stacks mainnet analogous to a development environnment. Similar to the testnet, it's a network used by developers to test their apps, smart contracts, or changes to the protocol in a production-like environment. However, it differs by producing a new BTC and STX block every two minutes, making it much more suitable for rapid development. The regtest is reset more regularly than testnet. ## Regtest nodes @@ -27,8 +27,10 @@ https://stacks-node-api.regtest.stacks.co/ ### Faucet -The regtest faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox?chain=regtest), or using the [API](https://blockstack.github.io/stacks-blockchain-api/#tag/Faucets). +The regtest faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox/faucet?chain=testnet), or using the [API](https://blockstack.github.io/stacks-blockchain-api/#tag/Faucets). -To get STX tokens from within the Explorer Sandbox, navigate to the "Faucet" tab and click on "Request STX" button. If you would like to get enough STX tokens to try out [Stacking](/understand-stacks/stacking), you should click on "I want to stack". +The Explorer does not yet list `regtest` as an available network by default. Before requesting STX tokens from the Explorer, you'll have to first add the `regtest` network to the Explorer by selecting Network, then "Add a network" in the top right. The URL of the regtest API is `[https://stacks-node-api.regtest.stacks.co](https://stacks-node-api.regtest.stacks.co)` + +Once completed, navigate to the "Faucet" tab from the link above and click on "Request STX" button. If you would like to get enough STX tokens to try out [Stacking](/understand-stacks/stacking), you should click on "I want to stack". > The Explorer Sandbox requires you to login with a Secret Key diff --git a/src/pages/understand-stacks/running-regtest-node.md b/src/pages/understand-stacks/running-regtest-node.md index cd378e1c..2ff6dbde 100644 --- a/src/pages/understand-stacks/running-regtest-node.md +++ b/src/pages/understand-stacks/running-regtest-node.md @@ -14,12 +14,12 @@ images: ## Introduction -> Note: The Stacks 2.0 regtest is similar to the testnet, however BTC and STX blocks are produced at a much faster rate at 1 block every 2 minutes. Making it ideal for rapid development. +-> **Warning:** There is an [open issue](https://github.com/blockstack/stacks-blockchain/issues/2596) to address degraded performance when syncing a stacks-node with the regtest network. Until this issue is closed, syncing a node on the regtest network may take longer than syncing a testnet or mainnet node. If only using the [regtest API](https://stacks-node-api.regtest.stacks.co/extended/v1/status), this issue should not affect you. This tutorial will walk you through the following steps: - Download and install the node software - Run the node against regtest -- Mine Stacks token ## Requirements diff --git a/src/pages/understand-stacks/testnet.md b/src/pages/understand-stacks/testnet.md index 76cdcf29..f0519590 100644 --- a/src/pages/understand-stacks/testnet.md +++ b/src/pages/understand-stacks/testnet.md @@ -9,6 +9,7 @@ images: ## About testnet The testnet is a separate blockchain from the Stacks mainnet analogous to a staging environnment. It's a network used by developers to test their apps, smart contracts, or changes to the protocol in a production-like environment. +It produces blocks at roughly the same rate as mainnet; about 1 block every 10 minutes on average. The Stacks testnet is rarely reset. ## Testnet nodes @@ -27,7 +28,7 @@ https://stacks-node-api.testnet.stacks.co/ ### Faucet -The testnet faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox?chain=testnet), or using the [API](https://blockstack.github.io/stacks-blockchain-api/#tag/Faucets). +The testnet faucet provides you with free Stacks Token (STX) to test with. These are not the same as STX on mainnet and have no value. You can get STX from the faucet on the [Stacks Explorer Sandbox](https://explorer.stacks.co/sandbox/faucet?chain=testnet), or using the [API](https://blockstack.github.io/stacks-blockchain-api/#tag/Faucets). To get STX tokens from within the Explorer Sandbox, navigate to the "Faucet" tab and click on "Request STX" button. If you would like to get enough STX tokens to try out [Stacking](/understand-stacks/stacking), you should click on "I want to stack".