Skip to content

Commit

Permalink
Merge branch 'main' into privacy-cli-dep
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandratran authored Nov 24, 2024
2 parents 3d18015 + 85dcf4c commit 5175a8e
Show file tree
Hide file tree
Showing 31 changed files with 191 additions and 29 deletions.
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/permissioning/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,13 @@ Local permissioning affects your node but not the rest of the network. Use local

Local permissioning does not require coordination with the rest of the network and you can act immediately to protect your node. Your rules are not enforced in blocks produced by other nodes.

### Onchain
### Onchain (Deprecated)

:::caution

Onchain permissioning is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

[Onchain permissioning](onchain.md) works through a smart contract on the network. Specifying permissioning onchain enables all nodes to read and update permissioning configuration from one location.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/permissioning/onchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Onchain permissioning
# Onchain permissioning (Deprecated)

:::caution

Onchain permissioning is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Onchain [permissioning](index.md) uses smart contracts to store and administer the node, account, and admin allowlists. Using onchain permissioning enables all nodes to read the allowlists from a single source, the blockchain.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/privacy/flexible-privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ sidebar_position: 3
description: Flexible privacy groups
---

# Flexible privacy groups
# Flexible privacy groups (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Flexible [privacy groups](privacy-groups.md) use smart contracts to store and maintain the group membership. You can [add and remove members to and from flexible privacy groups](../../how-to/use-privacy/flexible.md).

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/privacy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ sidebar_position: 1
description: Privacy
---

# Privacy
# Privacy (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

In Besu, privacy refers to the ability to keep transactions private between the involved participants. Other participants cannot access the transaction content or list of participants.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/privacy/multi-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ sidebar_position: 4
description: Multi-tenancy
---

# Multi-tenancy
# Multi-tenancy (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

By default, each participant in a privacy network uses its own Besu and Tessera node.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/privacy/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ description: Privacy plugin
sidebar_position: 5
---

# Privacy plugin
# Privacy plugin (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/concepts/privacy/privacy-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ sidebar_position: 2
description: Privacy groups
---

# Privacy groups
# Privacy groups (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

A privacy group is a group of nodes identified by a unique privacy group ID by Tessera. Tessera stores each private transaction with the privacy group ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@
description: Private transaction overview
---

# Private transactions
# Private transactions (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Private transactions have the same parameters as public Ethereum transactions, with the following additions:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ sidebar_position: 1
description: Private transaction processing
---

# Private transaction processing
# Private transaction processing (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Processing [private transactions](index.md) involves the following:

Expand Down
3 changes: 3 additions & 0 deletions docs/private-networks/how-to/configure/bootnodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ In production networks, [configure two or more nodes as bootnodes](#configure-bo

Bootnodes and static nodes are parallel methods for finding peers. Depending on your use case, you can use only bootnodes, only static nodes, or both bootnodes and static nodes.

When connecting to bootnodes, Besu attempts to connect to all bootnodes at once, at startup.
When connecting to static nodes, Besu attempts to reconnect periodically, if the connection fails or is lost.

To find peers, configure one or more bootnodes. To configure a specific set of peer connections, use [static nodes](../../../public-networks/how-to/connect/static-nodes.md).

:::
Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/monitor/quorum-hibernate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Use Quorum Hibernate
# Use Quorum Hibernate (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

[Quorum Hibernate] is a proxy that monitors a node's API traffic and hibernates the node when inactive. This reduces infrastructure costs by ensuring only nodes receiving API requests or nodes required to establish consensus are running.

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

# Send concurrent private transactions
# Send concurrent private transactions (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Private transaction processing involves two transactions, the private transaction and the [privacy marker transaction (PMT)](../../concepts/privacy/private-transactions/processing.md). The private transaction and the PMT each have their own [nonce](../../concepts/privacy/private-transactions/index.md#nonces).

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

# Create and send private transactions
# Create and send private transactions (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Create and send [private transactions](../../concepts/privacy/index.md) using:

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/use-permissioning/local.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Transaction validation against the accounts allowlist occurs at the following po

After adding transactions to a block, the transactions are not validated against the allowlist when received by another node. That is, a node can synchronize and add blocks containing transactions from accounts that are not on the accounts allowlist of that node.

The following diagram illustrates applying local and onchain permissioning rules.
The following diagram illustrates applying local and [onchain permissioning] rules.

![Permissioning Flow](../../../assets/images/PermissioningFlow.png)

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-permissioning/onchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Use onchain permissioning
# Use onchain permissioning (Deprecated)

:::caution

Onchain permissioning is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

This page contains some extra info if you're using [onchain permissioning](../../concepts/permissioning/onchain.md).

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

# Access private and privacy marker transactions
# Access private and privacy marker transactions (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/besu-extended.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Use Besu-extended privacy
# Use Besu-extended privacy (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/eea-compliant.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Use EEA-compliant privacy
# Use EEA-compliant privacy (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/flexible.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Use flexible privacy groups
# Use flexible privacy groups (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

Use the [`web3js-quorum` library](https://github.com/ConsenSys/web3js-quorum) to create and update membership of [flexible privacy groups](../../concepts/privacy/flexible-privacy.md).

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

# Performance best practices
# Privacy performance best practices (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

This document collects deployment and usage tips to help you achieve high performance for private transactions. If transaction throughput or latency is not meeting your expectations, please consider the following before raising an issue.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/privacy-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Create and manage privacy groups
# Create and manage privacy groups (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/sign-pmts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Sign privacy marker transactions
# Sign privacy marker transactions (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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-deprecated) when starting Besu.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/tessera.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Run Tessera with Besu
# Run Tessera with Besu (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/how-to/use-privacy/web3js-quorum.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ tags:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Use the web3js-quorum client library
# Use the web3js-quorum client library (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

[web3js-quorum](https://github.com/ConsenSys/web3js-quorum) is an Ethereum JavaScript library extending [web3.js](https://github.com/ethereum/web3.js/) that adds support for Besu-specific JSON-RPC APIs and features. Use the library to create and send RLP-encoded transactions using JSON-RPC.

Expand Down
2 changes: 1 addition & 1 deletion docs/private-networks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags:

You can use Besu to develop enterprise applications requiring secure, high-performance transaction processing in a private network.

A private network is a network not connected to Ethereum Mainnet or an Ethereum testnet. Private networks typically use a different [chain ID](../public-networks/concepts/network-and-chain-id.md) and proof of authority consensus ([QBFT](how-to/configure/consensus/qbft.md), [IBFT 2.0](how-to/configure/consensus/ibft.md), or [Clique](how-to/configure/consensus/clique.md)).
A private (also known as permissioned) network is a network not connected to Ethereum Mainnet or an Ethereum testnet. Private networks typically use a different [chain ID](../public-networks/concepts/network-and-chain-id.md) and proof of authority consensus ([QBFT](how-to/configure/consensus/qbft.md), [IBFT 2.0](how-to/configure/consensus/ibft.md), or [Clique](how-to/configure/consensus/clique.md)).

You can also [create a local development network](tutorials/ethash.md) using proof of work (Ethash).

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/tutorials/privacy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ tags:
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Create a privacy-enabled network
# Create a privacy-enabled network (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

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.

Expand Down
8 changes: 7 additions & 1 deletion docs/private-networks/tutorials/privacy/multi-tenancy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ tags:
- private networks
---

# Configure a multi-tenant node
# Configure a multi-tenant node (Deprecated)

:::caution

Tessera-based privacy is deprecated in Besu version 24.11.0 and later. Please read this [blog post](https://www.lfdecentralizedtrust.org/blog/sunsetting-tessera-and-simplifying-hyperledger-besu) for more context on the rationale behind this decision as well as alternative options.

:::

You can configure Besu and associated Tessera node in a privacy-enabled network to host [multiple tenants](../../concepts/privacy/multi-tenancy.md).

Expand Down
Loading

0 comments on commit 5175a8e

Please sign in to comment.