CipherLabs
/
besu-docs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update to sentence case (#780)

Browse Source 
* update to sentence case

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* update to sentence case

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
pull/783/head 21.7.3
rolandtyler 3 years ago committed by GitHub
parent 4677096eb5
commit 4fe168f11e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 225 additions and 225 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 6
      README.md
  2. 2
      docs/Concepts/NetworkID-And-ChainID.md
  3. 10
      docs/Concepts/Permissioning/Onchain-Permissioning.md
  4. 8
      docs/Concepts/Plugins.md
  5. 2
      docs/Concepts/Privacy/Plugin-Privacy.md
  6. 2
      docs/Concepts/Privacy/Private-Transaction-Processing.md
  7. 2
      docs/HowTo/Configure/Alternative-EC-Curves.md
  8. 2
      docs/HowTo/Configure/Configure-HA/Sample-Configuration.md
  9. 2
      docs/HowTo/Configure/Configure-Mining.md
  10. 10
      docs/HowTo/Configure/Configure-TLS.md
  11. 18
      docs/HowTo/Configure/Consensus-Protocols/Add-Validators.md
  12. 6
      docs/HowTo/Configure/Consensus-Protocols/Clique.md
  13. 4
      docs/HowTo/Configure/Consensus-Protocols/IBFT.md
  14. 2
      docs/HowTo/Configure/Consensus-Protocols/QBFT.md
  15. 4
      docs/HowTo/Deploy/Lite-Block-Explorer.md
  16. 2
      docs/HowTo/Deploy/Lite-Network-Monitor.md
  17. 12
      docs/HowTo/Deploy/Production.md
  18. 2
      docs/HowTo/Find-and-Connect/Static-Nodes.md
  19. 2
      docs/HowTo/Get-Started/Installation-Options/Build-from-source.md
  20. 2
      docs/HowTo/Get-Started/Installation-Options/Install-Binaries.md
  21. 2
      docs/HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
  22. 10
      docs/HowTo/Interact/APIs/Authentication.md
  23. 6
      docs/HowTo/Interact/APIs/GraphQL.md
  24. 6
      docs/HowTo/Interact/APIs/RPC-PubSub.md
  25. 10
      docs/HowTo/Interact/APIs/Using-JSON-RPC-API.md
  26. 2
      docs/HowTo/Interact/Client-Libraries/web3js-eea.md
  27. 4
      docs/HowTo/Limit-Access/Local-Permissioning.md
  28. 8
      docs/HowTo/Limit-Access/Updating-Permission-Lists.md
  29. 2
      docs/HowTo/Monitor/Metrics.md
  30. 4
      docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md
  31. 2
      docs/HowTo/Send-Transactions/Revert-Reason.md
  32. 2
      docs/HowTo/Troubleshoot/Troubleshooting.md
  33. 24
      docs/HowTo/Troubleshoot/Use-EVM-Tool.md
  34. 2
      docs/HowTo/Use-Privacy/Access-Private-Transactions.md
  35. 22
      docs/Reference/Evm-Tool.md
  36. 2
      docs/Reference/Projects-Using-Besu.md
  37. 10
      docs/Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
  38. 8
      docs/Tutorials/Permissioning/Upgrade-Permissioning-Contract.md
  39. 8
      docs/index.md
  40. 216
      mkdocs.yml

6
README.md
Unescape View File

@ -12,9 +12,9 @@ This repository only contains the sources for
## Useful links
* [Besu user documentation][Besu User Documentation]
* [Besu Issues](https://github.com/hyperledger/besu/issues)
* [Besu Docs Issues](https://github.com/hyperledger/besu-docs/issues)
* [Besu Wiki](https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu)
* [Besu issues](https://github.com/hyperledger/besu/issues)
* [Besu docs issues](https://github.com/hyperledger/besu-docs/issues)
* [Besu wiki](https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu)
* [How to contribute to the documentation](CONTRIBUTING.md)
* How to contribute to the
[Besu codebase](https://github.com/hyperledger/besu/blob/master/CONTRIBUTING.md).

2
docs/Concepts/NetworkID-And-ChainID.md
Unescape View File

@ -19,7 +19,7 @@ process uses the _chain ID_.
For most networks, including MainNet and the public testnets, the network ID and the chain ID are
the same, with the network ID defaulting to the chain ID, as specified in the genesis file.
!!! example "Chain ID in the Genesis File"
!!! example "Chain ID in the genesis file"
```json
{

10
docs/Concepts/Permissioning/Onchain-Permissioning.md
Unescape View File

@ -18,7 +18,7 @@ source, the blockchain.
!!! note
The permissioning smart contracts and Permissioning Management Dapp are a separate product to
The permissioning smart contracts and permissioning management dapp are a separate product to
Hyperledger Besu, located in the [ConsenSys/permissioning-smart-contracts] repository.
Custom smart contracts and dapps can be implemented to work with onchain permissioning.
@ -45,14 +45,14 @@ repository are:
Ensure that you specify the [permissioning contract interface](../../HowTo/Limit-Access/Specify-Perm-Version.md)
being used when starting Besu.
## Permissioning management Dapp
## Permissioning management dapp
The [Permissioning Management Dapp] provides view and maintain access to the allowlists.
The [permissioning management dapp] provides view and maintain access to the allowlists.
!!! tip
Before v1.2, the management interface used Truffle, now deprecated. For an improved user
experience, use the Dapp.
experience, use the dapp.
### Allowlists
@ -97,5 +97,5 @@ bootnodes to rediscover peers.
<!-- Links -->
[ConsenSys/permissioning-smart-contracts]: https://github.com/ConsenSys/permissioning-smart-contracts
[Permissioning Management Dapp]: ../../Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
[permissioning management dapp]: ../../Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
[`--privacy-marker-transaction-signing-key-file`]: ../../Reference/CLI/CLI-Syntax.md#privacy-marker-transaction-signing-key-file

8
docs/Concepts/Plugins.md
Unescape View File

@ -18,20 +18,20 @@ third-party application. The API exposes data about the following components:
* Logs
* Syncing state.
![Besu Plugin API](../images/Hyperledger-Besu-Plugin-API.png)
![Besu plugin API](../images/Hyperledger-Besu-Plugin-API.png)
The Plugin API provides access to [interfaces](../Reference/Plugin-API-Interfaces.md) allowing you
The plugin API provides access to [interfaces](../Reference/Plugin-API-Interfaces.md) allowing you
to build the plugin.
!!! tip
View the [Plugin API webinar](https://youtu.be/78sa2WuA1rg) for an example of how to build a
View the [plugin API webinar](https://youtu.be/78sa2WuA1rg) for an example of how to build a
plugin.
For more information about the available interfaces, see the
[Plugin API Javadoc](https://javadoc.io/doc/org.hyperledger.besu/plugin-api/latest/index.html).
## Install Plugins
## Install plugins
To allow Besu to access and use the plugin, copy the plugin (`.jar`) to the `plugins` directory.

2
docs/Concepts/Privacy/Plugin-Privacy.md
Unescape View File

@ -1,5 +1,5 @@
---
description: Privacy Plugin
description: Privacy plugin
---
# Privacy plugin

2
docs/Concepts/Privacy/Private-Transaction-Processing.md
Unescape View File

@ -12,7 +12,7 @@ description: Private transaction processing
Processing private transactions involves the following:
* **Precompiled Contract**: A smart contract compiled from the source language to EVM bytecode and
* **Precompiled contract**: A smart contract compiled from the source language to EVM bytecode and
stored by an Ethereum node for later execution.
* **Privacy Marker Transaction**: A public Ethereum transaction with a payload of the enclave key.

2
docs/HowTo/Configure/Alternative-EC-Curves.md
Unescape View File

@ -1,5 +1,5 @@
---
description: Using alternative Elliptic Curves in Besu
description: Using alternative elliptic curves in Besu
---
# Using alternative elliptic curves

2
docs/HowTo/Configure/Configure-HA/Sample-Configuration.md
Unescape View File

@ -1,5 +1,5 @@
---
description: Sample Load Balancers
description: Sample load balancers
---
# Sample load balancer configurations

2
docs/HowTo/Configure/Configure-Mining.md
Unescape View File

@ -69,7 +69,7 @@ get the miner data for a specified block.
* [`eth_submitWork`](../../Reference/API-Methods.md#eth_submitwork) to submit the PoW solution.
Only used when using the `getwork` scheme.
## Hyperledger Besu Mined Blocks
## Hyperledger Besu mined blocks
Hyperledger Besu has successfully mined blocks on the Ropsten testnet, ETC mainnet (uncle block only) and Mordor ETC testnet.
Blocks mined by the Hyperledger Besu team contain the version number used in the block's `extraData` field. The following accounts

10
docs/HowTo/Configure/Configure-TLS.md
Unescape View File

@ -16,16 +16,16 @@ Configure TLS communication from the command line.
* Besu's password-protected PKCS #12 keystore.
* File containing the keystore password
## Configure Client TLS
## Configure client TLS
Allow clients (for example a dApp, curl, or EthSigner) to send and receive secure HTTP JSON-RPCs.
Allow clients (for example a dapp, curl, or EthSigner) to send and receive secure HTTP JSON-RPCs.
**Client Prerequisites**:
* [Configure the client for TLS]
* Client's PKCS #12 keystore information.
### Create the Known Clients File
### Create the known clients file
The known clients file allows clients with self-signed certificates or non-public certificates to
connect to Besu.
@ -80,7 +80,7 @@ The command line:
Set [`--rpc-http-tls-ca-clients-enabled`](../../Reference/CLI/CLI-Syntax.md#rpc-http-tls-ca-clients-enabled)
to `true` to allow access to clients with signed and trusted root CAs.
## Configure Server TLS
## Configure server TLS
Allow Besu to securely communicate with the server (Tessera).
@ -89,7 +89,7 @@ Allow Besu to securely communicate with the server (Tessera).
* [Configure the server to allow TLS communication]
* Server's certificate information.
### Create the Known Servers file
### Create the known servers file
Create a file (in this example, `knownServers`) that lists one or more trusted servers. The file
contents use the format `<hostame>:<port> <hex-string>` where:

18
docs/HowTo/Configure/Consensus-Protocols/Add-Validators.md
Unescape View File

@ -43,7 +43,7 @@ To propose adding a signer to a Clique network, call
[`clique_propose`](../../../Reference/API-Methods.md#clique_propose), specifying the address of the proposed signer and `true`.
A majority of signers must execute the call.
!!! example "JSON-RPC clique_propose Request Example"
!!! example "JSON-RPC `clique_propose` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"clique_propose","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", true], "id":1}' <JSON-RPC-endpoint:port>
@ -57,7 +57,7 @@ signer can begin signing blocks.
To return a list of signers and confirm the addition of a proposed signer, call
[`clique_getSigners`](../../../Reference/API-Methods.md#clique_getsigners).
!!! example "JSON-RPC clique_getSigners Request Example"
!!! example "JSON-RPC `clique_getSigners` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"clique_getSigners","params":["latest"], "id":1}' <JSON-RPC-endpoint:port>
@ -66,7 +66,7 @@ To return a list of signers and confirm the addition of a proposed signer, call
To discard your proposal after confirming the addition of a signer, call
[`clique_discard`](../../../Reference/API-Methods.md#clique_discard) specifying the address of the proposed signer.
!!! example "JSON-RPC clique_discard Request Example"
!!! example "JSON-RPC `clique_discard` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"clique_discard","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73"], "id":1}' <JSON-RPC-endpoint:port>
@ -124,7 +124,7 @@ To propose adding a validator to an IBFT 2.0 network, call
proposed validator and `true`.
A majority of validators must execute the call.
!!! example "JSON-RPC `ibft_proposeValidatorVote` Request Example"
!!! example "JSON-RPC `ibft_proposeValidatorVote` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_proposeValidatorVote","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", true], "id":1}' <JSON-RPC-endpoint:port>
@ -140,7 +140,7 @@ validator to the validator pool and the validator can begin validating blocks.
To return a list of validators and confirm the addition of a proposed validator, use
[`ibft_getValidatorsByBlockNumber`](../../../Reference/API-Methods.md#ibft_getvalidatorsbyblocknumber).
!!! example "JSON-RPC `ibft_getValidatorsByBlockNumber` Request Example"
!!! example "JSON-RPC `ibft_getValidatorsByBlockNumber` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_getValidatorsByBlockNumber","params":["latest"], "id":1}' <JSON-RPC-endpoint:port>
@ -150,7 +150,7 @@ To discard your proposal after confirming the addition of a validator, call
[`ibft_discardValidatorVote`](../../../Reference/API-Methods.md#ibft_discardvalidatorvote),
specifying the address of the proposed validator.
!!! example "JSON-RPC `ibft_discardValidatorVote` Request Example"
!!! example "JSON-RPC `ibft_discardValidatorVote` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"ibft_discardValidatorVote","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73"], "id":1}' <JSON-RPC-endpoint:port>
@ -290,7 +290,7 @@ To propose adding a validator, call
specifying the address of the proposed validator and `true`. A majority of validators must execute
the call.
!!! example "JSON-RPC `qbft_proposeValidatorVote` Request Example"
!!! example "JSON-RPC `qbft_proposeValidatorVote` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_proposeValidatorVote","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73", true], "id":1}' <JSON-RPC-endpoint:port>
@ -307,7 +307,7 @@ adds the proposed validator to the validator pool and the validator can begin va
To return a list of validators and confirm the addition of a proposed validator, use
[`qbft_getValidatorsByBlockNumber`](../../../Reference/API-Methods.md#qbft_getvalidatorsbyblocknumber).
!!! example "JSON-RPC `qbft_getValidatorsByBlockNumber` Request Example"
!!! example "JSON-RPC `qbft_getValidatorsByBlockNumber` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_getValidatorsByBlockNumber","params":["latest"], "id":1}' <JSON-RPC-endpoint:port>
@ -317,7 +317,7 @@ To discard your proposal after confirming the addition of a validator, call
[`qbft_discardValidatorVote`](../../../Reference/API-Methods.md#qbft_discardvalidatorvote),
specifying the address of the proposed validator.
!!! example "JSON-RPC `qbft_discardValidatorVote` Request Example"
!!! example "JSON-RPC `qbft_discardValidatorVote` request example"
```bash
curl -X POST --data '{"jsonrpc":"2.0","method":"qbft_discardValidatorVote","params":["0xFE3B557E8Fb62b89F4916B721be55cEb828dBd73"], "id":1}' <JSON-RPC-endpoint:port>

6
docs/HowTo/Configure/Consensus-Protocols/Clique.md
Unescape View File

@ -22,7 +22,7 @@ genesis file in the `/besu/config/src/main/resources` directory.
A Clique genesis file defines properties specific to Clique.
!!! example "Sample Clique Genesis File"
!!! example "Sample Clique genesis file"
```json
{
@ -65,11 +65,11 @@ The `extraData` field consists of:
* 65 bytes (130 hex characters) for the proposer signature. In the genesis block there is no
initial proposer so the proposer signature is all zeros.
!!! example "One Initial Signer"
!!! example "One initial signer"
![One Initial Signer](../../../images/CliqueOneIntialSigner.png)
!!! example "Two Initial Signers"
!!! example "Two initial signers"
![Two Initial Signers](../../../images/CliqueTwoIntialSigners.png)

4
docs/HowTo/Configure/Consensus-Protocols/IBFT.md
Unescape View File

@ -36,7 +36,7 @@ propagating incorrect information to peers.
To use IBFT 2.0, Besu requires an IBFT 2.0 genesis file. The genesis file defines properties
specific to IBFT 2.0.
!!! example "Sample IBFT 2.0 Genesis File"
!!! example "Sample IBFT 2.0 genesis file"
Example genesis file for a 4 nodes IBFT2 network.
@ -110,7 +110,7 @@ write the validator address and copy it to the `toEncode.json` file, use the
[`public-key export-address`](../../../Reference/CLI/CLI-Subcommands.md#export-address) Besu
subcommand. For example:
!!! example "One Initial Validator in `toEncode.json` file"
!!! example "One initial validator in `toEncode.json` file"
```json
[

2
docs/HowTo/Configure/Consensus-Protocols/QBFT.md
Unescape View File

@ -134,7 +134,7 @@ write the validator address and copy it to the `toEncode.json` file, use the
[`public-key export-address`](../../../Reference/CLI/CLI-Subcommands.md#export-address) Besu
subcommand. For example:
!!! example "One Initial Validator in `toEncode.json` file"
!!! example "One initial validator in `toEncode.json` file"
```json
[

4
docs/HowTo/Deploy/Lite-Block-Explorer.md
Unescape View File

@ -104,9 +104,9 @@ To run the Ethereum Lite Explorer using the Docker image:
A browser window displays the Ethereum Lite Explorer [`http://localhost:3000/`](http://localhost:3000/).
## Use with JSON-RPC Authentication
## Use with JSON-RPC authentication
You can install the [Alethio Explorer Plugin](https://github.com/adetante/explorer-besu-plugin) to use the Alethio
Ethereum Lite Explorer with Hyperledger Besu nodes with
[JSON-RPC Authentication](../Interact/APIs/Authentication.md) enabled. See the
[JSON-RPC authentication](../Interact/APIs/Authentication.md) enabled. See the
[plugin documentation](https://github.com/adetante/explorer-besu-plugin) for how to use the plugin with Node.js and Docker.

2
docs/HowTo/Deploy/Lite-Network-Monitor.md
Unescape View File

@ -45,7 +45,7 @@ EthStats Lite consists of a:
* [Dashboard](https://github.com/Alethio/ethstats-network-dashboard). The dashboard displays
[statistics](#statistics).
## Pre-requisities
## Prerequisites
[Docker](https://docs.docker.com/install/)

12
docs/HowTo/Deploy/Production.md
Unescape View File

@ -1,10 +1,10 @@
---
description: Deploying Hyperledger Besu Permissioning Management Dapp for production
description: Deploying Hyperledger Besu permissioning management dapp for production
---
# Deploying the Hyperledger Besu Permissioning Management Dapp for production
# Deploying the Hyperledger Besu permissioning management dapp for production
To deploy the Permissioning Management Dapp for production:
To deploy the permissioning management dapp for production:
1. Retrieve the most recent release (tarball or zip) from the [projects release page].
@ -29,10 +29,10 @@ To deploy the Permissioning Management Dapp for production:
## Starting a production permissioned network
Follow the procedure as for [Getting Started with Onchain Permissioning], but do not perform the
Follow the procedure as for [Getting started with onchain permissioning], but do not perform the
steps using `yarn` to install, build, and start the development server. Instead, follow the
procedure above to deploy the Permissioning Management Dapp to your Web server.
procedure above to deploy the permissioning management dapp to your Web server.
<!-- Links -->
[projects release page]: https://github.com/PegaSysEng/permissioning-smart-contracts/releases/latest
[Getting Started with Onchain Permissioning]: ../../Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
[Getting started with onchain permissioning]: ../../Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md

2
docs/HowTo/Find-and-Connect/Static-Nodes.md
Unescape View File

@ -2,7 +2,7 @@
description: Configuring static nodes
---
# Static Nodes
# Static nodes
Static nodes are a configured set of trusted nodes. Static nodes are exempt from
[maximum peer](Managing-Peers.md#limiting-peers) and

2
docs/HowTo/Get-Started/Installation-Options/Build-from-source.md
Unescape View File

@ -2,7 +2,7 @@
description: Install or Hyperledger Besu from source
---
# Build from Source
# Build from source
If you want to use the latest development version of Hyperledger Besu or a specific commit,
build from source. Otherwise, use the [binary] or [Docker image] for more stable

2
docs/HowTo/Get-Started/Installation-Options/Install-Binaries.md
Unescape View File

@ -67,7 +67,7 @@ besu --help
Besu requires Java 11+ to compile. Earlier versions are not supported.
!!! note "Linux Open File Limit"
!!! note "Linux open file limit"
If synchronizing to MainNet on Linux or other chains with large data requirements, increase the
maximum number of open files allowed using `ulimit`. If the open files limit is not high

2
docs/HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
Unescape View File

@ -1,5 +1,5 @@
---
title: Hyperledger Besu System Requirements
title: Hyperledger Besu system requirements
description: System requirements to sync and run Besu
---

10
docs/HowTo/Interact/APIs/Authentication.md
Unescape View File

@ -1,5 +1,5 @@
---
description: Hyperledger Besu authentication and Authorization for JSON-RPC
description: Hyperledger Besu authentication and authorization for JSON-RPC
---
# Authentication and authorization for JSON-RPC
@ -38,7 +38,7 @@ Using [public key authentication](#jwt-public-key-authentication) disables the `
The `toml` credentials file defines user details and the JSON-RPC methods they can access.
!!! example "Sample Credentials File"
!!! example "Sample credentials file"
```toml
[Users.username1]
@ -63,7 +63,7 @@ Each user requiring JSON-RPC access the configuration file lists the:
* Optional. The tenant's Tessera public key using `privacyPublicKey`. Only used for
[multi-tenancy](../../../Concepts/Privacy/Multi-Tenancy.md).
!!! example "password hash Subcommand"
!!! example "Password hash subcommand"
```bash
besu password hash --password=pegasys
@ -218,13 +218,13 @@ Specify the `Bearer` in the header.
!!! example
=== "cURL Request with Authentication Placeholders"
=== "cURL Request with authentication placeholders"
```bash
curl -X POST -H 'Authorization: Bearer <JWT_TOKEN>' -d '{"jsonrpc":"2.0","method":"<API_METHOD>","params":[],"id":1}' <JSON-RPC-http-hostname:port>
```
=== "cURL Request with Authentication"
=== "cURL Request with authentication"
```bash
curl -X POST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwZXJtaXNzaW9ucyI6WyIqOioiXSwidXNlcm5hbWUiOiJ1c2VyMiIsImlhdCI6MTU1MDQ2MTQxNiwiZXhwIjoxNTUwNDYxNzE2fQ.WQ1mqpqzRLHaoL8gOSEZPvnRs_qf6j__7A3Sg8vf9RKvWdNTww_vRJF1gjcVy-FFh96AchVnQyXVx0aNUz9O0txt8VN3jqABVWbGMfSk2T_CFdSw5aDjuriCsves9BQpP70Vhj-tseaudg-XU5hCokX0tChbAqd9fB2138zYm5M' -d '{"jsonrpc":"2.0","method":"net_listening","params":[],"id":1}' http://localhost:8545

6
docs/HowTo/Interact/APIs/GraphQL.md
Unescape View File

@ -33,7 +33,7 @@ is `http://127.0.0.1:8547/graphql`.
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{syncing{startingBlock currentBlock highestBlock}}"}' http://localhost:8547/graphql
```
## GraphQL requests with GraphiQL App
## GraphQL requests with GraphiQL app
The third-party tool, [GraphiQL](https://github.com/skevy/graphiql-app), provides a tabbed
interface for editing and testing GraphQL queries and mutations. GraphiQL also provides access to
@ -52,7 +52,7 @@ the [Besu GraphQL schema] from within the app.
!!! example
=== "Pending Transaction Count"
=== "Pending transaction count"
```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{pending {transactionCount}}"}' http://localhost:8547/graphql
@ -72,7 +72,7 @@ the [Besu GraphQL schema] from within the app.
!!! example
=== "Pending Transactions"
=== "Pending transactions"
```bash
curl -X POST -H "Content-Type: application/json" --data '{ "query": "{pending {transactions{hash}}}"}' http://localhost:8547/graphql

6
docs/HowTo/Interact/APIs/RPC-PubSub.md
Unescape View File

@ -9,7 +9,7 @@ description: Using RPC Pub/Sub with Hyperledger Besu WebSockets
Subscribe to events by using either RPC Pub/Sub over WebSockets or
[filters over HTTP](../Filters/Accessing-Logs-Using-JSON-RPC.md).
Use RPC Pub/Sub over WebSockets to wait for events instead of polling for them. For example, Dapps
Use RPC Pub/Sub over WebSockets to wait for events instead of polling for them. For example, dapps
subscribe to logs and receive notifications when a specific event occurs.
Methods specific to RPC Pub/Sub are:
@ -302,7 +302,7 @@ If a chain reorganization occurs, Besu resubmits transactions for inclusion in t
chain. This means the subscription can publish notifications for the same pending transaction more
than once.
!!!example "Transaction Hashes"
!!!example "Transaction hashes"
To subscribe to pending transaction notifications and receive transaction hashes only:
@ -329,7 +329,7 @@ than once.
}
```
!!!example "Transaction Details"
!!!example "Transaction details"
To subscribe to pending transaction notifications and receive transaction details:

10
docs/HowTo/Interact/APIs/Using-JSON-RPC-API.md
Unescape View File

@ -179,19 +179,19 @@ peers. A live node with P2P disabled is always ready.
Use the query parameters `minPeers` and `maxBlocksBehind` to adjust the number of peers required
and the number of blocks tolerance.
=== "Readiness Endpoint"
=== "Readiness endpoint"
```bash
http://<JSON-RPC-HTTP-endpoint:port>/readiness
```
=== "curl Request Example"
=== "curl request example"
```bash
curl -v 'http://localhost:8545/readiness'
```
=== "Query Parameters Example"
=== "Query parameters example"
```bash
curl -v 'http://localhost:8545/readiness?minPeers=0&maxBlocksBehind=10'
@ -201,13 +201,13 @@ and the number of blocks tolerance.
The liveness check requires the JSON-RPC server to be up.
=== "Liveness Endpoint"
=== "Liveness endpoint"
```bash
http://<JSON-RPC-HTTP-endpoint:port>/liveness
```
=== "curl Request Example"
=== "curl request example"
```bash
curl -v 'http://localhost:8545/liveness'

2
docs/HowTo/Interact/Client-Libraries/web3js-eea.md
Unescape View File

@ -52,7 +52,7 @@ To deploy a private contract, you need the contract binary. You can use
[Solidity](https://solidity.readthedocs.io/en/develop/using-the-compiler.html) to get the
contract binary.
!!! example "Deploying a Contract with sendRawTransaction"
!!! example "Deploying a contract with sendRawTransaction"
```js
const contractOptions = {

4
docs/HowTo/Limit-Access/Local-Permissioning.md
Unescape View File

@ -53,7 +53,7 @@ To view the nodes allowlist, use the
On-chain permissioning is under development. On-chain permissioning uses one on-chain
nodes allowlist.
!!! example "An example of different node allowlists"
!!! example "Example of different node allowlists"
Node 1 Allowlist = [Node 2, Node 3]
@ -203,7 +203,7 @@ options.
[Docker image](../Get-Started/Installation-Options/Run-Docker-Image.md). Use a bind mount to
[specify a permissions configuration file with Docker].
!!! example "Sample Permissions Configuration File"
!!! example "Sample permissions configuration file"
```toml
accounts-allowlist=["0xb9b81ee349c3807e46bc71aa2632203c5b462032", "0xb9b81ee349c3807e46bc71aa2632203c5b462034"]

8
docs/HowTo/Limit-Access/Updating-Permission-Lists.md
Unescape View File

@ -8,14 +8,14 @@ description: Updating Hyperledger Besu onchain allowlists
To add a node to the Hyperledger Besu nodes allowlist:
1. On the _Nodes_ tab of the Permissioning Management Dapp, click the
1. On the _Nodes_ tab of the permissioning management dapp, click the
_Add Node_ button. The Add Node window displays.
1. Enter the [enode URL](../../Concepts/Node-Keys.md#enode-url) of the node you are adding and
click the _Add Node_ button.
To remove a node from the nodes allowlist:
1. On the _Nodes_ tab of the Permissioning Management Dapp, hover over the row of the
1. On the _Nodes_ tab of the permissioning management dapp, hover over the row of the
node you are removing. A trash can displays.
1. Click on the trash can.
@ -42,14 +42,14 @@ To remove a node from the nodes allowlist:
To add an account to the accounts allowlist:
1. On the _Accounts_ tab of the Permissioning Management Dapp, click the
1. On the _Accounts_ tab of the permissioning management dapp, click the
_Add Account_ button. The add Account Window displays.
1. Enter the account address in the _Account Address_ field and click the
_Add Account_ button.
To remove an account from the accounts allowlist:
1. On the _Accounts_ tab of the Permissioning Management Dapp, hover over the row of
1. On the _Accounts_ tab of the permissioning management dapp, hover over the row of
the account you are removing. A trash can displays.
1. Click on the trash can.

2
docs/HowTo/Monitor/Metrics.md
Unescape View File

@ -9,7 +9,7 @@ use the [`--metrics-enabled`](../../Reference/CLI/CLI-Syntax.md#metrics-enabled)
Use [Grafana](https://grafana.com/) to visualize the collected data.
See the sample [Besu Grafana dashboard](https://grafana.com/dashboards/10273).
The Besu Example Networks have [monitoring with Prometheus and Grafana configured].
The Besu example networks have [monitoring with Prometheus and Grafana configured].
!!! example

4
docs/HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md
Unescape View File

@ -29,7 +29,7 @@ The `gas` and `gasPrice` specified when sending a private transaction are used b
[`eea_sendRawTransaction`](../../Reference/API-Methods.md#eea_sendrawtransaction) distributes the
private transaction to the participating nodes, and signs and submits the
[privacy marker transaction], as described in
[Private Transaction Processing](../../Concepts/Privacy/Private-Transaction-Processing.md).
[Private transaction processing](../../Concepts/Privacy/Private-Transaction-Processing.md).
!!! note
If sending more than one transaction for mining in the same block (that is, you are not waiting
@ -116,7 +116,7 @@ to send [concurrent private transactions](Concurrent-Private-Transactions.md).
}
```
## EEA-compliant or Besu-extended Privacy
## EEA-compliant or Besu-extended privacy
To create an [EEA-compliant private transaction], specify `privateFor` when creating the signed
transaction passed as an input parameter to

2
docs/HowTo/Send-Transactions/Revert-Reason.md
Unescape View File

@ -151,7 +151,7 @@ As described in the [Solidity documentation], the revert reason is an ABI-encode
## Dapp support
Client libraries, such as web3j, do not support extracting the revert reason from the transaction
receipt. To extract the revert reason your Dapp must interact directly with Besu using a custom
receipt. To extract the revert reason your dapp must interact directly with Besu using a custom
JSON -> Object converter.
<!-- Links -->

2
docs/HowTo/Troubleshoot/Troubleshooting.md
Unescape View File

@ -128,7 +128,7 @@ means at some stage it was syncing.
The easiest solution in this scenario is to restart fast synchronization to obtain a new
pivot block.
## Homebrew Repair
## Homebrew repair
When upgrading Besu, you might get the following error:

24
docs/HowTo/Troubleshoot/Use-EVM-Tool.md
Unescape View File

@ -1,18 +1,18 @@
---
description: Hyperledger Besu EVM Tool
description: Hyperledger Besu EVM tool
---
# EVM Tool
# EVM tool
The Besu EVM Tool is a CLI program that executes arbitrary EVM programs and Ethereum State Tests
The Besu EVM tool is a CLI program that executes arbitrary EVM programs and Ethereum State Tests
outside the context of an operating node. Use the EVM tool for benchmarking and fuzz testing.
## Getting the EVM Tool
## Getting the EVM tool
The Besu EVM Tool does not have a standard zip file distribution. To use, you need to either
The Besu EVM tool does not have a standard zip file distribution. To use, you need to either
build from the source repository or use a pre-published docker image.
### Building from Source
### Building from source
To build from source, run the following from the root of the Besu repository:
@ -31,7 +31,7 @@ ethereum/evmtool/build/install/evmtool/bin/evm <evmtool options>
### Executing with Docker
To run the Besu EVM Tool in a container:
To run the Besu EVM tool in a container:
```bash
docker run -rm <docker options> hyperledger/besu-evmtool:develop <evmtool options>
@ -50,12 +50,12 @@ docker run -rm <docker options> hyperledger/besu-evmtool:develop <evmtool option
The `latest` tag is the latest released version of Besu, starting with 1.5.3. The `develop` tag
is the current main branch code that will go into a future release version of Besu.
## EVM Tool Run Options
## EVM tool run options
The first mode of the EVM Tool runs an arbitrary EVM and is invoked without an extra command. [Command
Line Options](../../Reference/Evm-Tool.md) specify the code and other contextual information.
The first mode of the EVM tool runs an arbitrary EVM and is invoked without an extra command. [Command
line options](../../Reference/Evm-Tool.md) specify the code and other contextual information.
The EVM Tool also has a [`state-test` sub command](../../Reference/Evm-Tool.md#evm-tool-state-test-options)
The EVM tool also has a [`state-test` sub command](../../Reference/Evm-Tool.md#evm-tool-state-test-options)
that allows the Ethereum State Tests to be evaluated. Most of the options from EVM execution do not apply.
The [EVM Tool reference](../../Reference/Evm-Tool.md) provides more information on both modes.
The [EVM tool reference](../../Reference/Evm-Tool.md) provides more information on both modes.

2
docs/HowTo/Use-Privacy/Access-Private-Transactions.md
Unescape View File

@ -28,7 +28,7 @@ receipt for the:
The transaction receipt includes a `status` indicating if the transaction failed (`0x0`), succeeded (`0x1`), or
was invalid (`0x2`).
!!! example "Private Transaction Failure Example"
!!! example "Private transaction failure example"
To deploy a private contract, you submit a transaction using
[`eea_sendRawTransaction`](../Send-Transactions/Creating-Sending-Private-Transactions.md). If

22
docs/Reference/Evm-Tool.md
Unescape View File

@ -1,15 +1,15 @@
---
description: Hyperledger Besu EVM Tool Reference
description: Hyperledger Besu EVM tool reference
---
# EVM Tool Reference
# EVM tool reference
Options for running:
* [Arbitrary EVM programs](#run-options)
* [Ethereum State Tests](#state-test-options).
## Run Options
## Run options
The first mode of the EVM tool runs an arbitrary EVM and is invoked without an extra command. Command Line
Options specify the code and other contextual information.
@ -186,7 +186,7 @@ For memory heavy scripts, setting this option may reduce the volume of JSON outp
The Besu Genesis file to use when evaluating the EVM.
Most useful are the `alloc` items that set up accounts and their stored memory states.
For a complete description of this file see [Genesis File Items](Config-Items.md).
For a complete description of this file see [Genesis file items](Config-Items.md).
`--prestate` is a deprecated alternative option name.
@ -297,12 +297,12 @@ The block number to evaluate the code against.
Used to ensure that the EVM is evaluating the code against the correct fork, or to specify the
specific world state when running with `rocksdb` for `key-value-storage`.
## State Test Options
## State test options
The `state-test` sub command allows the Ethereum State Tests to be evaluated.
Most of the options from EVM execution do not apply.
### Applicable Options
### Applicable options
#### `json`
@ -328,30 +328,30 @@ state test executed.
If you use command arguments, you can list one or more state tests.
All of the state tests are evaluated in the order they are specified.
=== "Docker Example"
=== "Docker example"
```bash
docker run --rm -v ${PWD}:/opt/referencetests hyperledger/besu-evmtool:develop --json state-test /opt/referencetests/GeneralStateTests/stExample/add11.json
```
=== "CLI Example"
=== "CLI example"
```bash
evm --json state-test stExample/add11.json
```
### Using Standard Input
### Using standard input
If no reference tests are passed in using the command line, the EVM Tool loads one complete JSON object
from standard input and executes that state test.
=== "Docker Example"
=== "Docker example"
```bash
docker run --rm -i hyperledger/besu-evmtool:develop --json state-test < stExample/add11.json
```
=== "CLI Example"
=== "CLI example"
```bash
evm --json state-test < stExample/add11.json

2
docs/Reference/Projects-Using-Besu.md
Unescape View File

@ -4,7 +4,7 @@ description: Projects using Besu.
# Projects using Besu
## Block Explorers
## Block explorers
- [Blockscout](https://github.com/blockscout/blockscout#readme) is a Besu-compatible blockchain explorer for inspecting
and analyzing Ethereum-based blockchains.

10
docs/Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
Unescape View File

@ -274,20 +274,20 @@ The migration logs the addresses of the Admin and Rules contracts.
The account that deploys the contracts is automatically an [admin account].
### 9. Start the Permissioning Management Dapp
### 9. Start the permissioning management dapp
!!! note
Production environments require a Web server to
[host the Permissioning Management Dapp](../../HowTo/Deploy/Production.md).
[host the permissioning management dapp](../../HowTo/Deploy/Production.md).
1. In the `permissioning-smart-contracts` directory, start the webserver serving the Dapp:
1. In the `permissioning-smart-contracts` directory, start the Web server serving the dapp:
```bash
yarn start
```
The Dapp displays at [`http://localhost:3000`](http://localhost:3000).
The dapp displays at [`http://localhost:3000`](http://localhost:3000).
1. Ensure MetaMask connects to your local node (by default [`http://localhost:8545`](http://localhost:8545)).
@ -341,7 +341,7 @@ The command line specifies:
### 12. Add nodes to the allowlist
In the [Permissioning Management Dapp started earlier](#9-start-the-permissioning-management-dapp)
In the [permissioning management dapp started earlier](#9-start-the-permissioning-management-dapp)
add [Node-1, Node-2, and Node-3 to the allowlist].
<!-- Links -->

8
docs/Tutorials/Permissioning/Upgrade-Permissioning-Contract.md
Unescape View File

@ -84,15 +84,15 @@ yarn truffle migrate --reset
Copy the `NodeIngress` and `AccountIngress` contract addresses which are displayed in the
output. These must be specified when restarting the nodes.
### 5. Start the Permissioning Management Dapp
### 5. Start the permissioning management dapp
1. In the `permissioning-smart-contracts` directory, start the webserver serving the Dapp:
1. In the `permissioning-smart-contracts` directory, start the Web server serving the dapp:
```bash
yarn start
```
The Dapp displays at [`http://localhost:3000`](http://localhost:3000).
The dapp displays at [`http://localhost:3000`](http://localhost:3000).
### 6. Restart Besu nodes
@ -115,7 +115,7 @@ In the command, the following options have been updated:
### 7. Add nodes to the allowlist
In the [Permissioning Management Dapp started earlier](#5-start-the-permissioning-management-dapp)
In the [permissioning management dapp started earlier](#5-start-the-permissioning-management-dapp)
add the [nodes to the allowlist].
<!--link-->

8
docs/index.md
Unescape View File

@ -1,11 +1,11 @@
---
title: Hyperledger Besu Enterprise Ethereum Client
title: Hyperledger Besu Enterprise Ethereum client
description: Besu is an open-source Enterprise 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.
---
# Besu Enterprise Ethereum Client
# Besu Enterprise Ethereum client
## What is Hyperledger Besu?
@ -28,7 +28,7 @@ supports Pub/Sub. The API supports typical Ethereum functionalities such as:
* Ether mining
* Smart contract development
* Decentralized application (Dapp) development.
* Decentralized application (dapp) development.
## New to Enterprise Ethereum?
@ -39,7 +39,7 @@ Learn more about [use cases for Enterprise Ethereum](https://consensys.net/block
## What does Besu support?
The Besu client supports common smart contract and Dapp development, deployment, and operational
The Besu client supports common smart contract and dapp development, deployment, and operational
use cases, using tools such as [Truffle](http://truffleframework.com/),
[Remix](https://github.com/ethereum/remix), and [web3j](https://web3j.io/). The client supports
common JSON-RPC API methods such as `eth`, `net`, `web3`, `debug`, and `miner`.

216
mkdocs.yml
Unescape View File

@ -59,52 +59,52 @@ extra_javascript:
- assets/javascripts/zoomify.min.js
nav:
- How To:
- Get Started with Besu:
- System Requirements:
- Private Network: HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
- Public Network: HowTo/Get-Started/System-Requirements/System-Requirements-Public.md
- How to:
- Get started with Besu:
- System requirements:
- Private network: HowTo/Get-Started/System-Requirements/System-Requirements-Private.md
- Public network: HowTo/Get-Started/System-Requirements/System-Requirements-Public.md
- Install Besu:
- Options: HowTo/Get-Started/Installation-Options/Options.md
- Run Besu from Docker Image: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
- Install Binary Distribution: HowTo/Get-Started/Installation-Options/Install-Binaries.md
- Build from Source: HowTo/Get-Started/Installation-Options/Build-from-source.md
- Run Besu from Docker image: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
- Install binary distribution: HowTo/Get-Started/Installation-Options/Install-Binaries.md
- Build from source: HowTo/Get-Started/Installation-Options/Build-from-source.md
- Start Besu: HowTo/Get-Started/Starting-node.md
- Configure Besu:
- Consensus Protocols:
- Consensus protocols:
- Clique: HowTo/Configure/Consensus-Protocols/Clique.md
- IBFT 2.0: HowTo/Configure/Consensus-Protocols/IBFT.md
- QBFT: HowTo/Configure/Consensus-Protocols/QBFT.md
- Quorum IBFT 1.0 Network: HowTo/Configure/Consensus-Protocols/QuorumIBFT.md
- Add and Remove Validators: HowTo/Configure/Consensus-Protocols/Add-Validators.md
- Create Besu Genesis File: HowTo/Configure/Genesis-File.md
- Specify Options in a Configuration File: HowTo/Configure/Using-Configuration-File.md
- Configure a Free Gas Network: HowTo/Configure/FreeGas.md
- Quorum IBFT 1.0 network: HowTo/Configure/Consensus-Protocols/QuorumIBFT.md
- Add and remove validators: HowTo/Configure/Consensus-Protocols/Add-Validators.md
- Create Besu genesis file: HowTo/Configure/Genesis-File.md
- Specify options in a configuration file: HowTo/Configure/Using-Configuration-File.md
- Configure a free gas network: HowTo/Configure/FreeGas.md
- Configure TLS: HowTo/Configure/Configure-TLS.md
- High Availability:
- Configure High Availability of APIs: HowTo/Configure/Configure-HA/High-Availability.md
- Sample Load Balancer Configurations: HowTo/Configure/Configure-HA/Sample-Configuration.md
- Predeploy a Contract in the Genesis File: HowTo/Configure/Contracts-in-Genesis.md
- Configure Mining: HowTo/Configure/Configure-Mining.md
- Pass JVM Options: HowTo/Configure/Passing-JVM-Options.md
- Alternative Elliptic Curves: HowTo/Configure/Alternative-EC-Curves.md
- Interact with Node:
- High availability:
- Configure high availability of APIs: HowTo/Configure/Configure-HA/High-Availability.md
- Sample load balancer configurations: HowTo/Configure/Configure-HA/Sample-Configuration.md
- Predeploy a contract in the genesis file: HowTo/Configure/Contracts-in-Genesis.md
- Configure mining: HowTo/Configure/Configure-Mining.md
- Pass JVM options: HowTo/Configure/Passing-JVM-Options.md
- Alternative elliptic curves: HowTo/Configure/Alternative-EC-Curves.md
- Interact with node:
- Besu APIs:
- Access Besu APIs: HowTo/Interact/APIs/API.md
- Use JSON-RPC API over HTTP or WebSockets: HowTo/Interact/APIs/Using-JSON-RPC-API.md
- Use RPC Pub/Sub API over WebSockets: HowTo/Interact/APIs/RPC-PubSub.md
- Use GraphQL over HTTP: HowTo/Interact/APIs/GraphQL.md
- Authenticate JSON-RPC Requests: HowTo/Interact/APIs/Authentication.md
- Client Libraries:
- Use the web3js-eea Client Library: HowTo/Interact/Client-Libraries/web3js-eea.md
- Authenticate JSON-RPC requests: HowTo/Interact/APIs/Authentication.md
- Client libraries:
- Use the web3js-eea client library: HowTo/Interact/Client-Libraries/web3js-eea.md
- Filters:
- Access Logs Using JSON-RPC API: HowTo/Interact/Filters/Accessing-Logs-Using-JSON-RPC.md
- Find and Connect to Peers:
- Specify Bootnodes: HowTo/Find-and-Connect/Bootnodes.md
- Configure Static Nodes: HowTo/Find-and-Connect/Static-Nodes.md
- Configure Ports for Access: HowTo/Find-and-Connect/Configuring-Ports.md
- Manage Peers: HowTo/Find-and-Connect/Managing-Peers.md
- Specify NAT Method: HowTo/Find-and-Connect/Specifying-NAT.md
- Access logs using JSON-RPC API: HowTo/Interact/Filters/Accessing-Logs-Using-JSON-RPC.md
- Find and connect to peers:
- Specify bootnodes: HowTo/Find-and-Connect/Bootnodes.md
- Configure static nodes: HowTo/Find-and-Connect/Static-Nodes.md
- Configure ports for access: HowTo/Find-and-Connect/Configuring-Ports.md
- Manage peers: HowTo/Find-and-Connect/Managing-Peers.md
- Specify NAT method: HowTo/Find-and-Connect/Specifying-NAT.md
- Monitor nodes:
- Use metrics: HowTo/Monitor/Metrics.md
- Use Elastic Stack: HowTo/Monitor/Elastic-Stack.md
@ -112,118 +112,118 @@ nav:
- Use Splunk: HowTo/Monitor/Splunk-Enterprise.md
- Use OpenTelemetry: HowTo/Monitor/OpenTelemetry-Collector.md
- Configure logging: HowTo/Monitor/Logging.md
- Send Transactions:
- Use Wallets for Key Management: HowTo/Send-Transactions/Account-Management.md
- Create and Send Transactions: HowTo/Send-Transactions/Transactions.md
- Create and Send Private Transactions: HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md
- Send Concurrent Private Transactions: HowTo/Send-Transactions/Concurrent-Private-Transactions.md
- Include Revert Reason: HowTo/Send-Transactions/Revert-Reason.md
- Limit Access to Node:
- Use Local Permissioning: HowTo/Limit-Access/Local-Permissioning.md
- Update Onchain Allowlists: HowTo/Limit-Access/Updating-Permission-Lists.md
- Specify Interface Version: HowTo/Limit-Access/Specify-Perm-Version.md
- Use Privacy Features:
- Use EEA-compliant Privacy: HowTo/Use-Privacy/EEA-Compliant.md
- Use Besu-extended Privacy: HowTo/Use-Privacy/Privacy.md
- Create and Manage Privacy Groups: HowTo/Use-Privacy/Create-Manage-Privacy-Groups.md
- Sign Privacy Marker Transactions: HowTo/Use-Privacy/Sign-Privacy-Marker-Transactions.md
- Access Private and Privacy Marker Transactions: HowTo/Use-Privacy/Access-Private-Transactions.md
- Send transactions:
- Use wallets for key management: HowTo/Send-Transactions/Account-Management.md
- Create and send transactions: HowTo/Send-Transactions/Transactions.md
- Create and send private transactions: HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md
- Send concurrent private transactions: HowTo/Send-Transactions/Concurrent-Private-Transactions.md
- Include revert reason: HowTo/Send-Transactions/Revert-Reason.md
- Limit access to node:
- Use local permissioning: HowTo/Limit-Access/Local-Permissioning.md
- Update onchain allowlists: HowTo/Limit-Access/Updating-Permission-Lists.md
- Specify interface version: HowTo/Limit-Access/Specify-Perm-Version.md
- Use privacy features:
- Use EEA-compliant privacy: HowTo/Use-Privacy/EEA-Compliant.md
- Use Besu-extended privacy: HowTo/Use-Privacy/Privacy.md
- Create and manage privacy groups: HowTo/Use-Privacy/Create-Manage-Privacy-Groups.md
- Sign privacy marker transactions: HowTo/Use-Privacy/Sign-Privacy-Marker-Transactions.md
- Access private and privacy marker transactions: HowTo/Use-Privacy/Access-Private-Transactions.md
- Run Tessera with Besu: HowTo/Use-Privacy/Run-Tessera-With-Besu.md
- Use Flexible Privacy: HowTo/Use-Privacy/Use-FlexiblePrivacy.md
- Use GoQuorum-compatibile Privacy: HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy.md
- Deploy for Production:
- Deploy to the Cloud: HowTo/Deploy/Cloud.md
- Use Ansible to Deploy Besu: HowTo/Deploy/Ansible.md
- Use Kubernetes to Deploy a Private Network: HowTo/Deploy/Kubernetes.md
- Configure Bootnodes: HowTo/Deploy/Bootnodes.md
- Configure Validators: HowTo/Deploy/Validators.md
- Deploy Permissioning Management Dapp: HowTo/Deploy/Production.md
- Use flexible privacy: HowTo/Use-Privacy/Use-FlexiblePrivacy.md
- Use GoQuorum-compatibile privacy: HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy.md
- Deploy for production:
- Deploy to the cloud: HowTo/Deploy/Cloud.md
- Use Ansible to deploy Besu: HowTo/Deploy/Ansible.md
- Use Kubernetes to deploy a private network: HowTo/Deploy/Kubernetes.md
- Configure bootnodes: HowTo/Deploy/Bootnodes.md
- Configure validators: HowTo/Deploy/Validators.md
- Deploy permissioning management dapp: HowTo/Deploy/Production.md
- Use Alethio Lite Explorer: HowTo/Deploy/Lite-Block-Explorer.md
- Use Alethio EthStats Lite Network Monitor: HowTo/Deploy/Lite-Network-Monitor.md
- Backup and Restore: HowTo/Backup/Backup.md
- Use Alethio EthStats Lite network monitor: HowTo/Deploy/Lite-Network-Monitor.md
- Backup and restore: HowTo/Backup/Backup.md
- Upgrade:
- Upgrade Node: HowTo/Upgrade/Upgrade-Node.md
- Upgrade Protocol: HowTo/Upgrade/Upgrade-Protocol.md
- Develop Dapps on Besu:
- Upgrade node: HowTo/Upgrade/Upgrade-Node.md
- Upgrade protocol: HowTo/Upgrade/Upgrade-Protocol.md
- Develop dapps on Besu:
- Use Truffle: HowTo/Develop-Dapps/Truffle.md
- Use Client Libraries: HowTo/Develop-Dapps/Client-Libraries.md
- Use client libraries: HowTo/Develop-Dapps/Client-Libraries.md
- Troubleshoot:
- Use EVM tool: HowTo/Troubleshoot/Use-EVM-Tool.md
- Collect Java runtime data: HowTo/Troubleshoot/Java-Flight-Recording.md
- Trace Transactions: HowTo/Troubleshoot/Trace-Transactions.md
- Solve Common Problems: HowTo/Troubleshoot/Troubleshooting.md
- Trace transactions: HowTo/Troubleshoot/Trace-Transactions.md
- Solve common problems: HowTo/Troubleshoot/Troubleshooting.md
- Tutorials:
- Examples:
- Private Network Example: Tutorials/Examples/Private-Network-Example.md
- Private Network Example for Private Transactions: Tutorials/Examples/Privacy-Example.md
- Private network example: Tutorials/Examples/Private-Network-Example.md
- Private network example for private transactions: Tutorials/Examples/Privacy-Example.md
- 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:
- Create a private network:
- 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
- Adding and Removing IBFT 2.0 Validators: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
- Adding and removing IBFT 2.0 validators: Tutorials/Private-Network/Adding-removing-IBFT-validators.md
- Permissioning:
- Create a Permissioned Network: Tutorials/Permissioning/Create-Permissioned-Network.md
- Get Started with Onchain Permissioning: Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
- Create a permissioned network: Tutorials/Permissioning/Create-Permissioned-Network.md
- Get started with onchain permissioning: Tutorials/Permissioning/Getting-Started-Onchain-Permissioning.md
- Upgrade the permissioning contract: Tutorials/Permissioning/Upgrade-Permissioning-Contract.md
- Smart Contracts and Transactions:
- Deploy a Contract: Tutorials/Contracts/Deploying-Contracts.md
- Interact with a Deployed Contract: Tutorials/Contracts/Calling-Contract-Functions.md
- Transfer Account Funds: Tutorials/Contracts/Account-Funds-Transfers.md
- Smart contracts and transactions:
- Deploy a contract: Tutorials/Contracts/Deploying-Contracts.md
- Interact with a deployed contract: Tutorials/Contracts/Calling-Contract-Functions.md
- Transfer account funds: Tutorials/Contracts/Account-Funds-Transfers.md
- Privacy:
- Create a Privacy-Enabled Network: Tutorials/Privacy/Configuring-Privacy.md
- Configure a Multi-Tenant Network: Tutorials/Privacy/Configuring-Multi-Tenancy.md
- Use web3js-eea Multinode Example: Tutorials/Privacy/web3js-eea-Multinode-example.md
- Create a privacy-enabled network: Tutorials/Privacy/Configuring-Privacy.md
- Configure a multi-tenant network: Tutorials/Privacy/Configuring-Multi-Tenancy.md
- Use web3js-eea multinode example: Tutorials/Privacy/web3js-eea-Multinode-example.md
- Developer Quickstart: Tutorials/Developer-Quickstart.md
- Concepts:
- Architecture: Concepts/ArchitectureOverview.md
- Consensus Protocols:
- Consensus protocols:
- Overview: Concepts/Consensus-Protocols/Overview-Consensus.md
- Comparing PoA Consensus Protocols: Concepts/Consensus-Protocols/Comparing-PoA.md
- Comparing PoA consensus protocols: Concepts/Consensus-Protocols/Comparing-PoA.md
- Plugins: Concepts/Plugins.md
- Privacy:
- Overview: Concepts/Privacy/Privacy-Overview.md
- Private Transactions: Concepts/Privacy/Private-Transactions.md
- Privacy Groups: Concepts/Privacy/Privacy-Groups.md
- Processing Private Transactions: Concepts/Privacy/Private-Transaction-Processing.md
- Flexible Privacy Groups: Concepts/Privacy/Flexible-PrivacyGroups.md
- Multi-Tenancy: Concepts/Privacy/Multi-Tenancy.md
- Private transactions: Concepts/Privacy/Private-Transactions.md
- Privacy groups: Concepts/Privacy/Privacy-Groups.md
- Processing private transactions: Concepts/Privacy/Private-Transaction-Processing.md
- Flexible privacy groups: Concepts/Privacy/Flexible-PrivacyGroups.md
- Multi-tenancy: Concepts/Privacy/Multi-Tenancy.md
- Privacy plugin: Concepts/Privacy/Plugin-Privacy.md
- Permissioning:
- Overview: Concepts/Permissioning/Permissioning-Overview.md
- Onchain Permissioning: Concepts/Permissioning/Onchain-Permissioning.md
- Onchain permissioning: Concepts/Permissioning/Onchain-Permissioning.md
- Permissioning plugin: Concepts/Permissioning/Plugin-Permissioning.md
- Protocol Upgrades: Concepts/Protocol-Upgrades.md
- Protocol upgrades: Concepts/Protocol-Upgrades.md
- Pruning: Concepts/Pruning.md
- Transactions:
- Transaction Types: Concepts/Transactions/Transaction-Types.md
- Transaction Pool: Concepts/Transactions/Transaction-Pool.md
- Validating Transactions: Concepts/Transactions/Transaction-Validation.md
- Transaction types: Concepts/Transactions/Transaction-Types.md
- Transaction pool: Concepts/Transactions/Transaction-Pool.md
- Validating transactions: Concepts/Transactions/Transaction-Validation.md
- Monitoring: Concepts/Monitoring.md
- Events and Logs: Concepts/Events-and-Logs.md
- TLS Communication: Concepts/TLS.md
- Node Types: Concepts/Node-Types.md
- Node Keys: Concepts/Node-Keys.md
- Network vs Node Configuration: Concepts/Network-vs-Node.md
- Network ID and Chain ID: Concepts/NetworkID-And-ChainID.md
- Events and logs: Concepts/Events-and-Logs.md
- TLS communication: Concepts/TLS.md
- Node types: Concepts/Node-Types.md
- Node keys: Concepts/Node-Keys.md
- Network vs node configuration: Concepts/Network-vs-Node.md
- Network ID and chain ID: Concepts/NetworkID-And-ChainID.md
- Mining: Concepts/Mining.md
- Reference:
- Besu Command Line:
- Besu command line:
- Options: Reference/CLI/CLI-Syntax.md
- Subcommands: Reference/CLI/CLI-Subcommands.md
- Besu API Methods: Reference/API-Methods.md
- Besu API Objects: Reference/API-Objects.md
- Transaction Trace Types: Reference/Trace-Types.md
- Genesis File Items: Reference/Config-Items.md
- web3js-eaa Reference: https://consensys.github.io/web3js-eea/latest/
- Plugin API Interfaces: Reference/Plugin-API-Interfaces.md
- Accounts for Testing: Reference/Accounts-for-Testing.md
- EVM Tool: Reference/Evm-Tool.md
- Projects Using Besu: Reference/Projects-Using-Besu.md
- Security Disclosure Policy: Reference/Responsible-Disclosure.md
- Blog Posts and Webinars: Reference/Resources.md
- Besu API methods: Reference/API-Methods.md
- Besu API objects: Reference/API-Objects.md
- Transaction trace types: Reference/Trace-Types.md
- Genesis file items: Reference/Config-Items.md
- web3js-eaa reference: https://consensys.github.io/web3js-eea/latest/
- Plugin API interfaces: Reference/Plugin-API-Interfaces.md
- Accounts for testing: Reference/Accounts-for-Testing.md
- EVM tool: Reference/Evm-Tool.md
- Projects using Besu: Reference/Projects-Using-Besu.md
- Security disclosure policy: Reference/Responsible-Disclosure.md
- Blog posts and webinars: Reference/Resources.md
markdown_extensions:
- toc:

Write Preview
Loading…
Cancel
Save