From da6ed9c41f39f0849b4b0d10b3434008056dba25 Mon Sep 17 00:00:00 2001 From: rolandtyler <88206508+rolandtyler@users.noreply.github.com> Date: Tue, 21 Dec 2021 09:40:47 -0500 Subject: [PATCH] Update "proof of" usage (#907) Signed-off-by: Roland Tyler --- docs/Concepts/Consensus-Protocols/Comparing-PoA.md | 12 ++++++------ .../Consensus-Protocols/Overview-Consensus.md | 10 +++++----- docs/HowTo/Configure/Consensus-Protocols/Clique.md | 4 ++-- docs/HowTo/Configure/Consensus-Protocols/IBFT.md | 4 ++-- docs/HowTo/Configure/Consensus-Protocols/QBFT.md | 4 ++-- .../Permissioning/Create-Permissioned-Network.md | 4 ++-- .../Tutorials/Private-Network/Create-IBFT-Network.md | 6 +++--- .../Private-Network/Create-Private-Clique-Network.md | 8 ++++---- .../Private-Network/Create-Private-Network.md | 4 ++-- .../Tutorials/Private-Network/Create-QBFT-Network.md | 6 +++--- docs/index.md | 2 +- mkdocs.yml | 2 +- 12 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/Concepts/Consensus-Protocols/Comparing-PoA.md b/docs/Concepts/Consensus-Protocols/Comparing-PoA.md index 2ce5b53d8a3..94f74d1921d 100644 --- a/docs/Concepts/Consensus-Protocols/Comparing-PoA.md +++ b/docs/Concepts/Consensus-Protocols/Comparing-PoA.md @@ -1,15 +1,15 @@ --- -description: Besu Proof of Authority consensus protocols comparison +description: Besu proof of authority consensus protocols comparison --- -# Comparing Proof of Authority consensus protocols +# Comparing proof of authority consensus protocols -Besu implements the Clique, IBFT 2.0, and QBFT Proof of Authority consensus protocols. Proof of -Authority consensus protocols work when participants know each other and there is a level of trust +Besu implements the Clique, IBFT 2.0, and QBFT proof of authority consensus protocols. Proof of +authority consensus protocols work when participants know each other and there is a level of trust between them. For example, in a permissioned consortium network. -Proof of Authority consensus protocols have faster block times and a much greater transaction -throughput than the Ethash Proof of Work consensus protocol used on the Ethereum MainNet. +Proof of authority consensus protocols have faster block times and a much greater transaction +throughput than the Ethash proof of work consensus protocol used on the Ethereum MainNet. In Clique, IBFT 2.0, or QBFT, a group of nodes in the network act as signers (Clique) or validators (IBFT 2.0 and QBFT). The existing nodes in the signer/validator pool vote to add nodes to or remove diff --git a/docs/Concepts/Consensus-Protocols/Overview-Consensus.md b/docs/Concepts/Consensus-Protocols/Overview-Consensus.md index 52777ca6b62..bf7ac2ebdef 100644 --- a/docs/Concepts/Consensus-Protocols/Overview-Consensus.md +++ b/docs/Concepts/Consensus-Protocols/Overview-Consensus.md @@ -6,11 +6,11 @@ description: Besu consensus protocols Besu implements the following consensus protocols: -* Ethash (Proof of Work) -* [Clique](../../HowTo/Configure/Consensus-Protocols/Clique.md) (Proof of Authority) -* [IBFT 2.0](../../HowTo/Configure/Consensus-Protocols/IBFT.md) (Proof of Authority) -* [Quorum IBFT 1.0](../../HowTo/Configure/Consensus-Protocols/QuorumIBFT.md) (Proof of Authority). -* [QBFT](../../HowTo/Configure/Consensus-Protocols/QBFT.md) (Proof of Authority). +* Ethash (proof of work) +* [Clique](../../HowTo/Configure/Consensus-Protocols/Clique.md) (proof of authority) +* [IBFT 2.0](../../HowTo/Configure/Consensus-Protocols/IBFT.md) (proof of authority) +* [Quorum IBFT 1.0](../../HowTo/Configure/Consensus-Protocols/QuorumIBFT.md) (proof of authority). +* [QBFT](../../HowTo/Configure/Consensus-Protocols/QBFT.md) (proof of authority). !!! warning diff --git a/docs/HowTo/Configure/Consensus-Protocols/Clique.md b/docs/HowTo/Configure/Consensus-Protocols/Clique.md index dcb2068faa4..52d5bce01bf 100644 --- a/docs/HowTo/Configure/Consensus-Protocols/Clique.md +++ b/docs/HowTo/Configure/Consensus-Protocols/Clique.md @@ -1,12 +1,12 @@ --- -description: Hyperledger Besu Clique Proof-of-Authority (PoA) consensus protocol implementation +description: Hyperledger Besu Clique proof of authority (PoA) consensus protocol implementation path: blob/master/config/src/main/resources/ source: rinkeby.json --- # Clique -Besu implements the Clique Proof-of-Authority (PoA) consensus protocol. The Rinkeby testnet uses +Besu implements the Clique proof of authority (PoA) consensus protocol. The Rinkeby testnet uses Clique and private networks can also use Clique. In Clique networks, approved accounts, known as signers, validate transactions and blocks. Signers diff --git a/docs/HowTo/Configure/Consensus-Protocols/IBFT.md b/docs/HowTo/Configure/Consensus-Protocols/IBFT.md index 343f02eda99..5d4108ee2a1 100644 --- a/docs/HowTo/Configure/Consensus-Protocols/IBFT.md +++ b/docs/HowTo/Configure/Consensus-Protocols/IBFT.md @@ -1,10 +1,10 @@ --- -description: Hyperledger Besu IBFT 2.0 Proof-of-Authority (PoA) consensus protocol implementation +description: Hyperledger Besu IBFT 2.0 proof of authority (PoA) consensus protocol implementation --- # IBFT 2.0 -Besu implements the IBFT 2.0 Proof-of-Authority (PoA) consensus protocol. Private networks can use +Besu implements the IBFT 2.0 proof of authority (PoA) consensus protocol. Private networks can use IBFT 2.0. !!! warning diff --git a/docs/HowTo/Configure/Consensus-Protocols/QBFT.md b/docs/HowTo/Configure/Consensus-Protocols/QBFT.md index ca2dc1af05f..b1e33061cc3 100644 --- a/docs/HowTo/Configure/Consensus-Protocols/QBFT.md +++ b/docs/HowTo/Configure/Consensus-Protocols/QBFT.md @@ -1,10 +1,10 @@ --- -description: Hyperledger Besu QBFT Proof-of-Authority (PoA) consensus protocol implementation +description: Hyperledger Besu QBFT proof of authority (PoA) consensus protocol implementation --- # QBFT -Hyperledger Besu implements the QBFT Proof-of-Authority (PoA) consensus protocol. Private networks +Hyperledger Besu implements the QBFT proof of authority (PoA) consensus protocol. Private networks can use QBFT. !!! warning diff --git a/docs/Tutorials/Permissioning/Create-Permissioned-Network.md b/docs/Tutorials/Permissioning/Create-Permissioned-Network.md index c85328f4318..654c9b923cd 100644 --- a/docs/Tutorials/Permissioning/Create-Permissioned-Network.md +++ b/docs/Tutorials/Permissioning/Create-Permissioned-Network.md @@ -5,7 +5,7 @@ description: Hyperledger Besu create a permissioned network # Create a permissioned network The following steps set up a permissioned network with local node and account permissions. The network -uses the [Clique Proof of Authority consensus protocol]. +uses the [Clique proof of authority consensus protocol]. !!!important @@ -392,5 +392,5 @@ window. To restart the permissioned network in the future, start from [step 5](#5-start-node-1). -[Clique Proof of Authority consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/Clique.md +[Clique proof of authority consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/Clique.md [Private network example tutorial]: ../Examples/Private-Network-Example.md#create-a-transaction-using-metamask diff --git a/docs/Tutorials/Private-Network/Create-IBFT-Network.md b/docs/Tutorials/Private-Network/Create-IBFT-Network.md index d3dc054c991..e41b9f45579 100644 --- a/docs/Tutorials/Private-Network/Create-IBFT-Network.md +++ b/docs/Tutorials/Private-Network/Create-IBFT-Network.md @@ -2,10 +2,10 @@ description: Hyperledger Besu private network using the IBFT 2.0 (Proof of Authority) consensus protocol --- -# Create a private network using the IBFT 2.0 (Proof of Authority) consensus protocol +# Create a private network using the IBFT 2.0 (proof of authority) consensus protocol A private network provides a configurable network for testing. This private network uses the -[IBFT 2.0 (Proof of Authority) consensus protocol](../../HowTo/Configure/Consensus-Protocols/IBFT.md). +[IBFT 2.0 (proof of authority) consensus protocol](../../HowTo/Configure/Consensus-Protocols/IBFT.md). !!!important @@ -372,7 +372,7 @@ When finished using the private network, stop all nodes using ++ctrl+c++ in each [6. Start First Node as Bootnode](#6-start-the-first-node-as-the-bootnode). -[IBFT 2.0 (Proof of Authority)consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/IBFT.md +[IBFT 2.0 (proof of authority)consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/IBFT.md [private network example tutorial]: ../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask diff --git a/docs/Tutorials/Private-Network/Create-Private-Clique-Network.md b/docs/Tutorials/Private-Network/Create-Private-Clique-Network.md index 6ea0ce7a33d..af57b9a5ba7 100644 --- a/docs/Tutorials/Private-Network/Create-Private-Clique-Network.md +++ b/docs/Tutorials/Private-Network/Create-Private-Clique-Network.md @@ -1,11 +1,11 @@ --- -description: Hyperledger Besu private network using the Clique (Proof of Authority) consensus protocol +description: Hyperledger Besu private network using the Clique (proof of authority) consensus protocol --- -# Create a private network using the Clique (Proof of Authority) consensus protocol +# Create a private network using the Clique (proof of authority) consensus protocol A private network provides a configurable network for testing. This private network uses the -[Clique (Proof of Authority) consensus protocol]. +[Clique (proof of authority) consensus protocol]. !!!important @@ -268,6 +268,6 @@ When finished using the private network, stop all nodes using ++ctrl+c++ in each [4. Start First Node as Bootnode](#4-start-first-node-as-bootnode). -[Clique (Proof of Authority) consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/Clique.md +[Clique (proof of authority) consensus protocol]: ../../HowTo/Configure/Consensus-Protocols/Clique.md [Clique API to add]: ../../HowTo/Configure/Consensus-Protocols/Clique.md#adding-and-removing-signers [private network example tutorial]: ../Examples/Private-Network-Example.md#creating-a-transaction-using-metamask diff --git a/docs/Tutorials/Private-Network/Create-Private-Network.md b/docs/Tutorials/Private-Network/Create-Private-Network.md index 4b342b0efff..e13d77ba6ef 100644 --- a/docs/Tutorials/Private-Network/Create-Private-Network.md +++ b/docs/Tutorials/Private-Network/Create-Private-Network.md @@ -1,8 +1,8 @@ --- -description: Hyperledger Besu private network using Ethash (Proof of Work) Consensus Protocol tutorial +description: Hyperledger Besu private network using Ethash (proof of work) Consensus Protocol tutorial --- -# Create a private network using the Ethash (Proof of Work) consensus protocol +# Create a private network using the Ethash (proof of work) consensus protocol A private network provides a configurable network for testing. By configuring a low difficulty and enabling mining, this allows for fast block creation. diff --git a/docs/Tutorials/Private-Network/Create-QBFT-Network.md b/docs/Tutorials/Private-Network/Create-QBFT-Network.md index cdf8990c252..bc51568a5d2 100644 --- a/docs/Tutorials/Private-Network/Create-QBFT-Network.md +++ b/docs/Tutorials/Private-Network/Create-QBFT-Network.md @@ -1,8 +1,8 @@ --- -description: Hyperledger Besu private network using the QBFT (Proof of Authority) consensus protocol +description: Hyperledger Besu private network using the QBFT (proof of authority) consensus protocol --- -# Create a private network using the QBFT (Proof of Authority) consensus protocol +# Create a private network using the QBFT (proof of authority) consensus protocol !!! warning @@ -10,7 +10,7 @@ description: Hyperledger Besu private network using the QBFT (Proof of Authority business critical impact. A private network provides a configurable network for testing. This private network uses the -[QBFT (Proof of Authority) consensus protocol](../../HowTo/Configure/Consensus-Protocols/QBFT.md). +[QBFT (proof of authority) consensus protocol](../../HowTo/Configure/Consensus-Protocols/QBFT.md). The QBFT network in this tutorial implements the [block header validator selection method] to manage validators. For a tutorial on how to implement the [contract validator selection method], follow the diff --git a/docs/index.md b/docs/index.md index a65d6f01275..1af2da4c29e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ description: Besu is an open-source Enterprise Ethereum client developed under t Hyperledger Besu is an open-source Ethereum client developed under the Apache 2.0 license and written in Java. It runs on the Ethereum public network, private networks, and test networks such -as Rinkeby, Ropsten, and Görli. Besu implements Proof of Work (Ethash) and Proof of Authority (IBFT +as Rinkeby, Ropsten, and Görli. Besu implements proof of work (Ethash) and proof of authority (IBFT 2.0, Clique, and QBFT) consensus mechanisms. You can use Besu to develop enterprise applications requiring secure, high-performance transaction diff --git a/mkdocs.yml b/mkdocs.yml index 6687efe3129..66a4841ffd2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -163,7 +163,7 @@ nav: - Configure Kubernetes mode in NAT Manager : Tutorials/Examples/Nat-Manager-Kubernetes.md - Deploy on Microsoft Azure: Tutorials/Examples/Private-Network-Example-Azure.md - Create a private network: - - Using Ethash (Pow): Tutorials/Private-Network/Create-Private-Network.md + - Using Ethash (PoW): Tutorials/Private-Network/Create-Private-Network.md - Using Clique (PoA): Tutorials/Private-Network/Create-Private-Clique-Network.md - Using IBFT 2.0 (PoA): Tutorials/Private-Network/Create-IBFT-Network.md - Using QBFT (PoA): Tutorials/Private-Network/Create-QBFT-Network.md