Skip to content

Commit

Permalink
Removing QBFT warning (#188)
Browse files Browse the repository at this point in the history
* Removing QBFT warning

- considering QBFT is not longer a beta.

* remove all qbft warnings

* fix lint padding issues

Co-authored-by: Alexandra Tran <alexandratran@protonmail.com>
Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
Co-authored-by: bgravenorst <50852695+bgravenorst@users.noreply.github.com>
  • Loading branch information
4 people authored Mar 6, 2022
1 parent 8338b28 commit 7e5d29b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ description: Configuring QBFT consensus
GoQuorum implements the QBFT Proof-of-Authority (PoA) consensus protocol.
You can [create a private network using QBFT](../../../tutorials/private-network/create-qbft-network.md).

!!! warning
QBFT is currently an early access feature. It is not recommended for production networks with business critical impact.

In QBFT networks, approved accounts known as validators validate transactions and blocks.
Validators take turns to create the next block.
Before inserting a block onto the chain, a super-majority (greater than 66%) of validators must first sign the block.
Expand Down Expand Up @@ -120,8 +117,8 @@ You can migrate an existing [IBFT](ibft.md) network to a QBFT network with the f

1. Stop the network.
1. Update the IBFT genesis file with a non-zero `testQBFTBlock` fork block.
For example, if the current block number in your IBFT network is 100, set `testQBFTBlock` to any block greater than
100, and once that fork block is reached, QBFT consensus will be used instead of IBFT.
For example, if the current block number in your IBFT network is 100, set `testQBFTBlock` to any block greater than
100, and once that fork block is reached, QBFT consensus will be used instead of IBFT.

!!! example "Sample QBFT genesis file"

Expand Down
16 changes: 6 additions & 10 deletions docs/tutorials/private-network/adding-removing-qbft-validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description: Adding and removing QBFT validators

# Adding and removing QBFT validators

!!! warning

QBFT is currently an early access feature. It is not recommended for production networks with business critical impact.

## Prerequisites

* A QBFT network as configured in the [QBFT tutorial](create-qbft-network.md).
Expand Down Expand Up @@ -92,8 +88,8 @@ description: Adding and removing QBFT validators
instance: Geth/v1.8.18-stable-bb88608c(quorum-v2.2.3)/darwin-amd64/go1.10.2
coinbase: 0x4c1ccd426833b9782729a212c857f2f03b7b4c0d
at block: 137 (Tue, 11 Jun 2019 16:32:47 BST)
datadir: /Users/username/fromscratchistanbul/node0/data
modules: admin:1.0 debug:1.0 eth:1.0 istanbul:1.0 miner:1.0 net:1.0 personal:1.0 rpc:1.0 txpool:1.0 web3:1.0
datadir: /Users/username/fromscratchistanbul/node0/data
modules: admin:1.0 debug:1.0 eth:1.0 istanbul:1.0 miner:1.0 net:1.0 personal:1.0 rpc:1.0 txpool:1.0 web3:1.0
```

Check existing validators:
Expand Down Expand Up @@ -248,7 +244,7 @@ description: Adding and removing QBFT validators
PID TTY TIME CMD
10554 ttys000 0:00.11 -bash
21829 ttys001 0:00.03 -bash
9125 ttys002 0:00.93 -bash
9125 ttys002 0:00.93 -bash
36432 ttys002 0:24.48 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22000 --http.api admin,
36433 ttys002 0:23.36 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22001 --http.api admin,
36434 ttys002 0:24.32 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22002 --http.api admin,
Expand Down Expand Up @@ -278,8 +274,8 @@ description: Adding and removing QBFT validators
instance: Geth/v1.8.18-stable-bb88608c(quorum-v2.2.3)/darwin-amd64/go1.10.2
coinbase: 0xc1056df7c02b6f1a353052eaf0533cc7cb743b52
at block: 181 (Tue, 11 Jun 2019 16:36:27 BST)
datadir: /Users/username/fromscratchistanbul/node0/data
modules: admin:1.0 debug:1.0 eth:1.0 istanbul:1.0 miner:1.0 net:1.0 personal:1.0 rpc:1.0 txpool:1.0 web3:1.0
datadir: /Users/username/fromscratchistanbul/node0/data
modules: admin:1.0 debug:1.0 eth:1.0 istanbul:1.0 miner:1.0 net:1.0 personal:1.0 rpc:1.0 txpool:1.0 web3:1.0
```
Run `istanbul.getValidators`:
Expand Down Expand Up @@ -346,7 +342,7 @@ description: Adding and removing QBFT validators
PID TTY TIME CMD
10554 ttys000 0:00.11 -bash
21829 ttys001 0:00.03 -bash
9125 ttys002 0:00.94 -bash
9125 ttys002 0:00.94 -bash
36432 ttys002 0:31.93 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22000 --http.api admin,
36433 ttys002 0:30.75 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22001 --http.api admin,
36434 ttys002 0:31.72 geth --datadir data --nodiscover --istanbul.blockperiod 5 --syncmode full --mine --minerthreads 1 --verbosity 5 --networkid 10 --http --http.addr 0.0.0.0 --http.port 22002 --http.api admin,
Expand Down
3 changes: 0 additions & 3 deletions docs/tutorials/private-network/create-qbft-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ A private network provides a configurable network for testing.
This tutorial walks you through creating an [QBFT](../../configure-and-manage/configure/consensus-protocols/qbft.md) private network
with five nodes.

!!! warning
QBFT is currently an early access feature. It is not recommended for production networks with business critical impact.

!!! important
The steps in this tutorial create an isolated, but not protected or secure, Ethereum private network.
We recommend running the private network behind a properly configured firewall.
Expand Down

0 comments on commit 7e5d29b

Please sign in to comment.