Skip to content

Commit 3382ecd

Browse files
authored
Merge pull request #2765 from pgray-hiro/fix/remove-outdated-testnets
Remove outdated testnet versions from README
2 parents 2f08f69 + a4ce2c3 commit 3382ecd

File tree

1 file changed

+19
-26
lines changed

1 file changed

+19
-26
lines changed

README.md

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ Stacks 2.0 is a layer-1 blockchain that connects to Bitcoin for security and ena
88

99
## Repository
1010

11-
| Blockstack Topic/Tech | Where to learn more more |
12-
| ------------------------ | --------------------------------------------------------------------------------- |
13-
| Stacks 2.0 | [master branch](https://github.com/blockstack/stacks-blockchain/tree/master) |
14-
| Stacks 1.0 | [legacy branch](https://github.com/blockstack/stacks-blockchain/tree/stacks-1.0) |
15-
| Use the package | [our core docs](https://docs.blockstack.org/core/naming/introduction.html) |
16-
| Develop a Blockstack App | [our developer docs](https://docs.blockstack.org/browser/hello-blockstack.html) |
17-
| Use a Blockstack App | [our browser docs](https://docs.blockstack.org/browser/browser-introduction.html) |
18-
| Blockstack PBC the company | [our website](https://blockstack.org) |
11+
| Blockstack Topic/Tech | Where to learn more more |
12+
| -------------------------- | --------------------------------------------------------------------------------- |
13+
| Stacks 2.0 | [master branch](https://github.com/blockstack/stacks-blockchain/tree/master) |
14+
| Stacks 1.0 | [legacy branch](https://github.com/blockstack/stacks-blockchain/tree/stacks-1.0) |
15+
| Use the package | [our core docs](https://docs.blockstack.org/core/naming/introduction.html) |
16+
| Develop a Blockstack App | [our developer docs](https://docs.blockstack.org/browser/hello-blockstack.html) |
17+
| Use a Blockstack App | [our browser docs](https://docs.blockstack.org/browser/browser-introduction.html) |
18+
| Blockstack PBC the company | [our website](https://blockstack.org) |
1919

2020
## Release Schedule and Hotfixes
2121

@@ -54,12 +54,12 @@ to upgrade to `2.0.10.1.0` or `2.0.10.0.1`. However, upgrading to `2.0.11.0.0` w
5454

5555
- [x] [SIP 001: Burn Election](https://github.com/stacksgov/sips/blob/main/sips/sip-001/sip-001-burn-election.md)
5656
- [x] [SIP 002: Clarity, a language for predictable smart contracts](https://github.com/stacksgov/sips/blob/main/sips/sip-002/sip-002-smart-contract-language.md)
57-
- [X] [SIP 003: Peer Network](https://github.com/stacksgov/sips/blob/main/sips/sip-003/sip-003-peer-network.md)
57+
- [x] [SIP 003: Peer Network](https://github.com/stacksgov/sips/blob/main/sips/sip-003/sip-003-peer-network.md)
5858
- [x] [SIP 004: Cryptographic Committment to Materialized Views](https://github.com/stacksgov/sips/blob/main/sips/sip-004/sip-004-materialized-view.md)
5959
- [x] [SIP 005: Blocks, Transactions, and Accounts](https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md)
60-
- [X] [SIP 006: Clarity Execution Cost Assessment](https://github.com/stacksgov/sips/blob/main/sips/sip-006/sip-006-runtime-cost-assessment.md)
60+
- [x] [SIP 006: Clarity Execution Cost Assessment](https://github.com/stacksgov/sips/blob/main/sips/sip-006/sip-006-runtime-cost-assessment.md)
6161
- [x] [SIP 007: Stacking Consensus](https://github.com/stacksgov/sips/blob/main/sips/sip-007/sip-007-stacking-consensus.md)
62-
- [X] [SIP 008: Clarity Parsing and Analysis Cost Assessment](https://github.com/stacksgov/sips/blob/main/sips/sip-008/sip-008-analysis-cost-assessment.md)
62+
- [x] [SIP 008: Clarity Parsing and Analysis Cost Assessment](https://github.com/stacksgov/sips/blob/main/sips/sip-008/sip-008-analysis-cost-assessment.md)
6363

6464
Stacks improvement proposals (SIPs) are aimed at describing the implementation of the Stacks blockchain, as well as proposing improvements. They should contain concise technical specifications of features or standards and the rationale behind it. SIPs are intended to be the primary medium for proposing new features, for collecting community input on a system-wide issue, and for documenting design decisions.
6565

@@ -69,19 +69,11 @@ The SIPs are now located in the [stacksgov/sips](https://github.com/stacksgov/si
6969

7070
### Testnet versions
7171

72-
- [x] **Helium** is a developer local setup, mono-node, assembling SIP 001, SIP 002, SIP 004 and SIP 005. With this version, developers can not only run Stacks 2.0 on their development machines, but also write, execute, and test smart contracts. See the instructions below for more details.
72+
- [x] **Krypton** is a Stacks 2 testnet with a fixed, two-minute block time, called `regtest`. Regtest is generally unstable for regular use, and is reset often. See the [regtest documentation](https://docs.stacks.co/understand-stacks/testnet) for more information on using regtest.
7373

74-
- [X] **Neon** is the first version of our public testnet, which shipped in Q2 2020. This testnet added SIP 003, and will be an open-membership public network, where participants will be able to validate and participate in mining testnet blocks.
74+
- [x] **Xenon** is the Stacks 2 public testnet, which runs PoX against the Bitcoin testnet. It is the full implementation of the Stacks 2 blockchain, and should be considered a stable testnet for developing Clarity smart contracts. See the [testnet documentation](https://docs.stacks.co/understand-stacks/testnet) for more information on the public testnet.
7575

76-
- [X] **Argon** is the second version of our public testnet, which shipped in Q2 2020. This testnet improved on the stability of the Neon testnet.
77-
78-
- [X] **Krypton** is the third version of our public testnet, which incorporates a partial implementation of SIP 007. It allows developers to test a simple version of Stacking and PoX consensus.
79-
80-
- [X] **Xenon** is the upcoming version of our public testnet, which will run on the Bitcoin testnet. It will include SIP 006 and SIP 008, and will contain bugfixes and improvements to the implementation of SIP 007.
81-
82-
- [X] **Mainnet** is the fully functional version, that is estimated for Q4 2020.
83-
84-
See the [testnet website](https://testnet.blockstack.org) and ["when mainnet?" FAQ](https://github.com/blockstack/stacks/blob/master/whenmainnet.md) for details.
76+
- [x] **Mainnet** is the fully functional Stacks 2 blockchain, see the [Stacks overview](https://docs.stacks.co/understand-stacks/overview) for information on running a Stacks node, mining, stacking, and writing Clarity smart contracts.
8577

8678
## Getting started
8779

@@ -129,7 +121,8 @@ cargo run --bin blockstack-cli generate-sk --testnet
129121
# stacksAddress: "ST2ZRX0K27GW0SP3GJCEMHD95TQGJMKB7G9Y0X1MH"
130122
# }
131123
```
132-
This keypair is already registered in the `testnet-follower-conf.toml` file, so it can be used as presented here.
124+
125+
This keypair is already registered in the `testnet-follower-conf.toml` file, so it can be used as presented here.
133126

134127
We will interact with the following simple contract `kv-store`. In our examples, we will assume this contract is saved to `./kv-store.clar`:
135128

@@ -162,7 +155,7 @@ With the following arguments:
162155
cargo run --bin blockstack-cli publish b8d99fd45da58038d630d9855d3ca2466e8e0f89d3894c4724f0efc9ff4b51f001 515 0 kv-store ./kv-store.clar --testnet
163156
```
164157

165-
The `515` is the transaction fee, denominated in microSTX. Right now, the
158+
The `515` is the transaction fee, denominated in microSTX. Right now, the
166159
testnet requires one microSTX per byte minimum, and this transaction should be
167160
less than 515 bytes.
168161
The third argument `0` is a nonce, that must be increased monotonically with each new transaction.
@@ -181,7 +174,7 @@ You can observe the state machine in action locally by running:
181174
cargo testnet start --config=./testnet/stacks-node/conf/testnet-follower-conf.toml
182175
```
183176

184-
`testnet-follower-conf.toml` is a configuration file that you can use for setting genesis balances or configuring Event observers. You can grant an address an initial account balance by adding the following entries:
177+
`testnet-follower-conf.toml` is a configuration file that you can use for setting genesis balances or configuring Event observers. You can grant an address an initial account balance by adding the following entries:
185178

186179
```
187180
[[ustx_balance]]
@@ -190,7 +183,7 @@ amount = 100000000
190183
```
191184

192185
The `address` field is the Stacks testnet address, and the `amount` field is the
193-
number of microSTX to grant to it in the genesis block. The addresses of the
186+
number of microSTX to grant to it in the genesis block. The addresses of the
194187
private keys used in the tutorial below are already added.
195188

196189
### Publish your contract

0 commit comments

Comments
 (0)