perf(crosschain): increase the outbound tracker buffer from 2 to 5
#2482
Conversation
WalkthroughThe recent update increases the outbound tracker buffer length from 2 to 5. This addresses issues with the outbound tracker by allowing more hashes to be stored, thereby reducing incidents caused by invalid trackers. This change is implemented in the Changes
Sequence Diagram(s)No sequence diagrams are necessary as the changes are straightforward constant updates. Assessment against linked issues
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
lumtis
requested review from
brewmaster012,
kingpinXD,
ws4charlie,
skosito,
swift1337 and
fbac
as code owners
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (2)
- changelog.md (1 hunks)
- x/crosschain/keeper/msg_server_add_outbound_tracker.go (1 hunks)
Files skipped from review due to trivial changes (1)
- changelog.md
Additional context used
Path-based instructions (1)
x/crosschain/keeper/msg_server_add_outbound_tracker.go (1)
Pattern
**/*.go: Review the Go code, point out issues relative to principles of clean code, expressiveness, and performance.
Additional comments not posted (1)
x/crosschain/keeper/msg_server_add_outbound_tracker.go (1)
18-18: LGTM! But verify the usage ofMaxOutboundTrackerHashesin the codebase.The change to increase the buffer size from 2 to 5 is approved.
However, ensure that all references to
MaxOutboundTrackerHashesin the codebase are consistent with the new value.Verification successful
Verify the usage of
MaxOutboundTrackerHashesin the codebase.The change to increase the buffer size from 2 to 5 is reflected in the main code and test files:
x/crosschain/keeper/msg_server_add_outbound_tracker.gox/crosschain/keeper/msg_server_add_outbound_tracker_test.goEnsure that all references to
MaxOutboundTrackerHashesare consistent with the new value and that the logic and tests are updated to accommodate the increased buffer size.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to `MaxOutboundTrackerHashes` in the codebase. # Test: Search for the usage of the `MaxOutboundTrackerHashes` constant. Expect: All references should be consistent with the new value. rg --type go 'MaxOutboundTrackerHashes'Length of output: 658
Description
Increase the outbound tracker buffer size from 2 to 5 to mitigate the risk of observers from pushing tx hashes from orphan blocks.
5 chosen as a arbitrary value. The issue of invalid hashes appear about once a month with size of 2. I think 5 is a good number to prevent this scenario.
Closes: #2477
How Has This Been Tested?
Summary by CodeRabbit