Fix/head tracker config doc (#15115)

* Fix headtracker config doc * make config-docs * changeset
smartcontractkit · Nov 5, 2024 · f8a6218 · f8a6218
1 parent 97abe0f
commit f8a6218
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/.changeset/great-spiders-greet.md b/.changeset/great-spiders-greet.md
@@ -0,0 +1,5 @@
+---
+"chainlink": patch
+---
+
+Fixed outdated headtracker config doc. #internal
diff --git a/core/config/docs/chains-evm.toml b/core/config/docs/chains-evm.toml
@@ -336,8 +336,8 @@ CacheTimeout = '10s' # Default
 [EVM.HeadTracker]
 # HistoryDepth tracks the top N blocks on top of the latest finalized block to keep in the `heads` database table.
 # Note that this can easily result in MORE than `N + finality depth`  records since in the case of re-orgs we keep multiple heads for a particular block height.
-# This number should be at least as large as `FinalityDepth`.
-# There may be a small performance penalty to setting this to something very large (10,000+)
+# Higher values help reduce number of RPC requests performed by TXM's Finalizer and improve TXM's Confirmer reorg protection on restarts.
+# At the same time, setting the value too high could lead to higher CPU consumption. The following formula could be used to calculate the optimal value: `expected_downtime_on_restart/block_time`.
 HistoryDepth = 100 # Default
 # MaxBufferSize is the maximum number of heads that may be
 # buffered in front of the head tracker before older heads start to be

diff --git a/docs/CONFIG.md b/docs/CONFIG.md
@@ -9503,8 +9503,8 @@ HistoryDepth = 100 # Default
 ```
 HistoryDepth tracks the top N blocks on top of the latest finalized block to keep in the `heads` database table.
 Note that this can easily result in MORE than `N + finality depth`  records since in the case of re-orgs we keep multiple heads for a particular block height.
-This number should be at least as large as `FinalityDepth`.
-There may be a small performance penalty to setting this to something very large (10,000+)
+Higher values help reduce number of RPC requests performed by TXM's Finalizer and improve TXM's Confirmer reorg protection on restarts.
+At the same time, setting the value too high could lead to higher CPU consumption. The following formula could be used to calculate the optimal value: `expected_downtime_on_restart/block_time`.
 
 ### MaxBufferSize
 ```toml