Skip to content

Commit

Permalink
added deprecation notice to CLI options for onchain permissioning (#1735
Browse files Browse the repository at this point in the history
)

* added deprecation notice to CLI options for onchain permissioning

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

* minor fixes

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

---------

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
  • Loading branch information
macfarla and Alexandra Tran authored Nov 25, 2024
1 parent 7768fe1 commit 74cc143
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/private-networks/how-to/use-permissioning/onchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
22 changes: 17 additions & 5 deletions docs/private-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<Tabs>

Expand Down Expand Up @@ -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)

<Tabs>

Expand Down Expand Up @@ -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`

<Tabs>
Expand Down Expand Up @@ -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)

<Tabs>

Expand Down Expand Up @@ -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)

<Tabs>

Expand Down Expand Up @@ -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)

<Tabs>

Expand Down

0 comments on commit 74cc143

Please sign in to comment.