From 50c5e50c4b01a9cca4852f153c53cf6fa7d0a9e5 Mon Sep 17 00:00:00 2001 From: Sally MacFarlane Date: Fri, 22 Nov 2024 13:40:03 +1000 Subject: [PATCH 1/3] change references to Besu prior to 25.1.0 Signed-off-by: Sally MacFarlane --- docs/Concepts/Multitenancy.md | 14 +++++++------- docs/Concepts/Privacy-Groups.md | 10 +++++----- docs/Concepts/Privacy-Manager/Privacy-manager.md | 2 +- docs/HowTo/Configure/Orion-Mode.md | 12 ++++++------ docs/HowTo/Configure/Tessera.md | 2 +- .../HowTo/Get-started/Use-GoQuorum-with-Tessera.md | 10 +++++----- docs/HowTo/Migrate/MigrateFromOrion.md | 6 +++--- docs/Reference/SampleConfiguration.md | 2 +- docs/index.md | 2 +- 9 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/Concepts/Multitenancy.md b/docs/Concepts/Multitenancy.md index 85bc47b..874ac02 100644 --- a/docs/Concepts/Multitenancy.md +++ b/docs/Concepts/Multitenancy.md @@ -5,12 +5,12 @@ description: Tessera and GoQuorum multi-tenancy # Multi-tenancy In a typical [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or -[Hyperledger Besu privacy-enabled](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Overview/) network, -each participant (tenant) uses their own GoQuorum or Besu node and Tessera node. +[Hyperledger Besu versions prior to 25.1.0 privacy-enabled](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Overview/) network, +each participant (tenant) uses their own GoQuorum or Besu (versions prior to 25.1.0) node and Tessera node. Tessera can be configured to manage multiple key pairs owned by one tenant. This model is costly to run and scale as more tenants join the network. -Multi-tenancy allows multiple tenants to use the same GoQuorum or Besu node, with each tenant having its own private state. +Multi-tenancy allows multiple tenants to use the same GoQuorum or Besu (versions prior to 25.1.0 node), with each tenant having its own private state. Each tenant can perform all operations (create, read, and write) on any contract in its private state. Multi-tenancy provides a user experience similar to a user running their own managed node. @@ -20,7 +20,7 @@ multiple private states. The public state remains publicly available to all tenants, and private states are logically separated. For more information about GoQuorum multi-tenancy via MPS, see the [GoQuorum multi-tenancy documentation](https://consensys.net/docs/goquorum/en/stable/concepts/multi-tenancy/). -For more information about Besu multi-tenancy, see the [Besu multi-tenancy documentation](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Multi-Tenancy/). +For more information about Besu (versions prior to 25.1.0) multi-tenancy, see the [Besu multi-tenancy documentation](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Multi-Tenancy/). ## Use GoQuorum multi-tenancy @@ -40,8 +40,8 @@ To use GoQuorum multi-tenancy via MPS: 3. You can also [add a new tenant to a multi-tenant node](https://consensys.net/docs/goquorum/en/stable/configure-and-manage/manage/multi-tenancy/multi-tenancy/). -## Use Besu multi-tenancy +## Use Besu (versions prior to 25.1.0) multi-tenancy -To use Besu multi-tenancy, you must [create a privacy-enabled network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). +To use Besu versions prior to 25.1.0 multi-tenancy, you must [create a privacy-enabled network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). -Configure multi-tenant Besu and Tessera nodes according to the [Besu multi-tenancy configuration tutorial](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). +Configure multi-tenant Besu (versions prior to 25.1.0) and Tessera nodes according to the [Besu multi-tenancy configuration tutorial](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). diff --git a/docs/Concepts/Privacy-Groups.md b/docs/Concepts/Privacy-Groups.md index 68c6dc4..911694b 100644 --- a/docs/Concepts/Privacy-Groups.md +++ b/docs/Concepts/Privacy-Groups.md @@ -4,7 +4,7 @@ description: Tessera privacy groups # Privacy groups -Tessera supports operations related to [Hyperledger Besu privacy groups](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Groups/) +Tessera supports operations related to [Hyperledger Besu (versions prior to 25.1.0) privacy groups](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Groups/) and [resident groups for GoQuorum multiple private states (MPS)](https://consensys.net/docs/goquorum/en/latest/concepts/multi-tenancy/#tessera-resident-groups), such as managing privacy group data and handling transactions intended for a privacy group. @@ -46,7 +46,7 @@ The following is an example of a privacy group and its related data: Tessera automatically creates a legacy privacy group when a private transaction is sent to a list of recipient public keys using `privateFor`. -When returning private transaction data to a Besu client (as part of a `/receive` response), the legacy `privacyGroupId` +When returning private transaction data to a Besu (versions prior to 25.1.0) client (as part of a `/receive` response), the legacy `privacyGroupId` is also returned. The legacy `privacyGroupId` is generated by hashing the list of recipient keys. @@ -54,12 +54,12 @@ For a given set of recipients, there can be only one legacy privacy group. !!! note - Besu and Tessera generate the same legacy `privacyGroupId` from the same list of recipients. + Besu versions prior to 25.1.0 and Tessera generate the same legacy `privacyGroupId` from the same list of recipients. ### Pantheon Tessera supports API methods that enable the creation of pantheon privacy groups from a compatible blockchain client -(for example, Besu). +(for example, Besu versions prior to 25.1.0). Upon creation, the privacy group is distributed to all members ahead of transaction processing. @@ -92,6 +92,6 @@ supporting a correct version, otherwise the transaction fails with `PrivacyGroup ## Privacy group APIs -Privacy group compatible blockchain clients (for example, Besu) can be used to create, delete, find, and retrieve +Privacy group compatible blockchain clients (for example, Besu versions prior to 25.1.0) can be used to create, delete, find, and retrieve privacy groups. Tessera's [`Q2T` API](https://consensys.github.io/tessera/#tag/quorum-to-tessera) adds support for these operations. diff --git a/docs/Concepts/Privacy-Manager/Privacy-manager.md b/docs/Concepts/Privacy-Manager/Privacy-manager.md index 5402303..710dd32 100644 --- a/docs/Concepts/Privacy-Manager/Privacy-manager.md +++ b/docs/Concepts/Privacy-Manager/Privacy-manager.md @@ -5,7 +5,7 @@ description: Overview of Tessera privacy manager # Privacy manager Tessera is the privacy manager for the [GoQuorum](https://docs.goquorum.consensys.net) and -[Hyperledger Besu](https://besu.hyperledger.org/en/stable/) Ethereum clients. +[Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/) Ethereum clients. A privacy manager consists of two components, each with their own responsibilities: diff --git a/docs/HowTo/Configure/Orion-Mode.md b/docs/HowTo/Configure/Orion-Mode.md index 46ec112..2f8c8a9 100644 --- a/docs/HowTo/Configure/Orion-Mode.md +++ b/docs/HowTo/Configure/Orion-Mode.md @@ -1,12 +1,12 @@ --- -description: Configure Tessera to use Besu. +description: Configure Tessera to use Besu versions prior to 25.1.0. --- -# Configure Hyperledger Besu support +# Configure Hyperledger Besu versions prior to 25.1.0 support -Tessera provides support for [Hyperledger Besu](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Privacy/). +Tessera provides support for [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Privacy/). -To enable Besu support in Tessera, set [`mode`](../../Reference/SampleConfiguration.md#mode) in the +To enable Besu versions prior to 25.1.0 support in Tessera, set [`mode`](../../Reference/SampleConfiguration.md#mode) in the Tessera [configuration file](Tessera.md) to `orion`. !!! example "Orion mode configuration" @@ -26,7 +26,7 @@ If you enable `orion` mode, Tessera: * Attempts to retrieve the [privacy group](../../Concepts/Privacy-Groups.md) and its associated members for transactions sent with `privacyGroupId`. * Creates a legacy privacy group for transactions sent with `privateFor` containing a list of recipient keys. -* Uses SHA-512/256 to generate 32-byte hashes of encrypted payloads to be returned to Besu. +* Uses SHA-512/256 to generate 32-byte hashes of encrypted payloads to be returned to Besu versions prior to 25.1.0. * Adds support for `/receive` `POST` requests using the `application/json` media type. -* Includes the `senderKey` (for Besu sender authentication) and the transaction's associated `privacyGroupId` in +* Includes the `senderKey` (for Besu versions prior to 25.1.0 sender authentication) and the transaction's associated `privacyGroupId` in responses to `/receive` requests. diff --git a/docs/HowTo/Configure/Tessera.md b/docs/HowTo/Configure/Tessera.md index e0765da..62b4b15 100644 --- a/docs/HowTo/Configure/Tessera.md +++ b/docs/HowTo/Configure/Tessera.md @@ -20,7 +20,7 @@ You can also configure: - An [external database](Database.md). - Support for [multiple private states](Multiple-private-state.md) and [resident groups](Multiple-private-state.md#resident-groups). - [Cryptographic elliptic curves](Cryptographic-elliptic-curves.md). -- Support for [Hyperledger Besu](Orion-Mode.md). +- Support for [Hyperledger Besu versions prior to 25.1.0](Orion-Mode.md). - [High availability](High-availability.md). You can [override configuration options](Override-config.md) using the command line. diff --git a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md index ebd38ac..b14a821 100644 --- a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md +++ b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md @@ -2,17 +2,17 @@ description: Use GoQuorum with Tessera to create private networks and send private transactions --- -# Use GoQuorum or Besu with Tessera +# Use GoQuorum or Besu versions prior to 25.1.0 with Tessera You can use Tessera as the private transaction manager for [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or -[Hyperledger Besu](https://besu.hyperledger.org/en/stable/). +[Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/). Get started with the following tutorials: - [Create a privacy-enabled GoQuorum network](https://consensys.net/docs/goquorum/en/stable/tutorials/create-privacy-enabled-network/). - [Send a private transaction on GoQuorum](https://consensys.net/docs/goquorum/en/stable/tutorials/send-private-transaction/). -- [Create a privacy-enabled Besu network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). -- [Configure a multi-tenant Besu network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). -- [Use the Besu multi-node example in the web3js-quorum library](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/web3js-quorum-Multinode-example/). +- [Create a privacy-enabled Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). +- [Configure a multi-tenant Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). +- [Use the Besu (versions prior to 25.1.0) multi-node example in the web3js-quorum library](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/web3js-quorum-Multinode-example/). !!! Note diff --git a/docs/HowTo/Migrate/MigrateFromOrion.md b/docs/HowTo/Migrate/MigrateFromOrion.md index de41959..6f686f9 100644 --- a/docs/HowTo/Migrate/MigrateFromOrion.md +++ b/docs/HowTo/Migrate/MigrateFromOrion.md @@ -5,14 +5,14 @@ description: Migrate your Orion configuration and data to Tessera. # Migrating from Orion to Tessera -A utility is included in Tessera which enables migration of an Orion configuration file and database to a Tessera configuration file and database for Hyperledger Besu users. +A utility is included in Tessera which enables migration of an Orion configuration file and database to a Tessera configuration file and database for Hyperledger Besu (versions prior to 25.1.0). A full migration workflow would be as follows: 1. Download or build the migration utility. -1. Shut down the Orion and Hyperledger Besu nodes. +1. Shut down the Orion and Hyperledger Besu (versions prior to 25.1.0) nodes. 1. Perform the migration. 1. Start Tessera with the new configuration and database files. -1. Start Hyperledger Besu nodes. +1. Start Hyperledger Besu (versions prior to 25.1.0) nodes. A full tutorial including links to the utility and example code can be found [here](https://docs.orion.consensys.net/en/latest/Tutorials/Migrating-from-Orion-to-Tessera/). diff --git a/docs/Reference/SampleConfiguration.md b/docs/Reference/SampleConfiguration.md index 66d41d9..af6afd8 100644 --- a/docs/Reference/SampleConfiguration.md +++ b/docs/Reference/SampleConfiguration.md @@ -157,7 +157,7 @@ Configuration items can be [overridden from the command line]. ### `mode` Set the `mode` to `orion` to use Tessera as the privacy manager when using -[Hyperledger Besu in non-GoQuorum mode](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy/). +[Hyperledger Besu versions prior to 25.1.0 in non-GoQuorum mode](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy/). [Enabling this mode](../HowTo/Configure/Orion-Mode.md) changes Tessera's behavior. This property is optional. diff --git a/docs/index.md b/docs/index.md index 2124ca9..d989858 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ description: Tessera is an open-source private transaction manager developed und Tessera is an open-source private transaction manager developed under the Apache 2.0 license and written in Java. The primary application of Tessera is as the privacy manager for privacy-enabled Ethereum clients such as [GoQuorum](https://docs.goquorum.consensys.net) and -[Hyperledger Besu](https://besu.hyperledger.org/en/stable/). +[Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/). ## What can you do with Tessera? From e16d0bb2e36e3fd71e63c2258e6cf7ca9c926b1f Mon Sep 17 00:00:00 2001 From: Sally MacFarlane Date: Fri, 22 Nov 2024 13:58:16 +1000 Subject: [PATCH 2/3] fixed links to privacy content Signed-off-by: Sally MacFarlane --- docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md index cc2c043..b862bd0 100644 --- a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md +++ b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md @@ -6,14 +6,14 @@ sidebar_position: 3 # Use GoQuorum or Besu versions prior to 25.1.0 with Tessera -You can use Tessera as the private transaction manager for [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/). +You can use Tessera as the private transaction manager for [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org). Get started with the following tutorials: - [Create a privacy-enabled GoQuorum network](https://consensys.net/docs/goquorum/en/stable/tutorials/create-privacy-enabled-network/). - [Send a private transaction on GoQuorum](https://consensys.net/docs/goquorum/en/stable/tutorials/send-private-transaction/). -- [Create a privacy-enabled Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). -- [Configure a multi-tenant Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). -- [Use the Besu (versions prior to 25.1.0) multi-node example in the web3js-quorum library](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/web3js-quorum-Multinode-example/). +- [Create a privacy-enabled Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/private-networks/concepts/privacy). +- [Configure a multi-tenant Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/private-networks/concepts/privacy/multi-tenancy). +- [Use the Besu (versions prior to 25.1.0) multi-node example in the web3js-quorum library](https://besu.hyperledger.org/private-networks/tutorials/privacy/web3js-quorum). :::note From f727afaf1e3b686227cd0c2bee1bcfdb792d4876 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Sun, 24 Nov 2024 11:58:52 -0800 Subject: [PATCH 3/3] edits --- docs/Concepts/Multitenancy.md | 15 +++++++++------ docs/Concepts/Privacy-Groups.md | 13 ++++++++----- docs/Concepts/Privacy-Manager/Privacy-manager.md | 2 +- docs/HowTo/Configure/Orion-Mode.md | 12 ++++++------ docs/HowTo/Configure/Tessera.md | 2 +- .../Get-started/Use-GoQuorum-with-Tessera.md | 12 +++++++----- docs/HowTo/Migrate/MigrateFromOrion.md | 7 ++++--- docs/Reference/SampleConfiguration.md | 2 +- docs/index.md | 4 +++- 9 files changed, 40 insertions(+), 29 deletions(-) diff --git a/docs/Concepts/Multitenancy.md b/docs/Concepts/Multitenancy.md index 16dca69..609d354 100644 --- a/docs/Concepts/Multitenancy.md +++ b/docs/Concepts/Multitenancy.md @@ -6,15 +6,18 @@ sidebar_position: 4 # Multi-tenancy -In a typical [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or [Hyperledger Besu versions prior to 25.1.0 privacy-enabled](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Overview/) network, each participant (tenant) uses their own GoQuorum or Besu (versions prior to 25.1.0) node and Tessera node. Tessera can be configured to manage multiple key pairs owned by one tenant. This model is costly to run and scale as more tenants join the network. +In a typical [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) network or +[privacy-enabled Hyperledger Besu](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Overview/) network (versions earlier than 25.1.0), +each participant (tenant) uses their own GoQuorum or Besu node and Tessera node. +You can configure Tessera to manage multiple key pairs owned by one tenant. This model is costly to run and scale as more tenants join the network. -Multi-tenancy allows multiple tenants to use the same GoQuorum or Besu (versions prior to 25.1.0) node, with each tenant having its own private state. Each tenant can perform all operations (create, read, and write) on any contract in its private state. Multi-tenancy provides a user experience similar to a user running their own managed node. +Multi-tenancy allows multiple tenants to use the same GoQuorum or Besu node, with each tenant having its own private state. Each tenant can perform all operations (create, read, and write) on any contract in its private state. Multi-tenancy provides a user experience similar to a user running their own managed node. In GoQuorum, you can enable multi-tenancy via multiple private states (MPS), which allows each tenant to have access to multiple private states. The public state remains publicly available to all tenants, and private states are logically separated. -For more information about GoQuorum multi-tenancy via MPS, see the [GoQuorum multi-tenancy documentation](https://consensys.net/docs/goquorum/en/stable/concepts/multi-tenancy/). For more information about Besu (versions prior to 25.1.0) multi-tenancy, see the [Besu multi-tenancy documentation](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Multi-Tenancy/). +For more information about GoQuorum multi-tenancy via MPS, see the [GoQuorum multi-tenancy documentation](https://consensys.net/docs/goquorum/en/stable/concepts/multi-tenancy/). For more information about Besu multi-tenancy, see the [Besu multi-tenancy documentation](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Multi-Tenancy/). ## Use GoQuorum multi-tenancy @@ -31,8 +34,8 @@ To use GoQuorum multi-tenancy via MPS: 3. You can also [add a new tenant to a multi-tenant node](https://consensys.net/docs/goquorum/en/stable/configure-and-manage/manage/multi-tenancy/multi-tenancy/). -## Use Besu (versions prior to 25.1.0) multi-tenancy +## Use Besu multi-tenancy -To use Besu versions prior to 25.1.0 multi-tenancy, you must [create a privacy-enabled network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). +To use Besu multi-tenancy, you must use a Besu version earlier than 25.1.0, and [create a privacy-enabled network](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Privacy/). -Configure multi-tenant Besu (versions prior to 25.1.0) and Tessera nodes according to the [Besu multi-tenancy configuration tutorial](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). +Configure multi-tenant Besu and Tessera nodes according to the [Besu multi-tenancy configuration tutorial](https://besu.hyperledger.org/en/stable/Tutorials/Privacy/Configuring-Multi-Tenancy/). diff --git a/docs/Concepts/Privacy-Groups.md b/docs/Concepts/Privacy-Groups.md index f4a24f2..c63feab 100644 --- a/docs/Concepts/Privacy-Groups.md +++ b/docs/Concepts/Privacy-Groups.md @@ -6,7 +6,8 @@ sidebar_position: 3 # Privacy groups -Tessera supports operations related to [Hyperledger Besu (versions prior to 25.1.0) privacy groups](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Groups/) and [resident groups for GoQuorum multiple private states (MPS)](https://consensys.net/docs/goquorum/en/latest/concepts/multi-tenancy/#tessera-resident-groups), such as managing privacy group data and handling transactions intended for a privacy group. +Tessera supports operations related to [Hyperledger Besu privacy groups (versions earlier than 25.1.0)](https://besu.hyperledger.org/en/stable/Concepts/Privacy/Privacy-Groups/) +and [resident groups for GoQuorum multiple private states (MPS)](https://consensys.net/docs/goquorum/en/latest/concepts/multi-tenancy/#tessera-resident-groups), such as managing privacy group data and handling transactions intended for a privacy group. Behavior may differ depending on which [`mode`](../HowTo/Configure/Orion-Mode.md) Tessera is running on. @@ -45,18 +46,20 @@ The following is an example of a privacy group and its related data: Tessera automatically creates a legacy privacy group when a private transaction is sent to a list of recipient public keys using `privateFor`. -When returning private transaction data to a Besu (versions prior to 25.1.0) client (as part of a `/receive` response), the legacy `privacyGroupId` +When returning private transaction data to a Besu client (as part of a `/receive` response), the legacy `privacyGroupId` is also returned. The legacy `privacyGroupId` is generated by hashing the list of recipient keys. For a given set of recipients, there can be only one legacy privacy group. :::note - Besu versions prior to 25.1.0 and Tessera generate the same legacy `privacyGroupId` from the same list of recipients. +Besu and Tessera generate the same legacy `privacyGroupId` from the same list of recipients. + +::: ### Pantheon -Tessera supports API methods that enable the creation of pantheon privacy groups from a compatible blockchain client (for example, Besu versions prior to 25.1.0). +Tessera supports API methods that enable the creation of pantheon privacy groups from a compatible blockchain client (for example, Besu). Upon creation, the privacy group is distributed to all members ahead of transaction processing. @@ -84,4 +87,4 @@ In API version 3.0, Tessera includes the privacy group in the encoded payload in ## Privacy group APIs -Privacy group compatible blockchain clients (for example, Besu versions prior to 25.1.0) can be used to create, delete, find, and retrieve privacy groups. Tessera's [`Q2T` API](https://consensys.github.io/tessera/#tag/quorum-to-tessera) adds support for these operations. +Privacy group compatible blockchain clients (for example, Besu) can be used to create, delete, find, and retrieve privacy groups. Tessera's [`Q2T` API](https://consensys.github.io/tessera/#tag/quorum-to-tessera) adds support for these operations. diff --git a/docs/Concepts/Privacy-Manager/Privacy-manager.md b/docs/Concepts/Privacy-Manager/Privacy-manager.md index a50455d..aca3803 100644 --- a/docs/Concepts/Privacy-Manager/Privacy-manager.md +++ b/docs/Concepts/Privacy-Manager/Privacy-manager.md @@ -6,7 +6,7 @@ sidebar_position: 1 # Privacy manager -Tessera is the privacy manager for the [GoQuorum](https://docs.goquorum.consensys.net) and [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/) Ethereum clients. +Tessera is the privacy manager for [GoQuorum](https://docs.goquorum.consensys.net) and [Hyperledger Besu versions earlier than 25.1.0](https://besu.hyperledger.org/en/stable/). A privacy manager consists of two components, each with their own responsibilities: diff --git a/docs/HowTo/Configure/Orion-Mode.md b/docs/HowTo/Configure/Orion-Mode.md index 8f8a1bf..5bbf06f 100644 --- a/docs/HowTo/Configure/Orion-Mode.md +++ b/docs/HowTo/Configure/Orion-Mode.md @@ -1,14 +1,14 @@ --- title: Hyperledger Besu support -description: Configure Tessera to use Besu versions prior to 25.1.0. +description: Configure Tessera to use Besu. sidebar_position: 11 --- -# Configure Hyperledger Besu versions prior to 25.1.0 support +# Configure Hyperledger Besu support -Tessera provides support for [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Privacy/). +Tessera provides support for [Hyperledger Besu versions earlier than 25.1.0](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Privacy/). -To enable Besu versions prior to 25.1.0 support in Tessera, set [`mode`](../../Reference/SampleConfiguration.md#mode) in the Tessera [configuration file](Tessera.md) to `orion`. +To enable Besu support in Tessera, set [`mode`](../../Reference/SampleConfiguration.md#mode) in the Tessera [configuration file](Tessera.md) to `orion`. ```json title="Orion mode configuration" "mode": "orion", @@ -25,6 +25,6 @@ If you enable `orion` mode, Tessera: * Attempts to retrieve the [privacy group](../../Concepts/Privacy-Groups.md) and its associated members for transactions sent with `privacyGroupId`. * Creates a legacy privacy group for transactions sent with `privateFor` containing a list of recipient keys. -* Uses SHA-512/256 to generate 32-byte hashes of encrypted payloads to be returned to Besu versions prior to 25.1.0. +* Uses SHA-512/256 to generate 32-byte hashes of encrypted payloads to be returned to Besu. * Adds support for `/receive` `POST` requests using the `application/json` media type. -* Includes the `senderKey` (for Besu versions prior to 25.1.0 sender authentication) and the transaction's associated `privacyGroupId` in responses to `/receive` requests. +* Includes the `senderKey` (for Besu sender authentication) and the transaction's associated `privacyGroupId` in responses to `/receive` requests. diff --git a/docs/HowTo/Configure/Tessera.md b/docs/HowTo/Configure/Tessera.md index b5346f3..8233ed9 100644 --- a/docs/HowTo/Configure/Tessera.md +++ b/docs/HowTo/Configure/Tessera.md @@ -20,7 +20,7 @@ You can also configure: - An [external database](Database.md). - Support for [multiple private states](Multiple-private-state.md) and [resident groups](Multiple-private-state.md#resident-groups). - [Cryptographic elliptic curves](Cryptographic-elliptic-curves.md). -- Support for [Hyperledger Besu versions prior to 25.1.0](Orion-Mode.md). +- Support for [Hyperledger Besu versions earlier than 25.1.0](Orion-Mode.md). - [High availability](High-availability.md). You can [override configuration options](Override-config.md) using the command line. diff --git a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md index b862bd0..8ec6845 100644 --- a/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md +++ b/docs/HowTo/Get-started/Use-GoQuorum-with-Tessera.md @@ -4,17 +4,19 @@ description: Use GoQuorum with Tessera to create private networks and send priva sidebar_position: 3 --- -# Use GoQuorum or Besu versions prior to 25.1.0 with Tessera +# Use GoQuorum or Besu with Tessera -You can use Tessera as the private transaction manager for [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org). +You can use Tessera as the private transaction manager for [GoQuorum](https://consensys.net/docs/goquorum/en/stable/) or [Hyperledger Besu versions earlier than 25.1.0](https://besu.hyperledger.org). Get started with the following tutorials: - [Create a privacy-enabled GoQuorum network](https://consensys.net/docs/goquorum/en/stable/tutorials/create-privacy-enabled-network/). - [Send a private transaction on GoQuorum](https://consensys.net/docs/goquorum/en/stable/tutorials/send-private-transaction/). -- [Create a privacy-enabled Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/private-networks/concepts/privacy). -- [Configure a multi-tenant Besu (versions prior to 25.1.0) network](https://besu.hyperledger.org/private-networks/concepts/privacy/multi-tenancy). -- [Use the Besu (versions prior to 25.1.0) multi-node example in the web3js-quorum library](https://besu.hyperledger.org/private-networks/tutorials/privacy/web3js-quorum). +- [Create a privacy-enabled Besu network](https://besu.hyperledger.org/private-networks/concepts/privacy). +- [Configure a multi-tenant Besu network](https://besu.hyperledger.org/private-networks/concepts/privacy/multi-tenancy). +- [Use the Besu multi-node example in the web3js-quorum library](https://besu.hyperledger.org/private-networks/tutorials/privacy/web3js-quorum). :::note All Tessera nodes included in a private transaction must be running when the private transaction is sent. Otherwise, the transaction doesn't propagate and an error is returned. + +::: \ No newline at end of file diff --git a/docs/HowTo/Migrate/MigrateFromOrion.md b/docs/HowTo/Migrate/MigrateFromOrion.md index 3cf37c3..57e1d35 100644 --- a/docs/HowTo/Migrate/MigrateFromOrion.md +++ b/docs/HowTo/Migrate/MigrateFromOrion.md @@ -6,14 +6,15 @@ sidebar_position: 1 # Migrating from Orion to Tessera -A utility is included in Tessera which enables migration of an Orion configuration file and database to a Tessera configuration file and database for Hyperledger Besu (versions prior to 25.1.0). +Tessera includes a utility that enables migration of an Orion configuration file and database to a Tessera configuration file and database, +for Hyperledger Besu (versions earlier than 25.1.0). A full migration workflow would be as follows: 1. Download or build the migration utility. -1. Shut down the Orion and Hyperledger Besu (versions prior to 25.1.0) nodes. +1. Shut down the Orion and Hyperledger Besu nodes. 1. Perform the migration. 1. Start Tessera with the new configuration and database files. -1. Start Hyperledger Besu (versions prior to 25.1.0) nodes. +1. Start Hyperledger Besu nodes. A full tutorial including links to the utility and example code can be found [here](https://docs.orion.consensys.net/en/latest/Tutorials/Migrating-from-Orion-to-Tessera/). diff --git a/docs/Reference/SampleConfiguration.md b/docs/Reference/SampleConfiguration.md index 2f88f57..2e694d0 100644 --- a/docs/Reference/SampleConfiguration.md +++ b/docs/Reference/SampleConfiguration.md @@ -152,7 +152,7 @@ Configuration items can be [overridden from the command line]. ### `mode` -Set the `mode` to `orion` to use Tessera as the privacy manager when using [Hyperledger Besu versions prior to 25.1.0 in non-GoQuorum mode](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy/). [Enabling this mode](../HowTo/Configure/Orion-Mode.md) changes Tessera's behavior. This property is optional. +Set the `mode` to `orion` to use Tessera as the privacy manager when using [Hyperledger Besu (versions earlier than 25.1.0) in non-GoQuorum mode](https://besu.hyperledger.org/en/stable/HowTo/Use-Privacy/Use-GoQuorum-compatible-privacy/). [Enabling this mode](../HowTo/Configure/Orion-Mode.md) changes Tessera's behavior. This property is optional. ### `useWhiteList` diff --git a/docs/index.md b/docs/index.md index 58598fc..d1d7d45 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,9 @@ slug: overview ## What is Tessera? -Tessera is an open-source private transaction manager developed under the Apache 2.0 license and written in Java. The primary application of Tessera is as the privacy manager for privacy-enabled Ethereum clients such as [GoQuorum](https://docs.goquorum.consensys.net) and [Hyperledger Besu versions prior to 25.1.0](https://besu.hyperledger.org/en/stable/). +Tessera is an open-source private transaction manager developed under the Apache 2.0 license and written in Java. +The primary application of Tessera is as the privacy manager for privacy-enabled Ethereum clients such as +[GoQuorum](https://docs.goquorum.consensys.net) and [Hyperledger Besu versions earlier than 25.1.0](https://besu.hyperledger.org/en/stable/). ## What can you do with Tessera?