Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add timeboost troubleshooting guide #2113

Merged
merged 33 commits into from
Mar 26, 2025
Merged

Conversation

leeederek
Copy link
Member

this pull request adds a troubleshooting guide and best practice recommendations for users of Timeboost following some testing with a few teams trying Timeboost out.

I'd really like to have a separate Timeboost section since we now have docs on: how to use timeboost, troubleshoot timeboost, and its conceptual design. We will have docs on decentralized timeboost eventually as well.

Copy link

vercel bot commented Feb 28, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Mar 26, 2025 3:24pm

Copy link
Member

@Tristan-Wilson Tristan-Wilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Content mostly good, some files included incorrectly.

Copy link
Contributor

@TucksonDev TucksonDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks ser!
A few notes and comments on the general document, but mainly requesting changes because of the extra files present in the PR.
I'll share a few other comments in Slack.

Copy link
Member Author

@leeederek leeederek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @TucksonDev for your review! How do the changes look to you now?

Copy link
Contributor

@ganeshvanahalli ganeshvanahalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes requested.
Its better to list all the timeboost related errors to clarify which leads to non-consumption of sequence numbers i.e

  • timeboost related error - dont consume
  • other sequencer returned errors or nil- consume

Listing timeboost related errors here as well-

  • MALFORMED_DATA
  • WRONG_CHAIN_ID
  • BAD_ROUND_NUMBER
  • NO_ONCHAIN_CONTROLLER
  • WRONG_AUCTION_CONTRACT
  • NOT_EXPRESS_LANE_CONTROLLER
  • SEQUENCE_NUMBER_ALREADY_SEEN
  • SEQUENCE_NUMBER_TOO_LOW
  • message sequence number has reached max allowed limit. SequenceNumber: %d, ExpectedSequenceNumber: %d, Limit: %d- error for hitting buffer limit, controller should retry with the ExpectedSequenceNumber in this case

@leeederek
Copy link
Member Author

Thanks @ganeshvanahalli for the review. I incorporated our suggested fix & also add more information about the error responses. Could I get another review from you?

@leeederek leeederek requested a review from TucksonDev March 24, 2025 19:06
Copy link
Contributor

@ganeshvanahalli ganeshvanahalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
Minor nit

Copy link
Contributor

@TucksonDev TucksonDev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

Copy link
Contributor

@anegg0 anegg0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@leeederek leeederek merged commit ba7b10f into master Mar 26, 2025
4 checks passed
@leeederek leeederek deleted the derek/troubleshoot-timeboost branch March 26, 2025 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants