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

feat: add new pages for guides

fix/update-miner-config
Alexander Graebe 5 years ago
parent
923f62f337
commit
083d6d0ac1
7 changed files with 64 additions and 36 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      src/common/navigation.yaml
  2. 6
      src/pages/stacks-blockchain/accounts.md
  3. 6
      src/pages/stacks-blockchain/network.md
  4. 25
      src/pages/stacks-blockchain/overview.md
  5. 22
      src/pages/stacks-blockchain/sending-tokens.md
  6. 31
      src/pages/stacks-blockchain/testnet.md
  7. 6
      src/pages/stacks-blockchain/transactions.md

4
src/common/navigation.yaml
View File

@ -45,6 +45,10 @@ sections:
- path: /stacks-blockchain
pages:
- path: /overview
- path: /testnet
- path: /accounts
- path: /transactions
- path: /network
sections:
- title: Tutorials
pages:

6
src/pages/stacks-blockchain/accounts.md
View File

@ -0,0 +1,6 @@
---
title: Account management
description: Guide to Stacks 2.0 account management
---
## Introduction

6
src/pages/stacks-blockchain/network.md
View File

@ -0,0 +1,6 @@
---
title: Stacks 2.0 network
description: Guide to Stacks 2.0 network concepts, architectures, and implications
---
## Introduction

25
src/pages/stacks-blockchain/overview.md
View File

@ -72,28 +72,3 @@ system-wide issue, and for documenting design decisions.
- ✅ [SIP 005:](https://github.com/blockstack/stacks-blockchain/blob/master/sip/sip-005-blocks-and-transactions.md) Blocks, Transactions, and Accounts
- [ ] SIP 006: Clarity Execution Cost Assessment _(Q2 2020)_
- [ ] SIP 007: Stacking Consensus _(Q2 2020)_
## Testnet phases
- ✅ **Phase 1 (Neon):** 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.
- ✅ **Phase 2 (Argon):** is the current version of our public testnet. This testnet includes SIP 003, and will be an open-membership public network, where participants will be able to validate and participate in mining testnet blocks.
- [ ] **Phase 3 (Krypton):** is the upcoming version that we're anticipating to ship in Q3 2020. This version focus on the PoX basics (miner get rewards, Stackers get BTC distributions, etc).
- [ ] **Phase 4 (Mainnet)** is the fully functional version, that we're intending to ship in Q4 2020.
## Testnet roadmap
✅ Released features&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<input type="checkbox" disabled /> Upcoming
| | Phase 1 | **Phase 2** | Phase 3 | Phase 4 |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ---------------------------------- | ---------------------------------- |
| [Simple Proof of Transfer mining](https://github.com/blockstack/stacks-blockchain) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Send and receive Stacks](https://github.com/blockstack/cli-blockstack) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Deploy Clarity contracts](/smart-contracts/overview) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [New Stacks Explorer](https://testnet-explorer.blockstack.org/) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [stacks-transactions-js](https://github.com/blockstack/stacks-transactions-js) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Transaction signing](https://blog.blockstack.org/build-apps-that-sign-transactions-with-clarity-smart-contracts-on-the-stacks-2-0-testnet/) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Proof of Transfer mining | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Stacking | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| New Stacks Wallet | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Testing upgrade to Stacks 2.0 | | | | <input type="checkbox" disabled /> |
| Integration with Bitcoin testnet | | | | <input type="checkbox" disabled /> |

22
src/pages/stacks-blockchain/sending-tokens.md
View File

@ -74,7 +74,7 @@ const senderKey = createStacksPrivateKey(key);
To generate a token transfer transaction, we will be using the `makeSTXTokenTransfer()` transaction builder function:
```js
const recipientAddress = 'SP3FGQ8Z7JY9BWYZ5WM53E0M9NK7WHJF0691NZ159';
const recipient = 'SP3FGQ8Z7JY9BWYZ5WM53E0M9NK7WHJF0691NZ159';
// amount of Stacks tokens to send (in microstacks). 1,000,000 microstacks are worth 1 STX token
const amount = new BN(1000000);
@ -91,7 +91,7 @@ const network = new StacksTestnet();
const memo = 'hello world';
const txOptions = {
recipientAddress,
recipient,
amount,
fee,
nonce,
@ -107,15 +107,15 @@ const transaction = await makeSTXTokenTransfer(txOptions);
The generation method will need a few more pieces of information, as specified in the `txOptions` object:
| Parameter | Description | Optional |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `recipientAddress` | The recipient Stacks address in c32check format | **No** |
| `amount` | The amount of Stacks tokens to send denominated in microstacks | **No** |
| `fee` | The fee that the sender is willing to pay for miners to process the transaction. Denominated in microstacks | Yes |
| `nonce` | A nonce is an integer that needs to be incremented by 1 for each sequential transaction from the same account. Nonces start at 0 | Yes |
| `senderKey` | A private key object | Yes |
| `network` | Specifies whether the transaction is meant for Stacks Mainnet or Testnet | Yes |
| `memo` | A memo string to attach additional information to the transaction. This data is limited to 33 bytes | Yes |
| Parameter | Description | Optional |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `recipient` | The recipient Stacks address in c32check format | **No** |
| `amount` | The amount of Stacks tokens to send denominated in microstacks | **No** |
| `fee` | The fee that the sender is willing to pay for miners to process the transaction. Denominated in microstacks | Yes |
| `nonce` | A nonce is an integer that needs to be incremented by 1 for each sequential transaction from the same account. Nonces start at 0 | Yes |
| `senderKey` | A private key object | Yes |
| `network` | Specifies whether the transaction is meant for Stacks Mainnet or Testnet | Yes |
| `memo` | A memo string to attach additional information to the transaction. This data is limited to 33 bytes | Yes |
### Estimating fees

31
src/pages/stacks-blockchain/testnet.md
View File

@ -0,0 +1,31 @@
---
title: Testnet
description: Learn about testnet phases, timelines, and features
---
## Introduction
## Testnet phases
- ✅ **Phase 1 (Neon):** 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.
- ✅ **Phase 2 (Argon):** is the current version of our public testnet. This testnet includes SIP 003, and will be an open-membership public network, where participants will be able to validate and participate in mining testnet blocks.
- [ ] **Phase 3 (Krypton):** is the upcoming version that we're anticipating to ship in Q3 2020. This version focus on the PoX basics (miner get rewards, Stackers get BTC distributions, etc).
- [ ] **Phase 4 (Mainnet)** is the fully functional version, that we're intending to ship in Q4 2020.
## Testnet roadmap
✅ Released features&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<input type="checkbox" disabled /> Upcoming
| | Phase 1 | **Phase 2** | Phase 3 | Phase 4 |
| -------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------- | ---------------------------------- | ---------------------------------- |
| [Simple Proof of Transfer mining](https://github.com/blockstack/stacks-blockchain) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Send and receive Stacks](https://github.com/blockstack/cli-blockstack) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Deploy Clarity contracts](/smart-contracts/overview) | ✅ | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [New Stacks Explorer](https://testnet-explorer.blockstack.org/) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [stacks-transactions-js](https://github.com/blockstack/stacks-transactions-js) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| [Transaction signing](https://blog.blockstack.org/build-apps-that-sign-transactions-with-clarity-smart-contracts-on-the-stacks-2-0-testnet/) | | ✅ | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Proof of Transfer mining | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Stacking | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| New Stacks Wallet | | | <input type="checkbox" disabled /> | <input type="checkbox" disabled /> |
| Testing upgrade to Stacks 2.0 | | | | <input type="checkbox" disabled /> |
| Integration with Bitcoin testnet | | | | <input type="checkbox" disabled /> |

6
src/pages/stacks-blockchain/transactions.md
View File

@ -0,0 +1,6 @@
---
title: Transaction generation
description: Guide to Stacks 2.0 transaction generation
---
## Introduction
Write Preview
Loading…
Cancel
Save