Skip to content

Commit

Permalink
Hyperledger Besu -> Besu (#1684)
Browse files Browse the repository at this point in the history
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
  • Loading branch information
macfarla committed Sep 13, 2024
1 parent 1873802 commit cc21fd1
Show file tree
Hide file tree
Showing 87 changed files with 160 additions and 160 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
For changes see the Hyperledger Besu
For changes see the Besu
[CHANGELOG.md](https://github.com/hyperledger/besu/blob/master/CHANGELOG.md)
2 changes: 1 addition & 1 deletion docs/private-networks/concepts/permissioning/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

# Permissioning plugin

You can define complex [permissioning](index.md) solutions by building a plugin that extends Hyperledger Besu functionality.
You can define complex [permissioning](index.md) solutions by building a plugin that extends Besu functionality.

The plugin API provides a `PermissioningService` interface that currently supports connection permissioning and message permissioning.

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/concepts/pki.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Public key infrastructure (PKI) support is an early access feature, and function

:::

Hyperledger Besu's public key infrastructure allows you to use certificates issued by a trusted authority to manage node and account identities in the following ways:
Besu's public key infrastructure allows you to use certificates issued by a trusted authority to manage node and account identities in the following ways:

- Node permissioning - Only authorized nodes can connect to other nodes in the network using TLS for the P2P communication.
- Block proposal permissioning - Only blocks proposed by authorized validators are accepted.
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/concepts/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:

# Plugins

You can extend Hyperledger Besu functionality by building Java plugins or using existing open source Besu plugins. Use the Plugin API to take data from any Besu network, public or permissioned, and feed it into an application or system.
You can extend Besu functionality by building Java plugins or using existing open source Besu plugins. Use the Plugin API to take data from any Besu network, public or permissioned, and feed it into an application or system.

For example, create a plugin to add more monitoring functionality or stream event data to a third-party application. The API exposes data about the following components:

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/concepts/privacy/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 5

# Privacy plugin

You can define your own strategy for private transactions by building a plugin that extends Hyperledger Besu functionality.
You can define your own strategy for private transactions by building a plugin that extends Besu functionality.

The plugin can take many forms, but it must provide Besu with a private transaction when required.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Install binary distribution
description: Install or upgrade Hyperledger Besu from binary distribution
description: Install or upgrade Besu from binary distribution
sidebar_position: 3
tags:
- private networks
Expand All @@ -17,7 +17,7 @@ tags:

:::caution

Hyperledger Besu supports:
Besu supports:

- MacOS High Sierra 10.13 or later versions.
- Java 21+. You can install Java using `brew install openjdk@21`. Alternatively, you can manually install the [Java JDK](https://www.oracle.com/java/technologies/downloads).
Expand Down
8 changes: 4 additions & 4 deletions docs/private-networks/get-started/install/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation options
description: Options for getting started with Hyperledger Besu
description: Options for getting started with Besu
sidebar_position: 1
tags:
- private networks
Expand All @@ -17,12 +17,12 @@ You can also install the following:

## 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 versions.
If you want to use the latest development version of Besu or a specific commit, build from source. Otherwise, use the [binary] or [Docker image] for more stable versions.

View the [Hyperledger Wiki] for instructions to install Hyperledger Besu from source.
View the [Wiki] for instructions to install Besu from source.

<!-- link -->

[Hyperledger Wiki]: https://wiki.hyperledger.org/display/BESU/Building+from+source
[Wiki]: https://wiki.hyperledger.org/display/BESU/Building+from+source
[binary]: binary-distribution.md
[Docker image]: run-docker-image.md
4 changes: 2 additions & 2 deletions docs/private-networks/get-started/install/run-docker-image.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Run Besu from Docker image
description: Run Hyperledger Besu using the official docker image
description: Run Besu using the official docker image
sidebar_position: 2
tags:
- private networks
---

# Run Besu from a Docker image

Hyperledger Besu provides a Docker image to run a Besu node in a Docker container.
Besu provides a Docker image to run a Besu node in a Docker container.

Use this Docker image to run a single Besu node without installing Besu.

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/configure/bootnodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To find peers, configure one or more bootnodes. To configure a specific set of p

:::note Mainnet and public testnets

For Mainnet and the Sepolia and Holesky testnets, Hyperledger Besu has an internal list of enode URLs and uses this list automatically when you specify the [`--network`](../../../public-networks/reference/cli/options.md#network) option.
For Mainnet and the Sepolia and Holesky testnets, Besu has an internal list of enode URLs and uses this list automatically when you specify the [`--network`](../../../public-networks/reference/cli/options.md#network) option.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/configure/consensus/clique.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Clique
description: Hyperledger Besu Clique Proof-of-Authority (PoA) consensus protocol implementation
description: Besu Clique Proof-of-Authority (PoA) consensus protocol implementation
sidebar_position: 4
path: blob/master/config/src/main/resources/
source: rinkeby.json
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/configure/consensus/ibft.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: IBFT 2.0
description: Hyperledger Besu IBFT 2.0 proof of authority (PoA) consensus protocol implementation
description: Besu IBFT 2.0 proof of authority (PoA) consensus protocol implementation
sidebar_position: 3
tags:
- private networks
Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/configure/consensus/qbft.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: QBFT
description: Hyperledger Besu QBFT proof of authority (PoA) consensus protocol implementation
description: Besu QBFT proof of authority (PoA) consensus protocol implementation
sidebar_position: 2
tags:
- private networks
Expand All @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Configure QBFT consensus

Hyperledger Besu implements the QBFT proof of authority (PoA) [consensus protocol](index.md). QBFT is the recommended enterprise-grade consensus protocol for private networks.
Besu implements the QBFT proof of authority (PoA) [consensus protocol](index.md). QBFT is the recommended enterprise-grade consensus protocol for private networks.

In QBFT networks, approved accounts, known as validators, validate transactions and blocks. Validators take turns to create the next block. Before inserting the block onto the chain, a super-majority (greater than or equal to 2/3) of validators must first sign the block.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:

# Configure client and server TLS

Hyperledger Besu supports TLS for client and server communication. For example, you can configure TLS for communication between [Web3Signer](https://docs.web3signer.consensys.net/concepts/tls) and Besu, and Besu and [Tessera](https://docs.tessera.consensys.net/HowTo/Configure/TLS/).
Besu supports TLS for client and server communication. For example, you can configure TLS for communication between [Web3Signer](https://docs.web3signer.consensys.net/concepts/tls) and Besu, and Besu and [Tessera](https://docs.tessera.consensys.net/HowTo/Configure/TLS/).

The following diagram displays an example client and server TLS configuration.

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/deploy/ansible.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
sidebar_position: 2
title: Use Ansible
description: Deploying Hyperledger Besu with Ansible role on Galaxy
description: Deploying Besu with Ansible role on Galaxy
tags:
- private networks
---

# Deploy Besu with Ansible

To deploy Besu using Ansible, use the [Hyperledger Besu role](https://galaxy.ansible.com/consensys/hyperledger_besu) published on Galaxy.
To deploy Besu using Ansible, use the [Besu role](https://galaxy.ansible.com/consensys/hyperledger_besu) published on Galaxy.

For more information, see the "Read Me" button on the [Ansible Galaxy Besu page](https://galaxy.ansible.com/consensys/hyperledger_besu).

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/deploy/kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 3
title: Use Kubernetes
description: Deploying Hyperledger Besu with Kubernetes
description: Deploying Besu with Kubernetes
tags:
- private networks
---
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/elastic-stack.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use Elastic Stack
sidebar_position: 3
description: Using Elastic Stack (ELK) with Hyperledger Besu
description: Using Elastic Stack (ELK) with Besu
tags:
- private networks
---
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ You can also use the following monitoring tools in private networks:
- [OpenTelemetry](opentelemetry.md)
- [Chainlens Explorer](chainlens.md)

For an overview of monitoring Hyperledger Besu, view [this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be).
For an overview of monitoring Besu, view [this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be).
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/loki.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use Grafana Loki
sidebar_position: 2
description: Using Grafana Loki log management platform with Hyperledger Besu
description: Using Grafana Loki log management platform with Besu
tags:
- private networks
---
Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/monitor/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ import TabItem from '@theme/TabItem';

# Use OpenTelemetry

You can use the OpenTelemetry monitoring and tracing service to gather node metrics and traces. To enable OpenTelemetry to access Hyperledger Besu, use the [`--metrics-enabled`](../../../public-networks/reference/cli/options.md#metrics-enabled) and [`--metrics-protocol=opentelemetry`](../../../public-networks/reference/cli/options.md#metrics-protocol) options. Use [Splunk](https://splunk.com) to visualize the collected data. A [Besu Sync example](https://github.com/splunk/splunk-connect-for-ethereum/tree/master/examples/besu-sync) is available.
You can use the OpenTelemetry monitoring and tracing service to gather node metrics and traces. To enable OpenTelemetry to access Besu, use the [`--metrics-enabled`](../../../public-networks/reference/cli/options.md#metrics-enabled) and [`--metrics-protocol=opentelemetry`](../../../public-networks/reference/cli/options.md#metrics-protocol) options. Use [Splunk](https://splunk.com) to visualize the collected data. A [Besu Sync example](https://github.com/splunk/splunk-connect-for-ethereum/tree/master/examples/besu-sync) is available.

:::tip

Use OpenTelemetry to monitor the sync time of your Besu node and show where time is spent internally and over the JSON-RPC interface.

[This office hours recording](https://wiki.hyperledger.org/display/BESU/2021-01-19+Office+Hours+Notes) shows examples of monitoring Hyperledger Besu.
[This office hours recording](https://wiki.hyperledger.org/display/BESU/2021-01-19+Office+Hours+Notes) shows examples of monitoring Besu.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/quorum-hibernate.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use Quorum Hibernate
sidebar_position: 4
description: Use Quorum Hibernate with Hyperledger Besu
description: Use Quorum Hibernate with Besu
tags:
- private networks
---
Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/monitor/splunk.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Use Splunk
sidebar_position: 5
toc_max_heading_level: 2
description: Send Hyperledger Besu logs to Splunk
description: Send Besu logs to Splunk
tags:
- private networks
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Send concurrent private transactions
description: Creating and sending concurrent private transactions with Hyperledger Besu
description: Creating and sending concurrent private transactions with Besu
sidebar_position: 2
tags:
- private networks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create and send private transactions
description: Creating and sending private transactions with Hyperledger Besu
description: Creating and sending private transactions with Besu
sidebar_position: 1
tags:
- private networks
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Include revert reason
description: Including revert reason in transactions with Hyperledger Besu
description: Including revert reason in transactions with Besu
sidebar_position: 3
tags:
- private networks
Expand Down Expand Up @@ -40,7 +40,7 @@ contract VendingMachine {

## Enable revert reason

Use the [`--revert-reason-enabled`](../../../public-networks/reference/cli/options.md#revert-reason-enabled) command line option to include the revert reason in the transaction receipt and the [`trace`](../../../public-networks/reference/trace-types.md#trace) response in Hyperledger Besu.
Use the [`--revert-reason-enabled`](../../../public-networks/reference/cli/options.md#revert-reason-enabled) command line option to include the revert reason in the transaction receipt and the [`trace`](../../../public-networks/reference/trace-types.md#trace) response in Besu.

:::caution

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-permissioning/local.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Use local permissioning
sidebar_position: 1
description: Hyperledger Besu local permissioning
description: Besu local permissioning
tags:
- private networks
---
Expand Down Expand Up @@ -32,7 +32,7 @@ Local permissioning doesn't check that the node using the permissions configurat

### Specify bootnodes in the allowlist

The nodes permissions list must include the [bootnodes](../configure/bootnodes.md) or Hyperledger Besu doesn't start with node permissions enabled.
The nodes permissions list must include the [bootnodes](../configure/bootnodes.md) or Besu doesn't start with node permissions enabled.

If you start Besu with specified bootnodes and have node permissioning enabled:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Access private and privacy marker transactions
description: Methods for accessing and managing private transactions and privacy groups in Hyperledger Besu
description: Methods for accessing and managing private transactions and privacy groups in Besu
sidebar_position: 6
tags:
- private networks
---

# Access private and privacy marker transactions

A Hyperledger Besu private transaction creates a [privacy marker transaction](../../concepts/privacy/private-transactions/processing.md) and the private transaction itself.
A Besu private transaction creates a [privacy marker transaction](../../concepts/privacy/private-transactions/processing.md) and the private transaction itself.

## Transaction receipts

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/besu-extended.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Use Besu-extended privacy
description: Hyperledger Besu-extended privacy
description: Besu-extended privacy
sidebar_position: 2
tags:
- private networks
---

# Use Besu-extended privacy

Hyperledger Besu provides an extended implementation of privacy allowing you to [create a privacy group for a set of participants](../../concepts/privacy/privacy-groups.md). You must specify the privacy group ID when sending private transactions.
Besu provides an extended implementation of privacy allowing you to [create a privacy group for a set of participants](../../concepts/privacy/privacy-groups.md). You must specify the privacy group ID when sending private transactions.

To enable the [`PRIV` API methods](../../reference/api/index.md#priv-methods), use the [`--rpc-http-api`](../../../public-networks/reference/cli/options.md#rpc-http-api) or [`--rpc-ws-api`](../../../public-networks/reference/cli/options.md#rpc-ws-api) command line options.

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/eea-compliant.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Use EEA-compliant privacy
description: Hyperledger Besu JSON-RPC methods to use for EEA-compliant privacy
description: Besu JSON-RPC methods to use for EEA-compliant privacy
sidebar_position: 1
tags:
- private networks
---

# Use EEA-compliant privacy

When using Hyperledger Besu [EEA-compliant privacy](../../concepts/privacy/privacy-groups.md), the group of nodes specified by `privateFrom` and `privateFor` form a privacy group, to which Tessera assigns a unique privacy group ID.
When using Besu [EEA-compliant privacy](../../concepts/privacy/privacy-groups.md), the group of nodes specified by `privateFrom` and `privateFor` form a privacy group, to which Tessera assigns a unique privacy group ID.

To enable the [`EEA` API methods](../../reference/api/index.md#eea-methods), use the [`--rpc-http-api`](../../../public-networks/reference/cli/options.md#rpc-http-api) or [`--rpc-ws-api`](../../../public-networks/reference/cli/options.md#rpc-ws-api) command line options.

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/privacy-groups.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Create and manage privacy groups
description: Create and manage privacy groups with Hyperledger Besu
description: Create and manage privacy groups with Besu
sidebar_position: 4
tags:
- private networks
---

# Create and manage privacy groups

Hyperledger Besu-extended privacy provides JSON-RPC API methods for creating and managing privacy groups:
Besu-extended privacy provides JSON-RPC API methods for creating and managing privacy groups:

- [`priv_createPrivacyGroup`](../../reference/api/index.md#priv_createprivacygroup)
- [`priv_findPrivacyGroup`](../../reference/api/index.md#priv_findprivacygroup)
Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/sign-pmts.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Sign privacy marker transactions
description: How to sign a privacy marker transaction with Hyperledger Besu
description: How to sign a privacy marker transaction with Besu
sidebar_position: 7
tags:
- private networks
---

# Sign privacy marker transactions

You can sign privacy marker transactions (PMTs) with either a random key or a specified key. To sign privacy marker transactions with a specified private key, use [`--privacy-marker-transaction-signing-key-file`](../../reference/cli/options.md#privacy-marker-transaction-signing-key-file) when starting Hyperledger Besu.
You can sign privacy marker transactions (PMTs) with either a random key or a specified key. To sign privacy marker transactions with a specified private key, use [`--privacy-marker-transaction-signing-key-file`](../../reference/cli/options.md#privacy-marker-transaction-signing-key-file) when starting Besu.

:::note

Expand Down
4 changes: 2 additions & 2 deletions docs/private-networks/how-to/use-privacy/tessera.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Run Tessera with Besu
description: Running ConsenSys Quorum Tessera with Hyperledger Besu
description: Running ConsenSys Quorum Tessera with Besu
sidebar_position: 3
tags:
- private networks
---

# Run Tessera with Besu

To enable [privacy functionality](../../concepts/privacy/index.md) in production systems, [Tessera](https://docs.tessera.consensys.net/) must be [highly available](#high-availability) and [run in a separate instance](#separate-instances) to Hyperledger Besu.
To enable [privacy functionality](../../concepts/privacy/index.md) in production systems, [Tessera](https://docs.tessera.consensys.net/) must be [highly available](#high-availability) and [run in a separate instance](#separate-instances) to Besu.

![Besu-Tessera-High-Availability](../../../assets/images/Besu-Tessera-High-Availability.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/use-privacy/web3js-quorum.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ npm install web3js-quorum
## Initialize the web3js-quorum client

Initialize your client where `<JSON-RPC HTTP endpoint>` is the JSON-RPC HTTP endpoint of your
Hyperledger Besu node.
Besu node.
Specified by the [`--rpc-http-host`](../../../public-networks/reference/cli/options.md#rpc-http-host)
and [`--rpc-http-port`](../../../public-networks/reference/cli/options.md#rpc-http-port) command
line options.
Expand Down
Loading

0 comments on commit cc21fd1

Please sign in to comment.