Add config to toggle the TXM #15714
Add config to toggle the TXM #15714
Conversation
AER Report: CI Core ran successfully ✅AER Report: Operator UI CI ran successfully ✅ |
amit-momin
force-pushed
the
MERC-6516-Allow-disabling-TXM-completely-substitute-null-txm-for-mercury-where-it-isn-t-needed
branch
from
3b65ac2 to
e29572f
Compare
| @@ -49,6 +49,7 @@ type EVM interface { | |||
| NodeNoNewHeadsThreshold() time.Duration | |||
| FinalizedBlockOffset() uint32 | |||
| NoNewFinalizedHeadsThreshold() time.Duration | |||
| TXMEnabled() bool | |||
There was a problem hiding this comment.
We already have EVM.Transactions. Would EVM.Transactions.XYZ make sense? Rather than EVM.TXMEnabled?
EVM.Transactions.EnabledEVM.Transactions.ManagerEnabled- ??
There was a problem hiding this comment.
I considered adding it there but since this also affects the gas estimator I thought it was better to keep the config at the EVM level like LogBroadcasterEnabled. I'm not steadfast on that though so not against moving this under EVM.Transactions. That does remind me that I should update the config description to mention the gas estimator though.
There was a problem hiding this comment.
Why does the gas estimator change things? Does that suggest that we might have wanted it nested as Transactions.GasEstimator?
There was a problem hiding this comment.
I think it still makes sense to have gas estimator configs outside of EVM.Transactions since that component could still be referenced separately. But in the case for chain initialization, the gas estimator depends on the TXM to start its lifecycle which is why they go hand in hand.
There was a problem hiding this comment.
OK, but I am still not seeing how this new field is relevant to the gas estimator. The TXMEnabled() method is only called from one place currently.
There was a problem hiding this comment.
The only relevance is that the new field is also responsible for enabling/disabling gas estimators along with the TXM. Maybe the config name is misleading since it only refers to the TXM.
There was a problem hiding this comment.
I think it should at least be expanded for clarity, but if there is a more general name that would be good.
| TXMEnabled() bool | |
| TransactionManagerEnabled() bool |
| return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err) | ||
| var txm txmgr.TxManager | ||
| var gasEstimator gas.EvmFeeEstimator | ||
| //nolint:gocritic // ignoring styling issue |
There was a problem hiding this comment.
What rule is being suppressed here?
There was a problem hiding this comment.
It wanted me to covert this if-else to a switch statement which I thought wouldn't be as clear to read
There was a problem hiding this comment.
Can you reference that in the description?
core/chains/legacyevm/chain.go
Outdated
| var err error | ||
| txm, gasEstimator, err = newEvmTxm(opts.DS, cfg.EVM(), opts.AppConfig.Database(), opts.AppConfig.Database().Listener(), client, l, logPoller, opts, headTracker, clientsByChainID) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err) |
There was a problem hiding this comment.
| return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID.String(), err) | |
| return nil, fmt.Errorf("failed to instantiate EvmTxm for chain with ID %s: %w", chainID, err) |
MERC-6516
Added the
TXMEnabledconfig to enable or disable the TXM. This toggle was added so a product that only needs read-only access (i.e client, head tracker, log poller) can disable the unused component.