Skip to content

Commit

Permalink
Add deprecation note (#1485)
Browse files Browse the repository at this point in the history
* Add deprecation note

Signed-off-by: Joan Edwards <[email protected]>

* remove link

Signed-off-by: Joan E <[email protected]>

* remove incorect link

Signed-off-by: Joan E <[email protected]>

* Update admonition location

Signed-off-by: Joan E <[email protected]>

* copy edits

Signed-off-by: Joan E <[email protected]>

* Apply suggestions

Signed-off-by: Joan E <[email protected]>

* fix broken link

Signed-off-by: Joan Edwards <[email protected]>

* update links

Signed-off-by: Joan Edwards <[email protected]>

* remove wordiness

Signed-off-by: Joan E <[email protected]>

---------

Signed-off-by: Joan Edwards <[email protected]>
Signed-off-by: Joan E <[email protected]>
  • Loading branch information
joaniefromtheblock authored Jan 31, 2024
1 parent bc1c6bd commit dc52b87
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ tags:

# Trace transactions

:::caution Forest pruning deprecation notice

Forest pruning (using the [`--pruning-enabled`](../../reference/cli/options.md#pruning-enabled) option) is deprecated and will be removed in a future release. We recommend using [Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) as an alternative for saving disk space.

:::

To get detailed information about transaction processing, use the [`TRACE` API](../../reference/api/index.md#trace-methods). Enable the `TRACE` API using the [`--rpc-http-api`](../../reference/cli/options.md#rpc-http-api) or [`--rpc-ws-api`](../../reference/cli/options.md#rpc-ws-api) command line options.

The `TRACE` API has two sets of trace calls, [ad-hoc tracing APIs](#ad-hoc-tracing-apis) and [transaction-trace filtering APIs](#transaction-trace-filtering-apis).
Expand Down
12 changes: 12 additions & 0 deletions docs/public-networks/reference/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ import TabItem from '@theme/TabItem';

:::

:::caution Forest pruning deprecation notice

Forest pruning (using the [`--pruning-enabled`](../cli/options.md#pruning-enable.md#pruning-enabled) option) is deprecated and will be removed in a future release. We recommend using [Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) as an alternative for saving disk space.

:::

<Postman />

## `ADMIN` methods
Expand Down Expand Up @@ -7210,6 +7216,12 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"trace_rawTransaction","params":[
Provides transaction processing tracing per block.
:::caution Forest pruning deprecation notice
Forest pruning (using the [`--pruning-enabled`](../cli/options.md#pruning-enabled) option) is deprecated and will be removed in a future release. We recommend using [Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) as an alternative for saving disk space.
:::
:::info
When using [Bonsai](../../concepts/data-storage-formats.md#bonsai-tries), the requested block must be within the number of [blocks retained](../cli/options.md#bonsai-historical-block-limit) (by default, 512 from the head of the chain).
Expand Down
4 changes: 2 additions & 2 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -2810,9 +2810,9 @@ Using pruning with [private transactions](../../../private-networks/concepts/pri

:::

:::note
:::caution

Pruning is being deprecated for [Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) and is currently not being updated.
This option is deprecated and will be removed in a future release. We recommend using [Bonsai Tries](../../concepts/data-storage-formats.md#bonsai-tries) as an alternative for saving disk space.

:::

Expand Down

0 comments on commit dc52b87

Please sign in to comment.