diff --git a/CHANGELOG.md b/CHANGELOG.md index 0b7ec913939..a30ef1febf0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/docs/private-networks/concepts/permissioning/plugin.md b/docs/private-networks/concepts/permissioning/plugin.md index 8c8caed18b4..9ccdff04fe1 100644 --- a/docs/private-networks/concepts/permissioning/plugin.md +++ b/docs/private-networks/concepts/permissioning/plugin.md @@ -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. diff --git a/docs/private-networks/concepts/pki.md b/docs/private-networks/concepts/pki.md index 97cec02eab0..f1c5b2171f8 100644 --- a/docs/private-networks/concepts/pki.md +++ b/docs/private-networks/concepts/pki.md @@ -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. diff --git a/docs/private-networks/concepts/plugins.md b/docs/private-networks/concepts/plugins.md index 70ee78f7ca4..df3d4c5074d 100644 --- a/docs/private-networks/concepts/plugins.md +++ b/docs/private-networks/concepts/plugins.md @@ -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: diff --git a/docs/private-networks/concepts/privacy/plugin.md b/docs/private-networks/concepts/privacy/plugin.md index 591637206e1..ce3f574068c 100644 --- a/docs/private-networks/concepts/privacy/plugin.md +++ b/docs/private-networks/concepts/privacy/plugin.md @@ -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. diff --git a/docs/private-networks/get-started/install/binary-distribution.md b/docs/private-networks/get-started/install/binary-distribution.md index 9629f0ee2cc..e95ce612d7b 100644 --- a/docs/private-networks/get-started/install/binary-distribution.md +++ b/docs/private-networks/get-started/install/binary-distribution.md @@ -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 @@ -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). diff --git a/docs/private-networks/get-started/install/index.md b/docs/private-networks/get-started/install/index.md index 5c6fb933f52..88244886c46 100644 --- a/docs/private-networks/get-started/install/index.md +++ b/docs/private-networks/get-started/install/index.md @@ -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 @@ -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. -[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 diff --git a/docs/private-networks/get-started/install/run-docker-image.md b/docs/private-networks/get-started/install/run-docker-image.md index 277adfe21d2..c85ebbf055f 100644 --- a/docs/private-networks/get-started/install/run-docker-image.md +++ b/docs/private-networks/get-started/install/run-docker-image.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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. diff --git a/docs/private-networks/how-to/configure/bootnodes.md b/docs/private-networks/how-to/configure/bootnodes.md index 5e6442791d4..d0e02ec6b14 100644 --- a/docs/private-networks/how-to/configure/bootnodes.md +++ b/docs/private-networks/how-to/configure/bootnodes.md @@ -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. ::: diff --git a/docs/private-networks/how-to/configure/consensus/clique.md b/docs/private-networks/how-to/configure/consensus/clique.md index cc9ab899393..39ceb2ef02e 100644 --- a/docs/private-networks/how-to/configure/consensus/clique.md +++ b/docs/private-networks/how-to/configure/consensus/clique.md @@ -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 diff --git a/docs/private-networks/how-to/configure/consensus/ibft.md b/docs/private-networks/how-to/configure/consensus/ibft.md index 4be07b7a73a..01a8b0c0003 100644 --- a/docs/private-networks/how-to/configure/consensus/ibft.md +++ b/docs/private-networks/how-to/configure/consensus/ibft.md @@ -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 diff --git a/docs/private-networks/how-to/configure/consensus/qbft.md b/docs/private-networks/how-to/configure/consensus/qbft.md index 03ceefb4599..9ee41430370 100644 --- a/docs/private-networks/how-to/configure/consensus/qbft.md +++ b/docs/private-networks/how-to/configure/consensus/qbft.md @@ -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 @@ -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. diff --git a/docs/private-networks/how-to/configure/tls/client-and-server.md b/docs/private-networks/how-to/configure/tls/client-and-server.md index 370745da964..5e57133b79b 100644 --- a/docs/private-networks/how-to/configure/tls/client-and-server.md +++ b/docs/private-networks/how-to/configure/tls/client-and-server.md @@ -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. diff --git a/docs/private-networks/how-to/deploy/ansible.md b/docs/private-networks/how-to/deploy/ansible.md index c8b9b82d5c1..c7747e4bd5c 100644 --- a/docs/private-networks/how-to/deploy/ansible.md +++ b/docs/private-networks/how-to/deploy/ansible.md @@ -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). diff --git a/docs/private-networks/how-to/deploy/kubernetes.md b/docs/private-networks/how-to/deploy/kubernetes.md index fe1a95bec41..6faaa432e2f 100644 --- a/docs/private-networks/how-to/deploy/kubernetes.md +++ b/docs/private-networks/how-to/deploy/kubernetes.md @@ -1,7 +1,7 @@ --- sidebar_position: 3 title: Use Kubernetes -description: Deploying Hyperledger Besu with Kubernetes +description: Deploying Besu with Kubernetes tags: - private networks --- diff --git a/docs/private-networks/how-to/monitor/elastic-stack.md b/docs/private-networks/how-to/monitor/elastic-stack.md index b74dd929dfd..5967beff30a 100644 --- a/docs/private-networks/how-to/monitor/elastic-stack.md +++ b/docs/private-networks/how-to/monitor/elastic-stack.md @@ -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 --- diff --git a/docs/private-networks/how-to/monitor/index.md b/docs/private-networks/how-to/monitor/index.md index 08ff29aede2..35d726e60dd 100644 --- a/docs/private-networks/how-to/monitor/index.md +++ b/docs/private-networks/how-to/monitor/index.md @@ -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). diff --git a/docs/private-networks/how-to/monitor/loki.md b/docs/private-networks/how-to/monitor/loki.md index eabe6f0667b..cc8e42322ed 100644 --- a/docs/private-networks/how-to/monitor/loki.md +++ b/docs/private-networks/how-to/monitor/loki.md @@ -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 --- diff --git a/docs/private-networks/how-to/monitor/opentelemetry.md b/docs/private-networks/how-to/monitor/opentelemetry.md index bdc90c326d2..0f5b85ec12a 100644 --- a/docs/private-networks/how-to/monitor/opentelemetry.md +++ b/docs/private-networks/how-to/monitor/opentelemetry.md @@ -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. ::: diff --git a/docs/private-networks/how-to/monitor/quorum-hibernate.md b/docs/private-networks/how-to/monitor/quorum-hibernate.md index 2d6b6139db0..9eb390e4e5c 100644 --- a/docs/private-networks/how-to/monitor/quorum-hibernate.md +++ b/docs/private-networks/how-to/monitor/quorum-hibernate.md @@ -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 --- diff --git a/docs/private-networks/how-to/monitor/splunk.md b/docs/private-networks/how-to/monitor/splunk.md index 22b946aa470..b76d976d70a 100644 --- a/docs/private-networks/how-to/monitor/splunk.md +++ b/docs/private-networks/how-to/monitor/splunk.md @@ -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 --- diff --git a/docs/private-networks/how-to/send-transactions/concurrent-private-transactions.md b/docs/private-networks/how-to/send-transactions/concurrent-private-transactions.md index a1fb71eb48a..b14ca734c72 100644 --- a/docs/private-networks/how-to/send-transactions/concurrent-private-transactions.md +++ b/docs/private-networks/how-to/send-transactions/concurrent-private-transactions.md @@ -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 diff --git a/docs/private-networks/how-to/send-transactions/private-transactions.md b/docs/private-networks/how-to/send-transactions/private-transactions.md index ea3866cb714..92f1d2a62a5 100644 --- a/docs/private-networks/how-to/send-transactions/private-transactions.md +++ b/docs/private-networks/how-to/send-transactions/private-transactions.md @@ -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 diff --git a/docs/private-networks/how-to/send-transactions/revert-reason.md b/docs/private-networks/how-to/send-transactions/revert-reason.md index da206b31e80..a044ca0d748 100644 --- a/docs/private-networks/how-to/send-transactions/revert-reason.md +++ b/docs/private-networks/how-to/send-transactions/revert-reason.md @@ -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 @@ -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 diff --git a/docs/private-networks/how-to/use-permissioning/local.md b/docs/private-networks/how-to/use-permissioning/local.md index 780e85dd229..b9f3bce4154 100644 --- a/docs/private-networks/how-to/use-permissioning/local.md +++ b/docs/private-networks/how-to/use-permissioning/local.md @@ -1,7 +1,7 @@ --- title: Use local permissioning sidebar_position: 1 -description: Hyperledger Besu local permissioning +description: Besu local permissioning tags: - private networks --- @@ -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: diff --git a/docs/private-networks/how-to/use-privacy/access-private-transactions.md b/docs/private-networks/how-to/use-privacy/access-private-transactions.md index 611f57269a3..fa0e1e0a94c 100644 --- a/docs/private-networks/how-to/use-privacy/access-private-transactions.md +++ b/docs/private-networks/how-to/use-privacy/access-private-transactions.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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 diff --git a/docs/private-networks/how-to/use-privacy/besu-extended.md b/docs/private-networks/how-to/use-privacy/besu-extended.md index 40c1c7d365e..4fb896542de 100644 --- a/docs/private-networks/how-to/use-privacy/besu-extended.md +++ b/docs/private-networks/how-to/use-privacy/besu-extended.md @@ -1,6 +1,6 @@ --- title: Use Besu-extended privacy -description: Hyperledger Besu-extended privacy +description: Besu-extended privacy sidebar_position: 2 tags: - private networks @@ -8,7 +8,7 @@ tags: # 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. diff --git a/docs/private-networks/how-to/use-privacy/eea-compliant.md b/docs/private-networks/how-to/use-privacy/eea-compliant.md index 300c0b987fd..67ec058f0de 100644 --- a/docs/private-networks/how-to/use-privacy/eea-compliant.md +++ b/docs/private-networks/how-to/use-privacy/eea-compliant.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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. diff --git a/docs/private-networks/how-to/use-privacy/privacy-groups.md b/docs/private-networks/how-to/use-privacy/privacy-groups.md index 1b3f0fadf23..887d84cd53b 100644 --- a/docs/private-networks/how-to/use-privacy/privacy-groups.md +++ b/docs/private-networks/how-to/use-privacy/privacy-groups.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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) diff --git a/docs/private-networks/how-to/use-privacy/sign-pmts.md b/docs/private-networks/how-to/use-privacy/sign-pmts.md index 7ad0029f5d1..1dea1b4ff63 100644 --- a/docs/private-networks/how-to/use-privacy/sign-pmts.md +++ b/docs/private-networks/how-to/use-privacy/sign-pmts.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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 diff --git a/docs/private-networks/how-to/use-privacy/tessera.md b/docs/private-networks/how-to/use-privacy/tessera.md index 02754f3fe8f..adf67093c9f 100644 --- a/docs/private-networks/how-to/use-privacy/tessera.md +++ b/docs/private-networks/how-to/use-privacy/tessera.md @@ -1,6 +1,6 @@ --- 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 @@ -8,7 +8,7 @@ tags: # 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) diff --git a/docs/private-networks/how-to/use-privacy/web3js-quorum.md b/docs/private-networks/how-to/use-privacy/web3js-quorum.md index 3ba8846f3eb..b3a83f2ec31 100644 --- a/docs/private-networks/how-to/use-privacy/web3js-quorum.md +++ b/docs/private-networks/how-to/use-privacy/web3js-quorum.md @@ -41,7 +41,7 @@ npm install web3js-quorum ## Initialize the web3js-quorum client Initialize your client where `` 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. diff --git a/docs/private-networks/index.md b/docs/private-networks/index.md index 377c1af8e90..1f23e1a2d0f 100644 --- a/docs/private-networks/index.md +++ b/docs/private-networks/index.md @@ -8,7 +8,7 @@ tags: - private networks --- -# Hyperledger Besu for private networks +# Besu for private networks You can use Besu to develop enterprise applications requiring secure, high-performance transaction processing in a private network. @@ -27,4 +27,4 @@ The following diagram outlines the high-level architecture of Besu for private n ![Private architecture](../assets/images/private-architecture.jpeg) If you have any questions about Besu for private networks, ask on the **besu** channel on -[Hyperledger Discord](https://discord.gg/hyperledger). +[Discord](https://discord.gg/hyperledger). diff --git a/docs/private-networks/reference/accounts-for-testing.md b/docs/private-networks/reference/accounts-for-testing.md index f32a1dbf8a1..76b2002c0a9 100644 --- a/docs/private-networks/reference/accounts-for-testing.md +++ b/docs/private-networks/reference/accounts-for-testing.md @@ -1,7 +1,7 @@ --- title: Accounts for testing sidebar_position: 3 -description: Ethereum accounts used for Hyperledger Besu testing only on private networks +description: Ethereum accounts used for Besu testing only on private networks tags: - private networks --- @@ -10,7 +10,7 @@ import TestAccounts from '../../global/test_accounts.md'; # Accounts for testing -You can use existing accounts for testing by including them in the genesis file for a private network. Hyperledger Besu also provides predefined accounts for use in development mode. +You can use existing accounts for testing by including them in the genesis file for a private network. Besu also provides predefined accounts for use in development mode. ## Development mode diff --git a/docs/private-networks/reference/api/index.md b/docs/private-networks/reference/api/index.md index 522ff996a94..7fcfe81d988 100644 --- a/docs/private-networks/reference/api/index.md +++ b/docs/private-networks/reference/api/index.md @@ -1,5 +1,5 @@ --- -description: Hyperledger Besu private network JSON-RPC API methods reference +description: Besu private network JSON-RPC API methods reference toc_max_heading_level: 3 tags: - private networks diff --git a/docs/private-networks/reference/api/objects.md b/docs/private-networks/reference/api/objects.md index 1bf7010446e..0bca489acbf 100644 --- a/docs/private-networks/reference/api/objects.md +++ b/docs/private-networks/reference/api/objects.md @@ -1,7 +1,7 @@ --- title: Private network API objects sidebar_position: 2 -description: Hyperledger Besu private network API objects reference +description: Besu private network API objects reference tags: - private networks --- diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md index 24ba7ff03a4..f04a9b77f9f 100644 --- a/docs/private-networks/reference/cli/options.md +++ b/docs/private-networks/reference/cli/options.md @@ -1,7 +1,7 @@ --- title: Private network options sidebar_position: 1 -description: Hyperledger Besu private networks CLI reference +description: Besu private networks CLI reference tags: - private networks --- @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; # Private network command line options -This reference describes the syntax of the Hyperledger Besu private network command line interface (CLI) options. +This reference describes the syntax of the Besu private network command line interface (CLI) options. :::caution Important diff --git a/docs/private-networks/reference/cli/subcommands.md b/docs/private-networks/reference/cli/subcommands.md index 2b3e3a38249..636608fac70 100644 --- a/docs/private-networks/reference/cli/subcommands.md +++ b/docs/private-networks/reference/cli/subcommands.md @@ -1,7 +1,7 @@ --- title: Private network subcommands sidebar_position: 2 -description: Hyperledger Besu command line interface subcommands +description: Besu command line interface subcommands tags: - private networks --- @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; # Private network subcommands -This reference describes the syntax of the Hyperledger Besu private network command line interface (CLI) subcommands. +This reference describes the syntax of the Besu private network command line interface (CLI) subcommands. :::caution Important diff --git a/docs/private-networks/reference/plugin-api-interfaces.md b/docs/private-networks/reference/plugin-api-interfaces.md index 54d4beda062..9b36bebd8b1 100644 --- a/docs/private-networks/reference/plugin-api-interfaces.md +++ b/docs/private-networks/reference/plugin-api-interfaces.md @@ -8,7 +8,7 @@ tags: # Plugin API interfaces -API interfaces in Hyperledger Besu allow users to [build plugins](../concepts/plugins.md) to extend Besu functionality. +API interfaces in Besu allow users to [build plugins](../concepts/plugins.md) to extend Besu functionality. For more information about the available interfaces, see the [Plugin API Javadoc](https://javadoc.io/doc/org.hyperledger.besu/plugin-api/latest/index.html). diff --git a/docs/private-networks/tutorials/clique.md b/docs/private-networks/tutorials/clique.md index 46ffd7fcbb9..02e228a4846 100644 --- a/docs/private-networks/tutorials/clique.md +++ b/docs/private-networks/tutorials/clique.md @@ -21,7 +21,7 @@ The steps in this tutorial create an isolated, but not protected or secure, Ethe ## Prerequisites -- [Hyperledger Besu](../get-started/install/binary-distribution.md) +- [Besu](../get-started/install/binary-distribution.md) - [Curl (or similar webservice client)](https://curl.haxx.se/download.html). ## Steps diff --git a/docs/private-networks/tutorials/contracts/index.md b/docs/private-networks/tutorials/contracts/index.md index 8e65e9a4ed8..9af823c16d1 100644 --- a/docs/private-networks/tutorials/contracts/index.md +++ b/docs/private-networks/tutorials/contracts/index.md @@ -133,7 +133,7 @@ This example code creates the transaction `tx`, signs it with the private key of ## Use `eth_sendTransaction` -You can use [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) as an alternative to `eth_sendSignedTransaction`. However, Hyperledger Besu does not support the `eth_sendTransaction` API call and keeps account management separate for stronger security. Configure [Web3Signer](https://docs.web3signer.consensys.net/) with your Besu node to make the `eth_sendTransaction` API call. +You can use [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) as an alternative to `eth_sendSignedTransaction`. However, Besu does not support the `eth_sendTransaction` API call and keeps account management separate for stronger security. Configure [Web3Signer](https://docs.web3signer.consensys.net/) with your Besu node to make the `eth_sendTransaction` API call. Pass the following parameters to the [`eth_sendTransaction`](https://docs.web3signer.consensys.net/reference/api/json-rpc#eth_sendtransaction) call to Web3Signer. Web3Signer converts the request to an [`eth_sendRawTransaction`](../../../public-networks/reference/api/index.md#eth_sendrawtransaction) call that Besu uses: @@ -164,7 +164,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sendTransaction","params":[{ ## Use `eea_sendRawTransaction` for private contracts with web3js-quorum -To deploy a private contract to another node or [privacy group](../../concepts/privacy/privacy-groups.md) member, use the [web3js-quorum](https://www.npmjs.com/package/web3js-quorum) library and the [`eea_sendRawTransaction`](../../../public-networks/reference/api/index.md#eea_sendrawtransaction) API call. You must use this API call instead of [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) because Hyperledger Besu keeps account management separate for stronger security. +To deploy a private contract to another node or [privacy group](../../concepts/privacy/privacy-groups.md) member, use the [web3js-quorum](https://www.npmjs.com/package/web3js-quorum) library and the [`eea_sendRawTransaction`](../../../public-networks/reference/api/index.md#eea_sendrawtransaction) API call. You must use this API call instead of [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) because Besu keeps account management separate for stronger security. The Developer Quickstart provides an [example of a private transaction script](https://github.com/ConsenSys/quorum-dev-quickstart/blob/1e8cc281098923802845cd829ec20c88513c2e1c/files/besu/smart_contracts/privacy/scripts/private_tx.js). diff --git a/docs/private-networks/tutorials/contracts/transfer-funds.md b/docs/private-networks/tutorials/contracts/transfer-funds.md index 10e96bbc521..b2b4e5a0990 100644 --- a/docs/private-networks/tutorials/contracts/transfer-funds.md +++ b/docs/private-networks/tutorials/contracts/transfer-funds.md @@ -88,7 +88,7 @@ A [full example](https://github.com/ConsenSys/quorum-dev-quickstart/blob/1e8cc28 ## Use `eth_sendTransaction` -An alternative to using `eth_sendSignedTransaction` is [`eth_sendTransaction`](https://web3js.readthedocs.io/en/v1.2.11/web3-eth.html#sendtransaction). However, Hyperledger Besu does not support the `eth_sendTransaction` API call and keeps account management separate for stronger security. Instead, Besu uses [Web3Signer](https://docs.web3signer.consensys.net/) to make the `eth_sendTransaction` API call. +An alternative to using `eth_sendSignedTransaction` is [`eth_sendTransaction`](https://web3js.readthedocs.io/en/v1.2.11/web3-eth.html#sendtransaction). However, Besu does not support the `eth_sendTransaction` API call and keeps account management separate for stronger security. Instead, Besu uses [Web3Signer](https://docs.web3signer.consensys.net/) to make the `eth_sendTransaction` API call. Use `eth_sendTransaction` similarly to [using `eth_sendSignedTransaction`](#use-eth_sendsignedtransaction) (without the signing step which is done by Web3Signer): diff --git a/docs/private-networks/tutorials/ethash.md b/docs/private-networks/tutorials/ethash.md index 84f7a21f1be..36c2bfd75a6 100644 --- a/docs/private-networks/tutorials/ethash.md +++ b/docs/private-networks/tutorials/ethash.md @@ -23,7 +23,7 @@ The steps in this tutorial create an isolated, but not protected or secure, Ethe ## Prerequisites -- [Hyperledger Besu](../get-started/install/binary-distribution.md) +- [Besu](../get-started/install/binary-distribution.md) - [Curl (or similar webservice client)](https://curl.haxx.se/download.html). ## Steps diff --git a/docs/private-networks/tutorials/ibft/index.md b/docs/private-networks/tutorials/ibft/index.md index cc9bc1cd99b..dd23ed2453d 100644 --- a/docs/private-networks/tutorials/ibft/index.md +++ b/docs/private-networks/tutorials/ibft/index.md @@ -1,5 +1,5 @@ --- -description: Hyperledger Besu private network using the IBFT 2.0 (Proof of Authority) consensus protocol +description: Besu private network using the IBFT 2.0 (Proof of Authority) consensus protocol tags: - private networks --- @@ -21,7 +21,7 @@ This tutorial configures a private network using IBFT 2.0 for educational purpos ## Prerequisites -- [Hyperledger Besu](../../get-started/install/binary-distribution.md) +- [Besu](../../get-started/install/binary-distribution.md) - [Curl (or similar webservice client)](https://curl.haxx.se/download.html). ## Steps diff --git a/docs/private-networks/tutorials/kubernetes/cluster.md b/docs/private-networks/tutorials/kubernetes/cluster.md index ba2772510b6..7f50b7f2930 100644 --- a/docs/private-networks/tutorials/kubernetes/cluster.md +++ b/docs/private-networks/tutorials/kubernetes/cluster.md @@ -73,7 +73,7 @@ Refer to the [official Rancher Desktop documentation](https://docs.rancherdeskto ### AWS EKS -[AWS Elastic Kubernetes Service (AWS EKS)](https://aws.amazon.com/eks/) is one of the most popular platforms to deploy Hyperledger Besu. +[AWS Elastic Kubernetes Service (AWS EKS)](https://aws.amazon.com/eks/) is one of the most popular platforms to deploy Besu. To create a cluster in AWS, you must install the [AWS CLI](https://aws.amazon.com/cli/) and [`eksctl`](https://eksctl.io/). diff --git a/docs/private-networks/tutorials/kubernetes/index.md b/docs/private-networks/tutorials/kubernetes/index.md index bd1dea65869..e27599a8840 100644 --- a/docs/private-networks/tutorials/kubernetes/index.md +++ b/docs/private-networks/tutorials/kubernetes/index.md @@ -1,6 +1,6 @@ --- -title: Deploy a Hyperledger Besu private network with Kubernetes -description: Deploying Hyperledger Besu with Kubernetes +title: Deploy a Besu private network with Kubernetes +description: Deploying Besu with Kubernetes tags: - private networks --- diff --git a/docs/private-networks/tutorials/kubernetes/nat-manager.md b/docs/private-networks/tutorials/kubernetes/nat-manager.md index 9f02cfa45a8..2e6a1aabc13 100644 --- a/docs/private-networks/tutorials/kubernetes/nat-manager.md +++ b/docs/private-networks/tutorials/kubernetes/nat-manager.md @@ -1,7 +1,7 @@ --- title: Configure Kubernetes mode in NAT manager sidebar_position: 9 -description: Tutorial to configure Kubernetes mode for Hyperledger Besu Nat Manager +description: Tutorial to configure Kubernetes mode for Besu Nat Manager tags: - private networks --- diff --git a/docs/private-networks/tutorials/kubernetes/playground.md b/docs/private-networks/tutorials/kubernetes/playground.md index 67962456a62..b2561ddc6fe 100644 --- a/docs/private-networks/tutorials/kubernetes/playground.md +++ b/docs/private-networks/tutorials/kubernetes/playground.md @@ -1,7 +1,7 @@ --- title: Local playground sidebar_position: 1 -description: Deploying a Hyperledger Besu private network locally with Kubernetes +description: Deploying a Besu private network locally with Kubernetes tags: - private networks --- @@ -14,7 +14,7 @@ The [playground](https://github.com/ConsenSys/quorum-kubernetes/tree/master/play 1. Navigate to the playground [`README`](https://github.com/ConsenSys/quorum-kubernetes/tree/master/playground). 1. Ensure that your system meets the requirements specified. -1. Choose your Ethereum client (Hyperledger Besu or GoQuorum): `quorum-besu` or `quorum-go`. +1. Choose your Ethereum client (Besu or GoQuorum): `quorum-besu` or `quorum-go`. 1. Choose your consensus algorithm. The playground supports Clique, Ethash (PoW), and IBFT2 for Besu, and IBFT for GoQuorum. 1. Follow the instructions from the `README` for the chosen client and consensus algorithm folder. diff --git a/docs/private-networks/tutorials/permissioning/index.md b/docs/private-networks/tutorials/permissioning/index.md index 028b0cca36f..f58a3792120 100644 --- a/docs/private-networks/tutorials/permissioning/index.md +++ b/docs/private-networks/tutorials/permissioning/index.md @@ -1,7 +1,7 @@ --- title: Create a permissioned network sidebar_position: 1 -description: Hyperledger Besu create a permissioned network +description: Besu create a permissioned network toc_max_heading_level: 3 tags: - private networks @@ -22,7 +22,7 @@ A permissioned Ethereum network as described here is not protected against all a ## Prerequisites -- [Hyperledger Besu](../../get-started/install/binary-distribution.md) +- [Besu](../../get-started/install/binary-distribution.md) - [curl (or similar Web service client)](https://curl.haxx.se/download.html) ## Steps diff --git a/docs/private-networks/tutorials/privacy/index.md b/docs/private-networks/tutorials/privacy/index.md index 63047dbbb9d..9c597a2455e 100644 --- a/docs/private-networks/tutorials/privacy/index.md +++ b/docs/private-networks/tutorials/privacy/index.md @@ -1,7 +1,7 @@ --- title: Create a privacy enabled network using the Quickstart sidebar_position: 1 -description: Configure Hyperledger Besu privacy +description: Configure Besu privacy tags: - private networks --- @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; # Create a privacy-enabled network -Configuring a network that supports private transactions requires starting a [Tessera] node for each Hyperledger Besu node. Besu command line options associate the Besu node with the Tessera node. +Configuring a network that supports private transactions requires starting a [Tessera] node for each Besu node. Besu command line options associate the Besu node with the Tessera node. This tutorial assumes you have completed setting up an IBFT 2.0 network to the point where you have [created the genesis file and copied the private keys](../ibft/index.md#5-copy-the-node-private-keys-to-the-node-directories). If not, complete steps 1 to 5 of the [Create an IBFT 2.0](../ibft/index.md) tutorial before continuing. diff --git a/docs/private-networks/tutorials/privacy/quickstart.md b/docs/private-networks/tutorials/privacy/quickstart.md index 7e08490d53f..d01bc599ffa 100644 --- a/docs/private-networks/tutorials/privacy/quickstart.md +++ b/docs/private-networks/tutorials/privacy/quickstart.md @@ -1,12 +1,12 @@ --- -description: Hyperledger Besu privacy-enabled private network tutorial +description: Besu privacy-enabled private network tutorial tags: - private networks --- # Create a privacy-enabled network using the Quorum Developer Quickstart -You can create a privacy-enabled network using the [Quorum Developer Quickstart](../quickstart.md). It runs a private Hyperledger Besu network that uses [Tessera](https://docs.tessera.consensys.net/en/stable/) as its private transaction manager. +You can create a privacy-enabled network using the [Quorum Developer Quickstart](../quickstart.md). It runs a private Besu network that uses [Tessera](https://docs.tessera.consensys.net/en/stable/) as its private transaction manager. You can use the [Block Explorer](../quickstart.md#block-explorer), make [JSON-RPC requests](../quickstart.md#run-json-rpc-requests), and [create transactions using MetaMask](../quickstart.md#create-a-transaction-using-metamask). This tutorial describes how to make private transactions between nodes, and perform read and write operations on private contracts. @@ -42,7 +42,7 @@ To create the docker-compose file and artifacts, run: npx quorum-dev-quickstart ``` -Follow the prompts displayed to run Hyperledger Besu, private transactions, and [logging with ELK](../../how-to/monitor/elastic-stack.md). Enter `n` for Codefi Orchestrate. +Follow the prompts displayed to run Besu, private transactions, and [logging with ELK](../../how-to/monitor/elastic-stack.md). Enter `n` for Codefi Orchestrate. ### 2. Start the network @@ -81,7 +81,7 @@ For more information on the endpoints and services, refer to README.md in the in ### 3. Deploy the private contract and interact with the nodes -To deploy a private contract to another [privacy group](../../concepts/privacy/privacy-groups.md) member, use the [web3js-quorum](https://consensys.github.io/web3js-quorum/latest/index.html) library and the [`eea_sendRawTransaction`](../../../private-networks/reference/api/index.md#eea_sendrawtransaction) API call. You must use this API call instead of [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) because Hyperledger Besu keeps account management separate for stronger security. +To deploy a private contract to another [privacy group](../../concepts/privacy/privacy-groups.md) member, use the [web3js-quorum](https://consensys.github.io/web3js-quorum/latest/index.html) library and the [`eea_sendRawTransaction`](../../../private-networks/reference/api/index.md#eea_sendrawtransaction) API call. You must use this API call instead of [`eth_sendTransaction`](https://ethereum.github.io/execution-apis/api-documentation) because Besu keeps account management separate for stronger security. This example uses the [web3js](https://www.npmjs.com/package/web3) library to make the API calls, the example creates three Besu nodes, with each node having a corresponding Tessera node for privacy. You can access the Besu member nodes for API calls on the following ports: diff --git a/docs/private-networks/tutorials/privacy/web3js-quorum.md b/docs/private-networks/tutorials/privacy/web3js-quorum.md index c4c7fd0f92d..b008bae0a56 100644 --- a/docs/private-networks/tutorials/privacy/web3js-quorum.md +++ b/docs/private-networks/tutorials/privacy/web3js-quorum.md @@ -32,8 +32,8 @@ This example uses 3 of the 4 nodes configured in the [privacy tutorial](index.md - chain ID - Tessera node public keys - - Hyperledger Besu node RPC URLs - - [Hyperledger Besu node private keys](../../../public-networks/concepts/node-keys.md#node-private-key). + - Besu node RPC URLs + - [Besu node private keys](../../../public-networks/concepts/node-keys.md#node-private-key). 4. In the `example/multiNodeExample` directory, deploy the contract: diff --git a/docs/private-networks/tutorials/qbft.md b/docs/private-networks/tutorials/qbft.md index b9de554e79c..264c0112e75 100644 --- a/docs/private-networks/tutorials/qbft.md +++ b/docs/private-networks/tutorials/qbft.md @@ -25,7 +25,7 @@ This tutorial configures a private network using QBFT for educational purposes o ## Prerequisites -- [Hyperledger Besu](../get-started/install/binary-distribution.md) +- [Besu](../get-started/install/binary-distribution.md) - [Curl (or similar webservice client)](https://curl.haxx.se/download.html). ## Steps diff --git a/docs/private-networks/tutorials/quickstart.md b/docs/private-networks/tutorials/quickstart.md index c47c0b7c984..4643ef8b7e1 100644 --- a/docs/private-networks/tutorials/quickstart.md +++ b/docs/private-networks/tutorials/quickstart.md @@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; # Developer Quickstart -The Quorum Developer Quickstart uses the Hyperledger Besu Docker image to run a private [IBFT 2.0](../how-to/configure/consensus/ibft.md) network of Besu nodes managed by Docker Compose. +The Quorum Developer Quickstart uses the Besu Docker image to run a private [IBFT 2.0](../how-to/configure/consensus/ibft.md) network of Besu nodes managed by Docker Compose. :::caution @@ -51,7 +51,7 @@ To create the tutorial `docker-compose` files and artifacts, run: npx quorum-dev-quickstart ``` -Follow the prompts displayed to run Hyperledger Besu and [logging with ELK](../how-to/monitor/elastic-stack.md). Enter `n` for Codefi Orchestrate and [private transactions](../concepts/privacy/index.md). +Follow the prompts displayed to run Besu and [logging with ELK](../how-to/monitor/elastic-stack.md). Enter `n` for Codefi Orchestrate and [private transactions](../concepts/privacy/index.md). :::note diff --git a/docs/public-networks/concepts/node-keys.md b/docs/public-networks/concepts/node-keys.md index 1f279276975..261e34e3b82 100644 --- a/docs/public-networks/concepts/node-keys.md +++ b/docs/public-networks/concepts/node-keys.md @@ -9,11 +9,11 @@ tags: # Node keys and node address -Each node has a private and public key pair, and a node address. Hyperledger Besu uses the private and public key pair to sign and verify transactions, and the node address as an identifier for the node. +Each node has a private and public key pair, and a node address. Besu uses the private and public key pair to sign and verify transactions, and the node address as an identifier for the node. ## Node private key -When starting Hyperledger Besu, if the [`--node-private-key-file`](../reference/cli/options.md#node-private-key-file) option is not specified and a `key` file does not exist in the data directory for the node, Besu generates a node private key and writes it to the `key` file. +When starting Besu, if the [`--node-private-key-file`](../reference/cli/options.md#node-private-key-file) option is not specified and a `key` file does not exist in the data directory for the node, Besu generates a node private key and writes it to the `key` file. If a `key` file does exist in the data directory when starting Besu, the node starts using the private key in the `key` file. diff --git a/docs/public-networks/concepts/transactions/types.md b/docs/public-networks/concepts/transactions/types.md index 892968f8b56..c166c0ea2e5 100644 --- a/docs/public-networks/concepts/transactions/types.md +++ b/docs/public-networks/concepts/transactions/types.md @@ -9,7 +9,7 @@ tags: # Transaction types -You can interact with the Hyperledger Besu JSON-RPC API using different transaction types (specified by the `transactionType` parameter). +You can interact with the Besu JSON-RPC API using different transaction types (specified by the `transactionType` parameter). The following API objects use a unique format for each `transactionType`: diff --git a/docs/public-networks/get-started/install/binary-distribution.md b/docs/public-networks/get-started/install/binary-distribution.md index 87c28c2f506..3848065f47f 100644 --- a/docs/public-networks/get-started/install/binary-distribution.md +++ b/docs/public-networks/get-started/install/binary-distribution.md @@ -1,7 +1,7 @@ --- title: Install binary distribution sidebar_position: 2 -description: Install or upgrade Hyperledger Besu from binary distribution +description: Install or upgrade Besu from binary distribution tags: - public networks --- @@ -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). diff --git a/docs/public-networks/get-started/install/index.md b/docs/public-networks/get-started/install/index.md index c4717c1fe65..9e5c93543cd 100644 --- a/docs/public-networks/get-started/install/index.md +++ b/docs/public-networks/get-started/install/index.md @@ -1,6 +1,6 @@ --- title: Installation options -description: Options for getting started with Hyperledger Besu +description: Options for getting started with Besu tags: - public networks --- @@ -12,12 +12,12 @@ tags: ## 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. -[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 diff --git a/docs/public-networks/get-started/install/run-docker-image.md b/docs/public-networks/get-started/install/run-docker-image.md index ba1e1fd2ad5..ca4c1407b6f 100644 --- a/docs/public-networks/get-started/install/run-docker-image.md +++ b/docs/public-networks/get-started/install/run-docker-image.md @@ -1,14 +1,14 @@ --- title: Run Besu from Docker image sidebar_position: 1 -description: Run Hyperledger Besu using the official docker image +description: Run Besu using the official docker image tags: - public 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. diff --git a/docs/public-networks/how-to/configure-ha/index.md b/docs/public-networks/how-to/configure-ha/index.md index 0f642295f0a..39a3a049e7a 100644 --- a/docs/public-networks/how-to/configure-ha/index.md +++ b/docs/public-networks/how-to/configure-ha/index.md @@ -1,5 +1,5 @@ --- -description: Hyperledger Besu high availability +description: Besu high availability tags: - public networks - private networks @@ -7,7 +7,7 @@ tags: # High availability of JSON-RPC and RPC Pub/Sub APIs -To enable high availability to the [RPC Pub/Sub API over WebSocket](../use-besu-api/rpc-pubsub.md) or the [JSON-RPC API](../use-besu-api/json-rpc.md), run and synchronize more than one Hyperledger Besu node to the network. Use a load balancer to distribute requests across nodes in the cluster that are ready to receive requests. +To enable high availability to the [RPC Pub/Sub API over WebSocket](../use-besu-api/rpc-pubsub.md) or the [JSON-RPC API](../use-besu-api/json-rpc.md), run and synchronize more than one Besu node to the network. Use a load balancer to distribute requests across nodes in the cluster that are ready to receive requests. ![Load Balancer](../../../assets/images/LoadBalancer.png) diff --git a/docs/public-networks/how-to/configure-ha/sample-configuration.md b/docs/public-networks/how-to/configure-ha/sample-configuration.md index b018ba2a75b..5f82f982dc2 100644 --- a/docs/public-networks/how-to/configure-ha/sample-configuration.md +++ b/docs/public-networks/how-to/configure-ha/sample-configuration.md @@ -11,7 +11,7 @@ tags: ## AWS -For AWS, we recommend the Classic Load Balancer. The Classic Load Balancer is the easiest to configure and work with. Register the Hyperledger Besu instances to the load balancer and use the [liveness endpoint](../use-besu-api/json-rpc.md#readiness-and-liveness-endpoints) for health checks. +For AWS, we recommend the Classic Load Balancer. The Classic Load Balancer is the easiest to configure and work with. Register the Besu instances to the load balancer and use the [liveness endpoint](../use-besu-api/json-rpc.md#readiness-and-liveness-endpoints) for health checks. For finer grain control, use the Application Load Balancer: diff --git a/docs/public-networks/how-to/configure-java/install-update-java.md b/docs/public-networks/how-to/configure-java/install-update-java.md index 3f9a7215529..cbedce4ad43 100644 --- a/docs/public-networks/how-to/configure-java/install-update-java.md +++ b/docs/public-networks/how-to/configure-java/install-update-java.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -description: Install or update Java for use with Hyperledger Besu +description: Install or update Java for use with Besu tags: - public networks - private networks diff --git a/docs/public-networks/how-to/configure-java/java-flight-recorder.md b/docs/public-networks/how-to/configure-java/java-flight-recorder.md index 7916129cb04..7733d963e65 100644 --- a/docs/public-networks/how-to/configure-java/java-flight-recorder.md +++ b/docs/public-networks/how-to/configure-java/java-flight-recorder.md @@ -1,7 +1,7 @@ --- title: Use Java Flight Recorder sidebar_position: 4 -description: Using Java Flight Recorder with Hyperledger Besu +description: Using Java Flight Recorder with Besu tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Use Java Flight Recorder -[Java Flight Recorder (JFR)](https://docs.oracle.com/javacomponents/jmc-5-4/jfr-runtime-guide/about.htm#JFRUH170) is a monitoring tool that collects information about the Java Virtual Machine (JVM) when Hyperledger Besu is running. Use the JFR as a tool to analyze Besu performance. +[Java Flight Recorder (JFR)](https://docs.oracle.com/javacomponents/jmc-5-4/jfr-runtime-guide/about.htm#JFRUH170) is a monitoring tool that collects information about the Java Virtual Machine (JVM) when Besu is running. Use the JFR as a tool to analyze Besu performance. ## Enable Java Flight Recorder diff --git a/docs/public-networks/how-to/configure-java/pass-jvm-options.md b/docs/public-networks/how-to/configure-java/pass-jvm-options.md index c400c9046c1..2c60e34af9a 100644 --- a/docs/public-networks/how-to/configure-java/pass-jvm-options.md +++ b/docs/public-networks/how-to/configure-java/pass-jvm-options.md @@ -1,7 +1,7 @@ --- title: Pass JVM options sidebar_position: 2 -description: Passing Java virtual machine JVM options to Hyperledger Besu at runtime +description: Passing Java virtual machine JVM options to Besu at runtime tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Pass JVM options -To perform tasks such as attaching a debugger or configuring the garbage collector, pass Java Virtual Machine (JVM) options to Hyperledger Besu. +To perform tasks such as attaching a debugger or configuring the garbage collector, pass Java Virtual Machine (JVM) options to Besu. Besu passes the contents of the `BESU_OPTS` environment variable to the JVM. Set standard JVM options in the `BESU_OPTS` variable. diff --git a/docs/public-networks/how-to/connect/configure-ports.md b/docs/public-networks/how-to/connect/configure-ports.md index b9802f3073e..ac16a8a588b 100644 --- a/docs/public-networks/how-to/connect/configure-ports.md +++ b/docs/public-networks/how-to/connect/configure-ports.md @@ -1,7 +1,7 @@ --- title: Configure ports sidebar_position: 2 -description: To enable communication you must expose Hyperledger Besu ports appropriately +description: To enable communication you must expose Besu ports appropriately tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Configure ports -To enable communication you must expose Hyperledger Besu ports appropriately. The following shows an example port configuration for a Besu node on AWS. +To enable communication you must expose Besu ports appropriately. The following shows an example port configuration for a Besu node on AWS. ![Port Configuration](../../../assets/images/PortConfiguration.png) diff --git a/docs/public-networks/how-to/connect/manage-peers.md b/docs/public-networks/how-to/connect/manage-peers.md index 768b904d0c0..4e70ec9e80c 100644 --- a/docs/public-networks/how-to/connect/manage-peers.md +++ b/docs/public-networks/how-to/connect/manage-peers.md @@ -1,7 +1,7 @@ --- title: Manage peers sidebar_position: 3 -description: Managing Hyperledger Besu peers +description: Managing Besu peers tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Manage peers -Hyperledger Besu peer-to-peer (P2P) discovery happens periodically based on the number of peers in a +Besu peer-to-peer (P2P) discovery happens periodically based on the number of peers in a network and the node's [peer limit](#limit-peers). The frequency of discovery isn't configurable, but you can: diff --git a/docs/public-networks/how-to/connect/specify-nat.md b/docs/public-networks/how-to/connect/specify-nat.md index 6438ab2fc13..c08580fd2cb 100644 --- a/docs/public-networks/how-to/connect/specify-nat.md +++ b/docs/public-networks/how-to/connect/specify-nat.md @@ -1,7 +1,7 @@ --- title: Specify NAT method sidebar_position: 4 -description: Configuring NAT with Hyperledger Besu +description: Configuring NAT with Besu tags: - public networks - private networks @@ -13,7 +13,7 @@ Use the [`--nat-method`](../../reference/cli/options.md#nat-method) option to sp The [enode](../../concepts/node-keys.md#enode-url) advertised to other nodes during discovery is the external IP address and port. The [`admin_nodeInfo`](../../reference/api/index.md#admin_nodeinfo) JSON-RPC API method returns the external address and port for the `enode` and `listenAddr` properties. -While Hyperledger Besu is running, the following are not supported: +While Besu is running, the following are not supported: - IP address changes - Changing NAT methods. To change the NAT method, restart the node with the [`--nat-method`](../../reference/cli/options.md#nat-method) option set. @@ -65,7 +65,7 @@ When the NAT method is set to `UPNP`, the advertised port is the same as the [li ## Kubernetes -Specify `KUBERNETES` to explicitly specify Hyperledger Besu is running inside a Kubernetes cluster. Besu automatically detects if it's running inside of a Kubernetes cluster and interacts with Kubernetes APIs as required to determine external IP addresses and exposed ports. +Specify `KUBERNETES` to explicitly specify Besu is running inside a Kubernetes cluster. Besu automatically detects if it's running inside of a Kubernetes cluster and interacts with Kubernetes APIs as required to determine external IP addresses and exposed ports. In Kubernetes, the Ingress IP of the load balancer will be used as the external IP for Besu. A load balancer service can map any incoming port to a target port. These mapping rules will be the one retrieved by Besu. @@ -73,7 +73,7 @@ A tutorial to [Configure the Nat Manager for Kubernetes](../../../private-networ ## Docker -Specify `DOCKER` to explicitly specify Hyperledger Besu is running inside a Docker container. If you specify `DOCKER`, you advertise the host IP address not the container IP address. +Specify `DOCKER` to explicitly specify Besu is running inside a Docker container. If you specify `DOCKER`, you advertise the host IP address not the container IP address. The host IP address is the advertised host specified in the [`docker run` command](https://docs.docker.com/engine/reference/commandline/run/#add-entries-to-container-hosts-file---add-host). If not specified in the `docker run` command, the advertised host defaults to the values for [`--p2p-host`](../../reference/cli/options.md#p2p-host) and [`--p2p-port`](../../reference/cli/options.md#p2p-port). diff --git a/docs/public-networks/how-to/develop/client-libraries.md b/docs/public-networks/how-to/develop/client-libraries.md index 009e82d8d35..2a5280aef39 100644 --- a/docs/public-networks/how-to/develop/client-libraries.md +++ b/docs/public-networks/how-to/develop/client-libraries.md @@ -1,7 +1,7 @@ --- title: Use client libraries sidebar_position: 2 -description: Hyperledger Besu client libraries +description: Besu client libraries tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Use client libraries -Dapps use client libraries, such as [web3.js](https://github.com/ethereum/web3.js/), [web3j](https://github.com/web3j/web3j), or [ethereumj](https://github.com/ethereum/ethereumj), to forward JSON-RPC requests to Hyperledger Besu. Any client library implementing core Ethereum RPC methods works with Besu. +Dapps use client libraries, such as [web3.js](https://github.com/ethereum/web3.js/), [web3j](https://github.com/web3j/web3j), or [ethereumj](https://github.com/ethereum/ethereumj), to forward JSON-RPC requests to Besu. Any client library implementing core Ethereum RPC methods works with Besu. Use the [web3js-quorum library](../../../private-networks/how-to/use-privacy/web3js-quorum.md) with Besu for [privacy features](../../../private-networks/concepts/privacy/index.md). @@ -22,7 +22,7 @@ Use client libraries to: :::note -[Hyperledger Besu does not support key management inside the client](../send-transactions.md#use-wallets-for-key-management). +[Besu does not support key management inside the client](../send-transactions.md#use-wallets-for-key-management). ::: diff --git a/docs/public-networks/how-to/develop/hardhat.md b/docs/public-networks/how-to/develop/hardhat.md index 42c486e7e67..c7a49b07c5d 100644 --- a/docs/public-networks/how-to/develop/hardhat.md +++ b/docs/public-networks/how-to/develop/hardhat.md @@ -1,7 +1,7 @@ --- title: Use Hardhat sidebar_position: 1 -description: Using Hyperledger Besu with Hardhat +description: Using Besu with Hardhat tags: - public networks - private networks @@ -9,7 +9,7 @@ tags: # Use Hardhat -Developing for Hyperledger Besu using Hardhat is the same as developing for public Ethereum networks using Hardhat. Hardhat +Developing for Besu using Hardhat is the same as developing for public Ethereum networks using Hardhat. Hardhat supports Besu with the only difference being Besu does not support private key management. You can therefore use a wallet provider, or specify your private key in the code. diff --git a/docs/public-networks/how-to/monitor/index.md b/docs/public-networks/how-to/monitor/index.md index c2c49d0e9fd..eb0f415a0a8 100644 --- a/docs/public-networks/how-to/monitor/index.md +++ b/docs/public-networks/how-to/monitor/index.md @@ -12,4 +12,4 @@ Monitoring enables identification of node and network issues. Specifically, conf - [Visual representation of declining node or network performance](metrics.md) - [Collection of log files to enable issue diagnosis](logging.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). diff --git a/docs/public-networks/how-to/monitor/logging.md b/docs/public-networks/how-to/monitor/logging.md index edcf00dd99c..eb06bc48603 100644 --- a/docs/public-networks/how-to/monitor/logging.md +++ b/docs/public-networks/how-to/monitor/logging.md @@ -1,7 +1,7 @@ --- title: Configure logging sidebar_position: 3 -description: Hyperledger Besu log level setting and log formatting +description: Besu log level setting and log formatting path: blob/master/besu/src/main/resources/ source: log4j2.xml tags: @@ -11,7 +11,7 @@ tags: # Use logging -Hyperledger Besu uses [Log4j 2](https://logging.apache.org/log4j/2.x/) for logging and provides two methods to configure logging behavior: +Besu uses [Log4j 2](https://logging.apache.org/log4j/2.x/) for logging and provides two methods to configure logging behavior: - [Basic](#basic-logging) - Changes the log level. - [Advanced](#advanced-logging) - Configures the output and format of the logs. diff --git a/docs/public-networks/how-to/monitor/metrics.md b/docs/public-networks/how-to/monitor/metrics.md index 6fc3dafd301..1b64ce1648a 100644 --- a/docs/public-networks/how-to/monitor/metrics.md +++ b/docs/public-networks/how-to/monitor/metrics.md @@ -12,13 +12,13 @@ import TabItem from '@theme/TabItem'; # Use metrics to monitor node performance -To enable the [Prometheus](https://prometheus.io/) monitoring and alerting service to access Hyperledger Besu metrics, use the [`--metrics-enabled`](../../reference/cli/options.md#metrics-enabled) option. Use [Grafana](https://grafana.com/) to visualize the collected data. See the sample [Besu Full Grafana dashboard](https://grafana.com/grafana/dashboards/16455-besu-full/). +To enable the [Prometheus](https://prometheus.io/) monitoring and alerting service to access Besu metrics, use the [`--metrics-enabled`](../../reference/cli/options.md#metrics-enabled) option. Use [Grafana](https://grafana.com/) to visualize the collected data. See the sample [Besu Full Grafana dashboard](https://grafana.com/grafana/dashboards/16455-besu-full/). The Besu example networks have [monitoring with Prometheus and Grafana configured]. Use Prometheus to monitor the number of blocks your Besu node is behind the chain head, and to alert you that your node is not keeping up with the chain head. -[This recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be) shows examples of monitoring Hyperledger Besu. +[This recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be) shows examples of monitoring Besu. ## Install Prometheus diff --git a/docs/public-networks/how-to/troubleshoot/evm-tool.md b/docs/public-networks/how-to/troubleshoot/evm-tool.md index 3ccf4e08dad..5c69410e0e3 100644 --- a/docs/public-networks/how-to/troubleshoot/evm-tool.md +++ b/docs/public-networks/how-to/troubleshoot/evm-tool.md @@ -1,7 +1,7 @@ --- title: Use EVM tool sidebar_position: 1 -description: Hyperledger Besu EVM tool +description: Besu EVM tool tags: - public networks - private networks diff --git a/docs/public-networks/how-to/use-besu-api/access-logs.md b/docs/public-networks/how-to/use-besu-api/access-logs.md index 4f35a86ffd8..5c92febe96d 100644 --- a/docs/public-networks/how-to/use-besu-api/access-logs.md +++ b/docs/public-networks/how-to/use-besu-api/access-logs.md @@ -1,17 +1,17 @@ --- title: Access logs using JSON-RPC sidebar_position: 5 -description: Accessing logs using the Hyperledger Besu API +description: Accessing logs using the Besu API tags: - public networks - private networks --- -# Access logs using the Hyperledger Besu API +# Access logs using the Besu API Subscribe to events, such as logs, using either [RPC Pub/Sub over WebSockets](rpc-pubsub.md) or filters over HTTP. -Access logs using the following Hyperledger Besu API methods: +Access logs using the following Besu API methods: - [`eth_getFilterChanges`](../../reference/api/index.md#eth_getfilterchanges) - [`eth_getFilterLogs`](../../reference/api/index.md#eth_getfilterlogs) diff --git a/docs/public-networks/how-to/use-besu-api/authenticate.md b/docs/public-networks/how-to/use-besu-api/authenticate.md index bd3b5136371..eba08628743 100644 --- a/docs/public-networks/how-to/use-besu-api/authenticate.md +++ b/docs/public-networks/how-to/use-besu-api/authenticate.md @@ -1,7 +1,7 @@ --- title: Authenticate over JSON-RPC requests sidebar_position: 4 -description: Hyperledger Besu authentication and authorization for JSON-RPC +description: Besu authentication and authorization for JSON-RPC tags: - public networks - private networks @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; # Authenticate and authorize JSON-RPC -Authentication identifies a user, and authorization verifies user access to requested JSON-RPC methods. Hyperledger Besu verifies users using [JSON Web Tokens (JWT)](https://jwt.io/introduction/). JWT is also used in [multi-tenancy](../../../private-networks/concepts/privacy/multi-tenancy.md) to verify tenant data access. +Authentication identifies a user, and authorization verifies user access to requested JSON-RPC methods. Besu verifies users using [JSON Web Tokens (JWT)](https://jwt.io/introduction/). JWT is also used in [multi-tenancy](../../../private-networks/concepts/privacy/multi-tenancy.md) to verify tenant data access. Besu supports two mutually exclusive authentication methods: diff --git a/docs/public-networks/how-to/use-besu-api/graphql.md b/docs/public-networks/how-to/use-besu-api/graphql.md index 51722c07e94..2f5c6f5ef99 100644 --- a/docs/public-networks/how-to/use-besu-api/graphql.md +++ b/docs/public-networks/how-to/use-besu-api/graphql.md @@ -1,7 +1,7 @@ --- title: Use GraphQL over HTTP sidebar_position: 3 -description: How to access the Hyperledger Besu API using GraphQL +description: How to access the Besu API using GraphQL tags: - public networks - private networks @@ -32,7 +32,7 @@ The default endpoint is `http://127.0.0.1:8547/graphql`. ## GraphQL requests with cURL -[Hyperledger Besu JSON-RPC API methods](../../reference/api/index.md) with an equivalent +[Besu JSON-RPC API methods](../../reference/api/index.md) with an equivalent [GraphQL](graphql.md) query include a GraphQL request and result in the method example. For example, the following request returns the block number: diff --git a/docs/public-networks/how-to/use-besu-api/index.md b/docs/public-networks/how-to/use-besu-api/index.md index 381c2e4ba93..78a7ccf374c 100644 --- a/docs/public-networks/how-to/use-besu-api/index.md +++ b/docs/public-networks/how-to/use-besu-api/index.md @@ -1,13 +1,13 @@ --- -description: Hyperledger Besu API +description: Besu API tags: - public networks - private networks --- -# Access the Hyperledger Besu API +# Access the Besu API -Access the [Hyperledger Besu API](../../reference/api/index.md) using: +Access the [Besu API](../../reference/api/index.md) using: - [JSON-RPC over HTTP, WebSocket, or IPC](json-rpc.md) - [RPC Pub/Sub over WebSockets](rpc-pubsub.md) diff --git a/docs/public-networks/how-to/use-besu-api/json-rpc.md b/docs/public-networks/how-to/use-besu-api/json-rpc.md index 43837f71cd5..af05d31118e 100644 --- a/docs/public-networks/how-to/use-besu-api/json-rpc.md +++ b/docs/public-networks/how-to/use-besu-api/json-rpc.md @@ -1,7 +1,7 @@ --- title: Use JSON-RPC over HTTP, WS, and IPC sidebar_position: 1 -description: How to access the Hyperledger Besu API using JSON-RPC +description: How to access the Besu API using JSON-RPC tags: - public networks - private networks @@ -35,7 +35,7 @@ To enable JSON-RPC over an [IPC socket](index.md#socket-path), use the `--Xrpc-i ## Geth console -The geth console is a REPL (Read, Evaluate, & Print Loop) JavaScript console. Use JSON-RPC APIs supported by geth and Hyperledger Besu directly in the console. +The geth console is a REPL (Read, Evaluate, & Print Loop) JavaScript console. Use JSON-RPC APIs supported by geth and Besu directly in the console. To use the geth console with Besu: diff --git a/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md b/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md index c33baff8bb8..555d4f7cefc 100644 --- a/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md +++ b/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md @@ -1,7 +1,7 @@ --- title: Use RPC Pub/Sub over WS sidebar_position: 2 -description: Using RPC Pub/Sub with Hyperledger Besu WebSockets +description: Using RPC Pub/Sub with Besu WebSockets tags: - public networks - private networks @@ -25,7 +25,7 @@ Methods specific to RPC Pub/Sub are: :::info -Unlike other [Hyperledger Besu API methods](../../reference/api/index.md), you cannot call the RPC Pub/Sub methods over HTTP. Use the [`--rpc-ws-enabled`](../../reference/cli/options.md#rpc-ws-enabled) option to enable the WebSockets JSON-RPC service. +Unlike other [Besu API methods](../../reference/api/index.md), you cannot call the RPC Pub/Sub methods over HTTP. Use the [`--rpc-ws-enabled`](../../reference/cli/options.md#rpc-ws-enabled) option to enable the WebSockets JSON-RPC service. ::: diff --git a/docs/public-networks/how-to/use-pow/mining.md b/docs/public-networks/how-to/use-pow/mining.md index 09f4bc5876a..ce8e30091e3 100644 --- a/docs/public-networks/how-to/use-pow/mining.md +++ b/docs/public-networks/how-to/use-pow/mining.md @@ -1,7 +1,7 @@ --- title: Configure mining sidebar_position: 1 -description: Using Hyperledger Besu for PoW CPU mining +description: Using Besu for PoW CPU mining tags: - public networks - private networks @@ -9,11 +9,11 @@ tags: # Configure mining -Hyperledger Besu supports CPU and GPU mining, which are configured using command line options. +Besu supports CPU and GPU mining, which are configured using command line options. GPU mining tests used [Ethminer](https://github.com/ethereum-mining/ethminer) with the `stratum+tcp` and `getwork` schemes. -Ethminer has been used with Hyperledger Besu to mine blocks on the Ropsten testnet, ETC Mainnet (uncle block only) and Mordor ETC testnet. +Ethminer has been used with Besu to mine blocks on the Ropsten testnet, ETC Mainnet (uncle block only) and Mordor ETC testnet. :::note - Some mining software supports the `getwork` scheme as the `http` scheme. @@ -22,7 +22,7 @@ Ethminer has been used with Hyperledger Besu to mine blocks on the Ropsten testn ## Configure CPU mining -To enable CPU mining, start Hyperledger Besu with the following options: +To enable CPU mining, start Besu with the following options: ```bash besu --rpc-http-api=ETH,MINER --miner-enabled --miner-coinbase= @@ -36,7 +36,7 @@ Start and stop mining using the [`miner_start`](../../reference/api/index.md#min Besu supports GPU mining, tested using [Ethminer](https://github.com/ethereum-mining/ethminer) with the `stratum+tcp` scheme. -To enable GPU mining, start Hyperledger Besu with the following options: +To enable GPU mining, start Besu with the following options: ```bash besu --rpc-http-api=ETH,MINER --miner-enabled --miner-stratum-enabled --miner-coinbase= diff --git a/docs/public-networks/index.md b/docs/public-networks/index.md index 1e8045a210e..02fcda2d210 100644 --- a/docs/public-networks/index.md +++ b/docs/public-networks/index.md @@ -7,7 +7,7 @@ tags: - public networks --- -# Hyperledger Besu for public networks +# Besu for public networks Besu serves as an [execution client](concepts/node-clients.md#execution-clients) on public proof-of-stake Ethereum networks such as Ethereum Mainnet, Holesky, and Sepolia. @@ -22,4 +22,4 @@ The following diagram outlines the high-level architecture of Besu for public ne ![Public architecture](../assets/images/public-architecture.jpeg) If you have any questions about Besu for public networks, ask on the **besu** channel on -[Hyperledger Discord](https://discord.gg/hyperledger). +[Discord](https://discord.gg/hyperledger). diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index 36a4e6499ae..f0f62a876d0 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -1,7 +1,7 @@ --- title: Besu API sidebar_position: 2 -description: Hyperledger Besu JSON-RPC API methods reference +description: Besu JSON-RPC API methods reference toc_max_heading_level: 3 tags: - public networks diff --git a/docs/public-networks/reference/api/objects.md b/docs/public-networks/reference/api/objects.md index abcaa967329..e9c8d9c78b3 100644 --- a/docs/public-networks/reference/api/objects.md +++ b/docs/public-networks/reference/api/objects.md @@ -1,6 +1,6 @@ --- title: Objects -description: Hyperledger Besu API objects reference +description: Besu API objects reference tags: - public networks - private networks diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 1bd9919862c..b14e0571752 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -1,6 +1,6 @@ --- title: Options -description: Hyperledger Besu command line interface reference +description: Besu command line interface reference sidebar_position: 1 tags: - public networks @@ -11,7 +11,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This reference describes the syntax of the Hyperledger Besu configuration options. +This reference describes the syntax of the Besu configuration options. :::info diff --git a/docs/public-networks/reference/cli/subcommands.md b/docs/public-networks/reference/cli/subcommands.md index c327d8dd04f..0d504bf25c3 100644 --- a/docs/public-networks/reference/cli/subcommands.md +++ b/docs/public-networks/reference/cli/subcommands.md @@ -1,6 +1,6 @@ --- title: Subcommands -description: Hyperledger Besu command line interface subcommands +description: Besu command line interface subcommands sidebar_position: 2 tags: - public networks @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; # Subcommands -This reference describes the syntax of the Hyperledger Besu command line interface (CLI) subcommands. +This reference describes the syntax of the Besu command line interface (CLI) subcommands. :::note diff --git a/docs/public-networks/reference/disclosure.md b/docs/public-networks/reference/disclosure.md index 3182278df61..46444839931 100644 --- a/docs/public-networks/reference/disclosure.md +++ b/docs/public-networks/reference/disclosure.md @@ -1,7 +1,7 @@ --- title: Security disclosure policy sidebar_position: 8 -description: Hyperledger Besu responsible disclosure statement +description: Besu responsible disclosure statement tags: - public networks - private networks @@ -9,6 +9,6 @@ tags: # Security disclosure policy -At Hyperledger Besu, security is a priority. But regardless of how much effort we put into system security, there might still be vulnerabilities present. If you discover a vulnerability, we need to know about it so we can take steps to address it as quickly as possible. We would like you to help us better protect our clients and our systems. +At Besu, security is a priority. But regardless of how much effort we put into system security, there might still be vulnerabilities present. If you discover a vulnerability, we need to know about it so we can take steps to address it as quickly as possible. We would like you to help us better protect our clients and our systems. -Please follow the process explained on [Hyperledger defect response wiki page](https://wiki.hyperledger.org/display/SEC/Defect+Response). +Please follow the process explained on [defect response wiki page](https://wiki.hyperledger.org/display/SEC/Defect+Response). diff --git a/docusaurus.config.js b/docusaurus.config.js index 1219a18851c..0092da6d004 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -184,9 +184,9 @@ const config = { }, footer: { copyright: - "Hyperledger Besu and its documentation are licensed under the Apache 2.0 license.", + "Besu and its documentation are licensed under the Apache 2.0 license.", logo: { - alt: "Hyperledger Besu logo", + alt: "Besu logo", src: "img/logo.svg", srcDark: "img/logo-reversed.svg", href: "https://www.hyperledger.org/use/besu", @@ -247,23 +247,23 @@ const config = { title: "Community", items: [ { - label: "Hyperledger Discord", + label: "Discord", href: "https://discord.gg/hyperledger", }, { - label: "Hyperledger Besu Wiki", + label: "Besu Wiki", href: "https://wiki.hyperledger.org/display/BESU/Hyperledger+Besu", }, { - label: "Hyperledger Besu Twitter", + label: "Besu Twitter", href: "https://twitter.com/HyperledgerBesu", }, { - label: "Hyperledger Besu GitHub", + label: "Besu GitHub", href: "https://github.com/hyperledger/besu/", }, { - label: "Hyperledger Besu documentation GitHub", + label: "Besu documentation GitHub", href: "https://github.com/hyperledger/besu-docs", }, ],