From 74cc143104f6b5edd9a070fd98fce1738949d979 Mon Sep 17 00:00:00 2001 From: Sally MacFarlane Date: Mon, 25 Nov 2024 11:40:26 +1000 Subject: [PATCH] added deprecation notice to CLI options for onchain permissioning (#1735) * added deprecation notice to CLI options for onchain permissioning Signed-off-by: Sally MacFarlane * minor fixes Signed-off-by: Alexandra Tran --------- Signed-off-by: Sally MacFarlane Signed-off-by: Alexandra Tran Co-authored-by: Alexandra Tran --- .../how-to/use-permissioning/onchain.md | 2 +- .../private-networks/reference/cli/options.md | 22 ++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/private-networks/how-to/use-permissioning/onchain.md b/docs/private-networks/how-to/use-permissioning/onchain.md index 054062f904..83421e2198 100644 --- a/docs/private-networks/how-to/use-permissioning/onchain.md +++ b/docs/private-networks/how-to/use-permissioning/onchain.md @@ -50,7 +50,7 @@ If you change your network configuration, you may need to update the node allowl ## Specify the permissioning contract interface version -Use the [`--permissions-nodes-contract-version`](../../reference/cli/options.md#permissions-nodes-contract-version) command line option to specify the version of the [permissioning contract interface](../../concepts/permissioning/onchain.md#permissioning-contracts). The default is 1. +Use the [`--permissions-nodes-contract-version`](../../reference/cli/options.md#permissions-nodes-contract-version-deprecated) command line option to specify the version of the [permissioning contract interface](../../concepts/permissioning/onchain.md#permissioning-contracts). The default is 1. Specify the contract interface version that maps to the version of the [Enterprise Ethereum Alliance Client Specification](https://entethalliance.org/technical-specifications/) the contract interface implements. diff --git a/docs/private-networks/reference/cli/options.md b/docs/private-networks/reference/cli/options.md index 72cb3377bf..12b178328c 100644 --- a/docs/private-networks/reference/cli/options.md +++ b/docs/private-networks/reference/cli/options.md @@ -141,7 +141,7 @@ permissions-accounts-config-file-enabled=true Enables or disables file-based account level permissions. The default is `false`. -### `permissions-accounts-contract-address` +### `permissions-accounts-contract-address` (Deprecated) @@ -181,7 +181,7 @@ permissions-accounts-contract-address="xyz" The contract address for [onchain account permissioning](../../concepts/permissioning/onchain.md). -### `permissions-accounts-contract-enabled` +### `permissions-accounts-contract-enabled` (Deprecated) @@ -221,6 +221,12 @@ permissions-accounts-contract-enabled=true Enables or disables contract-based [onchain account permissioning](../../concepts/permissioning/onchain.md). The default is `false`. +:::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. + +::: + ### `permissions-nodes-config-file` @@ -307,7 +313,7 @@ permissions-nodes-config-file-enabled=true Enables or disables file-based node level permissions. The default is `false`. -### `permissions-nodes-contract-address` +### `permissions-nodes-contract-address` (Deprecated) @@ -347,7 +353,7 @@ permissions-nodes-contract-address="xyz" The contract address for [onchain node permissioning](../../concepts/permissioning/onchain.md). -### `permissions-nodes-contract-enabled` +### `permissions-nodes-contract-enabled` (Deprecated) @@ -387,7 +393,13 @@ permissions-nodes-contract-enabled=true Enables or disables contract-based [onchain node permissioning](../../concepts/permissioning/onchain.md). The default is `false`. -### `permissions-nodes-contract-version` +:::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. + +::: + +### `permissions-nodes-contract-version` (Deprecated)