From a4624dd408d72d541487ff01a2de82c4aa647071 Mon Sep 17 00:00:00 2001 From: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> Date: Tue, 11 Jun 2024 23:22:11 -0700 Subject: [PATCH] add additional api methods Signed-off-by: Joan E <153745173+joaniefromtheblock@users.noreply.github.com> --- .../concepts/transactions/pool.md | 56 +++++++++++-------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/docs/public-networks/concepts/transactions/pool.md b/docs/public-networks/concepts/transactions/pool.md index 01e91c11297..8d075059908 100644 --- a/docs/public-networks/concepts/transactions/pool.md +++ b/docs/public-networks/concepts/transactions/pool.md @@ -97,26 +97,36 @@ or free gas networks: will cause an error. * If the [minimum gas price is zero](../../../private-networks/how-to/configure/free-gas.md), the transaction pool price bump is set to `0`, unless you specify a different value using [`--tx-pool-price-bump`](../../reference/cli/options.md#tx-pool-price-bump). -## Transaction pool options and methods - -Options and methods for configuring and monitoring the transaction pool include the following: - -| | Description | Transaction pool type| -|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------| -| [`txpool_besuTransactions`](../../reference/api/index.md#txpool_besutransactions) | API method to list transactions in the transaction pool. | Both | -| [`--tx-pool`](../../reference/cli/options.md#tx-pool) | Option to specify the type of transaction pool to use. | Both | -| [`--tx-pool-enable-save-restore`](../../reference/cli/options.md#tx-pool-enable-save-restore)| Option to enable save and restore functionality for the transaction pool. | Both | -| [`--tx-pool-layer-max-capacity`](../../reference/cli/options.md#tx-pool-layer-max-capacity) | Option to specify the maximum memory capacity of the transaction pool. | Layered only | -| [`--tx-pool-limit-by-account-percentage`](../../reference/cli/options.md#tx-pool-limit-by-account-percentage)| Option to limit the transaction pool by account percentage. | Both | -| [`--tx-pool-max-future-by-sender`](../../reference/cli/options.md#tx-pool-max-future-by-sender)| Option to specify the maximum number of future transactions by sender. | Both | -| [`--tx-pool-max-prioritized`](../../reference/cli/options.md#tx-pool-max-prioritized) | Option to specify the maximum number of prioritized transactions. | Both | -| [`--tx-pool-max-prioritized-by-type`](../../reference/cli/options.md#tx-pool-max-prioritized-by-type)| Option to specify the maximum number of prioritized transactions by type.| Both | -| [`--tx-pool-max-size`](../../reference/cli/options.md#tx-pool-max-size) | Option to specify the maximum size of the transaction pool. | Both | -| [`--tx-pool-min-gas-price`](../../reference/cli/options.md#tx-pool-min-gas-price) | Option to specify the minimum gas price for transactions in the pool. | Both | -| [`--tx-pool-no-local-priority`](../../reference/cli/options.md#tx-pool-no-local-priority) | Option to disable local priority for transactions. | Both | -| [`--tx-pool-price-bump`](../../reference/cli/options.md#tx-pool-price-bump) | Option to specify the price bump percentage to replace an existing transaction. | Both | -| [`--tx-pool-priority-senders`](../../reference/cli/options.md#tx-pool-priority-senders) | Option to specify sender addresses to prioritize in the transaction pool. | Both | -| [`--tx-pool-retention-hours`](../../reference/cli/options.md#tx-pool-retention-hours) | Option to specify the number of hours to retain transactions in the pool. | Both | -| [`--tx-pool-save-file`](../../reference/cli/options.md#tx-pool-save-file) | Option to specify the file for saving the transaction pool state. | Both | -| [`newPendingTransactions`](../../how-to/use-besu-api/rpc-pubsub.md#pending-transactions) | RPC subscription to notify you of transactions added to the transaction pool. | Both | -| [`droppedPendingTransactions`](../../how-to/use-besu-api/rpc-pubsub.md#dropped-transactions) | RPC subscription to notify you of transactions dropped from the transaction pool.| Both | +## Transaction pool methods and options + +Methods and options for configuring and monitoring the transaction pool include the following: + +| Method | Description | +|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| [`txpool_besuTransactions`](../../reference/api/index.md#txpool_besutransactions) | API method to list transactions in the transaction pool. | +| [`txpool_besuStatistics`](../../reference/api/index.md#txpool_besustatistics) | API method to list statistics of the transaction pool. | +| [`txpool_besuPendingTransactions`](../../reference/api/index.md#txpool_besupendingtransactions) | API method to list pending transactions in the transaction pool. | +| [`newPendingTransactions`](../../how-to/use-besu-api/rpc-pubsub.md#pending-transactions) | RPC subscription to notify you of transactions added to the transaction pool. | +| [`droppedPendingTransactions`](../../how-to/use-besu-api/rpc-pubsub.md#dropped-transactions) | RPC subscription to notify you of transactions dropped from the transaction pool. | + + +| Option | Description | +|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| [`--tx-pool`](../../reference/cli/options.md#tx-pool) | Option to specify the type of transaction pool to use. | +| [`--tx-pool-enable-save-restore`](../../reference/cli/options.md#tx-pool-enable-save-restore) | Option to enable save and restore functionality for the transaction pool. | +| [`--tx-pool-layer-max-capacity`](../../reference/cli/options.md#tx-pool-layer-max-capacity) | Option to specify the maximum memory capacity of the transaction pool. | +| [`--tx-pool-limit-by-account-percentage`](../../reference/cli/options.md#tx-pool-limit-by-account-percentage) | Option to limit the transaction pool by account percentage. | +| [`--tx-pool-max-future-by-sender`](../../reference/cli/options.md#tx-pool-max-future-by-sender) | Option to specify the maximum number of future transactions by sender. | +| [`--tx-pool-max-prioritized`](../../reference/cli/options.md#tx-pool-max-prioritized) | Option to specify the maximum number of prioritized transactions. | +| [`--tx-pool-max-prioritized-by-type`](../../reference/cli/options.md#tx-pool-max-prioritized-by-type) | Option to specify the maximum number of prioritized transactions by type. | +| [`--tx-pool-max-size`](../../reference/cli/options.md#tx-pool-max-size) | Option to specify the maximum size of the transaction pool. | +| [`--tx-pool-min-gas-price`](../../reference/cli/options.md#tx-pool-min-gas-price) | Option to specify the minimum gas price for transactions in the pool. | +| [`--tx-pool-no-local-priority`](../../reference/cli/options.md#tx-pool-no-local-priority) | Option to disable local priority for transactions. | +| [`--tx-pool-price-bump`](../../reference/cli/options.md#tx-pool-price-bump) | Option to specify the price bump percentage to replace an existing transaction. | +| [`--tx-pool-priority-senders`](../../reference/cli/options.md#tx-pool-priority-senders) | Option to specify sender addresses to prioritize in the transaction pool. | +| [`--tx-pool-retention-hours`](../../reference/cli/options.md#tx-pool-retention-hours) | Option to specify the number of hours to retain transactions in the pool. | +| [`--tx-pool-save-file`](../../reference/cli/options.md#tx-pool-save-file) | Option to specify the file for saving the transaction pool state. | + +:::note +The option [`--tx-pool-layer-max-capacity`](tx-pool-layer-max-capacity) is applicable only for [layered transaction pools](#layered-transaction-pool). +:::